root / pykota / trunk / man / th / edpykota.1 @ 2646

Revision 2562, 8.8 kB (checked in by jerome, 19 years ago)

1.23 final is out.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
Line 
1.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.35.
2.TH EDPYKOTA "1" "octobre 2005" "C@LL - Conseil Internet & Logiciels Libres" "User Commands"
3.SH NOM
4edpykota \- page de manuel de edpykota 1.23_unofficial
5.SH DESCRIPTION
6edpykota v1.23_unofficial (c) 2003, 2004, 2005 Jerome Alet \- alet@librelogiciel.com
7.PP
8A Print Quota editor for PyKota.
9.PP
10command line usage :
11.IP
12edpykota [options] user1 user2 ... userN
13.IP
14edpykota [options] group1 group2 ... groupN
15.PP
16options :
17.TP
18\fB\-v\fR | \fB\-\-version\fR
19Prints edpykota's version number then exits.
20.TP
21\fB\-h\fR | \fB\-\-help\fR
22Prints this message then exits.
23.TP
24\fB\-a\fR | \fB\-\-add\fR
25Adds users and/or printers if they don't
26exist on the Quota Storage Server.
27.TP
28\fB\-d\fR | \fB\-\-delete\fR
29Deletes users/groups from the quota storage.
30Printers are never deleted.
31.TP
32\fB\-c\fR | \fB\-\-charge\fR p[,j]
33Sets the price per page and per job to charge
34for a particular printer. Job price is optional.
35If both are to be set, separate them with a comma.
36Floating point values are allowed.
37.TP
38\fB\-o\fR | \fB\-\-overcharge\fR f
39Sets the overcharging factor applied to the user
40when computing the cost of a print job. Positive or
41negative floating point values are allowed,
42this allows you to do some really creative
43things like giving money to an user whenever
44he prints. The number of pages in a print job
45is not modified by this coefficient, only the
46cost of the job for a particular user.
47Only users have a coefficient.
48.TP
49\fB\-i\fR | \fB\-\-ingroups\fR g1[,g2...]
50Puts the users into each of the groups
51listed, separated by commas. The groups
52must already exist in the Quota Storage.
53.TP
54\fB\-u\fR | \fB\-\-users\fR
55Edit users print quotas, this is the default.
56.TP
57\fB\-P\fR | \fB\-\-printer\fR p
58Edit quotas on printer p only. Actually p can
59use wildcards characters to select only
60some printers. The default value is *, meaning
61all printers.
62You can specify several names or wildcards,
63by separating them with commas.
64.TP
65\fB\-G\fR | \fB\-\-pgroups\fR pg1[,pg2...] Adds the printer(s) to the printer groups
66pg1, pg2, etc... which must already exist.
67A printer group is just like a normal printer,
68only that it is usually unknown from the printing
69system. Create printer groups exactly the same
70way that you create printers, then add other
71printers to them with this option.
72Accounting is done on a printer and on all
73the printer groups it belongs to, quota checking
74is done on a printer and on all the printer groups
75it belongs to.
76.TP
77\fB\-g\fR | \fB\-\-groups\fR
78Edit users groups print quotas instead of users.
79.TP
80\fB\-p\fR | \fB\-\-prototype\fR u|g Uses user u or group g as a prototype to set
81print quotas
82.TP
83\fB\-n\fR | \fB\-\-noquota\fR
84Sets both soft and hard limits to None for a
85particular print quota entry.
86This is NOT the same as \fB\-\-limitby\fR noquota
87which acts on ALL print quota entries for a
88particular user.
89.TP
90\fB\-r\fR | \fB\-\-reset\fR
91Resets the actual page counter for the user
92or group to zero on the specified printers.
93The life time page counter is kept unchanged.
94.TP
95\fB\-R\fR | \fB\-\-hardreset\fR
96Resets the actual and life time page counters
97for the user or group to zero on the specified
98printers. This is a shortcut for '\-\-used 0'.
99.TP
100\fB\-l\fR | \fB\-\-limitby\fR l
101Choose if the user/group is limited in printing
102by its account balance or by its page quota.
103The default value is 'quota'. Allowed values
104are 'quota' 'balance' 'noquota' 'noprint'
105and 'nochange' :
106.IP
107\- quota : limit by number of pages per printer.
108\- balance : limit by number of credits in account.
109\- noquota : no limit, accounting still done.
110\- nochange : no limit, accounting not done.
111\- noprint : printing is denied.
112.IP
113NB : nochange and noprint are not supported for groups.
114.TP
115\fB\-b\fR | \fB\-\-balance\fR b
116Sets the user's account balance to b.
117Account balance may be increase or decreased
118if b is prefixed with + or \-.
119WARNING : when decreasing account balance,
120the total paid so far by the user is decreased
121too.
122Groups don't have a real balance, but the
123sum of their users' account balance.
124.TP
125\fB\-C\fR | \fB\-\-comment\fR txt
126Defines some informational text to be associated
127with a change to an user's account balance.
128Only meaningful if \fB\-b\fR | \fB\-\-balance\fR is also used.
129.TP
130\fB\-S\fR | \fB\-\-softlimit\fR sl
131Sets the quota soft limit to sl pages.
132.TP
133\fB\-H\fR | \fB\-\-hardlimit\fR hl
134Sets the quota hard limit to hl pages.
135.TP
136\fB\-I\fR | \fB\-\-increase\fR v
137Increase both Soft and Hard limits by the value
138of v. You can prefix v with + or \-, if no sign is
139used, + is assumed.
140.TP
141\fB\-U\fR | \fB\-\-used\fR usage
142Sets the pagecounters for the user to usage pages;
143useful for migrating users from a different system
144where they have already used some pages. Actual
145and Life Time page counters may be increased or decreased
146if usage is prefixed with + or \-.
147WARNING : BOTH page counters are modified in all cases,
148so be careful.
149NB : if 'usage' equals '0', then the action taken is
150the same as if \fB\-\-hardreset\fR was used.
151.IP
152user1 through userN and group1 through groupN can use wildcards
153if the \fB\-\-add\fR option is not set.
154.PP
155examples :
156.IP
157\f(CW$ edpykota --add -p jerome john paul george ringo/ringo@example.com\fR
158.IP
159This will add users john, paul, george and ringo to the quota
160database, and set their print quotas to the same values than user
161jerome. User jerome must already exist.
162User ringo's email address will also be set to 'ringo@example.com'
163.IP
164\f(CW$ edpykota --printer lp -S 50 -H 60 jerome\fR
165.IP
166This will set jerome's print quota on the lp printer to a soft limit
167of 50 pages, and a hard limit of 60 pages. If either user jerome or
168printer lp doesn't exist on the Quota Storage Server then nothing is done.
169.IP
170\f(CW$ edpykota --add --printer lp --ingroups coders,it -S 50 -H 60 jerome\fR
171.IP
172Same as above, but if either user jerome or printer lp doesn't exist
173on the Quota Storage Server they are automatically added. Also
174user jerome is put into the groups "coders" and "it" which must
175already exist in the Quota Storage.
176.IP
177\f(CW$ edpykota -g -S 500 -H 550 financial support\fR
178.IP
179This will set print quota soft limit to 500 pages and hard limit
180to 550 pages for groups financial and support on all printers.
181.IP
182\f(CW$ edpykota --reset jerome "jo*"\fR
183.IP
184This will reset jerome's page counter to zero on all printers, as
185well as every user whose name begins with 'jo'.
186Their life time page counter on each printer will be kept unchanged.
187You can also reset the life time page counters by using the
188\fB\-\-hardreset\fR | \fB\-R\fR command line option.
189.IP
190\f(CW$ edpykota --printer hpcolor --noquota jerome\fR
191.IP
192This will tell PyKota to not limit jerome when printing on the
193hpcolor printer. All his jobs will be allowed on this printer, but
194accounting of the pages he prints will still be kept.
195Print Quotas for jerome on other printers are unchanged.
196.IP
197\f(CW$ edpykota --limitby balance jerome\fR
198.IP
199This will tell PyKota to limit jerome by his account's balance
200when printing.
201.IP
202\f(CW$ edpykota --balance +10.0 jerome\fR
203.IP
204This will increase jerome's account balance by 10.0 (in your
205own currency). You can decrease the account balance with a
206dash prefix, and set it to a fixed amount with no prefix.
207.IP
208\f(CW$ edpykota --delete jerome rachel\fR
209.IP
210This will completely delete jerome and rachel from the Quota Storage
211database. All their quotas and jobs will be deleted too.
212.IP
213\f(CW$ edpykota --printer lp --charge 0.1\fR
214.IP
215This will set the page price for printer lp to 0.1. Job price
216will not be changed.
217.IP
218\f(CW$ edpykota --printer hplj1,hplj2 --pgroups Laser,HP\fR
219.IP
220This will put printers hplj1 and hplj2 in printers groups Laser and HP.
221When printing either on hplj1 or hplj2, print quota will also be
222checked and accounted for on virtual printers Laser and HP.
223.IP
224\f(CW$ edpykota --overcharge 2.5 poorstudent\fR
225.IP
226This will overcharge the poorstudent user by a factor of 2.5.
227.IP
228\f(CW$ edpykota --overcharge -1 jerome\fR
229.IP
230User jerome will actually earn money whenever he prints.
231.IP
232\f(CW$ edpykota --overcharge 0 boss\fR
233.IP
234User boss can print at will, it won't cost him anything because the
235cost of each print job will be multiplied by zero before charging
236his account.
237.PP
238This program is free software; you can redistribute it and/or modify
239it under the terms of the GNU General Public License as published by
240the Free Software Foundation; either version 2 of the License, or
241(at your option) any later version.
242.PP
243This program is distributed in the hope that it will be useful,
244but WITHOUT ANY WARRANTY; without even the implied warranty of
245MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
246GNU General Public License for more details.
247.PP
248You should have received a copy of the GNU General Public License
249along with this program; if not, write to the Free Software
250Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110\-1301, USA.
251.PP
252Please report bugs to : Jerome Alet \- alet@librelogiciel.com
Note: See TracBrowser for help on using the browser.