root / pykota / trunk / man / it / pkusers.1 @ 2934

Revision 2910, 5.2 kB (checked in by jerome, 18 years ago)

Updated URLs in manual pages too.

Line 
1.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.36.
2.TH PKUSERS "1" "juin 2006" "C@LL - Conseil Internet & Logiciels Libres" "User Commands"
3.SH NOM
4pkusers \- page de manuel de pkusers 1.25alpha5_unofficial
5.SH DESCRIPTION
6pkusers v1.25alpha5_unofficial (c) 2003, 2004, 2005, 2006 Jerome Alet \- alet@librelogiciel.com
7.PP
8An Users and Groups Manager for PyKota.
9.PP
10command line usage :
11.IP
12pkusers [options] user1 user2 user3 ... userN
13.PP
14or :
15.IP
16pkusers \fB\-\-groups\fR [options] group1 group2 group3 ... groupN
17.PP
18options :
19.TP
20\fB\-v\fR | \fB\-\-version\fR
21Prints pkusers's version number then exits.
22.TP
23\fB\-h\fR | \fB\-\-help\fR
24Prints this message then exits.
25.TP
26\fB\-a\fR | \fB\-\-add\fR
27Adds users if they don't exist on the database.
28If they exist, they are modified unless
29\fB\-s\fR|\-\-skipexisting is also used.
30.TP
31\fB\-d\fR | \fB\-\-delete\fR
32Deletes users from the quota storage.
33.HP
34\fB\-D\fR | \fB\-\-description\fR d Adds a textual description to users or groups.
35.TP
36\fB\-g\fR | \fB\-\-groups\fR
37Edit users groups instead of users.
38.TP
39\fB\-o\fR | \fB\-\-overcharge\fR f
40Sets the overcharging factor applied to the user
41when computing the cost of a print job. Positive or
42negative floating point values are allowed,
43this allows you to do some really creative
44things like giving money to an user whenever
45he prints. The number of pages in a print job
46is not modified by this coefficient, only the
47cost of the job for a particular user.
48Only users have such a coefficient.
49.TP
50\fB\-i\fR | \fB\-\-ingroups\fR g1[,g2...]
51Puts the users into each of the groups
52listed, separated by commas. The groups
53must already exist in the Quota Storage.
54.TP
55\fB\-L\fR | \fB\-\-list\fR
56Lists users or groups.
57.TP
58\fB\-l\fR | \fB\-\-limitby\fR l
59Choose if the user/group is limited in printing
60by its account balance or by its page quota.
61The default value is 'quota'. Allowed values
62are 'quota' 'balance' 'noquota' 'noprint'
63and 'nochange' :
64.IP
65\- quota : limit by number of pages per printer.
66\- balance : limit by number of credits in account.
67\- noquota : no limit, accounting still done.
68\- nochange : no limit, accounting not done.
69\- noprint : printing is denied.
70.IP
71NB : nochange and noprint are not supported for groups.
72.TP
73\fB\-b\fR | \fB\-\-balance\fR b
74Sets the user's account balance to b.
75Account balance may be increase or decreased
76if b is prefixed with + or \-.
77WARNING : when decreasing account balance,
78the total paid so far by the user is decreased
79too.
80Groups don't have a real balance, but the
81sum of their users' account balance.
82.TP
83\fB\-C\fR | \fB\-\-comment\fR txt
84Defines some informational text to be associated
85with a change to an user's account balance.
86Only meaningful if \fB\-b\fR | \fB\-\-balance\fR is also used.
87.TP
88\fB\-r\fR | \fB\-\-remove\fR
89In combination with the \fB\-\-ingroups\fR option above,
90remove users from the specified users groups.
91.TP
92\fB\-s\fR | \fB\-\-skipexisting\fR
93In combination with the \fB\-\-add\fR option above, tells
94pkusers to not modify existing users.
95.IP
96user1 through userN and group1 through groupN can use wildcards
97if the \fB\-\-add\fR option is not set.
98.PP
99examples :
100.IP
101\f(CW$ pkusers --add john paul george ringo/ringo@example.com\fR
102.IP
103This will add users john, paul, george and ringo to the quota
104database. User ringo's email address will also be set to
105\&'ringo@example.com'
106.IP
107\f(CW$ pkusers --ingroups coders,it jerome\fR
108.IP
109User jerome is put into the groups "coders" and "it" which must
110already exist in the quota database.
111.IP
112\f(CW$ pkusers --limitby balance jerome\fR
113.IP
114This will tell PyKota to limit jerome by his account's balance
115when printing.
116.IP
117\f(CW$ pkusers --balance +10.0 --comment "He paid with his blood !" jerome\fR
118.IP
119This will increase jerome's account balance by 10.0 (in your
120own currency). You can decrease the account balance with a
121dash prefix, and set it to a fixed amount with no prefix.
122A comment will be stored for this balance change.
123.IP
124\f(CW$ pkusers --delete jerome rachel\fR
125.IP
126This will completely delete jerome and rachel from the quota
127database. All their quotas and jobs will be deleted too.
128.IP
129\f(CW$ pkusers --overcharge 2.5 poorstudent\fR
130.IP
131This will overcharge the poorstudent user by a factor of 2.5.
132.IP
133\f(CW$ pkusers --overcharge -1 jerome\fR
134.IP
135User jerome will actually earn money whenever he prints.
136.IP
137\f(CW$ pkusers --overcharge 0 boss\fR
138.IP
139User boss can print at will, it won't cost him anything because the
140cost of each print job will be multiplied by zero before charging
141his account.
142.PP
143This program is free software; you can redistribute it and/or modify
144it under the terms of the GNU General Public License as published by
145the Free Software Foundation; either version 2 of the License, or
146(at your option) any later version.
147.PP
148This program is distributed in the hope that it will be useful,
149but WITHOUT ANY WARRANTY; without even the implied warranty of
150MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
151GNU General Public License for more details.
152.PP
153You should have received a copy of the GNU General Public License
154along with this program; if not, write to the Free Software
155Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110\-1301, USA.
156.PP
157Please report bugs to : Jerome Alet \- alet@librelogiciel.com
Note: See TracBrowser for help on using the browser.