Changeset 2086 for pykota/trunk/man/dumpykota.1

Timestamp:

02/21/05 01:15:37 (19 years ago)

Author:

jalet

Message:

Updated manual pages

Files:

• pykota/trunk/man/dumpykota.1 (modified) (6 diffs)

pykota/trunk/man/dumpykota.1

@@ -1 @@
-.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.33.
-.TH DUMPYKOTA "1" "November 2004" "C@LL - Conseil Internet & Logiciels Libres" "User Commands"
+.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.35.
+.TH DUMPYKOTA "1" "February 2005" "C@LL - Conseil Internet & Logiciels Libres" "User Commands"
 .SH NAME
-dumpykota \- manual page for dumpykota 1.21alpha6_unofficial
+dumpykota \- manual page for dumpykota 1.21alpha27_unofficial
 .SH DESCRIPTION
-dumpykota v1.21alpha6_unofficial (c) 2003-2004 C@LL - Conseil Internet & Logiciels Libres
+dumpykota v1.21alpha27_unofficial (c) 2003, 2004, 2005 C@LL \- Conseil Internet & Logiciels Libres
 .PP
 Dumps PyKota database's content.
@@ -10 +10 @@
 command line usage :
 .IP
-dumpykota [options]
+dumpykota [options] [filterexpr]
 .PP
 options :
@@ -23 +23 @@
 Dumps 'type' datas. Allowed types are :
 .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.
+\- 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.
 .IP
 NB : the \fB\-d\fR | \fB\-\-data\fR command line option
@@ -42 +42 @@
 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
+\- 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
+to the standard output. The special '\-' filename
 is the default value and means stdout.
 WARNING : existing files are truncated !
+.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
+.IP
+Contrary to other PyKota management tools, wildcard characters are not
+expanded, so you can't use them.
+.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 :
@@ -63 +91 @@
 .IP
 Dumps all users datas to the users.xml file.
+.IP
+\f(CW$ dumpykota --data history printername=HP2100 username=jerome\fR
+.IP
+Dumps the job history for user jerome on printer HP2100 only.
 .PP
 This program is free software; you can redistribute it and/or modify
@@ -76 +108 @@
 You should have received a copy of the GNU General Public License
 along with this program; if not, write to the Free Software
-Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
+Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111\-1307, USA.
 .PP
-Please e-mail bugs to: Jerome Alet - alet@librelogiciel.com
+Please e\-mail bugs to: Jerome Alet \- alet@librelogiciel.com