root / pykota / trunk / man / edpykota.1 @ 1338

Revision 1338, 6.5 kB (checked in by jalet, 20 years ago)

Preliminary work on the pkhint command

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