Show
Ignore:
Timestamp:
01/24/09 22:38:46 (15 years ago)
Author:
jerome
Message:

Updated manual pages.

Files:
1 modified

Legend:

Unmodified
Added
Removed

  • pykota/trunk/man/th/pkinvoice.1

    r3279 r3485  
    11.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.36. 
    2 .TH PKINVOICE "1" "janvier 2008" "C@LL - Conseil Internet & Logiciels Libres" "User Commands" 
     2.TH PKINVOICE "1" "janvier 2009" "C@LL - Conseil Internet & Logiciels Libres" "User Commands" 
    33.SH NOM 
    4 pkinvoice \- page de manuel de pkinvoice 1.27alpha3_BROKEN_unofficial 
     4pkinvoice \- page de manuel de pkinvoice (PyKota) 1.27alpha7_unofficial 
     5.SH SYNOPSIS 
     6.B pkinvoice 
     7[\fIoptions\fR] [\fIfilterexpr\fR] 
    58.SH DESCRIPTION 
    6 pkinvoice v1.27alpha3_BROKEN_unofficial (c) 2003, 2004, 2005, 2006, 2007, 2008 Jerome Alet \- alet@librelogiciel.com 
    7 .PP 
    8 An invoice generator for PyKota. 
    9 .PP 
    10 command line usage : 
     9Invoice generator 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\-l\fR LOGO, \fB\-\-logo\fR=\fILOGO\fR 
     23The image to use as a logo. The logo will be drawn at 
     24the 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 
     28Set the size of the page. Most well known page sizes 
     29are recognized, like 'A4' or 'Letter' to name a few. 
     30The default page size is A4. 
     31.TP 
     32\fB\-n\fR NUMBER, \fB\-\-number\fR=\fINUMBER\fR 
     33Set the number of the first invoice. This number will 
     34automatically be incremented for each invoice. The 
     35default value is 1. 
     36.TP 
     37\fB\-o\fR OUTPUT, \fB\-\-output\fR=\fIOUTPUT\fR 
     38The name of the file to which the PDF invoices will be 
     39written. If not set or set to '\-', the PDF document 
     40will be sent to the standard output. 
     41.TP 
     42\fB\-u\fR UNIT, \fB\-\-unit\fR=\fIUNIT\fR 
     43The name of the unit to use on the invoices. The 
     44default value is 'Credits' or its locale translation. 
     45.TP 
     46\fB\-V\fR VAT, \fB\-\-vat\fR=\fIVAT\fR 
     47The value in percent of the applicable VAT to be 
     48exposed. The default is 0.0, meaning no VAT. 
     49.SS "filtering expressions:" 
    1150.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. 
     51Use the filtering expressions to extract only parts of the datas. Allowed 
     52filters are of the form 'key=value'. Wildcards are not expanded as part of 
     53these filtering expressions, so you can't use them here. 
    5154.IP 
    52 Use the filter expressions to extract only parts of the 
    53 datas. Allowed filters are of the form : 
     55allowed keys for now: 
    5456.IP 
    55 key=value 
     57username : User's name 
     58printername : Printer's name 
     59hostname : Host's name 
     60jobid : Job's id 
     61billingcode : Job's billing code 
     62start : Job's date of printing 
     63end : Job's date of printing 
    5664.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 : 
     65formatting of dates with the 'start' and 'end' filtering keys: 
    8166.IP 
    8267YYYY : year boundaries 
    … …  
    8671YYYYMMDDhhmm : minute boundaries 
    8772YYYYMMDDhhmmss : 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) 
     73yesterday[+\-N] : yesterday more or less N days (e.g. : yesterday\-15) 
     74today[+\-N] : today more or less N days (e.g. : today\-15) 
     75tomorrow[+\-N] : tomorrow more or less N days (e.g. : tomorrow\-15) 
     76now[+\-N] : now more or less N days (e.g. now\-15) 
    9277.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 :\-) 
     78\&'now' and 'today' are not exactly the same since 'today' represents the 
     79first or last second of the day depending on if it's used in a 'start=' or 
     80\&'end=' date expression. 
    9781.IP 
    98 Contrary to other PyKota management tools, wildcard characters are not 
    99 expanded, so you can't use them. 
    100 .PP 
    101 examples : 
     82examples: 
    10283.IP 
    103 \f(CW$ pkinvoice \-\-unit EURO \-\-output /tmp/invoices.pdf start=now-30\fR 
     84pkinvoice \fB\-\-unit\fR EURO \fB\-\-output\fR /tmp/invoices.pdf start=now\-30 
     85This would generate a PDF document containing invoices for all users 
     86who have spent some credits last month. Amounts would be in EURO and 
     87not VAT information would be included. 
    10488.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 (c) 2003, 2004, 2005, 2006, 2007, 2008 Jerome Alet <alet@librelogiciel.com> 
     89licensing terms: 
     90.IP 
     91(c) 2003\-2009 Jerome Alet \- alet@librelogiciel.com 
    11092This program is free software: you can redistribute it and/or modify 
    11193it under the terms of the GNU General Public License as published by 
    112 the Free Software Foundation, either version 3 of the License, or 
    113 (at your option) any later version. 
    114 .PP 
    115 This program is distributed in the hope that it will be useful, 
    116 but WITHOUT ANY WARRANTY; without even the implied warranty of 
    117 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the 
    118 GNU General Public License for more details. 
    119 .PP 
     94the Free Software Foundation, either version 3 of the License, or (at 
     95your option) any later version. 
     96.IP 
     97This program is distributed in the hope that it will be useful, but 
     98WITHOUT ANY WARRANTY; without even the implied warranty of 
     99MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU 
     100General Public License for more details. 
     101.IP 
    120102You should have received a copy of the GNU General Public License 
    121103along with this program.  If not, see <http://www.gnu.org/licenses/>. 
    122 .PP 
    123 Please report bugs to : Jerome Alet \- alet@librelogiciel.com