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

Revision 937, 5.6 kB (checked in by jalet, 21 years ago)

Docstring corrected for better manual page

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