root / pykota / trunk / man / tr / dumpykota.1 @ 3238

Revision 3238, 5.0 kB (checked in by jerome, 17 years ago)

v1.26 is out.

  • 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" "juillet 2007" "C@LL - Conseil Internet & Logiciels Libres" "User Commands"
3.SH NOM
4dumpykota \- page de manuel de dumpykota 1.26_unofficial
5.SH DESCRIPTION
6dumpykota v1.26_unofficial (c) 2003, 2004, 2005, 2006, 2007 Jerome Alet \- alet@librelogiciel.com
7.PP
8Dumps PyKota database's content.
9.PP
10command line usage :
11.IP
12dumpykota [options] [filterexpr]
13.PP
14options :
15.TP
16\fB\-v\fR | \fB\-\-version\fR
17Prints dumpykota's version number then exits.
18.TP
19\fB\-h\fR | \fB\-\-help\fR
20Prints this message then exits.
21.TP
22\fB\-d\fR | \fB\-\-data\fR type
23Dumps 'type' datas. Allowed types are :
24.IP
25\- history : dumps the jobs history.
26\- users : dumps users.
27\- groups : dumps user groups.
28\- printers : dump printers.
29\- upquotas : dump user quotas.
30\- gpquotas : dump user groups quotas.
31\- payments : dumps user payments.
32\- pmembers : dumps printer groups members.
33\- umembers : dumps user groups members.
34\- billingcodes : dumps billing codes.
35\- all : dumps all PyKota datas. The output format
36.IP
37is always XML in this case.
38.IP
39NB : the \fB\-d\fR | \fB\-\-data\fR command line option
40is MANDATORY.
41.TP
42\fB\-f\fR | \fB\-\-format\fR fmt
43Dumps datas in the 'fmt' format. When not specified,
44the format is to dump datas in the csv format (comma
45separated values). All data dumped is between double
46quotes. Allowed formats are :
47.IP
48\- csv : separate datas with commas
49\- ssv : separate datas with semicolons
50\- tsv : separate datas with tabs
51\- xml : dump data as XML
52\- cups : dump datas in CUPS' page_log format :
53.IP
54ONLY AVAILABLE WITH \fB\-\-data\fR history
55.TP
56\fB\-o\fR | \fB\-\-output\fR fname
57All datas will be dumped to the file instead of
58to the standard output. The special '\-' filename
59is the default value and means stdout.
60WARNING : existing files are truncated !
61.TP
62\fB\-O\fR | \fB\-\-orderby\fR exp
63Change the ordering or result. 'exp' is a comma
64separated list of ordering statements, for example
65\&'\-\-orderby +username,\-printername'. Not all expression
66values are meaningful, so using this command line
67switch is not recommanded if you don't know the
68exact layout of PyKota's database schema.
69.TP
70\fB\-s\fR | \fB\-\-sum\fR
71Summarize the selected datas.
72ONLY AVAILABLE WITH \fB\-\-data\fR history or payments
73.IP
74Use the filter expressions to extract only parts of the
75datas. Allowed filters are of the form :
76.IP
77key=value
78.IP
79Allowed keys for now are :
80.TP
81username
82User's name
83.TP
84groupname
85Users group's name
86.TP
87printername
88Printer's name
89.TP
90pgroupname
91Printers group's name
92.TP
93hostname
94Client's hostname
95.TP
96jobid
97Job's Id
98.TP
99billingcode
100Job's billing code
101.TP
102start
103Job's date of printing
104.TP
105end
106Job's date of printing
107.IP
108Dates formatting with 'start' and 'end' filter keys :
109.IP
110YYYY : year boundaries
111YYYYMM : month boundaries
112YYYYMMDD : day boundaries
113YYYYMMDDhh : hour boundaries
114YYYYMMDDhhmm : minute boundaries
115YYYYMMDDhhmmss : second boundaries
116yesterday[+\-NbDays] : yesterday more or less N days (e.g. : yesterday\-15)
117today[+\-NbDays] : today more or less N days (e.g. : today\-15)
118tomorrow[+\-NbDays] : tomorrow more or less N days (e.g. : tomorrow\-15)
119now[+\-NbDays] : now more or less N days (e.g. now\-15)
120.IP
121\&'now' and 'today' are not exactly the same since today represents the first
122or last second of the day depending on if it's used in a start= or end=
123date expression. The utility to be able to specify dates in the future is
124a question which remains to be answered :\-)
125.IP
126Contrary to other PyKota management tools, wildcard characters are not
127expanded, so you can't use them.
128.IP
129NB : not all keys are allowed for each data type, so the result may be
130empty if you use a key not available for a particular data type.
131.PP
132Examples :
133.IP
134\f(CW$ dumpykota --data history --format csv >myfile.csv\fR
135.IP
136This dumps the history in a comma separated values file, for possible
137use in a spreadsheet.
138.IP
139\f(CW$ dumpykota --data users --format xml -o users.xml\fR
140.IP
141Dumps all users datas to the users.xml file.
142.IP
143\f(CW$ dumpykota --data history printername=HP2100 username=jerome\fR
144.IP
145Dumps the job history for user jerome on printer HP2100 only.
146.IP
147\f(CW$ dumpykota --data history start=200503 end=20050730234615\fR
148.IP
149Dumps all jobs printed between March 1st 2005 at midnight and
150July 30th 2005 at 23 hours 46 minutes and 15 secondes included.
151.PP
152This program is free software; you can redistribute it and/or modify
153it under the terms of the GNU General Public License as published by
154the Free Software Foundation; either version 2 of the License, or
155(at your option) any later version.
156.PP
157This program is distributed in the hope that it will be useful,
158but WITHOUT ANY WARRANTY; without even the implied warranty of
159MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
160GNU General Public License for more details.
161.PP
162You should have received a copy of the GNU General Public License
163along with this program; if not, write to the Free Software
164Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110\-1301, USA.
165.PP
166Please report bugs to : Jerome Alet \- alet@librelogiciel.com
Note: See TracBrowser for help on using the browser.