root / pykota / trunk / man / pkusers.1 @ 3216

Revision 3201, 5.5 kB (checked in by jerome, 17 years ago)

v1.26beta is out

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