root / pykota / trunk / man / tr / pkinvoice.1 @ 3550

Revision 3550, 3.7 kB (checked in by jerome, 14 years ago)

Updated manual pages.

Line 
1.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.38.2.
2.TH PKINVOICE "1" "août 2010" "C@LL - Conseil Internet & Logiciels Libres" "User Commands"
3.SH NOM
4pkinvoice \- page de manuel de pkinvoice (PyKota) 1.27alpha13_unofficial
5.SH SYNOPSIS
6.B pkinvoice
7[\fIoptions\fR] [\fIfilterexpr\fR]
8.SH DESCRIPTION
9Invoice generator 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\-l\fR LOGO, \fB\-\-logo\fR=\fILOGO\fR
23The image to use as a logo. The logo will be drawn at
24the center top of the page. The default logo is
25/usr/share/pykota/logos/pykota.jpeg.
26.TP
27\fB\-p\fR PAGESIZE, \fB\-\-pagesize\fR=\fIPAGESIZE\fR
28Set the size of the page. Most well known page sizes
29are recognized, like 'A4' or 'Letter' to name a few.
30The default page size is A4.
31.TP
32\fB\-n\fR NUMBER, \fB\-\-number\fR=\fINUMBER\fR
33Set the number of the first invoice. This number will
34automatically be incremented for each invoice. The
35default value is 1.
36.TP
37\fB\-o\fR OUTPUT, \fB\-\-output\fR=\fIOUTPUT\fR
38The name of the file to which the PDF invoices will be
39written. If not set or set to '\-', the PDF document
40will be sent to the standard output.
41.TP
42\fB\-u\fR UNIT, \fB\-\-unit\fR=\fIUNIT\fR
43The name of the unit to use on the invoices. The
44default value is 'Credits' or its locale translation.
45.TP
46\fB\-V\fR VAT, \fB\-\-vat\fR=\fIVAT\fR
47The value in percent of the applicable VAT to be
48exposed. The default is 0.0, meaning no VAT.
49.SS "filtering expressions:"
50.IP
51Use the filtering expressions to extract only parts of the datas. Allowed
52filters are of the form 'key=value'. Wildcards are not expanded as part of
53these filtering expressions, so you can't use them here.
54.IP
55allowed keys for now:
56.IP
57username : User's name
58printername : Printer's name
59hostname : Host's name
60jobid : Job's id
61billingcode : Job's billing code
62start : Job's date of printing
63end : Job's date of printing
64.IP
65formatting of dates with the 'start' and 'end' filtering keys:
66.IP
67YYYY : year boundaries
68YYYYMM : month boundaries
69YYYYMMDD : day boundaries
70YYYYMMDDhh : hour boundaries
71YYYYMMDDhhmm : minute boundaries
72YYYYMMDDhhmmss : second boundaries
73yesterday[+\-N] : yesterday more or less N days (e.g. : yesterday\-15)
74today[+\-N] : today more or less N days (e.g. : today\-15)
75tomorrow[+\-N] : tomorrow more or less N days (e.g. : tomorrow\-15)
76now[+\-N] : now more or less N days (e.g. now\-15)
77.IP
78\&'now' and 'today' are not exactly the same since 'today' represents the
79first or last second of the day depending on if it's used in a 'start=' or
80\&'end=' date expression.
81.IP
82examples:
83.IP
84pkinvoice \fB\-\-unit\fR EURO \fB\-\-output\fR /tmp/invoices.pdf start=now\-30
85This would generate a PDF document containing invoices for all users
86who have spent some credits last month. Amounts would be in EURO and
87not VAT information would be included.
88.IP
89licensing terms:
90.IP
91(c) 2003\-2010 Jerome Alet \- alet@librelogiciel.com
92This program is free software: you can redistribute it and/or modify
93it under the terms of the GNU General Public License as published by
94the Free Software Foundation, either version 3 of the License, or (at
95your option) any later version.
96.IP
97This program is distributed in the hope that it will be useful, but
98WITHOUT ANY WARRANTY; without even the implied warranty of
99MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
100General Public License for more details.
101.IP
102You should have received a copy of the GNU General Public License
103along with this program.  If not, see <http://www.gnu.org/licenses/>.
Note: See TracBrowser for help on using the browser.