root / pykota / trunk / man / it / pkinvoice.1 @ 3558

.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.38.2.
.TH PKINVOICE "1" "août 2010" "C@LL - Conseil Internet & Logiciels Libres" "User Commands"
.SH NOM
pkinvoice \- page de manuel de pkinvoice (PyKota) 1.27alpha13_unofficial
.SH SYNOPSIS
.B pkinvoice
[\fIoptions\fR] [\fIfilterexpr\fR]
.SH DESCRIPTION
Invoice generator for PyKota.
.SH OPTIONS
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit.
.TP
\fB\-v\fR, \fB\-\-version\fR
show the version number and exit.
.TP
\fB\-A\fR ARGUMENTSFILE, \fB\-\-arguments\fR=\fIARGUMENTSFILE\fR
loads additional options and arguments from a file,
one per line.
.TP
\fB\-l\fR LOGO, \fB\-\-logo\fR=\fILOGO\fR
The image to use as a 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 PAGESIZE, \fB\-\-pagesize\fR=\fIPAGESIZE\fR
Set the size of the page. Most well known page sizes
are recognized, like 'A4' or 'Letter' to name a few.
The default page size is A4.
.TP
\fB\-n\fR NUMBER, \fB\-\-number\fR=\fINUMBER\fR
Set the number of the first invoice. This number will
automatically be incremented for each invoice. The
default value is 1.
.TP
\fB\-o\fR OUTPUT, \fB\-\-output\fR=\fIOUTPUT\fR
The name of the file to which the PDF invoices will be
written. If not set or set to '\-', the PDF document
will be sent to the standard output.
.TP
\fB\-u\fR UNIT, \fB\-\-unit\fR=\fIUNIT\fR
The name of the unit to use on the invoices. The
default value is 'Credits' or its locale translation.
.TP
\fB\-V\fR VAT, \fB\-\-vat\fR=\fIVAT\fR
The value in percent of the applicable VAT to be
exposed. The default is 0.0, meaning no VAT.
.SS "filtering expressions:"
.IP
Use the filtering expressions to extract only parts of the datas. Allowed
filters are of the form 'key=value'. Wildcards are not expanded as part of
these filtering expressions, so you can't use them here.
.IP
allowed keys for now:
.IP
username : User's name
printername : Printer's name
hostname : Host's name
jobid : Job's id
billingcode : Job's billing code
start : Job's date of printing
end : Job's date of printing
.IP
formatting of dates with the 'start' and 'end' filtering keys:
.IP
YYYY : year boundaries
YYYYMM : month boundaries
YYYYMMDD : day boundaries
YYYYMMDDhh : hour boundaries
YYYYMMDDhhmm : minute boundaries
YYYYMMDDhhmmss : second boundaries
yesterday[+\-N] : yesterday more or less N days (e.g. : yesterday\-15)
today[+\-N] : today more or less N days (e.g. : today\-15)
tomorrow[+\-N] : tomorrow more or less N days (e.g. : tomorrow\-15)
now[+\-N] : 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.
.IP
examples:
.IP
pkinvoice \fB\-\-unit\fR EURO \fB\-\-output\fR /tmp/invoices.pdf start=now\-30
This would generate a PDF document containing invoices for all users
who have spent some credits last month. Amounts would be in EURO and
not VAT information would be included.
.IP
licensing terms:
.IP
(c) 2003\-2010 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.
.IP
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.
.IP
You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.