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/pl/pkusers.1

    r3279 r3485  
    11.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.36. 
    2 .TH PKUSERS "1" "janvier 2008" "C@LL - Conseil Internet & Logiciels Libres" "User Commands" 
     2.TH PKUSERS "1" "janvier 2009" "C@LL - Conseil Internet & Logiciels Libres" "User Commands" 
    33.SH NOM 
    4 pkusers \- page de manuel de pkusers 1.27alpha3_BROKEN_unofficial 
     4pkusers \- page de manuel de pkusers (PyKota) 1.27alpha7_unofficial 
     5.SH SYNOPSIS 
     6.B pkusers 
     7[\fIoptions\fR] [\fIusernames|groupnames\fR] 
    58.SH DESCRIPTION 
    6 pkusers v1.27alpha3_BROKEN_unofficial (c) 2003, 2004, 2005, 2006, 2007, 2008 Jerome Alet \- alet@librelogiciel.com 
    7 .PP 
    8 An Users and Groups Manager for PyKota. 
    9 .PP 
    10 command line usage : 
     9Manages PyKota users or users groups. 
     10.SH OPTIONS 
     11.TP 
     12\fB\-h\fR, \fB\-\-help\fR 
     13show this help message and exit. 
     14.TP 
     15\fB\-v\fR, \fB\-\-version\fR 
     16show the version number and exit. 
     17.TP 
     18\fB\-A\fR ARGUMENTSFILE, \fB\-\-arguments\fR=\fIARGUMENTSFILE\fR 
     19loads additional options and arguments from a file, 
     20one per line. 
     21.TP 
     22\fB\-a\fR, \fB\-\-add\fR 
     23Add new, or modify existing, users or groups. 
     24.TP 
     25\fB\-b\fR BALANCE, \fB\-\-balance\fR=\fIBALANCE\fR 
     26Set an user's account balance. The value can also be 
     27increased or decreased when the value is prefixed with 
     28\&'+' or '\-'. Users groups don't have a real account 
     29balance, instead the sum of their members' account 
     30balances is used. 
     31.TP 
     32\fB\-C\fR COMMENT, \fB\-\-comment\fR=\fICOMMENT\fR 
     33Associate a textual comment with a change in an user's 
     34account balance. Only meaningful when \fB\-\-balance\fR is 
     35also used. 
     36.TP 
     37\fB\-d\fR, \fB\-\-delete\fR 
     38Delete the specified users or groups. Also purge the 
     39print quota entries and printing history matching the 
     40specified users or groups. 
     41.TP 
     42\fB\-D\fR DESCRIPTION, \fB\-\-description\fR=\fIDESCRIPTION\fR 
     43Set a textual description for the specified users or 
     44groups. 
     45.TP 
     46\fB\-e\fR EMAIL, \fB\-\-email\fR=\fIEMAIL\fR 
     47Set an user's email address. If this parameter begins 
     48with '@' then the username is prepended to this 
     49parameter to form a valid email address. 
     50.TP 
     51\fB\-g\fR, \fB\-\-groups\fR 
     52Manage users groups instead of users. 
     53.TP 
     54\fB\-i\fR INGROUPS, \fB\-\-ingroups\fR=\fIINGROUPS\fR 
     55Put the specified users into the specified groups. 
     56When combined with the \fB\-\-remove\fR option, users are 
     57removed from the specified groups instead. 
     58.TP 
     59\fB\-l\fR LIMITBY, \fB\-\-limitby\fR=\fILIMITBY\fR 
     60Set the limiting factor for the specified users or 
     61groups. Can be any of 'quota' (limit by number of 
     62pages per printer), 'balance' (limit by number of 
     63credits), 'noquota' (no limit but accounting done), 
     64\&'nochange' (no limit and no accounting), or 'noprint' 
     65(printing is denied). The two latter ones are not 
     66supported for groups. 
     67.TP 
     68\fB\-L\fR, \fB\-\-list\fR 
     69Display detailed informations about the specified 
     70users or groups. 
     71.TP 
     72\fB\-o\fR OVERCHARGE, \fB\-\-overcharge\fR=\fIOVERCHARGE\fR 
     73Set the overcharging factor applied to the specified 
     74users when computing the cost of a print job. Any 
     75floating point value can be used, allowing you to 
     76express your creativity... 
     77.TP 
     78\fB\-r\fR, \fB\-\-remove\fR 
     79When combined with the \fB\-\-ingroups\fR option, remove users 
     80from the specified users groups. 
     81.TP 
     82\fB\-s\fR, \fB\-\-skipexisting\fR 
     83If \fB\-\-add\fR is used, ensure that existing users or groups 
     84won't be modified. 
     85.SS "examples:" 
    1186.IP 
    12 pkusers [options] user1 user2 user3 ... userN 
    13 .PP 
    14 or : 
     87pkusers \fB\-\-add\fR john paul george ringo/ringo@example.com 
     88Would make users 'john', 'paul', 'george' and 'ringo' be known to PyKota. 
     89User 'ringo''s email address would be set to 'ringo@example.com'. 
    1590.IP 
    16 pkusers \fB\-\-groups\fR [options] group1 group2 group3 ... groupN 
    17 .PP 
    18 options : 
    19 .TP 
    20 \fB\-v\fR | \fB\-\-version\fR 
    21 Prints pkusers's version number then exits. 
    22 .TP 
    23 \fB\-h\fR | \fB\-\-help\fR 
    24 Prints this message then exits. 
    25 .TP 
    26 \fB\-a\fR | \fB\-\-add\fR 
    27 Adds users if they don't exist on the database. 
    28 If they exist, they are modified unless 
    29 \fB\-s\fR|\-\-skipexisting is also used. 
    30 .TP 
    31 \fB\-d\fR | \fB\-\-delete\fR 
    32 Deletes users from the quota storage. 
    33 .TP 
    34 \fB\-e\fR | \fB\-\-email\fR addr 
    35 Sets the email address for the users. 
    36 If the addr parameter begins with @, then 
    37 the username is prepended to addr to form 
    38 a valid email address. 
    39 .HP 
    40 \fB\-D\fR | \fB\-\-description\fR d Adds a textual description to users or groups. 
    41 .TP 
    42 \fB\-g\fR | \fB\-\-groups\fR 
    43 Edit users groups instead of users. 
    44 .TP 
    45 \fB\-o\fR | \fB\-\-overcharge\fR f 
    46 Sets the overcharging factor applied to the user 
    47 when computing the cost of a print job. Positive or 
    48 negative floating point values are allowed, 
    49 this allows you to do some really creative 
    50 things like giving money to an user whenever 
    51 he prints. The number of pages in a print job 
    52 is not modified by this coefficient, only the 
    53 cost of the job for a particular user. 
    54 Only users have such a coefficient. 
    55 .TP 
    56 \fB\-i\fR | \fB\-\-ingroups\fR g1[,g2...] 
    57 Puts the users into each of the groups 
    58 listed, separated by commas. The groups 
    59 must already exist in the Quota Storage. 
    60 .TP 
    61 \fB\-L\fR | \fB\-\-list\fR 
    62 Lists users or groups. 
    63 .TP 
    64 \fB\-l\fR | \fB\-\-limitby\fR l 
    65 Choose if the user/group is limited in printing 
    66 by its account balance or by its page quota. 
    67 The default value is 'quota'. Allowed values 
    68 are 'quota' 'balance' 'noquota' 'noprint' 
    69 and 'nochange' : 
     91pkusers \fB\-\-add\fR \fB\-\-groups\fR coders it 
     92Would create two users groups named 'coders' and 'it'. 
    7093.IP 
    71 \- quota : limit by number of pages per printer. 
    72 \- balance : limit by number of credits in account. 
    73 \- noquota : no limit, accounting still done. 
    74 \- nochange : no limit, accounting not done. 
    75 \- noprint : printing is denied. 
     94pkusers \fB\-\-add\fR \fB\-\-ingroups\fR coders,it jerome 
     95Would add user 'jerome' and put him into the 'coders' and 'it' groups. 
     96Both groups would have to be existing. 
    7697.IP 
    77 NB : nochange and noprint are not supported for groups. 
    78 .TP 
    79 \fB\-b\fR | \fB\-\-balance\fR b 
    80 Sets the user's account balance to b. 
    81 Account balance may be increase or decreased 
    82 if b is prefixed with + or \-. 
    83 WARNING : when decreasing account balance, 
    84 the total paid so far by the user is decreased 
    85 too. 
    86 Groups don't have a real balance, but the 
    87 sum of their users' account balance. 
    88 .TP 
    89 \fB\-C\fR | \fB\-\-comment\fR txt 
    90 Defines some informational text to be associated 
    91 with a change to an user's account balance. 
    92 Only meaningful if \fB\-b\fR | \fB\-\-balance\fR is also used. 
    93 .TP 
    94 \fB\-r\fR | \fB\-\-remove\fR 
    95 In combination with the \fB\-\-ingroups\fR option above, 
    96 remove users from the specified users groups. 
    97 .TP 
    98 \fB\-s\fR | \fB\-\-skipexisting\fR 
    99 In combination with the \fB\-\-add\fR option above, tells 
    100 pkusers to not modify existing users. 
     98pkusers \fB\-\-limitby\fR balance \fB\-\-balance\fR 10.0 john 
     99Would give 10.0 credits to 'john' and make his printing be limited by his 
     100account balance. 
    101101.IP 
    102 user1 through userN and group1 through groupN can use wildcards 
    103 if the \fB\-\-add\fR option is not set. 
    104 .PP 
    105 examples : 
     102pkusers \fB\-\-balance\fR +10.0 \fB\-\-comment\fR "He paid with his blood." jerome 
     103Would add 10.0 credits to 'jerome''s account and register a comment 
     104associated with his payment. 
    106105.IP 
    107 \f(CW$ pkusers \-\-add john paul george ringo/ringo@example.com\fR 
     106pkusers \fB\-\-delete\fR "jer*" "rach*" 
     107Would delete all user accounts whose names begin with either 'jer' or 
     108\&'rach'. 
    108109.IP 
    109 This will add users john, paul, george and ringo to the quota 
    110 database. User ringo's email address will also be set to 
    111 \&'ringo@example.com' 
     110pkusers \fB\-\-overcharge\fR \fB\-1\fR.50 theboss 
     111Would make the boss earn money whenever he prints. 
    112112.IP 
    113 \f(CW$ pkusers \-\-ingroups coders,it jerome\fR 
     113pkusers \fB\-\-email\fR @example.com 
     114Would set the email address for each existing user to username@example.com 
    114115.IP 
    115 User jerome is put into the groups "coders" and "it" which must 
    116 already exist in the quota database. 
     116pkusers \fB\-\-list\fR 
     117Would list all users. 
     118.SS "licensing terms:" 
    117119.IP 
    118 \f(CW$ pkusers \-\-limitby balance jerome\fR 
     120(c) 2003\-2009 Jerome Alet \- alet@librelogiciel.com 
     121This program is free software: you can redistribute it and/or modify it 
     122under the terms of the GNU General Public License as published by the Free 
     123Software Foundation, either version 3 of the License, or (at your option) 
     124any later version. 
    119125.IP 
    120 This will tell PyKota to limit jerome by his account's balance 
    121 when printing. 
     126This program is distributed in the hope that it will be useful, but 
     127WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY 
     128or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License 
     129for more details. 
    122130.IP 
    123 \f(CW$ pkusers \-\-balance +10.0 \-\-comment "He paid with his blood !" jerome\fR 
    124 .IP 
    125 This will increase jerome's account balance by 10.0 (in your 
    126 own currency). You can decrease the account balance with a 
    127 dash prefix, and set it to a fixed amount with no prefix. 
    128 A comment will be stored for this balance change. 
    129 .IP 
    130 \f(CW$ pkusers \-\-delete jerome rachel\fR 
    131 .IP 
    132 This will completely delete jerome and rachel from the quota 
    133 database. All their quotas and jobs will be deleted too. 
    134 .IP 
    135 \f(CW$ pkusers \-\-overcharge 2.5 poorstudent\fR 
    136 .IP 
    137 This will overcharge the poorstudent user by a factor of 2.5. 
    138 .IP 
    139 \f(CW$ pkusers \-\-overcharge -1 jerome\fR 
    140 .IP 
    141 User jerome will actually earn money whenever he prints. 
    142 .IP 
    143 \f(CW$ pkusers \-\-overcharge 0 boss\fR 
    144 .IP 
    145 User boss can print at will, it won't cost him anything because the 
    146 cost of each print job will be multiplied by zero before charging 
    147 his account. 
    148 .IP 
    149 \f(CW$ pkusers \-\-email @example.com\fR 
    150 .IP 
    151 This will set the email address for each user to username@example.com 
    152 .PP 
    153 (c) 2003, 2004, 2005, 2006, 2007, 2008 Jerome Alet <alet@librelogiciel.com> 
    154 This program is free software: you can redistribute it and/or modify 
    155 it under the terms of the GNU General Public License as published by 
    156 the Free Software Foundation, either version 3 of the License, or 
    157 (at your option) any later version. 
    158 .PP 
    159 This program is distributed in the hope that it will be useful, 
    160 but WITHOUT ANY WARRANTY; without even the implied warranty of 
    161 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the 
    162 GNU General Public License for more details. 
    163 .PP 
    164 You should have received a copy of the GNU General Public License 
    165 along with this program.  If not, see <http://www.gnu.org/licenses/>. 
    166 .PP 
    167 Please report bugs to : Jerome Alet \- alet@librelogiciel.com 
     131You should have received a copy of the GNU General Public License along 
     132with this program.  If not, see <http://www.gnu.org/licenses/>.