1 | .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.36. |
---|
2 | .TH PKREFUND "1" "juillet 2007" "C@LL - Conseil Internet & Logiciels Libres" "User Commands" |
---|
3 | .SH NOM |
---|
4 | pkrefund \- page de manuel de pkrefund 1.26_unofficial |
---|
5 | .SH DESCRIPTION |
---|
6 | pkrefund v1.26_unofficial (c) 2003, 2004, 2005, 2006, 2007 Jerome Alet \- alet@librelogiciel.com |
---|
7 | .PP |
---|
8 | Refunds jobs. |
---|
9 | .PP |
---|
10 | command line usage : |
---|
11 | .IP |
---|
12 | pkrefund [options] [filterexpr] |
---|
13 | .PP |
---|
14 | options : |
---|
15 | .TP |
---|
16 | \fB\-v\fR | \fB\-\-version\fR |
---|
17 | Prints pkrefund's version number then exits. |
---|
18 | .TP |
---|
19 | \fB\-h\fR | \fB\-\-help\fR |
---|
20 | Prints this message then exits. |
---|
21 | .TP |
---|
22 | \fB\-f\fR | \fB\-\-force\fR |
---|
23 | Doesn't ask for confirmation before refunding jobs. |
---|
24 | .TP |
---|
25 | \fB\-r\fR | \fB\-\-reason\fR txt |
---|
26 | Sets textual information to explain the refunding. |
---|
27 | .TP |
---|
28 | \fB\-l\fR | \fB\-\-logo\fR img |
---|
29 | Use the image as the receipt's logo. The logo will |
---|
30 | be drawn at the center top of the page. The default |
---|
31 | logo is /usr/share/pykota/logos/pykota.jpeg |
---|
32 | .TP |
---|
33 | \fB\-p\fR | \fB\-\-pagesize\fR sz |
---|
34 | Sets sz as the page size. Most well known |
---|
35 | page sizes are recognized, like 'A4' or 'Letter' |
---|
36 | to name a few. The default size is A4. |
---|
37 | .TP |
---|
38 | \fB\-n\fR | \fB\-\-number\fR N |
---|
39 | Sets the number of the first receipt. This number |
---|
40 | will automatically be incremented for each receipt. |
---|
41 | .TP |
---|
42 | \fB\-o\fR | \fB\-\-output\fR f.pdf |
---|
43 | Defines the name of the PDF file which will contain |
---|
44 | the receipts. If not set, then no PDF file will |
---|
45 | be created. If set to '\-', then \fB\-\-force\fR is assumed, |
---|
46 | and the PDF document is sent to standard output. |
---|
47 | .TP |
---|
48 | \fB\-u\fR | \fB\-\-unit\fR u |
---|
49 | Defines the name of the unit to use on the receipts. |
---|
50 | The default unit is 'Credits', optionally translated |
---|
51 | to your native language if it is supported by PyKota. |
---|
52 | .IP |
---|
53 | Use the filter expressions to extract only parts of the |
---|
54 | datas. Allowed filters are of the form : |
---|
55 | .IP |
---|
56 | key=value |
---|
57 | .IP |
---|
58 | Allowed keys for now are : |
---|
59 | .TP |
---|
60 | username |
---|
61 | User's name |
---|
62 | .TP |
---|
63 | printername |
---|
64 | Printer's name |
---|
65 | .TP |
---|
66 | hostname |
---|
67 | Client's hostname |
---|
68 | .TP |
---|
69 | jobid |
---|
70 | Job's Id |
---|
71 | .TP |
---|
72 | billingcode |
---|
73 | Job's billing code |
---|
74 | .TP |
---|
75 | start |
---|
76 | Job's date of printing |
---|
77 | .TP |
---|
78 | end |
---|
79 | Job's date of printing |
---|
80 | .IP |
---|
81 | Dates formatting with 'start' and 'end' filter keys : |
---|
82 | .IP |
---|
83 | YYYY : year boundaries |
---|
84 | YYYYMM : month boundaries |
---|
85 | YYYYMMDD : day boundaries |
---|
86 | YYYYMMDDhh : hour boundaries |
---|
87 | YYYYMMDDhhmm : minute boundaries |
---|
88 | YYYYMMDDhhmmss : second boundaries |
---|
89 | yesterday[+\-NbDays] : yesterday more or less N days (e.g. : yesterday\-15) |
---|
90 | today[+\-NbDays] : today more or less N days (e.g. : today\-15) |
---|
91 | tomorrow[+\-NbDays] : tomorrow more or less N days (e.g. : tomorrow\-15) |
---|
92 | now[+\-NbDays] : now more or less N days (e.g. now\-15) |
---|
93 | .IP |
---|
94 | \&'now' and 'today' are not exactly the same since today represents the first |
---|
95 | or last second of the day depending on if it's used in a start= or end= |
---|
96 | date expression. The utility to be able to specify dates in the future is |
---|
97 | a question which remains to be answered :\-) |
---|
98 | .IP |
---|
99 | Contrary to other PyKota management tools, wildcard characters are not |
---|
100 | expanded, so you can't use them. |
---|
101 | .PP |
---|
102 | Examples : |
---|
103 | .IP |
---|
104 | \f(CW$ pkrefund --output /tmp/receipts.pdf jobid=503\fR |
---|
105 | .IP |
---|
106 | This will refund all jobs which Id is 503. BEWARE : installing CUPS |
---|
107 | afresh will reset the first job id at 1, so you probably want to use |
---|
108 | a more precise filter as explained below. A confirmation will |
---|
109 | be asked for each job to refund, and a PDF file named /tmp/receipts.pdf |
---|
110 | will be created which will contain printable receipts. |
---|
111 | .IP |
---|
112 | \f(CW$ pkrefund --reason "Hardware problem" jobid=503 start=today-7\fR |
---|
113 | .IP |
---|
114 | Refunds all jobs which id is 503 but which were printed during the |
---|
115 | past week. The reason will be marked as being an hardware problem. |
---|
116 | .IP |
---|
117 | \f(CW$ pkrefund --force username=jerome printername=HP2100\fR |
---|
118 | .IP |
---|
119 | Refunds all jobs printed by user jerome on printer HP2100. No |
---|
120 | confirmation will be asked. |
---|
121 | .IP |
---|
122 | \f(CW$ pkrefund --force printername=HP2100 start=200602 end=yesterday\fR |
---|
123 | .IP |
---|
124 | Refunds all jobs printed on printer HP2100 between February 1st 2006 |
---|
125 | and yesterday. No confirmation will be asked. |
---|
126 | .PP |
---|
127 | This program is free software; you can redistribute it and/or modify |
---|
128 | it under the terms of the GNU General Public License as published by |
---|
129 | the Free Software Foundation; either version 2 of the License, or |
---|
130 | (at your option) any later version. |
---|
131 | .PP |
---|
132 | This program is distributed in the hope that it will be useful, |
---|
133 | but WITHOUT ANY WARRANTY; without even the implied warranty of |
---|
134 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
---|
135 | GNU General Public License for more details. |
---|
136 | .PP |
---|
137 | You should have received a copy of the GNU General Public License |
---|
138 | along with this program; if not, write to the Free Software |
---|
139 | Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110\-1301, USA. |
---|
140 | .PP |
---|
141 | Please report bugs to : Jerome Alet \- alet@librelogiciel.com |
---|