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