Show
Ignore:
Timestamp:
01/24/09 22:38:46 (15 years ago)
Author:
jerome
Message:

Updated manual pages.

Files:
1 modified

Legend:

Unmodified
Added
Removed
  • pykota/trunk/man/pt/edpykota.1

    r3279 r3485  
    11.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.36. 
    2 .TH EDPYKOTA "1" "janvier 2008" "C@LL - Conseil Internet & Logiciels Libres" "User Commands" 
     2.TH EDPYKOTA "1" "janvier 2009" "C@LL - Conseil Internet & Logiciels Libres" "User Commands" 
    33.SH NOM 
    4 edpykota \- page de manuel de edpykota 1.27alpha3_BROKEN_unofficial 
     4edpykota \- page de manuel de edpykota (PyKota) 1.27alpha7_unofficial 
     5.SH SYNOPSIS 
     6.B edpykota 
     7[\fIoptions\fR] [\fIusernames|groupnames\fR] 
    58.SH DESCRIPTION 
    6 edpykota v1.27alpha3_BROKEN_unofficial (c) 2003, 2004, 2005, 2006, 2007, 2008 Jerome Alet \- alet@librelogiciel.com 
    7 .PP 
    8 A Print Quota editor for PyKota. 
    9 .PP 
    10 command line usage : 
     9Manages PyKota print quota entries for users or users groups. A print quota 
     10entry is related to both an user and a printer, or to both a group and a 
     11printer, meaning that for example different users can have different page 
     12count limits on the same printer. If an user doesn't have a print quota entry 
     13on a particular printer, he won't be allowed to print to it. 
     14.SH OPTIONS 
     15.TP 
     16\fB\-h\fR, \fB\-\-help\fR 
     17show this help message and exit. 
     18.TP 
     19\fB\-v\fR, \fB\-\-version\fR 
     20show the version number and exit. 
     21.TP 
     22\fB\-A\fR ARGUMENTSFILE, \fB\-\-arguments\fR=\fIARGUMENTSFILE\fR 
     23loads additional options and arguments from a file, 
     24one per line. 
     25.TP 
     26\fB\-a\fR, \fB\-\-add\fR 
     27Add new, or modify existing, users or groups print 
     28quota entries. 
     29.TP 
     30\fB\-d\fR, \fB\-\-delete\fR 
     31Delete the specified users or groups print quota 
     32entries. When deleting users print quota entries, the 
     33matching jobs are also deleted from the printing 
     34history. 
     35.TP 
     36\fB\-S\fR SOFTLIMIT, \fB\-\-softlimit\fR=\fISOFTLIMIT\fR 
     37Set the soft page count limit for the specified print 
     38quota entries. Users can print over this limit for a 
     39number of days specified in the 'gracedelay' directive 
     40in pykota.conf 
     41.TP 
     42\fB\-H\fR HARDLIMIT, \fB\-\-hardlimit\fR=\fIHARDLIMIT\fR 
     43Set the hard page count limit for the specified print 
     44quota entries. Users are never allowed to print over 
     45this limit. 
     46.TP 
     47\fB\-g\fR, \fB\-\-groups\fR 
     48Manage groups print quota entries instead of users 
     49print quota entries. 
     50.TP 
     51\fB\-I\fR INCREASE, \fB\-\-increase\fR=\fIINCREASE\fR 
     52Increase the existing soft and hard page count limits 
     53for the specified print quota entries. You can 
     54decrease the values instead by prefixing this 
     55parameter with a negative sign. 
     56.TP 
     57\fB\-L\fR, \fB\-\-list\fR 
     58Display detailed informations about the specified 
     59users or groups print quota entries. 
     60.TP 
     61\fB\-n\fR, \fB\-\-noquota\fR 
     62Set no limit for both soft and hard page counts for 
     63the specified users or groups print quota entries. 
     64.TP 
     65\fB\-P\fR PRINTER, \fB\-\-printer\fR=\fIPRINTER\fR 
     66Specify a comma separated list of printers you want to 
     67manage print quota entries on. The default is '*', 
     68meaning all printers. 
     69.TP 
     70\fB\-r\fR, \fB\-\-reset\fR 
     71Reset the actual page counter for the specified users 
     72print quota entries (doesn't work for groups print 
     73quota entries). The life time page counter is left 
     74unchanged. 
     75.TP 
     76\fB\-R\fR, \fB\-\-hardreset\fR 
     77Reset the actual and life time page counters for the 
     78specified users print quota entries (doesn't work for 
     79groups print quota entries). This is a shortcut for 
     80\fB\-\-used\fR 0. 
     81.TP 
     82\fB\-s\fR, \fB\-\-skipexisting\fR 
     83If \fB\-\-add\fR is used, ensure that existing users or groups 
     84print quota entries won't be modified. 
     85.TP 
     86\fB\-U\fR USED, \fB\-\-used\fR=\fIUSED\fR 
     87Set the values of both the actual and life time page 
     88counters for the specified users print quota entries 
     89(doesn't work for groups print quota entries). This 
     90can be useful when migrating from a different print 
     91quota software. The values can also be increased or 
     92decreased by prefixing this parameter with either a 
     93positive or negative sign. 
     94.SS "examples:" 
    1195.IP 
    12 edpykota [options] user1 user2 ... userN 
     96edpykota \fB\-\-add\fR john paul george ringo 
     97Would create print quota entries with no page count limits for these four 
     98users on all existing printers. 
    1399.IP 
    14 edpykota [options] group1 group2 ... groupN 
    15 .PP 
    16 options : 
    17 .TP 
    18 \fB\-v\fR | \fB\-\-version\fR 
    19 Prints edpykota's version number then exits. 
    20 .TP 
    21 \fB\-h\fR | \fB\-\-help\fR 
    22 Prints this message then exits. 
    23 .TP 
    24 \fB\-a\fR | \fB\-\-add\fR 
    25 Adds users or groups print quota entries if 
    26 they don't exist in database. 
    27 .TP 
    28 \fB\-d\fR | \fB\-\-delete\fR 
    29 Deletes users or groups print quota entries. 
    30 Users or groups are never deleted, you have 
    31 to use the pkusers command to delete them. 
    32 The history will be purge from all matching 
    33 jobs, unless \fB\-g\fR | \fB\-\-groups\fR is used. 
    34 .TP 
    35 \fB\-P\fR | \fB\-\-printer\fR p 
    36 Edit quotas on printer p only. Actually p can 
    37 use wildcards characters to select only 
    38 some printers. The default value is *, meaning 
    39 all printers. 
    40 You can specify several names or wildcards, 
    41 by separating them with commas. 
    42 .TP 
    43 \fB\-g\fR | \fB\-\-groups\fR 
    44 Edit groups print quota entries instead of 
    45 users print quota entries. 
    46 .TP 
    47 \fB\-L\fR | \fB\-\-list\fR 
    48 Lists users or groups print quota entries. 
    49 .TP 
    50 \fB\-n\fR | \fB\-\-noquota\fR 
    51 Sets both soft and hard limits to None for users 
    52 or groups print quota entries. 
    53 .TP 
    54 \fB\-r\fR | \fB\-\-reset\fR 
    55 Resets the actual page counter for the user 
    56 or group to zero on the specified printers. 
    57 The life time page counter is kept unchanged. 
    58 .TP 
    59 \fB\-R\fR | \fB\-\-hardreset\fR 
    60 Resets the actual and life time page counters 
    61 for the user or group to zero on the specified 
    62 printers. This is a shortcut for '\-\-used 0'. 
    63 .TP 
    64 \fB\-s\fR | \fB\-\-skipexisting\fR 
    65 In combination with the \fB\-\-add\fR option above, tells 
    66 edpykota to not modify existing print quota entries. 
    67 .TP 
    68 \fB\-S\fR | \fB\-\-softlimit\fR sl 
    69 Sets the quota soft limit to sl pages. 
    70 .TP 
    71 \fB\-H\fR | \fB\-\-hardlimit\fR hl 
    72 Sets the quota hard limit to hl pages. 
    73 .TP 
    74 \fB\-I\fR | \fB\-\-increase\fR v 
    75 Increase existing Soft and Hard limits by the value 
    76 of v. You can prefix v with + or \-, if no sign is 
    77 used, + is assumed. 
    78 .TP 
    79 \fB\-U\fR | \fB\-\-used\fR u 
    80 Sets the page counters for the user u pages on 
    81 the selected printers. Doesn't work for groups, since 
    82 their page counters are the sum of all their members' 
    83 page counters. 
    84 Useful for migrating users from a different system 
    85 where they have already used some pages. Actual 
    86 and Life Time page counters may be increased or decreased 
    87 if u is prefixed with + or \-. 
    88 WARNING : BOTH page counters are modified in all cases, 
    89 so be careful. 
    90 NB : if u equals '0', then the action taken is 
    91 the same as if \fB\-\-hardreset\fR was used. 
     100edpykota \fB\-\-printer\fR HP \fB\-\-softlimit\fR 50 \fB\-\-hardlimit\fR 60 jerome 
     101Would allow user 'jerome' to print up to 60 pages on printer 'HP'. This 
     102user would be warned when he would have reached 50 pages on this printer. 
     103Both the user and printer must have been created previously using the 
     104pkusers and pkprinters commands, respectively. 
    92105.IP 
    93 user1 through userN and group1 through groupN can use wildcards 
    94 if the \fB\-\-add\fR option is not set. 
    95 .PP 
    96 examples : 
     106edpykota \fB\-\-groups\fR \fB\-\-softlimit\fR 500 \fB\-\-hardlimit\fR 600 support financial 
     107Would set soft and hard page count limits on any printer for groups 
     108\&'support' and 'financial'. 
    97109.IP 
    98 \f(CW$ edpykota \-\-add john paul george ringo\fR 
     110edpykota \fB\-\-reset\fR \fB\-\-printer\fR HP jerome "jo*" 
     111Would reset the actual page counter for users 'jerome' and all users whose 
     112name begins with 'jo' on printer 'HP'. 
    99113.IP 
    100 This will create print quota entries for users john, paul, george 
    101 and ringo on all printers. These print quota entries will have no 
    102 limit set. 
     114edpykota \fB\-\-printer\fR HPCOLOR \fB\-\-noquota\fR jerome 
     115Would allow this user to print without any page limit on printer 
     116\&'HPCOLOR'. Depending on how this user is limited, he may still be subject 
     117to being limited by the number of available credits in his account. 
    103118.IP 
    104 \f(CW$ edpykota \-\-printer lp -S 50 -H 60 jerome\fR 
     119edpykota \fB\-\-add\fR \fB\-\-skipexisting\fR 
     120Would create a print quota entry for each user on each printer for which 
     121none already existed. You'll most likely want to use this command at least 
     122once after initial setup. 
     123.SS "licensing terms:" 
    105124.IP 
    106 This will set jerome's print quota on the lp printer to a soft limit 
    107 of 50 pages, and a hard limit of 60 pages. Both user jerome and 
    108 printer lp have been previously created with the pkusers and pkprinters 
    109 commands, respectively. 
     125(c) 2003\-2009 Jerome Alet \- alet@librelogiciel.com 
     126This program is free software: you can redistribute it and/or modify it 
     127under the terms of the GNU General Public License as published by the Free 
     128Software Foundation, either version 3 of the License, or (at your option) 
     129any later version. 
    110130.IP 
    111 \f(CW$ edpykota -g -S 500 -H 550 financial support\fR 
     131This program is distributed in the hope that it will be useful, but 
     132WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY 
     133or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License 
     134for more details. 
    112135.IP 
    113 This will set print quota soft limit to 500 pages and hard limit 
    114 to 550 pages for groups financial and support on all printers. 
    115 .IP 
    116 \f(CW$ edpykota \-\-reset jerome "jo*"\fR 
    117 .IP 
    118 This will reset jerome's page counter to zero on all printers, as 
    119 well as every user whose name begins with 'jo'. 
    120 Their life time page counter on each printer will be kept unchanged. 
    121 You can also reset the life time page counters by using the 
    122 \fB\-\-hardreset\fR | \fB\-R\fR command line option. 
    123 .IP 
    124 \f(CW$ edpykota \-\-printer hpcolor \-\-noquota jerome\fR 
    125 .IP 
    126 This will tell PyKota to not limit jerome when printing on the 
    127 hpcolor printer. All his jobs will be allowed on this printer, but 
    128 accounting of the pages he prints will still be kept. 
    129 Print Quotas for jerome on other printers are unchanged. 
    130 .IP 
    131 \f(CW$ edpykota \-\-delete \-\-printer "HP*,XER*" jerome rachel\fR 
    132 .IP 
    133 This will delete users jerome and rachel's print quota 
    134 entries on all printers which name begin with 'HP' or 
    135 \&'XER'. The jobs printed by these users on these printers 
    136 will be deleted from the history. 
    137 .PP 
    138 (c) 2003, 2004, 2005, 2006, 2007, 2008 Jerome Alet <alet@librelogiciel.com> 
    139 This program is free software: you can redistribute it and/or modify 
    140 it under the terms of the GNU General Public License as published by 
    141 the Free Software Foundation, either version 3 of the License, or 
    142 (at your option) any later version. 
    143 .PP 
    144 This program is distributed in the hope that it will be useful, 
    145 but WITHOUT ANY WARRANTY; without even the implied warranty of 
    146 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the 
    147 GNU General Public License for more details. 
    148 .PP 
    149 You should have received a copy of the GNU General Public License 
    150 along with this program.  If not, see <http://www.gnu.org/licenses/>. 
    151 .PP 
    152 Please report bugs to : Jerome Alet \- alet@librelogiciel.com 
     136You should have received a copy of the GNU General Public License along 
     137with this program.  If not, see <http://www.gnu.org/licenses/>.