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