root / pykota / trunk / man / pkusers.1 @ 3525

.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.36.
.TH PKUSERS "1" "January 2009" "C@LL - Conseil Internet & Logiciels Libres" "User Commands"
.SH NAME
pkusers \- manual page for pkusers (PyKota) 1.27alpha7_unofficial
.SH SYNOPSIS
.B pkusers
[\fIoptions\fR] [\fIusernames|groupnames\fR]
.SH DESCRIPTION
Manages PyKota users or users groups.
.SH OPTIONS
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit.
.TP
\fB\-v\fR, \fB\-\-version\fR
show the version number and exit.
.TP
\fB\-A\fR ARGUMENTSFILE, \fB\-\-arguments\fR=\fIARGUMENTSFILE\fR
loads additional options and arguments from a file,
one per line.
.TP
\fB\-a\fR, \fB\-\-add\fR
Add new, or modify existing, users or groups.
.TP
\fB\-b\fR BALANCE, \fB\-\-balance\fR=\fIBALANCE\fR
Set an user's account balance. The value can also be
increased or decreased when the value is prefixed with
\&'+' or '\-'. Users groups don't have a real account
balance, instead the sum of their members' account
balances is used.
.TP
\fB\-C\fR COMMENT, \fB\-\-comment\fR=\fICOMMENT\fR
Associate a textual comment with a change in an user's
account balance. Only meaningful when \fB\-\-balance\fR is
also used.
.TP
\fB\-d\fR, \fB\-\-delete\fR
Delete the specified users or groups. Also purge the
print quota entries and printing history matching the
specified users or groups.
.TP
\fB\-D\fR DESCRIPTION, \fB\-\-description\fR=\fIDESCRIPTION\fR
Set a textual description for the specified users or
groups.
.TP
\fB\-e\fR EMAIL, \fB\-\-email\fR=\fIEMAIL\fR
Set an user's email address. If this parameter begins
with '@' then the username is prepended to this
parameter to form a valid email address.
.TP
\fB\-g\fR, \fB\-\-groups\fR
Manage users groups instead of users.
.TP
\fB\-i\fR INGROUPS, \fB\-\-ingroups\fR=\fIINGROUPS\fR
Put the specified users into the specified groups.
When combined with the \fB\-\-remove\fR option, users are
removed from the specified groups instead.
.TP
\fB\-l\fR LIMITBY, \fB\-\-limitby\fR=\fILIMITBY\fR
Set the limiting factor for the specified users or
groups. Can be any of 'quota' (limit by number of
pages per printer), 'balance' (limit by number of
credits), 'noquota' (no limit but accounting done),
\&'nochange' (no limit and no accounting), or 'noprint'
(printing is denied). The two latter ones are not
supported for groups.
.TP
\fB\-L\fR, \fB\-\-list\fR
Display detailed informations about the specified
users or groups.
.TP
\fB\-o\fR OVERCHARGE, \fB\-\-overcharge\fR=\fIOVERCHARGE\fR
Set the overcharging factor applied to the specified
users when computing the cost of a print job. Any
floating point value can be used, allowing you to
express your creativity...
.TP
\fB\-r\fR, \fB\-\-remove\fR
When combined with the \fB\-\-ingroups\fR option, remove users
from the specified users groups.
.TP
\fB\-s\fR, \fB\-\-skipexisting\fR
If \fB\-\-add\fR is used, ensure that existing users or groups
won't be modified.
.SS "examples:"
.IP
pkusers \fB\-\-add\fR john paul george ringo/ringo@example.com
Would make users 'john', 'paul', 'george' and 'ringo' be known to PyKota.
User 'ringo''s email address would be set to 'ringo@example.com'.
.IP
pkusers \fB\-\-add\fR \fB\-\-groups\fR coders it
Would create two users groups named 'coders' and 'it'.
.IP
pkusers \fB\-\-add\fR \fB\-\-ingroups\fR coders,it jerome
Would add user 'jerome' and put him into the 'coders' and 'it' groups.
Both groups would have to be existing.
.IP
pkusers \fB\-\-limitby\fR balance \fB\-\-balance\fR 10.0 john
Would give 10.0 credits to 'john' and make his printing be limited by his
account balance.
.IP
pkusers \fB\-\-balance\fR +10.0 \fB\-\-comment\fR "He paid with his blood." jerome
Would add 10.0 credits to 'jerome''s account and register a comment
associated with his payment.
.IP
pkusers \fB\-\-delete\fR "jer*" "rach*"
Would delete all user accounts whose names begin with either 'jer' or
\&'rach'.
.IP
pkusers \fB\-\-overcharge\fR \fB\-1\fR.50 theboss
Would make the boss earn money whenever he prints.
.IP
pkusers \fB\-\-email\fR @example.com
Would set the email address for each existing user to username@example.com
.IP
pkusers \fB\-\-list\fR
Would list all users.
.SS "licensing terms:"
.IP
(c) 2003\-2009 Jerome Alet \- alet@librelogiciel.com
This program is free software: you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the Free
Software Foundation, either version 3 of the License, or (at your option)
any later version.
.IP
This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
for more details.
.IP
You should have received a copy of the GNU General Public License along
with this program.  If not, see <http://www.gnu.org/licenses/>.