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

Revision 3550, 5.7 kB (checked in by jerome, 14 years ago)

Updated manual pages.

  • 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.38.2.
2.TH EDPYKOTA "1" "August 2010" "C@LL - Conseil Internet & Logiciels Libres" "User Commands"
3.SH NAME
4edpykota \- manual page for edpykota (PyKota) 1.27alpha13_unofficial
5.SH SYNOPSIS
6.B edpykota
7[\fIoptions\fR] [\fIusernames|groupnames\fR]
8.SH DESCRIPTION
9Manages PyKota print quota entries for users or users groups. A print quota
10entry is related to both an user and a printer, or to both a group and a
11printer, meaning that for example different users can have different page
12count limits on the same printer. If an user doesn't have a print quota entry
13on a particular printer, he won't be allowed to print to it.
14.SH OPTIONS
15.TP
16\fB\-h\fR, \fB\-\-help\fR
17show this help message and exit.
18.TP
19\fB\-v\fR, \fB\-\-version\fR
20show the version number and exit.
21.TP
22\fB\-A\fR ARGUMENTSFILE, \fB\-\-arguments\fR=\fIARGUMENTSFILE\fR
23loads additional options and arguments from a file,
24one per line.
25.TP
26\fB\-a\fR, \fB\-\-add\fR
27Add new, or modify existing, users or groups print
28quota entries.
29.TP
30\fB\-d\fR, \fB\-\-delete\fR
31Delete the specified users or groups print quota
32entries. When deleting users print quota entries, the
33matching jobs are also deleted from the printing
34history.
35.TP
36\fB\-S\fR SOFTLIMIT, \fB\-\-softlimit\fR=\fISOFTLIMIT\fR
37Set the soft page count limit for the specified print
38quota entries. Users can print over this limit for a
39number of days specified in the 'gracedelay' directive
40in pykota.conf
41.TP
42\fB\-H\fR HARDLIMIT, \fB\-\-hardlimit\fR=\fIHARDLIMIT\fR
43Set the hard page count limit for the specified print
44quota entries. Users are never allowed to print over
45this limit.
46.TP
47\fB\-g\fR, \fB\-\-groups\fR
48Manage groups print quota entries instead of users
49print quota entries.
50.TP
51\fB\-I\fR INCREASE, \fB\-\-increase\fR=\fIINCREASE\fR
52Increase the existing soft and hard page count limits
53for the specified print quota entries. You can
54decrease the values instead by prefixing this
55parameter with a negative sign.
56.TP
57\fB\-L\fR, \fB\-\-list\fR
58Display detailed informations about the specified
59users or groups print quota entries.
60.TP
61\fB\-m\fR MAXJOBSIZE, \fB\-\-maxjobsize\fR=\fIMAXJOBSIZE\fR
62Set the maximum job size in pages the specified users
63are allowed to print to the specified printers in a
64single job. Accepted values are '0' to forbid
65printing, 'unlimited' to allow unrestricted printing,
66or any positive integer value. This option is not
67supported for users groups.
68.TP
69\fB\-n\fR, \fB\-\-noquota\fR
70Set no limit for both soft and hard page counts for
71the specified users or groups print quota entries.
72.TP
73\fB\-P\fR PRINTER, \fB\-\-printer\fR=\fIPRINTER\fR
74Specify a comma separated list of printers you want to
75manage print quota entries on. The default is '*',
76meaning all printers.
77.TP
78\fB\-r\fR, \fB\-\-reset\fR
79Reset the actual page counter for the specified users
80print quota entries (doesn't work for groups print
81quota entries). The life time page counter is left
82unchanged.
83.TP
84\fB\-R\fR, \fB\-\-hardreset\fR
85Reset the actual and life time page counters for the
86specified users print quota entries (doesn't work for
87groups print quota entries). This is a shortcut for
88\fB\-\-used\fR 0.
89.TP
90\fB\-s\fR, \fB\-\-skipexisting\fR
91If \fB\-\-add\fR is used, ensure that existing users or groups
92print quota entries won't be modified.
93.TP
94\fB\-U\fR USED, \fB\-\-used\fR=\fIUSED\fR
95Set the values of both the actual and life time page
96counters for the specified users print quota entries
97(doesn't work for groups print quota entries). This
98can be useful when migrating from a different print
99quota software. The values can also be increased or
100decreased by prefixing this parameter with either a
101positive or negative sign.
102.SS "examples:"
103.IP
104edpykota \fB\-\-add\fR john paul george ringo
105Would create print quota entries with no page count limits for these four
106users on all existing printers.
107.IP
108edpykota \fB\-\-printer\fR HP \fB\-\-softlimit\fR 50 \fB\-\-hardlimit\fR 60 jerome
109Would allow user 'jerome' to print up to 60 pages on printer 'HP'. This
110user would be warned when he would have reached 50 pages on this printer.
111Both the user and printer must have been created previously using the
112pkusers and pkprinters commands, respectively.
113.IP
114edpykota \fB\-\-groups\fR \fB\-\-softlimit\fR 500 \fB\-\-hardlimit\fR 600 support financial
115Would set soft and hard page count limits on any printer for groups
116\&'support' and 'financial'.
117.IP
118edpykota \fB\-\-reset\fR \fB\-\-printer\fR HP jerome "jo*"
119Would reset the actual page counter for users 'jerome' and all users whose
120name begins with 'jo' on printer 'HP'.
121.IP
122edpykota \fB\-\-printer\fR HPCOLOR \fB\-\-noquota\fR jerome
123Would allow this user to print without any page limit on printer
124\&'HPCOLOR'. Depending on how this user is limited, he may still be subject
125to being limited by the number of available credits in his account.
126.IP
127edpykota \fB\-\-add\fR \fB\-\-skipexisting\fR
128Would create a print quota entry for each user on each printer for which
129none already existed. You'll most likely want to use this command at least
130once after initial setup.
131.SS "licensing terms:"
132.IP
133(c) 2003\-2010 Jerome Alet \- alet@librelogiciel.com
134This program is free software: you can redistribute it and/or modify it
135under the terms of the GNU General Public License as published by the Free
136Software Foundation, either version 3 of the License, or (at your option)
137any later version.
138.IP
139This program is distributed in the hope that it will be useful, but
140WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
141or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
142for more details.
143.IP
144You should have received a copy of the GNU General Public License along
145with this program.  If not, see <http://www.gnu.org/licenses/>.
Note: See TracBrowser for help on using the browser.