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