root / pykota / trunk / man / pt / pkusers.1 @ 3502

Revision 3485, 4.7 kB (checked in by jerome, 16 years ago)

Updated manual pages.

Line 
1.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.36.
2.TH PKUSERS "1" "janvier 2009" "C@LL - Conseil Internet & Logiciels Libres" "User Commands"
3.SH NOM
4pkusers \- page de manuel de pkusers (PyKota) 1.27alpha7_unofficial
5.SH SYNOPSIS
6.B pkusers
7[\fIoptions\fR] [\fIusernames|groupnames\fR]
8.SH DESCRIPTION
9Manages PyKota users or users groups.
10.SH OPTIONS
11.TP
12\fB\-h\fR, \fB\-\-help\fR
13show this help message and exit.
14.TP
15\fB\-v\fR, \fB\-\-version\fR
16show the version number and exit.
17.TP
18\fB\-A\fR ARGUMENTSFILE, \fB\-\-arguments\fR=\fIARGUMENTSFILE\fR
19loads additional options and arguments from a file,
20one per line.
21.TP
22\fB\-a\fR, \fB\-\-add\fR
23Add new, or modify existing, users or groups.
24.TP
25\fB\-b\fR BALANCE, \fB\-\-balance\fR=\fIBALANCE\fR
26Set an user's account balance. The value can also be
27increased or decreased when the value is prefixed with
28\&'+' or '\-'. Users groups don't have a real account
29balance, instead the sum of their members' account
30balances is used.
31.TP
32\fB\-C\fR COMMENT, \fB\-\-comment\fR=\fICOMMENT\fR
33Associate a textual comment with a change in an user's
34account balance. Only meaningful when \fB\-\-balance\fR is
35also used.
36.TP
37\fB\-d\fR, \fB\-\-delete\fR
38Delete the specified users or groups. Also purge the
39print quota entries and printing history matching the
40specified users or groups.
41.TP
42\fB\-D\fR DESCRIPTION, \fB\-\-description\fR=\fIDESCRIPTION\fR
43Set a textual description for the specified users or
44groups.
45.TP
46\fB\-e\fR EMAIL, \fB\-\-email\fR=\fIEMAIL\fR
47Set an user's email address. If this parameter begins
48with '@' then the username is prepended to this
49parameter to form a valid email address.
50.TP
51\fB\-g\fR, \fB\-\-groups\fR
52Manage users groups instead of users.
53.TP
54\fB\-i\fR INGROUPS, \fB\-\-ingroups\fR=\fIINGROUPS\fR
55Put the specified users into the specified groups.
56When combined with the \fB\-\-remove\fR option, users are
57removed from the specified groups instead.
58.TP
59\fB\-l\fR LIMITBY, \fB\-\-limitby\fR=\fILIMITBY\fR
60Set the limiting factor for the specified users or
61groups. Can be any of 'quota' (limit by number of
62pages per printer), 'balance' (limit by number of
63credits), 'noquota' (no limit but accounting done),
64\&'nochange' (no limit and no accounting), or 'noprint'
65(printing is denied). The two latter ones are not
66supported for groups.
67.TP
68\fB\-L\fR, \fB\-\-list\fR
69Display detailed informations about the specified
70users or groups.
71.TP
72\fB\-o\fR OVERCHARGE, \fB\-\-overcharge\fR=\fIOVERCHARGE\fR
73Set the overcharging factor applied to the specified
74users when computing the cost of a print job. Any
75floating point value can be used, allowing you to
76express your creativity...
77.TP
78\fB\-r\fR, \fB\-\-remove\fR
79When combined with the \fB\-\-ingroups\fR option, remove users
80from the specified users groups.
81.TP
82\fB\-s\fR, \fB\-\-skipexisting\fR
83If \fB\-\-add\fR is used, ensure that existing users or groups
84won't be modified.
85.SS "examples:"
86.IP
87pkusers \fB\-\-add\fR john paul george ringo/ringo@example.com
88Would make users 'john', 'paul', 'george' and 'ringo' be known to PyKota.
89User 'ringo''s email address would be set to 'ringo@example.com'.
90.IP
91pkusers \fB\-\-add\fR \fB\-\-groups\fR coders it
92Would create two users groups named 'coders' and 'it'.
93.IP
94pkusers \fB\-\-add\fR \fB\-\-ingroups\fR coders,it jerome
95Would add user 'jerome' and put him into the 'coders' and 'it' groups.
96Both groups would have to be existing.
97.IP
98pkusers \fB\-\-limitby\fR balance \fB\-\-balance\fR 10.0 john
99Would give 10.0 credits to 'john' and make his printing be limited by his
100account balance.
101.IP
102pkusers \fB\-\-balance\fR +10.0 \fB\-\-comment\fR "He paid with his blood." jerome
103Would add 10.0 credits to 'jerome''s account and register a comment
104associated with his payment.
105.IP
106pkusers \fB\-\-delete\fR "jer*" "rach*"
107Would delete all user accounts whose names begin with either 'jer' or
108\&'rach'.
109.IP
110pkusers \fB\-\-overcharge\fR \fB\-1\fR.50 theboss
111Would make the boss earn money whenever he prints.
112.IP
113pkusers \fB\-\-email\fR @example.com
114Would set the email address for each existing user to username@example.com
115.IP
116pkusers \fB\-\-list\fR
117Would list all users.
118.SS "licensing terms:"
119.IP
120(c) 2003\-2009 Jerome Alet \- alet@librelogiciel.com
121This program is free software: you can redistribute it and/or modify it
122under the terms of the GNU General Public License as published by the Free
123Software Foundation, either version 3 of the License, or (at your option)
124any later version.
125.IP
126This program is distributed in the hope that it will be useful, but
127WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
128or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
129for more details.
130.IP
131You should have received a copy of the GNU General Public License along
132with this program.  If not, see <http://www.gnu.org/licenses/>.
Note: See TracBrowser for help on using the browser.