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

Revision 2493, 8.7 kB (checked in by jerome, 19 years ago)

Updated manual pages

  • 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" "septembre 2005" "C@LL - Conseil Internet & Logiciels Libres" "User Commands"
3.SH NOM
4edpykota \- page de manuel de edpykota 1.23beta_unofficial
5.SH DESCRIPTION
6edpykota v1.23beta_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
84Doesn't set a quota but only does accounting.
85This is the same as \fB\-\-limitby\fR noquota.
86.TP
87\fB\-r\fR | \fB\-\-reset\fR
88Resets the actual page counter for the user
89or group to zero on the specified printers.
90The life time page counter is kept unchanged.
91.TP
92\fB\-R\fR | \fB\-\-hardreset\fR
93Resets the actual and life time page counters
94for the user or group to zero on the specified
95printers. This is a shortcut for '\-\-used 0'.
96.TP
97\fB\-l\fR | \fB\-\-limitby\fR l
98Choose if the user/group is limited in printing
99by its account balance or by its page quota.
100The default value is 'quota'. Allowed values
101are 'quota' 'balance' 'noquota' 'noprint'
102and 'nochange' :
103.IP
104\- quota : limit by number of pages per printer.
105\- balance : limit by number of credits in account.
106\- noquota : no limit, accounting still done.
107\- nochange : no limit, accounting not done.
108\- noprint : printing is denied.
109.IP
110NB : nochange and noprint are not supported for groups.
111.TP
112\fB\-b\fR | \fB\-\-balance\fR b
113Sets the user's account balance to b.
114Account balance may be increase or decreased
115if b is prefixed with + or \-.
116WARNING : when decreasing account balance,
117the total paid so far by the user is decreased
118too.
119Groups don't have a real balance, but the
120sum of their users' account balance.
121.TP
122\fB\-C\fR | \fB\-\-comment\fR txt
123Defines some informational text to be associated
124with a change to an user's account balance.
125Only meaningful if \fB\-b\fR | \fB\-\-balance\fR is also used.
126.TP
127\fB\-S\fR | \fB\-\-softlimit\fR sl
128Sets the quota soft limit to sl pages.
129.TP
130\fB\-H\fR | \fB\-\-hardlimit\fR hl
131Sets the quota hard limit to hl pages.
132.TP
133\fB\-I\fR | \fB\-\-increase\fR v
134Increase both Soft and Hard limits by the value
135of v. You can prefix v with + or \-, if no sign is
136used, + is assumed.
137.TP
138\fB\-U\fR | \fB\-\-used\fR usage
139Sets the pagecounters for the user to usage pages;
140useful for migrating users from a different system
141where they have already used some pages. Actual
142and Life Time page counters may be increased or decreased
143if usage is prefixed with + or \-.
144WARNING : BOTH page counters are modified in all cases,
145so be careful.
146NB : if 'usage' equals '0', then the action taken is
147the same as if \fB\-\-hardreset\fR was used.
148.IP
149user1 through userN and group1 through groupN can use wildcards
150if the \fB\-\-add\fR option is not set.
151.PP
152examples :
153.IP
154\f(CW$ edpykota --add -p jerome john paul george ringo/ringo@example.com\fR
155.IP
156This will add users john, paul, george and ringo to the quota
157database, and set their print quotas to the same values than user
158jerome. User jerome must already exist.
159User ringo's email address will also be set to 'ringo@example.com'
160.IP
161\f(CW$ edpykota --printer lp -S 50 -H 60 jerome\fR
162.IP
163This will set jerome's print quota on the lp printer to a soft limit
164of 50 pages, and a hard limit of 60 pages. If either user jerome or
165printer lp doesn't exist on the Quota Storage Server then nothing is done.
166.IP
167\f(CW$ edpykota --add --printer lp --ingroups coders,it -S 50 -H 60 jerome\fR
168.IP
169Same as above, but if either user jerome or printer lp doesn't exist
170on the Quota Storage Server they are automatically added. Also
171user jerome is put into the groups "coders" and "it" which must
172already exist in the Quota Storage.
173.IP
174\f(CW$ edpykota -g -S 500 -H 550 financial support\fR
175.IP
176This will set print quota soft limit to 500 pages and hard limit
177to 550 pages for groups financial and support on all printers.
178.IP
179\f(CW$ edpykota --reset jerome "jo*"\fR
180.IP
181This will reset jerome's page counter to zero on all printers, as
182well as every user whose name begins with 'jo'.
183Their life time page counter on each printer will be kept unchanged.
184You can also reset the life time page counters by using the
185\fB\-\-hardreset\fR | \fB\-R\fR command line option.
186.IP
187\f(CW$ edpykota --printer hpcolor --noquota jerome\fR
188.IP
189This will tell PyKota to not limit jerome when printing on the
190hpcolor printer. All his jobs will be allowed on this printer, but
191accounting of the pages he prints will still be kept.
192Print Quotas for jerome on other printers are unchanged.
193.IP
194\f(CW$ edpykota --limitby balance jerome\fR
195.IP
196This will tell PyKota to limit jerome by his account's balance
197when printing.
198.IP
199\f(CW$ edpykota --balance +10.0 jerome\fR
200.IP
201This will increase jerome's account balance by 10.0 (in your
202own currency). You can decrease the account balance with a
203dash prefix, and set it to a fixed amount with no prefix.
204.IP
205\f(CW$ edpykota --delete jerome rachel\fR
206.IP
207This will completely delete jerome and rachel from the Quota Storage
208database. All their quotas and jobs will be deleted too.
209.IP
210\f(CW$ edpykota --printer lp --charge 0.1\fR
211.IP
212This will set the page price for printer lp to 0.1. Job price
213will not be changed.
214.IP
215\f(CW$ edpykota --printer hplj1,hplj2 --pgroups Laser,HP\fR
216.IP
217This will put printers hplj1 and hplj2 in printers groups Laser and HP.
218When printing either on hplj1 or hplj2, print quota will also be
219checked and accounted for on virtual printers Laser and HP.
220.IP
221\f(CW$ edpykota --overcharge 2.5 poorstudent\fR
222.IP
223This will overcharge the poorstudent user by a factor of 2.5.
224.IP
225\f(CW$ edpykota --overcharge -1 jerome\fR
226.IP
227User jerome will actually earn money whenever he prints.
228.IP
229\f(CW$ edpykota --overcharge 0 boss\fR
230.IP
231User boss can print at will, it won't cost him anything because the
232cost of each print job will be multiplied by zero before charging
233his account.
234.PP
235This program is free software; you can redistribute it and/or modify
236it under the terms of the GNU General Public License as published by
237the Free Software Foundation; either version 2 of the License, or
238(at your option) any later version.
239.PP
240This program is distributed in the hope that it will be useful,
241but WITHOUT ANY WARRANTY; without even the implied warranty of
242MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
243GNU General Public License for more details.
244.PP
245You should have received a copy of the GNU General Public License
246along with this program; if not, write to the Free Software
247Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110\-1301, USA.
248.PP
249Please report bugs to : Jerome Alet \- alet@librelogiciel.com
Note: See TracBrowser for help on using the browser.