root / pykota / trunk / man / pkinvoice.1 @ 3201

Revision 3201, 3.8 kB (checked in by jerome, 17 years ago)

v1.26beta is out

Line 
1.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.36.
2.TH PKINVOICE "1" "July 2007" "C@LL - Conseil Internet & Logiciels Libres" "User Commands"
3.SH NAME
4pkinvoice \- manual page for pkinvoice 1.26beta_unofficial
5.SH DESCRIPTION
6pkinvoice v1.26beta_unofficial (c) 2003, 2004, 2005, 2006, 2007 Jerome Alet \- alet@librelogiciel.com
7.PP
8An invoice generator for PyKota.
9.PP
10command line usage :
11.IP
12pkinvoice [options] [filterexpr]
13.PP
14options :
15.TP
16\fB\-v\fR | \fB\-\-version\fR
17Prints pkinvoice's version number then exits.
18.TP
19\fB\-h\fR | \fB\-\-help\fR
20Prints this message then exits.
21.TP
22\fB\-l\fR | \fB\-\-logo\fR img
23Use the image as the invoice's logo. The logo will
24be drawn at the center top of the page. The default
25logo is /usr/share/pykota/logos/pykota.jpeg
26.TP
27\fB\-p\fR | \fB\-\-pagesize\fR sz
28Sets sz as the page size. Most well known
29page sizes are recognized, like 'A4' or 'Letter'
30to name a few. The default size is A4.
31.TP
32\fB\-n\fR | \fB\-\-number\fR N
33Sets the number of the first invoice. This number
34will automatically be incremented for each invoice.
35.TP
36\fB\-o\fR | \fB\-\-output\fR f.pdf
37Defines the name of the invoice file which will
38be generated as a PDF document. If not set or
39set to '\-', the PDF document is sent to standard
40output.
41.TP
42\fB\-u\fR | \fB\-\-unit\fR u
43Defines the name of the unit to use on the invoice.
44The default unit is 'Credits', optionally translated
45to your native language if it is supported by PyKota.
46.TP
47\fB\-V\fR | \fB\-\-vat\fR p
48Sets the percent value of the applicable VAT to be
49exposed. The default is 0.0, meaning no VAT
50information will be included.
51.IP
52Use the filter expressions to extract only parts of the
53datas. Allowed filters are of the form :
54.IP
55key=value
56.IP
57Allowed keys for now are :
58.TP
59username
60User's name
61.TP
62printername
63Printer's name
64.TP
65hostname
66Client's hostname
67.TP
68jobid
69Job's Id
70.TP
71billingcode
72Job's billing code
73.TP
74start
75Job's date of printing
76.TP
77end
78Job's date of printing
79.IP
80Dates formatting with 'start' and 'end' filter keys :
81.IP
82YYYY : year boundaries
83YYYYMM : month boundaries
84YYYYMMDD : day boundaries
85YYYYMMDDhh : hour boundaries
86YYYYMMDDhhmm : minute boundaries
87YYYYMMDDhhmmss : second boundaries
88yesterday[+\-NbDays] : yesterday more or less N days (e.g. : yesterday\-15)
89today[+\-NbDays] : today more or less N days (e.g. : today\-15)
90tomorrow[+\-NbDays] : tomorrow more or less N days (e.g. : tomorrow\-15)
91now[+\-NbDays] : now more or less N days (e.g. now\-15)
92.IP
93\&'now' and 'today' are not exactly the same since today represents the first
94or last second of the day depending on if it's used in a start= or end=
95date expression. The utility to be able to specify dates in the future is
96a question which remains to be answered :\-)
97.IP
98Contrary to other PyKota management tools, wildcard characters are not
99expanded, so you can't use them.
100.PP
101examples :
102.IP
103\f(CW$ pkinvoice --unit EURO --output /tmp/invoices.pdf start=now-30\fR
104.IP
105Will generate a PDF document containing invoices for all users
106who have spent some credits last month. Invoices will be done in
107EURO.  No VAT information will be included.
108.PP
109This program is free software; you can redistribute it and/or modify
110it under the terms of the GNU General Public License as published by
111the Free Software Foundation; either version 2 of the License, or
112(at your option) any later version.
113.PP
114This program is distributed in the hope that it will be useful,
115but WITHOUT ANY WARRANTY; without even the implied warranty of
116MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
117GNU General Public License for more details.
118.PP
119You should have received a copy of the GNU General Public License
120along with this program; if not, write to the Free Software
121Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110\-1301, USA.
122.PP
123Please report bugs to : Jerome Alet \- alet@librelogiciel.com
Note: See TracBrowser for help on using the browser.