root / pykota / trunk / man / pkrefund.1 @ 3485

Revision 3485, 4.9 kB (checked in by jerome, 15 years ago)

Updated manual pages.

Line 
1.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.36.
2.TH PKREFUND "1" "January 2009" "C@LL - Conseil Internet & Logiciels Libres" "User Commands"
3.SH NAME
4pkrefund \- manual page for pkrefund (PyKota) 1.27alpha7_unofficial
5.SH SYNOPSIS
6.B pkrefund
7[\fIoptions\fR] [\fIfilterexpr\fR]
8.SH DESCRIPTION
9Refunding tool 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\-f\fR, \fB\-\-force\fR
23Doesn't ask for confirmation before refunding. Only
24needed if you specify a filename for the PDF receipts.
25If you send such receipts to stdout, \fB\-\-force\fR is
26assumed to be set.
27.TP
28\fB\-i\fR INFO, \fB\-\-info\fR=\fIINFO\fR
29The informations to be prepended to the refunding
30reason, which can include some of Python's string
31interpolations to access to certain internal values.
32If you don't want such information, set this
33explicitely to an empty string. The default is
34\&'''Refunded %(nbpages)i pages and %(nbcredits).3f
35credits by %(effectiveuser)s (%(loginname)s) on
36%(date)s'''
37.TP
38\fB\-l\fR LOGO, \fB\-\-logo\fR=\fILOGO\fR
39The image to use as a logo. The logo will be drawn at
40the center top of the page. The default logo is
41/usr/share/pykota/logos/pykota.jpeg.
42.TP
43\fB\-n\fR NUMBER, \fB\-\-number\fR=\fINUMBER\fR
44Sets the number of the first receipt. This number will
45automatically be incremented for each receipt. The
46default value is 1.
47.TP
48\fB\-o\fR OUTPUT, \fB\-\-output\fR=\fIOUTPUT\fR
49The name of the file to which the PDF receipts will be
50written. If not set or set to '\-', the PDF document
51will be sent to the standard output, and \fB\-\-force\fR will
52be assumed to be set.
53.TP
54\fB\-p\fR PAGESIZE, \fB\-\-pagesize\fR=\fIPAGESIZE\fR
55Set the size of the page. Most well known page sizes
56are recognized, like 'A4' or 'Letter' to name a few.
57The default page size is A4.
58.TP
59\fB\-r\fR REASON, \fB\-\-reason\fR=\fIREASON\fR
60The reason why there was a refund.
61.TP
62\fB\-u\fR UNIT, \fB\-\-unit\fR=\fIUNIT\fR
63The name of the unit to use on the receipts. The
64default value is 'Credits' or its locale translation.
65.SS "filtering expressions:"
66.IP
67Use the filtering expressions to extract only parts of the datas. Allowed
68filters are of the form 'key=value'. Wildcards are not expanded as part of
69these filtering expressions, so you can't use them here.
70.IP
71allowed keys for now:
72.IP
73username : User's name
74printername : Printer's name
75hostname : Host's name
76jobid : Job's id
77billingcode : Job's billing code
78start : Job's date of printing
79end : Job's date of printing
80.IP
81formatting of dates with the 'start' and 'end' filtering keys:
82.IP
83YYYY : year boundaries
84YYYYMM : month boundaries
85YYYYMMDD : day boundaries
86YYYYMMDDhh : hour boundaries
87YYYYMMDDhhmm : minute boundaries
88YYYYMMDDhhmmss : second boundaries
89yesterday[+\-N] : yesterday more or less N days (e.g. : yesterday\-15)
90today[+\-N] : today more or less N days (e.g. : today\-15)
91tomorrow[+\-N] : tomorrow more or less N days (e.g. : tomorrow\-15)
92now[+\-N] : 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
95first or last second of the day depending on if it's used in a 'start=' or
96\&'end=' date expression.
97.IP
98examples:
99.IP
100pkrefund \fB\-\-output\fR /tmp/receipts.pdf jobid=503
101This would refund all jobs which Id is 503. A confirmation would be
102asked for each job to refund, and a PDF file named /tmp/receipts.pdf
103would be created containing printable receipts. BEWARE of job ids
104rolling over if you reset CUPS' history.
105.IP
106pkrefund \fB\-\-reason\fR "Hardware problem" jobid=503 start=today\-7
107This would refund all jobs which id is 503 but which would have been
108printed during the  past week. The reason would be marked as being an
109hardware problem.
110.IP
111pkrefund \fB\-\-force\fR username=jerome printername=HP2100
112This would refund all jobs printed by user jerome on printer HP2100.
113No confirmation would be asked.
114.IP
115pkrefund \fB\-\-force\fR printername=HP2100 start=200602 end=yesterday
116This would refund all jobs printed on printer HP2100 between February
1171st 2006 and yesterday. No confirmation would be asked.
118.IP
119licensing terms:
120.IP
121(c) 2003\-2009 Jerome Alet \- alet@librelogiciel.com
122This program is free software: you can redistribute it and/or modify
123it under the terms of the GNU General Public License as published by
124the Free Software Foundation, either version 3 of the License, or (at
125your option) any later version.
126.IP
127This program is distributed in the hope that it will be useful, but
128WITHOUT ANY WARRANTY; without even the implied warranty of
129MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
130General Public License for more details.
131.IP
132You should have received a copy of the GNU General Public License
133along with this program.  If not, see <http://www.gnu.org/licenses/>.
Note: See TracBrowser for help on using the browser.