root / pykota / trunk / man / th / edpykota.1 @ 2646

.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.35.
.TH EDPYKOTA "1" "octobre 2005" "C@LL - Conseil Internet & Logiciels Libres" "User Commands"
.SH NOM
edpykota \- page de manuel de edpykota 1.23_unofficial
.SH DESCRIPTION
edpykota v1.23_unofficial (c) 2003, 2004, 2005 Jerome Alet \- alet@librelogiciel.com
.PP
A Print Quota editor for PyKota.
.PP
command line usage :
.IP
edpykota [options] user1 user2 ... userN
.IP
edpykota [options] group1 group2 ... groupN
.PP
options :
.TP
\fB\-v\fR | \fB\-\-version\fR
Prints edpykota's version number then exits.
.TP
\fB\-h\fR | \fB\-\-help\fR
Prints this message then exits.
.TP
\fB\-a\fR | \fB\-\-add\fR
Adds users and/or printers if they don't
exist on the Quota Storage Server.
.TP
\fB\-d\fR | \fB\-\-delete\fR
Deletes users/groups from the quota storage.
Printers are never deleted.
.TP
\fB\-c\fR | \fB\-\-charge\fR p[,j]
Sets the price per page and per job to charge
for a particular printer. Job price is optional.
If both are to be set, separate them with a comma.
Floating point values are allowed.
.TP
\fB\-o\fR | \fB\-\-overcharge\fR f
Sets the overcharging factor applied to the user
when computing the cost of a print job. Positive or
negative floating point values are allowed,
this allows you to do some really creative
things like giving money to an user whenever
he prints. The number of pages in a print job
is not modified by this coefficient, only the
cost of the job for a particular user.
Only users have a coefficient.
.TP
\fB\-i\fR | \fB\-\-ingroups\fR g1[,g2...]
Puts the users into each of the groups
listed, separated by commas. The groups
must already exist in the Quota Storage.
.TP
\fB\-u\fR | \fB\-\-users\fR
Edit users print quotas, this is the default.
.TP
\fB\-P\fR | \fB\-\-printer\fR p
Edit quotas on printer p only. Actually p can
use wildcards characters to select only
some printers. The default value is *, meaning
all printers.
You can specify several names or wildcards,
by separating them with commas.
.TP
\fB\-G\fR | \fB\-\-pgroups\fR pg1[,pg2...] Adds the printer(s) to the printer groups
pg1, pg2, etc... which must already exist.
A printer group is just like a normal printer,
only that it is usually unknown from the printing
system. Create printer groups exactly the same
way that you create printers, then add other
printers to them with this option.
Accounting is done on a printer and on all
the printer groups it belongs to, quota checking
is done on a printer and on all the printer groups
it belongs to.
.TP
\fB\-g\fR | \fB\-\-groups\fR
Edit users groups print quotas instead of users.
.TP
\fB\-p\fR | \fB\-\-prototype\fR u|g Uses user u or group g as a prototype to set
print quotas
.TP
\fB\-n\fR | \fB\-\-noquota\fR
Sets both soft and hard limits to None for a
particular print quota entry.
This is NOT the same as \fB\-\-limitby\fR noquota
which acts on ALL print quota entries for a
particular user.
.TP
\fB\-r\fR | \fB\-\-reset\fR
Resets the actual page counter for the user
or group to zero on the specified printers.
The life time page counter is kept unchanged.
.TP
\fB\-R\fR | \fB\-\-hardreset\fR
Resets the actual and life time page counters
for the user or group to zero on the specified
printers. This is a shortcut for '\-\-used 0'.
.TP
\fB\-l\fR | \fB\-\-limitby\fR l
Choose if the user/group is limited in printing
by its account balance or by its page quota.
The default value is 'quota'. Allowed values
are 'quota' 'balance' 'noquota' 'noprint'
and 'nochange' :
.IP
\- quota : limit by number of pages per printer.
\- balance : limit by number of credits in account.
\- noquota : no limit, accounting still done.
\- nochange : no limit, accounting not done.
\- noprint : printing is denied.
.IP
NB : nochange and noprint are not supported for groups.
.TP
\fB\-b\fR | \fB\-\-balance\fR b
Sets the user's account balance to b.
Account balance may be increase or decreased
if b is prefixed with + or \-.
WARNING : when decreasing account balance,
the total paid so far by the user is decreased
too.
Groups don't have a real balance, but the
sum of their users' account balance.
.TP
\fB\-C\fR | \fB\-\-comment\fR txt
Defines some informational text to be associated
with a change to an user's account balance.
Only meaningful if \fB\-b\fR | \fB\-\-balance\fR is also used.
.TP
\fB\-S\fR | \fB\-\-softlimit\fR sl
Sets the quota soft limit to sl pages.
.TP
\fB\-H\fR | \fB\-\-hardlimit\fR hl
Sets the quota hard limit to hl pages.
.TP
\fB\-I\fR | \fB\-\-increase\fR v
Increase both Soft and Hard limits by the value
of v. You can prefix v with + or \-, if no sign is
used, + is assumed.
.TP
\fB\-U\fR | \fB\-\-used\fR usage
Sets the pagecounters for the user to usage pages;
useful for migrating users from a different system
where they have already used some pages. Actual
and Life Time page counters may be increased or decreased
if usage is prefixed with + or \-.
WARNING : BOTH page counters are modified in all cases,
so be careful.
NB : if 'usage' equals '0', then the action taken is
the same as if \fB\-\-hardreset\fR was used.
.IP
user1 through userN and group1 through groupN can use wildcards
if the \fB\-\-add\fR option is not set.
.PP
examples :
.IP
\f(CW$ edpykota --add -p jerome john paul george ringo/ringo@example.com\fR
.IP
This will add users john, paul, george and ringo to the quota
database, and set their print quotas to the same values than user
jerome. User jerome must already exist.
User ringo's email address will also be set to 'ringo@example.com'
.IP
\f(CW$ edpykota --printer lp -S 50 -H 60 jerome\fR
.IP
This will set jerome's print quota on the lp printer to a soft limit
of 50 pages, and a hard limit of 60 pages. If either user jerome or
printer lp doesn't exist on the Quota Storage Server then nothing is done.
.IP
\f(CW$ edpykota --add --printer lp --ingroups coders,it -S 50 -H 60 jerome\fR
.IP
Same as above, but if either user jerome or printer lp doesn't exist
on the Quota Storage Server they are automatically added. Also
user jerome is put into the groups "coders" and "it" which must
already exist in the Quota Storage.
.IP
\f(CW$ edpykota -g -S 500 -H 550 financial support\fR
.IP
This will set print quota soft limit to 500 pages and hard limit
to 550 pages for groups financial and support on all printers.
.IP
\f(CW$ edpykota --reset jerome "jo*"\fR
.IP
This will reset jerome's page counter to zero on all printers, as
well as every user whose name begins with 'jo'.
Their life time page counter on each printer will be kept unchanged.
You can also reset the life time page counters by using the
\fB\-\-hardreset\fR | \fB\-R\fR command line option.
.IP
\f(CW$ edpykota --printer hpcolor --noquota jerome\fR
.IP
This will tell PyKota to not limit jerome when printing on the
hpcolor printer. All his jobs will be allowed on this printer, but
accounting of the pages he prints will still be kept.
Print Quotas for jerome on other printers are unchanged.
.IP
\f(CW$ edpykota --limitby balance jerome\fR
.IP
This will tell PyKota to limit jerome by his account's balance
when printing.
.IP
\f(CW$ edpykota --balance +10.0 jerome\fR
.IP
This will increase jerome's account balance by 10.0 (in your
own currency). You can decrease the account balance with a
dash prefix, and set it to a fixed amount with no prefix.
.IP
\f(CW$ edpykota --delete jerome rachel\fR
.IP
This will completely delete jerome and rachel from the Quota Storage
database. All their quotas and jobs will be deleted too.
.IP
\f(CW$ edpykota --printer lp --charge 0.1\fR
.IP
This will set the page price for printer lp to 0.1. Job price
will not be changed.
.IP
\f(CW$ edpykota --printer hplj1,hplj2 --pgroups Laser,HP\fR
.IP
This will put printers hplj1 and hplj2 in printers groups Laser and HP.
When printing either on hplj1 or hplj2, print quota will also be
checked and accounted for on virtual printers Laser and HP.
.IP
\f(CW$ edpykota --overcharge 2.5 poorstudent\fR
.IP
This will overcharge the poorstudent user by a factor of 2.5.
.IP
\f(CW$ edpykota --overcharge -1 jerome\fR
.IP
User jerome will actually earn money whenever he prints.
.IP
\f(CW$ edpykota --overcharge 0 boss\fR
.IP
User boss can print at will, it won't cost him anything because the
cost of each print job will be multiplied by zero before charging
his account.
.PP
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 2 of the License, or
(at your option) any later version.
.PP
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.
.PP
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110\-1301, USA.
.PP
Please report bugs to : Jerome Alet \- alet@librelogiciel.com