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

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

Updated manual pages.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
Line 
1.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.36.
2.TH DUMPYKOTA "1" "janvier 2009" "C@LL - Conseil Internet & Logiciels Libres" "User Commands"
3.SH NOM
4dumpykota \- page de manuel de dumpykota (PyKota) 1.27alpha7_unofficial
5.SH SYNOPSIS
6.B dumpykota
7[\fIoptions\fR] [\fIfilterexpr\fR]
8.SH DESCRIPTION
9Data Dumper for PyKota.
10.SH OPTIONS
11.TP
12\fB\-h\fR, \fB\-\-help\fR
13show this help message and exit.
14.TP
15\fB\-v\fR, \fB\-\-version\fR
16show the version number and exit.
17.TP
18\fB\-A\fR ARGUMENTSFILE, \fB\-\-arguments\fR=\fIARGUMENTSFILE\fR
19loads additional options and arguments from a file,
20one per line.
21.TP
22\fB\-d\fR DATA, \fB\-\-data\fR=\fIDATA\fR
23Select the type of datas to dump. This option is
24mandatory. Supported data types are : history,
25payments, billingcodes, users, groups, printers,
26upquotas, gpquotas, umembers, pmembers, and all. The
27\&'all' value forces the output format to XML.
28.TP
29\fB\-f\fR FORMAT, \fB\-\-format\fR=\fIFORMAT\fR
30Select the output format, the default being comma
31separated values. Supported formats are : csv, ssv,
32tsv, xml and cups. The 'cups' output format only works
33when dumping the history, and produces CUPS' page_log
34compatible output.
35.TP
36\fB\-o\fR OUTPUT, \fB\-\-output\fR=\fIOUTPUT\fR
37The name of the file the data dump will be written to.
38The default value is '\-', which tells dumpykota to
39write the dump to stdout.
40.TP
41\fB\-O\fR ORDERBY, \fB\-\-orderby\fR=\fIORDERBY\fR
42Change the ordering of the output based on a comma
43separated list of ordering statements. For example
44\&'\-username,+printername' would sort the output by
45descending order of user names and ascending order of
46printer names. Not all expressions are supported, and
47you should not use this if you don't know the internal
48structure of PyKota's database.
49.TP
50\fB\-s\fR, \fB\-\-sum\fR
51Summarize the output. Only available when dumping the
52printing history or the payments.
53.SS "filtering expressions:"
54.IP
55Use the filtering expressions to extract only parts of the datas. Allowed
56filters are of the form 'key=value'. Wildcards are not expanded as part of
57these filtering expressions, so you can't use them here.
58.IP
59allowed keys for now:
60.IP
61username : User's name
62groupname : Users group's name
63printername : Printer's name
64pgroupname : Printers group's name
65hostname : Host's name
66jobid : Job's id
67billingcode : Job's billing code
68start : Job's date of printing
69end : Job's date of printing
70.IP
71formatting of dates with the 'start' and 'end' filtering keys:
72.IP
73YYYY : year boundaries
74YYYYMM : month boundaries
75YYYYMMDD : day boundaries
76YYYYMMDDhh : hour boundaries
77YYYYMMDDhhmm : minute boundaries
78YYYYMMDDhhmmss : second boundaries
79yesterday[+\-N] : yesterday more or less N days (e.g. : yesterday\-15)
80today[+\-N] : today more or less N days (e.g. : today\-15)
81tomorrow[+\-N] : tomorrow more or less N days (e.g. : tomorrow\-15)
82now[+\-N] : now more or less N days (e.g. now\-15)
83.IP
84\&'now' and 'today' are not exactly the same since 'today' represents the
85first or last second of the day depending on if it's used in a 'start=' or
86\&'end=' date expression.
87.IP
88examples:
89.IP
90dumpykota \fB\-\-unit\fR EURO \fB\-\-output\fR /tmp/invoices.pdf start=now\-30
91This would generate a PDF document containing invoices for all users
92who have spent some credits last month. Amounts would be in EURO and
93not VAT information would be included.
94.IP
95dumpykota \fB\-\-data\fR history \fB\-\-format\fR csv >myfile.csv
96This would dump the whole printing history to stdout in the CSV
97format, and redirect the output to a file.
98.IP
99dumpykota \fB\-\-data\fR users \fB\-\-format\fR xml \fB\-o\fR users.xml
100This would dump all users into the 'users.xml' file in the XML format.
101.IP
102dumpykota \fB\-\-data\fR history printername=HP2100 username=jerome
103This would dump jerome's printing history on printer HP2100.
104.IP
105dumpykota \fB\-\-data\fR history start=200503 end=20050730234615
106This would dump all jobs printer between March 1st 2008 at midnight
107and July 30th 2008 at 23 hours 46 minutes and 15 seconds, included.
108.IP
109licensing terms:
110.IP
111(c) 2003\-2009 Jerome Alet \- alet@librelogiciel.com
112This program is free software: you can redistribute it and/or modify
113it under the terms of the GNU General Public License as published by
114the Free Software Foundation, either version 3 of the License, or (at
115your option) any later version.
116.IP
117This program is distributed in the hope that it will be useful, but
118WITHOUT ANY WARRANTY; without even the implied warranty of
119MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
120General Public License for more details.
121.IP
122You should have received a copy of the GNU General Public License
123along with this program.  If not, see <http://www.gnu.org/licenses/>.
Note: See TracBrowser for help on using the browser.