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

Revision 1167, 6.0 kB (checked in by jalet, 21 years ago)

Manpages updated

  • 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" "October 2003" "C@LL - Conseil Internet & Logiciels Libres" "PyKota Print Quota for CUPS and LPRng"
3.SH NAME
4edpykota \- manual page for edpykota 1.15_unofficial
5.SH DESCRIPTION
6edpykota v1.15_unofficial (C) 2003 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\-\-groups\fR
54Edit groups print quotas instead of users.
55.TP
56\fB\-p\fR | \fB\-\-prototype\fR u|g Uses user u or group g as a prototype to set
57print quotas
58.TP
59\fB\-n\fR | \fB\-\-noquota\fR
60Doesn't set a quota but only does accounting.
61.TP
62\fB\-r\fR | \fB\-\-reset\fR
63Resets the printed page counter for the user
64or group to zero. The life time page counter
65is kept unchanged.
66.TP
67\fB\-l\fR | \fB\-\-limitby\fR l
68Choose if the user/group is limited in printing
69by its account balance or by its page quota.
70The default value is 'quota'. Allowed values
71are 'quota' and 'balance'.
72.TP
73\fB\-b\fR | \fB\-\-balance\fR b
74Sets the user's account balance to b.
75Account balance may be increase or decreased
76if b is prefixed with + or -.
77WARNING : when decreasing account balance,
78the total paid so far by the user is decreased
79too.
80Groups don't have a real balance, but the
81sum of their users' account balance.
82.TP
83\fB\-S\fR | \fB\-\-softlimit\fR sl
84Sets the quota soft limit to sl pages.
85.TP
86\fB\-H\fR | \fB\-\-hardlimit\fR hl
87Sets the quota hard limit to hl pages.
88.IP
89user1 through userN and group1 through groupN can use wildcards
90if the \fB\-\-add\fR option is not set.
91.PP
92examples :
93.IP
94\f(CW$ edpykota -p jerome john paul george ringo\fR
95.IP
96This will set print quotas for the users john, paul, george and ringo
97to the same values than user jerome. User jerome must exist.
98.IP
99\f(CW$ edpykota --printer lp -S 50 -H 60 jerome\fR
100.IP
101This will set jerome's print quota on the lp printer to a soft limit
102of 50 pages, and a hard limit of 60 pages. If either user jerome or
103printer lp doesn't exist on the Quota Storage Server then nothing is done.
104.IP
105\f(CW$ edpykota --add --printer lp --ingroups coders,it -S 50 -H 60 jerome\fR
106.IP
107Same as above, but if either user jerome or printer lp doesn't exist
108on the Quota Storage Server they are automatically added. Also
109user jerome is put into the groups "coders" and "it" which must
110already exist in the Quota Storage.
111WARNING : the CUPS PPD file for this printer or the /etc/printcap
112.TP
113file (depending on your printing backend)
114must still be
115.IP
116modified manually, as well as pykota's configuration file
117for a new printer to be managed successfully.
118.IP
119\f(CW$ edpykota -g -S 500 -H 550 financial support\fR
120.IP
121This will set print quota soft limit to 500 pages and hard limit
122to 550 pages for groups financial and support on all printers.
123.IP
124\f(CW$ edpykota --reset jerome "jo*"\fR
125.IP
126This will reset jerome's page counter to zero on all printers, as
127well as every user whose name begins with 'jo'.
128Their life time page counter on each printer will be kept unchanged.
129.IP
130\f(CW$ edpykota --printer hpcolor --noquota jerome\fR
131.IP
132This will tell PyKota to not limit jerome when printing on the
133hpcolor printer. All his jobs will be allowed on this printer, but
134accounting of the pages he prints will still be kept.
135Print Quotas for jerome on other printers are unchanged.
136.IP
137\f(CW$ edpykota --limitby balance jerome\fR
138.IP
139This will tell PyKota to limit jerome by his account's balance
140when printing.
141.IP
142\f(CW$ edpykota --balance +10.0 jerome\fR
143.IP
144This will increase jerome's account balance by 10.0 (in your
145own currency). You can decrease the account balance with a
146dash prefix, and set it to a fixed amount with no prefix.
147.IP
148\f(CW$ edpykota --delete jerome rachel\fR
149.IP
150This will completely delete jerome and rachel from the Quota Storage
151database. All their quotas and jobs will be deleted too.
152.IP
153\f(CW$ edpykota --printer lp --charge 0.1\fR
154.IP
155This will set the page price for printer lp to 0.1. Job price
156will not be changed.
157.PP
158This program is free software; you can redistribute it and/or modify
159it under the terms of the GNU General Public License as published by
160the Free Software Foundation; either version 2 of the License, or
161(at your option) any later version.
162.PP
163This program is distributed in the hope that it will be useful,
164but WITHOUT ANY WARRANTY; without even the implied warranty of
165MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
166GNU General Public License for more details.
167.PP
168You should have received a copy of the GNU General Public License
169along with this program; if not, write to the Free Software
170Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
171.PP
172Please e-mail bugs to: Jerome Alet - alet@librelogiciel.com
173.SH "SEE ALSO"
174The full documentation for
175.B edpykota
176is maintained as a Texinfo manual.  If the
177.B info
178and
179.B edpykota
180programs are properly installed at your site, the command
181.IP
182.B info edpykota
183.PP
184should give you access to the complete manual.
Note: See TracBrowser for help on using the browser.