root / pykota / branches / specialauth / man / pkinvoice.1 @ 3515

.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.36.
.TH PKINVOICE "1" "December 2006" "C@LL - Conseil Internet & Logiciels Libres" "User Commands"
.SH NAME
pkinvoice \- manual page for pkinvoice 1.25_unofficial
.SH DESCRIPTION
pkinvoice v1.25_unofficial (c) 2003, 2004, 2005, 2006, 2007 Jerome Alet \- alet@librelogiciel.com
.PP
An invoice generator for PyKota.
.PP
command line usage :
.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.
.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
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 :
.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.
.PP
examples :
.IP
\f(CW$ pkinvoice --unit EURO --output /tmp/invoices.pdf start=now-30\fR
.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
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 2 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, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110\-1301, USA.
.PP
Please report bugs to : Jerome Alet \- alet@librelogiciel.com