Changeset 3485 for pykota/trunk/man/tr

Timestamp:

01/24/09 22:38:46 (15 years ago)

Author:

jerome

Message:

Updated manual pages.

Location:

pykota/trunk/man/tr

Files:

• autopykota.1 (modified) (1 diff)
• dumpykota.1 (modified) (2 diffs)
• edpykota.1 (modified) (1 diff)
• pkbanner.1 (modified) (1 diff)
• pkbcodes.1 (modified) (1 diff)
• pkinvoice.1 (modified) (2 diffs)
• pkprinters.1 (modified) (1 diff)
• pkrefund.1 (modified) (2 diffs)
• pksetup.1 (modified) (1 diff)
• pkturnkey.1 (modified) (1 diff)
• pkusers.1 (modified) (1 diff)
• pykosd.1 (modified) (1 diff)
• pykotme.1 (modified) (1 diff)
• repykota.1 (modified) (1 diff)
• warnpykota.1 (modified) (1 diff)

pykota/trunk/man/tr/autopykota.1

@@ -1 +1 @@
 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.36.
-.TH AUTOPYKOTA "1" "janvier 2008" "C@LL - Conseil Internet & Logiciels Libres" "User Commands"
+.TH AUTOPYKOTA "1" "janvier 2009" "C@LL - Conseil Internet & Logiciels Libres" "User Commands"
 .SH NOM
-autopykota \- page de manuel de autopykota 1.27alpha3_BROKEN_unofficial
+autopykota \- page de manuel de autopykota (PyKota) 1.27alpha7_unofficial
+.SH SYNOPSIS
+.B autopykota
+\fI{ -i | \-\-initbalance value } \fR[\fIoptions\fR]
 .SH DESCRIPTION
-autopykota v1.27alpha3_BROKEN_unofficial (c) 2003, 2004, 2005, 2006, 2007, 2008 Jerome Alet \- alet@librelogiciel.com
-.PP
-A tool to automate user account creation and initial balance setting.
-.PP
-THIS TOOL MUST NOT BE USED IF YOU WANT TO LIMIT YOUR USERS BY PAGE QUOTA !
-.PP
-command line usage :
+A tool to automate user account creation and initial balance setting. THIS
+TOOL MUST NOT BE USED FROM THE COMMAND LINE BUT ONLY AS PART OF AN external
+policy IN pykota.conf, AND MUST NOT BE USED IF YOU WANT TO LIMIT YOUR USERS BY
+PAGE QUOTA !
+.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\-i\fR INITBALANCE, \fB\-\-initbalance\fR=\fIINITBALANCE\fR
+Set the user's initial account balance value. If the
+user already exists, actual balance is left unchanged.
+If unset, the default value is 0.0.
+.TP
+\fB\-e\fR EMAIL, \fB\-\-email\fR=\fIEMAIL\fR
+Set the user's email address.
+.SS "examples:"
 .IP
-THIS TOOL MUST NOT BE USED FROM THE COMMAND LINE BUT ONLY AS PART
-OF AN external policy IN pykota.conf
+autopykota \fB\-\-email=\fR"@example.com" \fB\-\-initbalance\fR=\fI10\fR.0
+This would set the current user's email address to
+$PYKOTAUSERNAME@example.com, and would set the initial value of his
+account balance to 10.0 credits.
+.SS "licensing terms:"
 .IP
-autopykota { \fB\-i\fR | \fB\-\-initbalance\fR value }
-.PP
-options :
-.TP
-\fB\-v\fR | \fB\-\-version\fR
-Prints autopykota's version number then exits.
-.TP
-\fB\-h\fR | \fB\-\-help\fR
-Prints this message then exits.
-.TP
-\fB\-i\fR | \fB\-\-initbalance\fR b Sets the user's account initial balance value to b.
-If the user already exists, actual balance is left
-unmodified. If unset, the default value is 0.
-.TP
-\fB\-e\fR | \fB\-\-email\fR addr
-Sets the user's e\-mail address.
-.PP
-(c) 2003, 2004, 2005, 2006, 2007, 2008 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.
-.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, see <http://www.gnu.org/licenses/>.
-.PP
-Please report bugs to : Jerome Alet \- alet@librelogiciel.com
+(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/>.

pykota/trunk/man/tr/dumpykota.1

@@ -1 +1 @@
 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.36.
-.TH DUMPYKOTA "1" "janvier 2008" "C@LL - Conseil Internet & Logiciels Libres" "User Commands"
+.TH DUMPYKOTA "1" "janvier 2009" "C@LL - Conseil Internet & Logiciels Libres" "User Commands"
 .SH NOM
-dumpykota \- page de manuel de dumpykota 1.27alpha3_BROKEN_unofficial
+dumpykota \- page de manuel de dumpykota (PyKota) 1.27alpha7_unofficial
+.SH SYNOPSIS
+.B dumpykota
+[\fIoptions\fR] [\fIfilterexpr\fR]
 .SH DESCRIPTION
-dumpykota v1.27alpha3_BROKEN_unofficial (c) 2003, 2004, 2005, 2006, 2007, 2008 Jerome Alet \- alet@librelogiciel.com
-.PP
-Dumps PyKota database's content.
-.PP
-command line usage :
+Data Dumper for PyKota.
+.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\-d\fR DATA, \fB\-\-data\fR=\fIDATA\fR
+Select the type of datas to dump. This option is
+mandatory. Supported data types are : history,
+payments, billingcodes, users, groups, printers,
+upquotas, gpquotas, umembers, pmembers, and all. The
+\&'all' value forces the output format to XML.
+.TP
+\fB\-f\fR FORMAT, \fB\-\-format\fR=\fIFORMAT\fR
+Select the output format, the default being comma
+separated values. Supported formats are : csv, ssv,
+tsv, xml and cups. The 'cups' output format only works
+when dumping the history, and produces CUPS' page_log
+compatible output.
+.TP
+\fB\-o\fR OUTPUT, \fB\-\-output\fR=\fIOUTPUT\fR
+The name of the file the data dump will be written to.
+The default value is '\-', which tells dumpykota to
+write the dump to stdout.
+.TP
+\fB\-O\fR ORDERBY, \fB\-\-orderby\fR=\fIORDERBY\fR
+Change the ordering of the output based on a comma
+separated list of ordering statements. For example
+\&'\-username,+printername' would sort the output by
+descending order of user names and ascending order of
+printer names. Not all expressions are supported, and
+you should not use this if you don't know the internal
+structure of PyKota's database.
+.TP
+\fB\-s\fR, \fB\-\-sum\fR
+Summarize the output. Only available when dumping the
+printing history or the payments.
+.SS "filtering expressions:"
 .IP
-dumpykota [options] [filterexpr]
-.PP
-options :
-.TP
-\fB\-v\fR | \fB\-\-version\fR
-Prints dumpykota's version number then exits.
-.TP
-\fB\-h\fR | \fB\-\-help\fR
-Prints this message then exits.
-.TP
-\fB\-d\fR | \fB\-\-data\fR type
-Dumps 'type' datas. Allowed types are :
+Use the filtering expressions to extract only parts of the datas. Allowed
+filters are of the form 'key=value'. Wildcards are not expanded as part of
+these filtering expressions, so you can't use them here.
 .IP
-\- history : dumps the jobs history.
-\- users : dumps users.
-\- groups : dumps user groups.
-\- printers : dump printers.
-\- upquotas : dump user quotas.
-\- gpquotas : dump user groups quotas.
-\- payments : dumps user payments.
-\- pmembers : dumps printer groups members.
-\- umembers : dumps user groups members.
-\- billingcodes : dumps billing codes.
-\- all : dumps all PyKota datas. The output format
+allowed keys for now:
 .IP
-is always XML in this case.
+username : User's name
+groupname : Users group's name
+printername : Printer's name
+pgroupname : Printers group's name
+hostname : Host's name
+jobid : Job's id
+billingcode : Job's billing code
+start : Job's date of printing
+end : Job's date of printing
 .IP
-NB : the \fB\-d\fR | \fB\-\-data\fR command line option
-is MANDATORY.
-.TP
-\fB\-f\fR | \fB\-\-format\fR fmt
-Dumps datas in the 'fmt' format. When not specified,
-the format is to dump datas in the csv format (comma
-separated values). All data dumped is between double
-quotes. Allowed formats are :
-.IP
-\- csv : separate datas with commas
-\- ssv : separate datas with semicolons
-\- tsv : separate datas with tabs
-\- xml : dump data as XML
-\- cups : dump datas in CUPS' page_log format :
-.IP
-ONLY AVAILABLE WITH \fB\-\-data\fR history
-.TP
-\fB\-o\fR | \fB\-\-output\fR fname
-All datas will be dumped to the file instead of
-to the standard output. The special '\-' filename
-is the default value and means stdout.
-WARNING : existing files are truncated !
-.TP
-\fB\-O\fR | \fB\-\-orderby\fR exp
-Change the ordering or result. 'exp' is a comma
-separated list of ordering statements, for example
-\&'\-\-orderby +username,\-printername'. Not all expression
-values are meaningful, so using this command line
-switch is not recommanded if you don't know the
-exact layout of PyKota's database schema.
-.TP
-\fB\-s\fR | \fB\-\-sum\fR
-Summarize the selected datas.
-ONLY AVAILABLE WITH \fB\-\-data\fR history or payments
-.IP
-Use the filter expressions to extract only parts of the
-datas. Allowed filters are of the form :
-.IP
-key=value
-.IP
-Allowed keys for now are :
-.TP
-username
-User's name
-.TP
-groupname
-Users group's name
-.TP
-printername
-Printer's name
-.TP
-pgroupname
-Printers group's name
-.TP
-hostname
-Client's hostname
-.TP
-jobid
-Job's Id
-.TP
-billingcode
-Job's billing code
-.TP
-start
-Job's date of printing
-.TP
-end
-Job's date of printing
-.IP
-Dates formatting with 'start' and 'end' filter keys :
+formatting of dates with the 'start' and 'end' filtering keys:
 .IP
 YYYY : year boundaries
@@ -114 +77 @@
 YYYYMMDDhhmm : minute boundaries
 YYYYMMDDhhmmss : second boundaries
-yesterday[+\-NbDays] : yesterday more or less N days (e.g. : yesterday\-15)
-today[+\-NbDays] : today more or less N days (e.g. : today\-15)
-tomorrow[+\-NbDays] : tomorrow more or less N days (e.g. : tomorrow\-15)
-now[+\-NbDays] : now more or less N days (e.g. now\-15)
+yesterday[+\-N] : yesterday more or less N days (e.g. : yesterday\-15)
+today[+\-N] : today more or less N days (e.g. : today\-15)
+tomorrow[+\-N] : tomorrow more or less N days (e.g. : tomorrow\-15)
+now[+\-N] : now more or less N days (e.g. now\-15)
 .IP
-\&'now' and 'today' are not exactly the same since today represents the first
-or last second of the day depending on if it's used in a start= or end=
-date expression. The utility to be able to specify dates in the future is
-a question which remains to be answered :\-)
+\&'now' and 'today' are not exactly the same since 'today' represents the
+first or last second of the day depending on if it's used in a 'start=' or
+\&'end=' date expression.
 .IP
