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