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/zh_TW/dumpykota.1

    r3279 r3485  
    11.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.36. 
    2 .TH DUMPYKOTA "1" "janvier 2008" "C@LL - Conseil Internet & Logiciels Libres" "User Commands" 
     2.TH DUMPYKOTA "1" "janvier 2009" "C@LL - Conseil Internet & Logiciels Libres" "User Commands" 
    33.SH NOM 
    4 dumpykota \- page de manuel de dumpykota 1.27alpha3_BROKEN_unofficial 
     4dumpykota \- page de manuel de dumpykota (PyKota) 1.27alpha7_unofficial 
     5.SH SYNOPSIS 
     6.B dumpykota 
     7[\fIoptions\fR] [\fIfilterexpr\fR] 
    58.SH DESCRIPTION 
    6 dumpykota v1.27alpha3_BROKEN_unofficial (c) 2003, 2004, 2005, 2006, 2007, 2008 Jerome Alet \- alet@librelogiciel.com 
    7 .PP 
    8 Dumps PyKota database's content. 
    9 .PP 
    10 command line usage : 
     9Data Dumper 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\-d\fR DATA, \fB\-\-data\fR=\fIDATA\fR 
     23Select the type of datas to dump. This option is 
     24mandatory. Supported data types are : history, 
     25payments, billingcodes, users, groups, printers, 
     26upquotas, gpquotas, umembers, pmembers, and all. The 
     27\&'all' value forces the output format to XML. 
     28.TP 
     29\fB\-f\fR FORMAT, \fB\-\-format\fR=\fIFORMAT\fR 
     30Select the output format, the default being comma 
     31separated values. Supported formats are : csv, ssv, 
     32tsv, xml and cups. The 'cups' output format only works 
     33when dumping the history, and produces CUPS' page_log 
     34compatible output. 
     35.TP 
     36\fB\-o\fR OUTPUT, \fB\-\-output\fR=\fIOUTPUT\fR 
     37The name of the file the data dump will be written to. 
     38The default value is '\-', which tells dumpykota to 
     39write the dump to stdout. 
     40.TP 
     41\fB\-O\fR ORDERBY, \fB\-\-orderby\fR=\fIORDERBY\fR 
     42Change the ordering of the output based on a comma 
     43separated list of ordering statements. For example 
     44\&'\-username,+printername' would sort the output by 
     45descending order of user names and ascending order of 
     46printer names. Not all expressions are supported, and 
     47you should not use this if you don't know the internal 
     48structure of PyKota's database. 
     49.TP 
     50\fB\-s\fR, \fB\-\-sum\fR 
     51Summarize the output. Only available when dumping the 
     52printing history or the payments. 
     53.SS "filtering expressions:" 
    1154.IP 
    12 dumpykota [options] [filterexpr] 
    13 .PP 
    14 options : 
    15 .TP 
    16 \fB\-v\fR | \fB\-\-version\fR 
    17 Prints dumpykota's version number then exits. 
    18 .TP 
    19 \fB\-h\fR | \fB\-\-help\fR 
    20 Prints this message then exits. 
    21 .TP 
    22 \fB\-d\fR | \fB\-\-data\fR type 
    23 Dumps 'type' datas. Allowed types are : 
     55Use the filtering expressions to extract only parts of the datas. Allowed 
     56filters are of the form 'key=value'. Wildcards are not expanded as part of 
     57these filtering expressions, so you can't use them here. 
    2458.IP 
    25 \- history : dumps the jobs history. 
    26 \- users : dumps users. 
    27 \- groups : dumps user groups. 
    28 \- printers : dump printers. 
    29 \- upquotas : dump user quotas. 
    30 \- gpquotas : dump user groups quotas. 
    31 \- payments : dumps user payments. 
    32 \- pmembers : dumps printer groups members. 
    33 \- umembers : dumps user groups members. 
    34 \- billingcodes : dumps billing codes. 
    35 \- all : dumps all PyKota datas. The output format 
     59allowed keys for now: 
    3660.IP 
    37 is always XML in this case. 
     61username : User's name 
     62groupname : Users group's name 
     63printername : Printer's name 
     64pgroupname : Printers group's name 
     65hostname : Host's name 
     66jobid : Job's id 
     67billingcode : Job's billing code 
     68start : Job's date of printing 
     69end : Job's date of printing 
    3870.IP 
    39 NB : the \fB\-d\fR | \fB\-\-data\fR command line option 
    40 is MANDATORY. 
    41 .TP 
    42 \fB\-f\fR | \fB\-\-format\fR fmt 
    43 Dumps datas in the 'fmt' format. When not specified, 
    44 the format is to dump datas in the csv format (comma 
    45 separated values). All data dumped is between double 
    46 quotes. Allowed formats are : 
    47 .IP 
    48 \- csv : separate datas with commas 
    49 \- ssv : separate datas with semicolons 
    50 \- tsv : separate datas with tabs 
    51 \- xml : dump data as XML 
    52 \- cups : dump datas in CUPS' page_log format : 
    53 .IP 
    54 ONLY AVAILABLE WITH \fB\-\-data\fR history 
    55 .TP 
    56 \fB\-o\fR | \fB\-\-output\fR fname 
    57 All datas will be dumped to the file instead of 
    58 to the standard output. The special '\-' filename 
    59 is the default value and means stdout. 
    60 WARNING : existing files are truncated ! 
    61 .TP 
    62 \fB\-O\fR | \fB\-\-orderby\fR exp 
    63 Change the ordering or result. 'exp' is a comma 
    64 separated list of ordering statements, for example 
    65 \&'\-\-orderby +username,\-printername'. Not all expression 
    66 values are meaningful, so using this command line 
    67 switch is not recommanded if you don't know the 
    68 exact layout of PyKota's database schema. 
    69 .TP 
    70 \fB\-s\fR | \fB\-\-sum\fR 
    71 Summarize the selected datas. 
    72 ONLY AVAILABLE WITH \fB\-\-data\fR history or payments 
    73 .IP 
    74 Use the filter expressions to extract only parts of the 
    75 datas. Allowed filters are of the form : 
    76 .IP 
    77 key=value 
    78 .IP 
    79 Allowed keys for now are : 
    80 .TP 
    81 username 
    82 User's name 
    83 .TP 
    84 groupname 
    85 Users group's name 
    86 .TP 
    87 printername 
    88 Printer's name 
    89 .TP 
    90 pgroupname 
    91 Printers group's name 
    92 .TP 
    93 hostname 
    94 Client's hostname 
    95 .TP 
    96 jobid 
    97 Job's Id 
    98 .TP 
    99 billingcode 
    100 Job's billing code 
    101 .TP 
    102 start 
    103 Job's date of printing 
    104 .TP 
    105 end 
    106 Job's date of printing 
    107 .IP 
    108 Dates formatting with 'start' and 'end' filter keys : 
     71formatting of dates with the 'start' and 'end' filtering keys: 
    10972.IP 
    11073YYYY : year boundaries 
    … …  
    11477YYYYMMDDhhmm : minute boundaries 
    11578YYYYMMDDhhmmss : second boundaries 
    116 yesterday[+\-NbDays] : yesterday more or less N days (e.g. : yesterday\-15) 
    117 today[+\-NbDays] : today more or less N days (e.g. : today\-15) 
    118 tomorrow[+\-NbDays] : tomorrow more or less N days (e.g. : tomorrow\-15) 
    119 now[+\-NbDays] : now more or less N days (e.g. now\-15) 
     79yesterday[+\-N] : yesterday more or less N days (e.g. : yesterday\-15) 
     80today[+\-N] : today more or less N days (e.g. : today\-15) 
     81tomorrow[+\-N] : tomorrow more or less N days (e.g. : tomorrow\-15) 
     82now[+\-N] : now more or less N days (e.g. now\-15) 
    12083.IP 
    121 \&'now' and 'today' are not exactly the same since today represents the first 
    122 or last second of the day depending on if it's used in a start= or end= 
    123 date expression. The utility to be able to specify dates in the future is 
    124 a question which remains to be answered :\-) 
     84\&'now' and 'today' are not exactly the same since 'today' represents the 
     85first or last second of the day depending on if it's used in a 'start=' or 
     86\&'end=' date expression. 
    12587.IP 
    126 Contrary to other PyKota management tools, wildcard characters are not 
    127 expanded, so you can't use them. 
     88examples: 
    12889.IP 
    129 NB : not all keys are allowed for each data type, so the result may be 
    130 empty if you use a key not available for a particular data type. 
    131 .PP 
    132 Examples : 
     90dumpykota \fB\-\-unit\fR EURO \fB\-\-output\fR /tmp/invoices.pdf start=now\-30 
     91This would generate a PDF document containing invoices for all users 
     92who have spent some credits last month. Amounts would be in EURO and 
     93not VAT information would be included. 
    13394.IP 
    134 \f(CW$ dumpykota \-\-data history \-\-format csv >myfile.csv\fR 
     95dumpykota \fB\-\-data\fR history \fB\-\-format\fR csv >myfile.csv 
     96This would dump the whole printing history to stdout in the CSV 
     97format, and redirect the output to a file. 
    13598.IP 
    136 This dumps the history in a comma separated values file, for possible 
    137 use in a spreadsheet. 
     99dumpykota \fB\-\-data\fR users \fB\-\-format\fR xml \fB\-o\fR users.xml 
     100This would dump all users into the 'users.xml' file in the XML format. 
    138101.IP 
    139 \f(CW$ dumpykota \-\-data users \-\-format xml -o users.xml\fR 
     102dumpykota \fB\-\-data\fR history printername=HP2100 username=jerome 
     103This would dump jerome's printing history on printer HP2100. 
    140104.IP 
    141 Dumps all users datas to the users.xml file. 
     105dumpykota \fB\-\-data\fR history start=200503 end=20050730234615 
     106This would dump all jobs printer between March 1st 2008 at midnight 
     107and July 30th 2008 at 23 hours 46 minutes and 15 seconds, included. 
    142108.IP 
    143 \f(CW$ dumpykota \-\-data history printername=HP2100 username=jerome\fR 
     109licensing terms: 
    144110.IP 
    145 Dumps the job history for user jerome on printer HP2100 only. 
    146 .IP 
    147 \f(CW$ dumpykota \-\-data history start=200503 end=20050730234615\fR 
    148 .IP 
    149 Dumps all jobs printed between March 1st 2005 at midnight and 
    150 July 30th 2005 at 23 hours 46 minutes and 15 secondes included. 
    151 .PP 
    152 (c) 2003, 2004, 2005, 2006, 2007, 2008 Jerome Alet <alet@librelogiciel.com> 
     111(c) 2003\-2009 Jerome Alet \- alet@librelogiciel.com 
    153112This program is free software: you can redistribute it and/or modify 
    154113it under the terms of the GNU General Public License as published by 
    155 the Free Software Foundation, either version 3 of the License, or 
    156 (at your option) any later version. 
    157 .PP 
    158 This program is distributed in the hope that it will be useful, 
    159 but WITHOUT ANY WARRANTY; without even the implied warranty of 
    160 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the 
    161 GNU General Public License for more details. 
    162 .PP 
     114the Free Software Foundation, either version 3 of the License, or (at 
     115your option) any later version. 
     116.IP 
     117This program is distributed in the hope that it will be useful, but 
     118WITHOUT ANY WARRANTY; without even the implied warranty of 
     119MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU 
     120General Public License for more details. 
     121.IP 
    163122You should have received a copy of the GNU General Public License 
    164123along with this program.  If not, see <http://www.gnu.org/licenses/>. 
    165 .PP 
    166 Please report bugs to : Jerome Alet \- alet@librelogiciel.com