-Contrary to other PyKota management tools, wildcard characters are not
-expanded, so you can't use them.
+examples:
 .IP
-NB : not all keys are allowed for each data type, so the result may be
-empty if you use a key not available for a particular data type.
-.PP
-Examples :
+dumpykota \fB\-\-unit\fR EURO \fB\-\-output\fR /tmp/invoices.pdf start=now\-30
+This would generate a PDF document containing invoices for all users
+who have spent some credits last month. Amounts would be in EURO and
+not VAT information would be included.
 .IP
-\f(CW$ dumpykota \-\-data history \-\-format csv >myfile.csv\fR
+dumpykota \fB\-\-data\fR history \fB\-\-format\fR csv >myfile.csv
+This would dump the whole printing history to stdout in the CSV
+format, and redirect the output to a file.
 .IP
-This dumps the history in a comma separated values file, for possible
-use in a spreadsheet.
+dumpykota \fB\-\-data\fR users \fB\-\-format\fR xml \fB\-o\fR users.xml
+This would dump all users into the 'users.xml' file in the XML format.
 .IP
-\f(CW$ dumpykota \-\-data users \-\-format xml -o users.xml\fR
+dumpykota \fB\-\-data\fR history printername=HP2100 username=jerome
+This would dump jerome's printing history on printer HP2100.
 .IP
-Dumps all users datas to the users.xml file.
+dumpykota \fB\-\-data\fR history start=200503 end=20050730234615
+This would dump all jobs printer between March 1st 2008 at midnight
+and July 30th 2008 at 23 hours 46 minutes and 15 seconds, included.
 .IP
-\f(CW$ dumpykota \-\-data history printername=HP2100 username=jerome\fR
+licensing terms:
 .IP
-Dumps the job history for user jerome on printer HP2100 only.
-.IP
-\f(CW$ dumpykota \-\-data history start=200503 end=20050730234615\fR
-.IP
-Dumps all jobs printed between March 1st 2005 at midnight and
-July 30th 2005 at 23 hours 46 minutes and 15 secondes included.
-.PP
-(c) 2003, 2004, 2005, 2006, 2007, 2008 Jerome Alet <alet@librelogiciel.com>
+(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.
-.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
+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/>.
-.PP
-Please report bugs to : Jerome Alet \- alet@librelogiciel.com

pykota/trunk/man/tr/edpykota.1

@@ -1 +1 @@
 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.36.
-.TH EDPYKOTA "1" "janvier 2008" "C@LL - Conseil Internet & Logiciels Libres" "User Commands"
+.TH EDPYKOTA "1" "janvier 2009" "C@LL - Conseil Internet & Logiciels Libres" "User Commands"
 .SH NOM
-edpykota \- page de manuel de edpykota 1.27alpha3_BROKEN_unofficial
+edpykota \- page de manuel de edpykota (PyKota) 1.27alpha7_unofficial
+.SH SYNOPSIS
+.B edpykota
+[\fIoptions\fR] [\fIusernames|groupnames\fR]
 .SH DESCRIPTION
-edpykota v1.27alpha3_BROKEN_unofficial (c) 2003, 2004, 2005, 2006, 2007, 2008 Jerome Alet \- alet@librelogiciel.com
-.PP
-A Print Quota editor for PyKota.
-.PP
-command line usage :
+Manages PyKota print quota entries for users or users groups. A print quota
+entry is related to both an user and a printer, or to both a group and a
+printer, meaning that for example different users can have different page
+count limits on the same printer. If an user doesn't have a print quota entry
+on a particular printer, he won't be allowed to print to it.
+.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 print
+quota entries.
+.TP
+\fB\-d\fR, \fB\-\-delete\fR
+Delete the specified users or groups print quota
+entries. When deleting users print quota entries, the
+matching jobs are also deleted from the printing
+history.
+.TP
+\fB\-S\fR SOFTLIMIT, \fB\-\-softlimit\fR=\fISOFTLIMIT\fR
+Set the soft page count limit for the specified print
+quota entries. Users can print over this limit for a
+number of days specified in the 'gracedelay' directive
+in pykota.conf
+.TP
+\fB\-H\fR HARDLIMIT, \fB\-\-hardlimit\fR=\fIHARDLIMIT\fR
+Set the hard page count limit for the specified print
+quota entries. Users are never allowed to print over
+this limit.
+.TP
+\fB\-g\fR, \fB\-\-groups\fR
+Manage groups print quota entries instead of users
+print quota entries.
+.TP
+\fB\-I\fR INCREASE, \fB\-\-increase\fR=\fIINCREASE\fR
+Increase the existing soft and hard page count limits
+for the specified print quota entries. You can
+decrease the values instead by prefixing this
+parameter with a negative sign.
+.TP
+\fB\-L\fR, \fB\-\-list\fR
+Display detailed informations about the specified
+users or groups print quota entries.
+.TP
+\fB\-n\fR, \fB\-\-noquota\fR
+Set no limit for both soft and hard page counts for
+the specified users or groups print quota entries.
+.TP
+\fB\-P\fR PRINTER, \fB\-\-printer\fR=\fIPRINTER\fR
+Specify a comma separated list of printers you want to
+manage print quota entries on. The default is '*',
+meaning all printers.
+.TP
+\fB\-r\fR, \fB\-\-reset\fR
+Reset the actual page counter for the specified users
+print quota entries (doesn't work for groups print
+quota entries). The life time page counter is left
+unchanged.
+.TP
+\fB\-R\fR, \fB\-\-hardreset\fR
+Reset the actual and life time page counters for the
+specified users print quota entries (doesn't work for
+groups print quota entries). This is a shortcut for
+\fB\-\-used\fR 0.
+.TP
+\fB\-s\fR, \fB\-\-skipexisting\fR
+If \fB\-\-add\fR is used, ensure that existing users or groups
+print quota entries won't be modified.
+.TP
+\fB\-U\fR USED, \fB\-\-used\fR=\fIUSED\fR
+Set the values of both the actual and life time page
+counters for the specified users print quota entries
+(doesn't work for groups print quota entries). This
+can be useful when migrating from a different print
+quota software. The values can also be increased or
+decreased by prefixing this parameter with either a
+positive or negative sign.
+.SS "examples:"
 .IP
-edpykota [options] user1 user2 ... userN
+edpykota \fB\-\-add\fR john paul george ringo
+Would create print quota entries with no page count limits for these four
+users on all existing printers.
 .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 or groups print quota entries if
-they don't exist in database.
-.TP
-\fB\-d\fR | \fB\-\-delete\fR
-Deletes users or groups print quota entries.
-Users or groups are never deleted, you have
-to use the pkusers command to delete them.
-The history will be purge from all matching
-jobs, unless \fB\-g\fR | \fB\-\-groups\fR is used.
-.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\-\-groups\fR
-Edit groups print quota entries instead of
-users print quota entries.
-.TP
-\fB\-L\fR | \fB\-\-list\fR
-Lists users or groups print quota entries.
-.TP
-\fB\-n\fR | \fB\-\-noquota\fR
-Sets both soft and hard limits to None for users
-or groups print quota entries.
-.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\-s\fR | \fB\-\-skipexisting\fR
-In combination with the \fB\-\-add\fR option above, tells
-edpykota to not modify existing print quota entries.
-.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 existing 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 u
-Sets the page counters for the user u pages on
-the selected printers. Doesn't work for groups, since
-their page counters are the sum of all their members'
-page counters.
-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 u is prefixed with + or \-.
-WARNING : BOTH page counters are modified in all cases,
-so be careful.
-NB : if u equals '0', then the action taken is
-the same as if \fB\-\-hardreset\fR was used.
+edpykota \fB\-\-printer\fR HP \fB\-\-softlimit\fR 50 \fB\-\-hardlimit\fR 60 jerome
+Would allow user 'jerome' to print up to 60 pages on printer 'HP'. This
+user would be warned when he would have reached 50 pages on this printer.
+Both the user and printer must have been created previously using the
+pkusers and pkprinters commands, respectively.
 .IP
-user1 through userN and group1 through groupN can use wildcards
-if the \fB\-\-add\fR option is not set.
-.PP
-examples :
+edpykota \fB\-\-groups\fR \fB\-\-softlimit\fR 500 \fB\-\-hardlimit\fR 600 support financial
+Would set soft and hard page count limits on any printer for groups
+\&'support' and 'financial'.
 .IP
-\f(CW$ edpykota \-\-add john paul george ringo\fR
+edpykota \fB\-\-reset\fR \fB\-\-printer\fR HP jerome "jo*"
+Would reset the actual page counter for users 'jerome' and all users whose
+name begins with 'jo' on printer 'HP'.
 .IP
-This will create print quota entries for users john, paul, george
-and ringo on all printers. These print quota entries will have no
-limit set.
+edpykota \fB\-\-printer\fR HPCOLOR \fB\-\-noquota\fR jerome
+Would allow this user to print without any page limit on printer
+\&'HPCOLOR'. Depending on how this user is limited, he may still be subject
+to being limited by the number of available credits in his account.
 .IP
-\f(CW$ edpykota \-\-printer lp -S 50 -H 60 jerome\fR
+edpykota \fB\-\-add\fR \fB\-\-skipexisting\fR
+Would create a print quota entry for each user on each printer for which
+none already existed. You'll most likely want to use this command at least
+once after initial setup.
+.SS "licensing terms:"
 .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. Both user jerome and
-printer lp have been previously created with the pkusers and pkprinters
-commands, respectively.
+(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
-\f(CW$ edpykota -g -S 500 -H 550 financial support\fR
+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
-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 \-\-delete \-\-printer "HP*,XER*" jerome rachel\fR
-.IP
-This will delete users jerome and rachel's print quota
-entries on all printers which name begin with 'HP' or
-\&'XER'. The jobs printed by these users on these printers
-will be deleted from the history.
-.PP
-(c) 2003, 2004, 2005, 2006, 2007, 2008 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.
-.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, see <http://www.gnu.org/licenses/>.
-.PP
-Please report bugs to : Jerome Alet \- alet@librelogiciel.com
+You should have received a copy of the GNU General Public License along
+with this program.  If not, see <http://www.gnu.org/licenses/>.

pykota/trunk/man/tr/pkbanner.1

@@ -1 +1 @@
 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.36.
-.TH PKBANNER "1" "janvier 2008" "C@LL - Conseil Internet & Logiciels Libres" "User Commands"
+.TH PKBANNER "1" "janvier 2009" "C@LL - Conseil Internet & Logiciels Libres" "User Commands"
 .SH NOM
-pkbanner \- page de manuel de pkbanner 1.27alpha3_BROKEN_unofficial
+pkbanner \- page de manuel de pkbanner (PyKota) 1.27alpha7_unofficial
+.SH SYNOPSIS
+.B pkbanner
+[\fIoptions\fR]
 .SH DESCRIPTION
-pkbanner v1.27alpha3_BROKEN_unofficial (c) 2003, 2004, 2005, 2006, 2007, 2008 Jerome Alet \- alet@librelogiciel.com
-.PP
-Generates banners.
-.PP
-command line usage :
+Banner generator for PyKota.
+.SH OPTIONS
 .TP
-pkbanner
-[options]  [more info]
-.PP
-options :
+\fB\-h\fR, \fB\-\-help\fR
+show this help message and exit.
 .TP
-\fB\-v\fR | \fB\-\-version\fR
-Prints pkbanner's version number then exits.
+\fB\-v\fR, \fB\-\-version\fR
+show the version number and exit.
 .TP
-\fB\-h\fR | \fB\-\-help\fR
-Prints this message then exits.
+\fB\-A\fR ARGUMENTSFILE, \fB\-\-arguments\fR=\fIARGUMENTSFILE\fR
+loads additional options and arguments from a file,
+one per line.
 .TP
-\fB\-l\fR | \fB\-\-logo\fR img
-Use the image as the banner's logo. The logo will
-be drawn at the center top of the page. The default
-logo is /usr/share/pykota/logos/pykota.jpeg
+\fB\-l\fR LOGO, \fB\-\-logo\fR=\fILOGO\fR
+The image to use as a logo. The logo will be drawn at
+the center top of the page. The default logo is
+/usr/share/pykota/logos/pykota.jpeg.
 .TP
-\fB\-p\fR | \fB\-\-pagesize\fR sz
-Sets sz as the page size. Most well known
-page sizes are recognized, like 'A4' or 'Letter'
-to name a few. The default size is A4.
+\fB\-p\fR PAGESIZE, \fB\-\-pagesize\fR=\fIPAGESIZE\fR
+Set the size of the page. Most well known page sizes
+are recognized, like 'A4' or 'Letter' to name a few.
+The default page size is A4.
 .TP
-\fB\-s\fR | \fB\-\-savetoner\fR s
-Sets the text luminosity factor to s%. This can be
-used to save toner. The default value is 0, which
+\fB\-s\fR SAVETONER, \fB\-\-savetoner\fR=\fISAVETONER\fR
+Set the text luminosity to this percent. This can be
+used to save toner. The default value is 0.0, which
 means that no toner saving will be done.
 .TP
-\fB\-u\fR | \fB\-\-url\fR u
-Uses u as an url to be written at the bottom of
-the banner page. The default url is :
-http://www.pykota.com/
-.PP
-examples :
+\fB\-u\fR URL, \fB\-\-url\fR=\fIURL\fR
+Set the url to write at the bottom of the banner page.
+The default url is http://www.pykota.com.
+.SS "examples:"
 .IP
-Using pkbanner directly from the command line is not recommended,
-excepted for testing purposes. You should use pkbanner in the
-\&'startingbanner' or 'endingbanner' directives in pykota.conf
+pkbanner \fB\-\-logo=\fR"" \fB\-\-savetoner\fR=\fI75\fR
+This would generate a banner in the default page size, with no logo, and
+text luminosity would be increased by 75%.
+.SS "licensing terms:"
 .IP
-startingbanner: /usr/bin/pkbanner \fB\-\-logo=\fR"" \fB\-\-savetoner\fR=\fI75\fR
+(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
-With such a setting in pykota.conf, all print jobs will be
-prefixed with an A4 banner with no logo, and text luminosity will
-be increased by 75%. The PostScript output will be directly sent
-to your printer.
+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'll find more examples in the sample configuration file included
-in PyKota.
-.PP
-(c) 2003, 2004, 2005, 2006, 2007, 2008 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.
-.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, see <http://www.gnu.org/licenses/>.
-.PP
-Please report bugs to : Jerome Alet \- alet@librelogiciel.com
+You should have received a copy of the GNU General Public License along
+with this program.  If not, see <http://www.gnu.org/licenses/>.

pykota/trunk/man/tr/pkbcodes.1

@@ -1 +1 @@
 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.36.
-.TH PKBCODES "1" "janvier 2008" "C@LL - Conseil Internet & Logiciels Libres" "User Commands"
+.TH PKBCODES "1" "janvier 2009" "C@LL - Conseil Internet & Logiciels Libres" "User Commands"
 .SH NOM
-pkbcodes \- page de manuel de pkbcodes 1.27alpha3_BROKEN_unofficial
+pkbcodes \- page de manuel de pkbcodes (PyKota) 1.27alpha7_unofficial
+.SH SYNOPSIS
+.B pkbcodes
+[\fIoptions\fR] \fIcode1 code2 \fR... \fIcodeN\fR
 .SH DESCRIPTION
-pkbcodes v1.27alpha3_BROKEN_unofficial (c) 2003, 2004, 2005, 2006, 2007, 2008 Jerome Alet \- alet@librelogiciel.com
-.PP
-A billing codes Manager for PyKota.
-.PP
-command line usage :
+A billing codes manager for PyKota.
+.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, billing codes.
+.TP
+\fB\-d\fR, \fB\-\-delete\fR
+Deletes billing codes. Matching entries in the
+printing history are not deleted, on purpose.
+.TP
+\fB\-D\fR DESCRIPTION, \fB\-\-description\fR=\fIDESCRIPTION\fR
+Set a textual description for the specified billing
+codes.
+.TP
+\fB\-l\fR, \fB\-\-list\fR
+Display detailed informations about the specified
+billing codes.
+.TP
+\fB\-r\fR, \fB\-\-reset\fR
+Reset the page count and amount spent for the
+specified billing codes.
+.TP
+\fB\-s\fR, \fB\-\-skipexisting\fR
+If \fB\-\-add\fR is used, ensure that existing billing codes
+won't be modified.
+.SS "examples:"
 .IP
-pkbcodes [options] code1 code2 code3 ... codeN
-.PP
-options :
-.TP
-\fB\-v\fR | \fB\-\-version\fR
-Prints pkbcodes version number then exits.
-.TP
-\fB\-h\fR | \fB\-\-help\fR
-Prints this message then exits.
-.TP
-\fB\-a\fR | \fB\-\-add\fR
-Adds billing codes if they don't exist in PyKota's
-database. If they exist, they are modified
-unless \fB\-s\fR|\-\-skipexisting is also used.
-.TP
-\fB\-d\fR | \fB\-\-delete\fR
-Deletes billing codes from PyKota's database.
-NB : the history entries with this billing code
-are not deleted, voluntarily.
-.HP
-\fB\-D\fR | \fB\-\-description\fR d Adds a textual description to billing codes.
-.TP
-\fB\-l\fR | \fB\-\-list\fR
-List informations about the billing codes.
-.TP
-\fB\-r\fR | \fB\-\-reset\fR
-Resets the billing codes' balance and page counters
-to 0.
-.TP
-\fB\-s\fR | \fB\-\-skipexisting\fR
-In combination with the \fB\-\-add\fR option above, tells
-pkbcodes to not modify existing billing codes.
+pkbcodes \fB\-D\fR "Financial Department" financial
+Would create a billing code labelled 'financial' with the specified
+textual description.
 .IP
-code1 through codeN can contain wildcards if the \fB\-\-add\fR option
-is not set.
-.PP
-examples :
+pkbcodes \fB\-\-delete\fR "fin*"
+Would delete all billing codes which label begins with 'fin'. Matching
+jobs in the printing history wouldn't be deleted though.
 .IP
-\f(CW$ pkbcodes \-\-add -D "My project" myproj\fR
+pkbcodes \fB\-\-list\fR
+Would display details about all existing billing codes.
+.SS "licensing terms:"
 .IP
-Will create the myproj billing code with "My project"
-as the description.
+(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
-\f(CW$ pkbcodes \-\-delete "*"\fR
+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
-This will completely delete all the billing codes, but without
-removing any matching job from the history. USE WITH CARE ANYWAY !
-.IP
-\f(CW$ pkbcodes \-\-list "my*"\fR
-.IP
-This will list all billing codes which name begins with 'my'.
-.PP
-(c) 2003, 2004, 2005, 2006, 2007, 2008 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.
-.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, see <http://www.gnu.org/licenses/>.
-.PP
-Please report bugs to : Jerome Alet \- alet@librelogiciel.com
+You should have received a copy of the GNU General Public License along
+with this program.  If not, see <http://www.gnu.org/licenses/>.

pykota/trunk/man/tr/pkinvoice.1

@@ -1 +1 @@
 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.36.
-.TH PKINVOICE "1" "janvier 2008" "C@LL - Conseil Internet & Logiciels Libres" "User Commands"
+.TH PKINVOICE "1" "janvier 2009" "C@LL - Conseil Internet & Logiciels Libres" "User Commands"
 .SH NOM
-pkinvoice \- page de manuel de pkinvoice 1.27alpha3_BROKEN_unofficial
+pkinvoice \- page de manuel de pkinvoice (PyKota) 1.27alpha7_unofficial
+.SH SYNOPSIS
+.B pkinvoice
+[\fIoptions\fR] [\fIfilterexpr\fR]
 .SH DESCRIPTION
-pkinvoice v1.27alpha3_BROKEN_unofficial (c) 2003, 2004, 2005, 2006, 2007, 2008 Jerome Alet \- alet@librelogiciel.com
-.PP
-An invoice generator for PyKota.
-.PP
-command line usage :
+Invoice generator for PyKota.
+.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\-l\fR LOGO, \fB\-\-logo\fR=\fILOGO\fR
+The image to use as a logo. The logo will be drawn at
+the center top of the page. The default logo is
+/usr/share/pykota/logos/pykota.jpeg.
+.TP
+\fB\-p\fR PAGESIZE, \fB\-\-pagesize\fR=\fIPAGESIZE\fR
+Set the size of the page. Most well known page sizes
+are recognized, like 'A4' or 'Letter' to name a few.
+The default page size is A4.
+.TP
+\fB\-n\fR NUMBER, \fB\-\-number\fR=\fINUMBER\fR
+Set the number of the first invoice. This number will
+automatically be incremented for each invoice. The
+default value is 1.
+.TP
+\fB\-o\fR OUTPUT, \fB\-\-output\fR=\fIOUTPUT\fR
+The name of the file to which the PDF invoices will be
+written. If not set or set to '\-', the PDF document
+will be sent to the standard output.
+.TP
+\fB\-u\fR UNIT, \fB\-\-unit\fR=\fIUNIT\fR
+The name of the unit to use on the invoices. The
+default value is 'Credits' or its locale translation.
+.TP
+\fB\-V\fR VAT, \fB\-\-vat\fR=\fIVAT\fR
+The value in percent of the applicable VAT to be
+exposed. The default is 0.0, meaning no VAT.
+.SS "filtering expressions:"
 .IP
-pkinvoice [options] [filterexpr]
-.PP
-options :
-.TP
-\fB\-v\fR | \fB\-\-version\fR
-Prints pkinvoice's version number then exits.
-.TP
-\fB\-h\fR | \fB\-\-help\fR
-Prints this message then exits.
-.TP
-\fB\-l\fR | \fB\-\-logo\fR img
-Use the image as the invoice's logo. The logo will
-be drawn at the center top of the page. The default
-logo is /usr/share/pykota/logos/pykota.jpeg
-.TP
-\fB\-p\fR | \fB\-\-pagesize\fR sz
-Sets sz as the page size. Most well known
-page sizes are recognized, like 'A4' or 'Letter'
-to name a few. The default size is A4.
-.TP
-\fB\-n\fR | \fB\-\-number\fR N
-Sets the number of the first invoice. This number
-will automatically be incremented for each invoice.
-.TP
-\fB\-o\fR | \fB\-\-output\fR f.pdf
-Defines the name of the invoice file which will
-be generated as a PDF document. If not set or
-set to '\-', the PDF document is sent to standard
-output.
-.TP
-\fB\-u\fR | \fB\-\-unit\fR u
-Defines the name of the unit to use on the invoice.
-The default unit is 'Credits', optionally translated
-to your native language if it is supported by PyKota.
-.TP
-\fB\-V\fR | \fB\-\-vat\fR p
-Sets the percent value of the applicable VAT to be
-exposed. The default is 0.0, meaning no VAT
-information will be included.
+Use the filtering expressions to extract only parts of the datas. Allowed
+filters are of the form 'key=value'. Wildcards are not expanded as part of
+these filtering expressions, so you can't use them here.
 .IP
-Use the filter expressions to extract only parts of the
-datas. Allowed filters are of the form :
+allowed keys for now:
 .IP
-key=value
+username : User's name
+printername : Printer's name
+hostname : Host's name
+jobid : Job's id
+billingcode : Job's billing code
+start : Job's date of printing
+end : Job's date of printing
 .IP
-Allowed keys for now are :
-.TP
-username
-User's name
-.TP
-printername
-Printer's name
-.TP
-hostname
-Client's hostname
-.TP
-jobid
-Job's Id
-.TP
-billingcode
-Job's billing code
-.TP
-start
-Job's date of printing
-.TP
-end
-Job's date of printing
-.IP
-Dates formatting with 'start' and 'end' filter keys :
+formatting of dates with the 'start' and 'end' filtering keys:
 .IP
 YYYY : year boundaries
@@ -86 +71 @@
 YYYYMMDDhhmm : minute boundaries
 YYYYMMDDhhmmss : second boundaries
-yesterday[+\-NbDays] : yesterday more or less N days (e.g. : yesterday\-15)
-today[+\-NbDays] : today more or less N days (e.g. : today\-15)
-tomorrow[+\-NbDays] : tomorrow more or less N days (e.g. : tomorrow\-15)
-now[+\-NbDays] : now more or less N days (e.g. now\-15)
+yesterday[+\-N] : yesterday more or less N days (e.g. : yesterday\-15)
+today[+\-N] : today more or less N days (e.g. : today\-15)
+tomorrow[+\-N] : tomorrow more or less N days (e.g. : tomorrow\-15)
+now[+\-N] : now more or less N days (e.g. now\-15)
 .IP
-\&'now' and 'today' are not exactly the same since today represents the first
-or last second of the day depending on if it's used in a start= or end=
-date expression. The utility to be able to specify dates in the future is
-a question which remains to be answered :\-)
+\&'now' and 'today' are not exactly the same since 'today' represents the
+first or last second of the day depending on if it's used in a 'start=' or
+\&'end=' date expression.
 .IP
-Contrary to other PyKota management tools, wildcard characters are not
-expanded, so you can't use them.
-.PP
-examples :
+examples:
 .IP
-\f(CW$ pkinvoice \-\-unit EURO \-\-output /tmp/invoices.pdf start=now-30\fR
+pkinvoice \fB\-\-unit\fR EURO \fB\-\-output\fR /tmp/invoices.pdf start=now\-30
+This would generate a PDF document containing invoices for all users
+who have spent some credits last month. Amounts would be in EURO and
+not VAT information would be included.
 .IP
-Will generate a PDF document containing invoices for all users
-who have spent some credits last month. Invoices will be done in
-EURO.  No VAT information will be included.
-.PP
-(c) 2003, 2004, 2005, 2006, 2007, 2008 Jerome Alet <alet@librelogiciel.com>
+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.
-.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
+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/>.
-.PP
-Please report bugs to : Jerome Alet \- alet@librelogiciel.com

pykota/trunk/man/tr/pkprinters.1

@@ -1 +1 @@
 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.36.
-.TH PKPRINTERS "1" "janvier 2008" "C@LL - Conseil Internet & Logiciels Libres" "User Commands"
+.TH PKPRINTERS "1" "janvier 2009" "C@LL - Conseil Internet & Logiciels Libres" "User Commands"
 .SH NOM
-pkprinters \- page de manuel de pkprinters 1.27alpha3_BROKEN_unofficial
+pkprinters \- page de manuel de pkprinters (PyKota) 1.27alpha7_unofficial
+.SH SYNOPSIS
+.B pkprinters
+[\fIoptions\fR] \fIprinter1 printer2 \fR... \fIprinterN\fR
 .SH DESCRIPTION
-pkprinters v1.27alpha3_BROKEN_unofficial (c) 2003, 2004, 2005, 2006, 2007, 2008 Jerome Alet \- alet@librelogiciel.com
-.PP
-A Printers Manager for PyKota.
-.PP
-command line usage :
+Manages PyKota printers.
+.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, printers.
+.TP
+\fB\-c\fR CHARGE, \fB\-\-charge\fR=\fICHARGE\fR
+Set the cost per page, and optionally per job, for
+printing to the specified printers. If both are to be
+set, separate them with a comma. Floating point and
+negative values are allowed.
+.TP
+\fB\-C\fR, \fB\-\-cups\fR
+Tell CUPS to either start or stop managing the
+specified printers with PyKota.
+.TP
+\fB\-d\fR, \fB\-\-delete\fR
+Delete the specified printers. Also purge the print
+quota entries and printing history matching the
+specified printers.
+.TP
+\fB\-D\fR DESCRIPTION, \fB\-\-description\fR=\fIDESCRIPTION\fR
+Set a textual description for the specified printers.
+.TP
+\fB\-g\fR GROUPS, \fB\-\-groups\fR=\fIGROUPS\fR
+If the \fB\-\-remove\fR option is not used, the default action
+is to add the specified printers to the specified
+printers groups. Otherwise they are removed from these
+groups. The specified printers groups must already
+exist, and should be created beforehand just like
+normal printers with this very command.
+.TP
+\fB\-l\fR, \fB\-\-list\fR
+Display detailed informations about the specified
+printers.
+.TP
+\fB\-m\fR MAXJOBSIZE, \fB\-\-maxjobsize\fR=\fIMAXJOBSIZE\fR
+Set the maximum job size in pages allowed on the
+specified printers.
+.TP
+\fB\-n\fR, \fB\-\-nopassthrough\fR
+Deactivate passthrough mode for the specified
+printers. This is the normal mode of operations, in
+which print jobs are accounted for, and are checked
+against printing quotas and available credits.
+.TP
+\fB\-p\fR, \fB\-\-passthrough\fR
+Activate passthrough mode for the specified printers.
+In this mode, jobs sent to these printers are not
+accounted for. This can be useful for exams during
+which no user should be charged for his printouts.
+.TP
+\fB\-r\fR, \fB\-\-remove\fR
+When combined with the \fB\-\-groups\fR option, remove
+printers from the specified printers groups.
+.TP
+\fB\-s\fR, \fB\-\-skipexisting\fR
+If \fB\-\-add\fR is used, ensure that existing printers won't
+be modified.
+.SS "examples:"
 .IP
-pkprinters [options] printer1 printer2 printer3 ... printerN
-.PP
-options :
-.TP
-\fB\-v\fR | \fB\-\-version\fR
-Prints pkprinters'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 printers if they don't exist on the Quota
-Storage Server. If they exist, they are modified
-unless \fB\-s\fR|\-\-skipexisting is also used.
-.TP
-\fB\-d\fR | \fB\-\-delete\fR
-Deletes printers from the quota storage.
-.HP
-\fB\-D\fR | \fB\-\-description\fR d Adds a textual description to printers.
-.TP
-\fB\-C\fR | \fB\-\-cups\fR
-Also modifies the DeviceURI in CUPS' printers.conf
-.TP
-\fB\-c\fR | \fB\-\-charge\fR p[,j]
-Sets the price per page and per job to charge.
-Job price is optional.
-If both are to be set, separate them with a comma.
-Floating point and negative values are allowed.
-.TP
-\fB\-g\fR | \fB\-\-groups\fR pg1[,pg2...] Adds or Remove 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.
-If the \fB\-\-remove\fR option below is not used, the
-default action is to add printers to the specified
-printer groups.
-.TP
-\fB\-l\fR | \fB\-\-list\fR
-List informations about the printer(s) and the
-printers groups it is a member of.
-.TP
-\fB\-r\fR | \fB\-\-remove\fR
-In combination with the \fB\-\-groups\fR option above,
-remove printers from the specified printers groups.
-.TP
-\fB\-s\fR | \fB\-\-skipexisting\fR
-In combination with the \fB\-\-add\fR option above, tells
-pkprinters to not modify existing printers.
-.TP
-\fB\-m\fR | \fB\-\-maxjobsize\fR s
-Sets the maximum job size allowed on the printer
-to s pages.
-.TP
-\fB\-p\fR | \fB\-\-passthrough\fR
-Activate passthrough mode for the printer. In this
-mode, users are allowed to print without any impact
-on their quota or account balance.
-.TP
-\fB\-n\fR | \fB\-\-nopassthrough\fR Deactivate passthrough mode for the printer.
-Without \fB\-p\fR or \fB\-n\fR, printers are created in
-normal mode, i.e. no passthrough.
+pkprinters \fB\-\-add\fR \fB\-\-cups\fR \fB\-D\fR "HP Printer" \fB\-\-charge\fR 0.05,0.1 hp2100 hp2200
+Would create three printers named 'hp2100', and 'hp2200' in PyKota's
+database, while telling CUPS to route all print jobs through PyKota for
+these printers. Each of them would have 'HP Printer' as its description.
+Printing to any of them would cost 0.05 credit per page, plus 0.1 credit
+for each job.
 .IP
-printer1 through printerN can contain wildcards if the \fB\-\-add\fR option
-is not set.
-.PP
-examples :
+pkprinters \fB\-\-delete\fR "*"
+Would delete all existing printers and matching print quota entries and
+printing history from PyKota's database. USE WITH CARE.
 .IP
-\f(CW$ pkprinters \-\-add -D "HP Printer" \-\-charge 0.05,0.1 hp2100 hp2200 hp8000\fR
+pkprinters \fB\-\-groups\fR Laser,HP "hp*"
+Would add all printers which name begins with 'hp' to the 'Laser' and 'HP'
+printers groups, which must already exist.
 .IP
-Will create three printers named hp2100, hp2200 and hp8000.
-Their price per page will be set at 0.05 unit, and their price
-per job will be set at 0.1 unit. Units are in your own currency,
-or whatever you want them to mean.
-All of their descriptions will be set to the string "HP Printer".
-If any of these printers already exists, it will also be modified
-unless the \fB\-s\fR|\-\-skipexisting command line option is also used.
+pkprinters \fB\-\-groups\fR Lexmark \fB\-\-remove\fR hp2200
+Would remove printer 'hp2200' from the 'Lexmark' printers group.
+.SS "licensing terms:"
 .IP
-\f(CW$ pkprinters \-\-delete "*"\fR
+(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 will completely delete all printers and associated quota information,
-as well as their job history. USE WITH CARE !
+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
-\f(CW$ pkprinters \-\-groups Laser,HP "hp*"\fR
-.IP
-This will put all printers which name matches "hp*" into printers groups
-Laser and HP, which MUST already exist.
-.IP
-\f(CW$ pkprinters \-\-groups LexMark \-\-remove hp2200\fR
-.IP
-This will remove the hp2200 printer from the LexMark printer group.
-.PP
-(c) 2003, 2004, 2005, 2006, 2007, 2008 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.
-.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, see <http://www.gnu.org/licenses/>.
-.PP
-Please report bugs to : Jerome Alet \- alet@librelogiciel.com
+You should have received a copy of the GNU General Public License along
+with this program.  If not, see <http://www.gnu.org/licenses/>.

pykota/trunk/man/tr/pkrefund.1

@@ -1 +1 @@
 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.36.
-.TH PKREFUND "1" "janvier 2008" "C@LL - Conseil Internet & Logiciels Libres" "User Commands"
+.TH PKREFUND "1" "janvier 2009" "C@LL - Conseil Internet & Logiciels Libres" "User Commands"
 .SH NOM
-pkrefund \- page de manuel de pkrefund 1.27alpha3_BROKEN_unofficial
+pkrefund \- page de manuel de pkrefund (PyKota) 1.27alpha7_unofficial
+.SH SYNOPSIS
+.B pkrefund
+[\fIoptions\fR] [\fIfilterexpr\fR]
 .SH DESCRIPTION
-pkrefund v1.27alpha3_BROKEN_unofficial (c) 2003, 2004, 2005, 2006, 2007, 2008 Jerome Alet \- alet@librelogiciel.com
-.PP
-Refunds jobs.
-.PP
-command line usage :
+Refunding tool for PyKota.
+.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\-f\fR, \fB\-\-force\fR
+Doesn't ask for confirmation before refunding. Only
+needed if you specify a filename for the PDF receipts.
+If you send such receipts to stdout, \fB\-\-force\fR is
+assumed to be set.
+.TP
+\fB\-i\fR INFO, \fB\-\-info\fR=\fIINFO\fR
+The informations to be prepended to the refunding
+reason, which can include some of Python's string
+interpolations to access to certain internal values.
+If you don't want such information, set this
+explicitely to an empty string. The default is
+\&'''Refunded %(nbpages)i pages and %(nbcredits).3f
+credits by %(effectiveuser)s (%(loginname)s) on
+%(date)s'''
+.TP
+\fB\-l\fR LOGO, \fB\-\-logo\fR=\fILOGO\fR
+The image to use as a logo. The logo will be drawn at
+the center top of the page. The default logo is
+/usr/share/pykota/logos/pykota.jpeg.
+.TP
+\fB\-n\fR NUMBER, \fB\-\-number\fR=\fINUMBER\fR
+Sets the number of the first receipt. This number will
+automatically be incremented for each receipt. The
+default value is 1.
+.TP
+\fB\-o\fR OUTPUT, \fB\-\-output\fR=\fIOUTPUT\fR
+The name of the file to which the PDF receipts will be
+written. If not set or set to '\-', the PDF document
+will be sent to the standard output, and \fB\-\-force\fR will
+be assumed to be set.
+.TP
+\fB\-p\fR PAGESIZE, \fB\-\-pagesize\fR=\fIPAGESIZE\fR
+Set the size of the page. Most well known page sizes
+are recognized, like 'A4' or 'Letter' to name a few.
+The default page size is A4.
+.TP
+\fB\-r\fR REASON, \fB\-\-reason\fR=\fIREASON\fR
+The reason why there was a refund.
+.TP
+\fB\-u\fR UNIT, \fB\-\-unit\fR=\fIUNIT\fR
+The name of the unit to use on the receipts. The
+default value is 'Credits' or its locale translation.
+.SS "filtering expressions:"
 .IP
-pkrefund [options] [filterexpr]
-.PP
-options :
-.TP
-\fB\-v\fR | \fB\-\-version\fR
-Prints pkrefund's version number then exits.
-.TP
-\fB\-h\fR | \fB\-\-help\fR
-Prints this message then exits.
-.TP
-\fB\-f\fR | \fB\-\-force\fR
-Doesn't ask for confirmation before refunding jobs.
-.TP
-\fB\-r\fR | \fB\-\-reason\fR txt
-Sets textual information to explain the refunding.
-.TP
-\fB\-l\fR | \fB\-\-logo\fR img
-Use the image as the receipt's logo. The logo will
-be drawn at the center top of the page. The default
-logo is /usr/share/pykota/logos/pykota.jpeg
-.TP
-\fB\-p\fR | \fB\-\-pagesize\fR sz
-Sets sz as the page size. Most well known
-page sizes are recognized, like 'A4' or 'Letter'
-to name a few. The default size is A4.
-.TP
-\fB\-n\fR | \fB\-\-number\fR N
-Sets the number of the first receipt. This number
-will automatically be incremented for each receipt.
-.TP
-\fB\-o\fR | \fB\-\-output\fR f.pdf
-Defines the name of the PDF file which will contain
-the receipts. If not set, then no PDF file will
-be created. If set to '\-', then \fB\-\-force\fR is assumed,
-and the PDF document is sent to standard output.
-.TP
-\fB\-u\fR | \fB\-\-unit\fR u
-Defines the name of the unit to use on the receipts.
-The default unit is 'Credits', optionally translated
-to your native language if it is supported by PyKota.
+Use the filtering expressions to extract only parts of the datas. Allowed
+filters are of the form 'key=value'. Wildcards are not expanded as part of
+these filtering expressions, so you can't use them here.
 .IP
-Use the filter expressions to extract only parts of the
-datas. Allowed filters are of the form :
+allowed keys for now:
 .IP
-key=value
+username : User's name
+printername : Printer's name
+hostname : Host's name
+jobid : Job's id
+billingcode : Job's billing code
+start : Job's date of printing
+end : Job's date of printing
 .IP
-Allowed keys for now are :
-.TP
-username
-User's name
-.TP
-printername
-Printer's name
-.TP
-hostname
-Client's hostname
-.TP
-jobid
-Job's Id
-.TP
-billingcode
-Job's billing code
-.TP
-start
-Job's date of printing
-.TP
-end
-Job's date of printing
-.IP
-Dates formatting with 'start' and 'end' filter keys :
+formatting of dates with the 'start' and 'end' filtering keys:
 .IP
 YYYY : year boundaries
@@ -87 +87 @@
 YYYYMMDDhhmm : minute boundaries
 YYYYMMDDhhmmss : second boundaries
-yesterday[+\-NbDays] : yesterday more or less N days (e.g. : yesterday\-15)
-today[+\-NbDays] : today more or less N days (e.g. : today\-15)
-tomorrow[+\-NbDays] : tomorrow more or less N days (e.g. : tomorrow\-15)
-now[+\-NbDays] : now more or less N days (e.g. now\-15)
+yesterday[+\-N] : yesterday more or less N days (e.g. : yesterday\-15)
+today[+\-N] : today more or less N days (e.g. : today\-15)
+tomorrow[+\-N] : tomorrow more or less N days (e.g. : tomorrow\-15)
+now[+\-N] : now more or less N days (e.g. now\-15)
 .IP
-\&'now' and 'today' are not exactly the same since today represents the first
-or last second of the day depending on if it's used in a start= or end=
-date expression. The utility to be able to specify dates in the future is
-a question which remains to be answered :\-)
+\&'now' and 'today' are not exactly the same since 'today' represents the
+first or last second of the day depending on if it's used in a 'start=' or
+\&'end=' date expression.
 .IP
-Contrary to other PyKota management tools, wildcard characters are not
-expanded, so you can't use them.
-.PP
-Examples :
+examples:
 .IP
-\f(CW$ pkrefund \-\-output /tmp/receipts.pdf jobid=503\fR
+pkrefund \fB\-\-output\fR /tmp/receipts.pdf jobid=503
+This would refund all jobs which Id is 503. A confirmation would be
+asked for each job to refund, and a PDF file named /tmp/receipts.pdf
+would be created containing printable receipts. BEWARE of job ids
+rolling over if you reset CUPS' history.
 .IP
-This will refund all jobs which Id is 503. BEWARE : installing CUPS
-afresh will reset the first job id at 1, so you probably want to use
-a more precise filter as explained below. A confirmation will
-be asked for each job to refund, and a PDF file named /tmp/receipts.pdf
-will be created which will contain printable receipts.
+pkrefund \fB\-\-reason\fR "Hardware problem" jobid=503 start=today\-7
+This would refund all jobs which id is 503 but which would have been
+printed during the  past week. The reason would be marked as being an
+hardware problem.
 .IP
-\f(CW$ pkrefund \-\-reason "Hardware problem" jobid=503 start=today-7\fR
+pkrefund \fB\-\-force\fR username=jerome printername=HP2100
+This would refund all jobs printed by user jerome on printer HP2100.
+No confirmation would be asked.
 .IP
-Refunds all jobs which id is 503 but which were printed during the
-past week. The reason will be marked as being an hardware problem.
+pkrefund \fB\-\-force\fR printername=HP2100 start=200602 end=yesterday
+This would refund all jobs printed on printer HP2100 between February
+1st 2006 and yesterday. No confirmation would be asked.
 .IP
-\f(CW$ pkrefund \-\-force username=jerome printername=HP2100\fR
+licensing terms:
 .IP
-Refunds all jobs printed by user jerome on printer HP2100. No
-confirmation will be asked.
-.IP
-\f(CW$ pkrefund \-\-force printername=HP2100 start=200602 end=yesterday\fR
-.IP
-Refunds all jobs printed on printer HP2100 between February 1st 2006
-and yesterday. No confirmation will be asked.
-.PP
-(c) 2003, 2004, 2005, 2006, 2007, 2008 Jerome Alet <alet@librelogiciel.com>
+(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.
-.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
+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/>.
-.PP
-Please report bugs to : Jerome Alet \- alet@librelogiciel.com

pykota/trunk/man/tr/pksetup.1

@@ -1 +1 @@
 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.36.
-.TH PKSETUP "1" "janvier 2008" "C@LL - Conseil Internet & Logiciels Libres" "User Commands"
+.TH PKSETUP "1" "janvier 2009" "C@LL - Conseil Internet & Logiciels Libres" "User Commands"
 .SH NOM
 pksetup \- page de manuel de pksetup 0.1

pykota/trunk/man/tr/pkturnkey.1

@@ -1 +1 @@
 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.36.
-.TH PKTURNKEY "1" "janvier 2008" "C@LL - Conseil Internet & Logiciels Libres" "User Commands"
+.TH PKTURNKEY "1" "janvier 2009" "C@LL - Conseil Internet & Logiciels Libres" "User Commands"
 .SH NOM
-pkturnkey \- page de manuel de pkturnkey 1.27alpha3_BROKEN_unofficial
+pkturnkey \- page de manuel de pkturnkey (PyKota) 1.27alpha7_unofficial
+.SH SYNOPSIS
+.B pkturnkey
+[\fIoptions\fR] \fIprinter1 printer2 \fR... \fIprinterN\fR
 .SH DESCRIPTION
-pkturnkey v1.27alpha3_BROKEN_unofficial (c) 2003, 2004, 2005, 2006, 2007, 2008 Jerome Alet \- alet@librelogiciel.com
-.PP
 A turn key tool for PyKota. When launched, this command will initialize
-PyKota's database with all existing print queues and some or all users.
-For now, no prices or limits are set, so printing is fully accounted
-for, but not limited. That's why you'll probably want to also use
-edpykota once the database has been initialized.
-.PP
-command line usage :
+PyKota's database with all existing print queues and some or all users. For
+now, no prices or limits are set, so printing is fully accounted for, but not
+limited. That's why you'll probably want to also use edpykota once the
+database has been initialized.
+.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\-c\fR, \fB\-\-doconf\fR
+Try to autodetect the best print accounting settings
+for existing CUPS printers. All printers must be
+switched ON beforehand.
+.TP
+\fB\-d\fR, \fB\-\-dousers\fR
+Create accounts for users, and allocate print quota
+entries for them.
+.TP
+\fB\-D\fR, \fB\-\-dogroups\fR
+Create accounts for users groups, and allocate print
+quota entries for them.
+.TP
+\fB\-e\fR, \fB\-\-emptygroups\fR
+Also include groups which don't have any member.
+.TP
+\fB\-f\fR, \fB\-\-force\fR
+Modifies PyKota's database content for real, instead
+of faking it (for safety reasons).
+.TP
+\fB\-u\fR UIDMIN, \fB\-\-uidmin\fR=\fIUIDMIN\fR
+Only include users whose uid is greater than or equal
+to this parameter. If you pass an username instead,
+his uid will be used automatically.
+.TP
+\fB\-U\fR UIDMAX, \fB\-\-uidmax\fR=\fIUIDMAX\fR
+Only include users whose uid is lesser than or equal
+to this parameter. If you pass an username instead,
+his uid will be used automatically.
+.TP
+\fB\-g\fR GIDMIN, \fB\-\-gidmin\fR=\fIGIDMIN\fR
+Only include users groups whose gid is greater than or
+equal to this parameter. If you pass a groupname
+instead, its gid will be used automatically.
+.TP
+\fB\-G\fR GIDMAX, \fB\-\-gidmax\fR=\fIGIDMAX\fR
+Only include users groups whose gid is lesser than or
+equal to this parameter. If you pass a groupname
+instead, its gid will be used automatically.
+.SS "examples:"
 .IP
-pkturnkey [options] [printqueues names]
-.PP
-options :
-.TP
-\fB\-v\fR | \fB\-\-version\fR
-Prints pkturnkey version number then exits.
-.TP
-\fB\-h\fR | \fB\-\-help\fR
-Prints this message then exits.
-.TP
-\fB\-c\fR | \fB\-\-doconf\fR
-Give hints about what to put into pykota.conf
-.TP
-\fB\-d\fR | \fB\-\-dousers\fR
-Manages users accounts as well.
-.TP
-\fB\-D\fR | \fB\-\-dogroups\fR
-Manages users groups as well.
-Implies \fB\-d\fR | \fB\-\-dousers\fR.
-.TP
-\fB\-e\fR | \fB\-\-emptygroups\fR
-Includes empty groups.
-.TP
-\fB\-f\fR | \fB\-\-force\fR
-Modifies the database instead of printing what
-it would do.
-.TP
-\fB\-u\fR | \fB\-\-uidmin\fR uid
-Only adds users whose uid is greater than or equal to
-uid. You can pass an username there as well, and its
-uid will be used automatically.
-If not set, 0 will be used automatically.
-Implies \fB\-d\fR | \fB\-\-dousers\fR.
-.TP
-\fB\-U\fR | \fB\-\-uidmax\fR uid
-Only adds users whose uid is lesser than or equal to
-uid. You can pass an username there as well, and its
-uid will be used automatically.
-If not set, a large value will be used automatically.
-Implies \fB\-d\fR | \fB\-\-dousers\fR.
-.TP
-\fB\-g\fR | \fB\-\-gidmin\fR gid
-Only adds groups whose gid is greater than or equal to
-gid. You can pass a groupname there as well, and its
-gid will be used automatically.
-If not set, 0 will be used automatically.
-Implies \fB\-D\fR | \fB\-\-dogroups\fR.
-.TP
-\fB\-G\fR | \fB\-\-gidmax\fR gid
-Only adds groups whose gid is lesser than or equal to
-gid. You can pass a groupname there as well, and its
-gid will be used automatically.
-If not set, a large value will be used automatically.
-Implies \fB\-D\fR | \fB\-\-dogroups\fR.
-.PP
-examples :
+pkturnkey \fB\-\-dousers\fR \fB\-\-uidmin\fR jerome HPLASER1 HPLASER2
+Would simulate the creation in PyKota's database of the printing accounts
+for all users whose uid is greater than or equal to 'jerome''s. Each of
+them would be given a print quota entry on printers 'HPLASER1' and
+\&'HPLASER2'.
 .IP
-\f(CW$ pkturnkey \-\-dousers \-\-uidmin jerome\fR
+pkturnkey \fB\-\-force\fR \fB\-\-dousers\fR \fB\-\-uidmin\fR jerome HPLASER1 HPLASER2
+Would do the same as the example above, but for real. Please take great
+care when using the \fB\-\-force\fR command line option.
 .IP
-Will simulate the initialization of PyKota's database will all existing
-printers and print accounts for all users whose uid is greater than
-or equal to jerome's one. Won't manage any users group.
+pkturnkey \fB\-\-doconf\fR
+Would try to automatically detect the best print accounting settings for
+all active printers, and generate some lines for you to add into your
+pykota.conf
+.SS "licensing terms:"
 .IP
-To REALLY initialize the database instead of simulating it, please
-use the \fB\-f\fR | \fB\-\-force\fR command line switch.
+(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
-You can limit the initialization to only a subset of the existing
-printers, by passing their names at the end of the command line.
-.PP
-(c) 2003, 2004, 2005, 2006, 2007, 2008 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.
-.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, see <http://www.gnu.org/licenses/>.
-.PP
-Please report bugs to : Jerome Alet \- alet@librelogiciel.com
+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/>.

pykota/trunk/man/tr/pkusers.1

@@ -1 +1 @@
 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.36.
-.TH PKUSERS "1" "janvier 2008" "C@LL - Conseil Internet & Logiciels Libres" "User Commands"
+.TH PKUSERS "1" "janvier 2009" "C@LL - Conseil Internet & Logiciels Libres" "User Commands"
 .SH NOM
-pkusers \- page de manuel de pkusers 1.27alpha3_BROKEN_unofficial
+pkusers \- page de manuel de pkusers (PyKota) 1.27alpha7_unofficial
+.SH SYNOPSIS
+.B pkusers
+[\fIoptions\fR] [\fIusernames|groupnames\fR]
 .SH DESCRIPTION
-pkusers v1.27alpha3_BROKEN_unofficial (c) 2003, 2004, 2005, 2006, 2007, 2008 Jerome Alet \- alet@librelogiciel.com
-.PP
-An Users and Groups Manager for PyKota.
-.PP
-command line usage :
+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 [options] user1 user2 user3 ... userN
-.PP
-or :
+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\-\-groups\fR [options] group1 group2 group3 ... groupN
-.PP
-options :
-.TP
-\fB\-v\fR | \fB\-\-version\fR
-Prints pkusers'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 if they don't exist on the database.
-If they exist, they are modified unless
-\fB\-s\fR|\-\-skipexisting is also used.
-.TP
-\fB\-d\fR | \fB\-\-delete\fR
-Deletes users from the quota storage.
-.TP
-\fB\-e\fR | \fB\-\-email\fR addr
-Sets the email address for the users.
-If the addr parameter begins with @, then
-the username is prepended to addr to form
-a valid email address.
-.HP
-\fB\-D\fR | \fB\-\-description\fR d Adds a textual description to users or groups.
-.TP
-\fB\-g\fR | \fB\-\-groups\fR
-Edit users groups instead of users.
-.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 such 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\-L\fR | \fB\-\-list\fR
-Lists users or groups.
-.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' :
+pkusers \fB\-\-add\fR \fB\-\-groups\fR coders it
+Would create two users groups named 'coders' and 'it'.
 .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.
+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
-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\-r\fR | \fB\-\-remove\fR
-In combination with the \fB\-\-ingroups\fR option above,
-remove users from the specified users groups.
-.TP
-\fB\-s\fR | \fB\-\-skipexisting\fR
-In combination with the \fB\-\-add\fR option above, tells
-pkusers to not modify existing users.
+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
-user1 through userN and group1 through groupN can use wildcards
-if the \fB\-\-add\fR option is not set.
-.PP
-examples :
+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
-\f(CW$ pkusers \-\-add john paul george ringo/ringo@example.com\fR
+pkusers \fB\-\-delete\fR "jer*" "rach*"
+Would delete all user accounts whose names begin with either 'jer' or
+\&'rach'.
 .IP
-This will add users john, paul, george and ringo to the quota
-database. User ringo's email address will also be set to
-\&'ringo@example.com'
+pkusers \fB\-\-overcharge\fR \fB\-1\fR.50 theboss
+Would make the boss earn money whenever he prints.
 .IP
-\f(CW$ pkusers \-\-ingroups coders,it jerome\fR
+pkusers \fB\-\-email\fR @example.com
+Would set the email address for each existing user to username@example.com
 .IP
-User jerome is put into the groups "coders" and "it" which must
-already exist in the quota database.
+pkusers \fB\-\-list\fR
+Would list all users.
+.SS "licensing terms:"
 .IP
-\f(CW$ pkusers \-\-limitby balance jerome\fR
+(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 will tell PyKota to limit jerome by his account's balance
-when printing.
+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
-\f(CW$ pkusers \-\-balance +10.0 \-\-comment "He paid with his blood !" 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.
-A comment will be stored for this balance change.
-.IP
-\f(CW$ pkusers \-\-delete jerome rachel\fR
-.IP
-This will completely delete jerome and rachel from the quota
-database. All their quotas and jobs will be deleted too.
-.IP
-\f(CW$ pkusers \-\-overcharge 2.5 poorstudent\fR
-.IP
-This will overcharge the poorstudent user by a factor of 2.5.
-.IP
-\f(CW$ pkusers \-\-overcharge -1 jerome\fR
-.IP
-User jerome will actually earn money whenever he prints.
-.IP
-\f(CW$ pkusers \-\-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.
-.IP
-\f(CW$ pkusers \-\-email @example.com\fR
-.IP
-This will set the email address for each user to username@example.com
-.PP
-(c) 2003, 2004, 2005, 2006, 2007, 2008 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.
-.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, see <http://www.gnu.org/licenses/>.
-.PP
-Please report bugs to : Jerome Alet \- alet@librelogiciel.com
+You should have received a copy of the GNU General Public License along
+with this program.  If not, see <http://www.gnu.org/licenses/>.

pykota/trunk/man/tr/pykosd.1

@@ -1 +1 @@
 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.36.
-.TH PYKOSD "1" "janvier 2008" "C@LL - Conseil Internet & Logiciels Libres" "User Commands"
+.TH PYKOSD "1" "janvier 2009" "C@LL - Conseil Internet & Logiciels Libres" "User Commands"
 .SH NOM
-pykosd \- page de manuel de pykosd 1.27alpha3_BROKEN_unofficial
+pykosd \- page de manuel de pykosd (PyKota) 1.27alpha7_unofficial
+.SH SYNOPSIS
+.B pykosd
+[\fIoptions\fR]
 .SH DESCRIPTION
-pykosd v1.27alpha3_BROKEN_unofficial (c) 2003, 2004, 2005, 2006, 2007, 2008 Jerome Alet \- alet@librelogiciel.com
-.PP
-An OSD quota monitor for PyKota.
-.PP
-command line usage :
-.IP
-pykosd [options]
-.PP
-options :
+An On Screen Display (OSD) monitor for PyKota's end users.
+.SH OPTIONS
 .TP
-\fB\-v\fR | \fB\-\-version\fR
-Prints pykosd's version number then exits.
+\fB\-h\fR, \fB\-\-help\fR
+show this help message and exit.
 .TP
-\fB\-h\fR | \fB\-\-help\fR
-Prints this message then exits.
+\fB\-v\fR, \fB\-\-version\fR
+show the version number and exit.
 .TP
-\fB\-c\fR | \fB\-\-color\fR #rrggbb Sets the color to use for display as an hexadecimal
-triplet, for example #FF0000 is 100% red.
-Defaults to 100% green (#00FF00).
+\fB\-A\fR ARGUMENTSFILE, \fB\-\-arguments\fR=\fIARGUMENTSFILE\fR
+loads additional options and arguments from a file,
+one per line.
 .TP
-\fB\-d\fR | \fB\-\-duration\fR d
-Sets the duration of the display in seconds.
-Defaults to 3 seconds.
+\fB\-c\fR COLOR, \fB\-\-color\fR=\fICOLOR\fR, \fB\-\-colour\fR=\fICOLOR\fR
+Set the color that will be used for display, as an
+hexadecimal triplet. For example #FF0000 is 100% red.
+The default is 100% green (#00FF00).
 .TP
-\fB\-f\fR | \fB\-\-font\fR f
-Sets the font to use for display.
-Defaults to the Python OSD library's default.
+\fB\-d\fR DURATION, \fB\-\-duration\fR=\fIDURATION\fR
+Set the time in seconds during which the message will
+be displayed. Defaults to 3 seconds.
 .TP
-\fB\-l\fR | \fB\-\-loop\fR n
-Sets the number of times the info will be displayed.
+\fB\-f\fR FONT, \fB\-\-font\fR=\fIFONT\fR
+Set the font to use. Defaults to \-*\-helveticamedium\-r\-normal\-*\-*\-360\-*\-*\-p\-*\-*\-*.
+.TP
+\fB\-l\fR LOOP, \fB\-\-loop\fR=\fILOOP\fR
+Set the number of times the info will be displayed.
 Defaults to 0, which means loop forever.
 .TP
-\fB\-s\fR | \fB\-\-sleep\fR s
-Sets the sleeping duration between two displays
-in seconds. Defaults to 180 seconds (3 minutes).
-.PP
-examples :
+\fB\-s\fR SLEEP, \fB\-\-sleep\fR=\fISLEEP\fR
+Set the sleeping time in seconds between two
+refreshes. Defaults to 180 seconds.
+.SS "examples:"
 .IP
-\f(CW$ pykosd -s 60 \-\-loop 5\fR
+pykosd \fB\-s\fR 60 \fB\-\-loop\fR 5
+This would tell pykosd to display the current user's status for 3 seconds
+(the default) every 60 seconds, and exit after 5 iterations.
+.SS "licensing terms:"
 .IP
-Will launch pykosd. Display will be refreshed every 60 seconds,
-and will last for 3 seconds (the default) each time. After five
-iterations, the program will exit.
-.PP
-(c) 2003, 2004, 2005, 2006, 2007, 2008 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.
-.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, see <http://www.gnu.org/licenses/>.
-.PP
-Please report bugs to : Jerome Alet \- alet@librelogiciel.com
+(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/>.

pykota/trunk/man/tr/pykotme.1

@@ -1 +1 @@
 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.36.
-.TH PYKOTME "1" "janvier 2008" "C@LL - Conseil Internet & Logiciels Libres" "User Commands"
+.TH PYKOTME "1" "janvier 2009" "C@LL - Conseil Internet & Logiciels Libres" "User Commands"
 .SH NOM
-pykotme \- page de manuel de pykotme 1.27alpha3_BROKEN_unofficial
+pykotme \- page de manuel de pykotme (PyKota) 1.27alpha7_unofficial
+.SH SYNOPSIS
+.B pykotme
+[\fIoptions\fR] [\fIfiles\fR]
 .SH DESCRIPTION
-pykotme v1.27alpha3_BROKEN_unofficial (c) 2003, 2004, 2005, 2006, 2007, 2008 Jerome Alet \- alet@librelogiciel.com
-.PP
-Gives print quotes to users.
-.PP
-command line usage :
+Generates print quotes for end users.
+.SH OPTIONS
 .TP
-pykotme
-[options]  [files]
-.PP
-options :
+\fB\-h\fR, \fB\-\-help\fR
+show this help message and exit.
 .TP
-\fB\-v\fR | \fB\-\-version\fR
-Prints pykotme's version number then exits.
+\fB\-v\fR, \fB\-\-version\fR
+show the version number and exit.
 .TP
-\fB\-h\fR | \fB\-\-help\fR
-Prints this message then exits.
+\fB\-A\fR ARGUMENTSFILE, \fB\-\-arguments\fR=\fIARGUMENTSFILE\fR
+loads additional options and arguments from a file,
+one per line.
 .TP
-\fB\-P\fR | \fB\-\-printer\fR p
-Gives a quote for this printer 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.
-.PP
-examples :
+\fB\-P\fR PRINTER, \fB\-\-printer\fR=\fIPRINTER\fR
+Acts on this printer only. You can specify several
+printer names by separating them with commas. The
+default value is '*', which means all printers.
+.TP
+\fB\-u\fR USER, \fB\-\-user\fR=\fIUSER\fR
+Acts on this user only. Only one username can be
+specified this way. The default value is the name of
+the user who launched this command. This option is
+ignored when the command is not launched by a PyKota
+Administrator.
+.SS "examples:"
 .IP
-\f(CW$ pykotme \-\-printer apple file1.ps file2.ps\fR
+pykotme \fB\-\-printer\fR apple file1.ps <file2.pclxl
+This would show the number of pages needed to print these two files, as
+well as the cost of printing them to the 'apple' printer for the user who
+launched this command.
 .IP
-This will give a print quote to the current user. The quote will show
-the price and size of a job consisting in file1.ps and file2.ps
-which would be sent to the apple printer.
+pykotme \fB\-\-user\fR john
+This would show the number of pages needed to print the content of the
+standard input, and the cost of printing this on all printers for user
+\&'john'.
+.SS "licensing terms:"
 .IP
-\f(CW$ pykotme \-\-printer apple,hplaser <file1.ps\fR
+(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 will give a print quote to the current user. The quote will show
-the price and size of a job consisting in file1.ps as read from
-standard input, which would be sent to the apple or hplaser
-printer.
+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
-\f(CW$ pykotme\fR
-.IP
-This will give a quote for a job consisting of what is on standard
-input. The quote will list the job size, and the price the job
-would cost on each printer.
-.PP
-(c) 2003, 2004, 2005, 2006, 2007, 2008 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.
-.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, see <http://www.gnu.org/licenses/>.
-.PP
-Please report bugs to : Jerome Alet \- alet@librelogiciel.com
+You should have received a copy of the GNU General Public License along
+with this program.  If not, see <http://www.gnu.org/licenses/>.

pykota/trunk/man/tr/repykota.1

@@ -1 +1 @@
 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.36.
-.TH REPYKOTA "1" "janvier 2008" "C@LL - Conseil Internet & Logiciels Libres" "User Commands"
+.TH REPYKOTA "1" "janvier 2009" "C@LL - Conseil Internet & Logiciels Libres" "User Commands"
 .SH NOM
-repykota \- page de manuel de repykota 1.27alpha3_BROKEN_unofficial
+repykota \- page de manuel de repykota (PyKota) 1.27alpha7_unofficial
+.SH SYNOPSIS
+.B repykota
+[\fIoptions\fR] [\fIusernames|groupnames\fR]
 .SH DESCRIPTION
-repykota v1.27alpha3_BROKEN_unofficial (c) 2003, 2004, 2005, 2006, 2007, 2008 Jerome Alet \- alet@librelogiciel.com
-.PP
-Generates print quota reports.
-.PP
-command line usage :
+Minimalist print accounting reports for PyKota. If not launched by a PyKota
+administrator, additionnal arguments representing users or groups names are
+ignored, limiting the scope of the reports to the current user.
+.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\-g\fR, \fB\-\-groups\fR
+Generate group print quota reports instead of user
+print quota reports.
+.TP
+\fB\-i\fR INGROUPS, \fB\-\-ingroups\fR=\fIINGROUPS\fR
+Only report users who are members of the specified
+groups. This option is reserved to PyKota
+administrators.
+.TP
+\fB\-P\fR PRINTER, \fB\-\-printer\fR=\fIPRINTER\fR
+Acts on this printer only. You can specify several
+printer names by separating them with commas. The
+default value is '*', which means all printers.
+.SS "examples:"
 .IP
-repykota [options]
-.PP
-options :
-.TP
-\fB\-v\fR | \fB\-\-version\fR
-Prints repykota's version number then exits.
-.TP
-\fB\-h\fR | \fB\-\-help\fR
-Prints this message then exits.
-.TP
-\fB\-u\fR | \fB\-\-users\fR
-Generates a report on users quota, this is
-the default.
-.TP
-\fB\-g\fR | \fB\-\-groups\fR
-Generates a report on group quota instead of users.
-.TP
-\fB\-i\fR | \fB\-\-ingroups\fR g1[,g2...]
-Only lists users who are members of these
-groups. Reserved to PyKota Administrators.
-.TP
-\fB\-P\fR | \fB\-\-printer\fR p
-Report quotas on this printer 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.
-.PP
-examples :
+repykota
+This would generate a report for all users on all printers.
 .IP
-\f(CW$ repykota \-\-printer lp\fR
+repykota \fB\-\-printer\fR HP2100
+This would generate a report for all users who print to printer 'HP2100'.
 .IP
-This will print the quota status for all users who use the lp printer.
+repykota \fB\-\-printer\fR "laser*,*pson" jerome "jo*"
+This would generate a report for all users named 'jerome' or whose name
+begins with 'jo', on all printers which name begins with 'laser' or ends
+with 'pson'.
+.SS "licensing terms:"
 .IP
-\f(CW$ repykota\fR
+(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 will print the quota status for all users on all printers.
+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
-\f(CW$ repykota \-\-printer "laser*,*pson" jerome "jo*"\fR
-.IP
-This will print the quota status for user jerome and all users
-whose name begins with "jo" on all printers which name begins
-with "laser" or ends with "pson".
-.IP
-If launched by an user who is not a PyKota administrator, additionnal
-arguments representing users or groups names are ignored, and only the
-current user/group is reported.
-.PP
-(c) 2003, 2004, 2005, 2006, 2007, 2008 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.
-.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, see <http://www.gnu.org/licenses/>.
-.PP
-Please report bugs to : Jerome Alet \- alet@librelogiciel.com
+You should have received a copy of the GNU General Public License along
+with this program.  If not, see <http://www.gnu.org/licenses/>.

pykota/trunk/man/tr/warnpykota.1

@@ -1 +1 @@
 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.36.
-.TH WARNPYKOTA "1" "janvier 2008" "C@LL - Conseil Internet & Logiciels Libres" "User Commands"
+.TH WARNPYKOTA "1" "janvier 2009" "C@LL - Conseil Internet & Logiciels Libres" "User Commands"
 .SH NOM
-warnpykota \- page de manuel de warnpykota 1.27alpha3_BROKEN_unofficial
+warnpykota \- page de manuel de warnpykota (PyKota) 1.27alpha7_unofficial
+.SH SYNOPSIS
+.B warnpykota
+[\fIoptions\fR] [\fIusernames|groupnames\fR]
 .SH DESCRIPTION
-warnpykota v1.27alpha3_BROKEN_unofficial (c) 2003, 2004, 2005, 2006, 2007, 2008 Jerome Alet \- alet@librelogiciel.com
-.PP
-Sends mail to users over print quota.
-.PP
-command line usage :
+A tool to warn users and groups who have reached the limit of their printing
+quota.
+.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\-g\fR, \fB\-\-groups\fR
+Notify all members for all the named groups which have
+reached the limit of their printing quota. Without
+this option, individual users are notified instead of
+users groups.
+.TP
+\fB\-P\fR PRINTER, \fB\-\-printer\fR=\fIPRINTER\fR
+Acts on this printer only. You can specify several
+printer names by separating them with commas. The
+default value is '*', which means all printers.
+.SS "examples:"
+.IP
 warnpykota
-[options]  [names]
-.PP
-options :
-.TP
-\fB\-v\fR | \fB\-\-version\fR
-Prints warnpykota's version number then exits.
-.TP
-\fB\-h\fR | \fB\-\-help\fR
-Prints this message then exits.
-.TP
-\fB\-u\fR | \fB\-\-users\fR
-Warns users over their print quota, this is the
-default.
-.TP
-\fB\-g\fR | \fB\-\-groups\fR
-Warns users whose groups quota are over limit.
-.TP
-\fB\-P\fR | \fB\-\-printer\fR p
-Verify quotas on this printer 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.
-.PP
-examples :
+This would notify all users who have reached the limit of their printing
+quota on any printer.
 .IP
-\f(CW$ warnpykota \-\-printer lp\fR
+warnpykota \fB\-\-printer\fR HP2100
+This would notify all users who have reached the limit of their printing
+quota on printer 'HP2100'.
 .IP
-This will warn all users of the lp printer who have exceeded their
-print quota.
+warnpykota \fB\-\-groups\fR \fB\-\-printer\fR "HP*,XER*" "dev*"
+This would notify all users of the groups whose name begins with 'dev' and
+for which the printing quota limit is reached on any printer whose name
+begins with 'HP' or 'XER'.
+.SS "licensing terms:"
 .IP
-\f(CW$ warnpykota\fR
-.TP
-This will warn all users
-who have exceeded their print quota on
+(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
-any printer.
+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
-\f(CW$ warnpykota \-\-groups \-\-printer "laserjet*" "dev*"\fR
-.IP
-This will warn all users of groups which names begins with "dev" and
-who have exceeded their print quota on any printer which name begins
-with "laserjet"
-.IP
-If launched by an user who is not a PyKota administrator, additionnal
-arguments representing users or groups names are ignored, and only the
-current user/group is reported.
-.PP
-(c) 2003, 2004, 2005, 2006, 2007, 2008 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.
-.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, see <http://www.gnu.org/licenses/>.
-.PP
-Please report bugs to : Jerome Alet \- alet@librelogiciel.com
+You should have received a copy of the GNU General Public License along
+with this program.  If not, see <http://www.gnu.org/licenses/>.