root / pykota / trunk / man / dumpykota.1 @ 3436

.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.36.
.TH DUMPYKOTA "1" "January 2008" "C@LL - Conseil Internet & Logiciels Libres" "User Commands"
.SH NAME
dumpykota \- manual page for dumpykota 1.27alpha3_BROKEN_unofficial
.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 :
.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 :
.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
.IP
is always XML in this case.
.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 :
.IP
YYYY : year boundaries
YYYYMM : month boundaries
YYYYMMDD : day boundaries
YYYYMMDDhh : hour boundaries
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)
.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 :\-)
.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 :
.IP
\f(CW$ dumpykota \-\-data history \-\-format csv >myfile.csv\fR
.IP
This dumps the history in a comma separated values file, for possible
use in a spreadsheet.
.IP
\f(CW$ dumpykota \-\-data users \-\-format xml -o users.xml\fR
.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.
.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>
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