[2808] | 1 | .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.36. |
---|
[3272] | 2 | .TH DUMPYKOTA "1" "d�mbre 2007" "C@LL - Conseil Internet & Logiciels Libres" "User Commands" |
---|
[2086] | 3 | .SH NOM |
---|
[3272] | 4 | dumpykota \- page de manuel de dumpykota 1.27alpha3_BROKEN_unofficial |
---|
[2086] | 5 | .SH DESCRIPTION |
---|
[3272] | 6 | dumpykota v1.27alpha3_BROKEN_unofficial (c) 2003, 2004, 2005, 2006, 2007 Jerome Alet \- alet@librelogiciel.com |
---|
[2086] | 7 | .PP |
---|
| 8 | Dumps PyKota database's content. |
---|
| 9 | .PP |
---|
| 10 | command line usage : |
---|
| 11 | .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 : |
---|
| 24 | .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. |
---|
[2342] | 34 | \- billingcodes : dumps billing codes. |
---|
[2667] | 35 | \- all : dumps all PyKota datas. The output format |
---|
[2086] | 36 | .IP |
---|
[2667] | 37 | is always XML in this case. |
---|
| 38 | .IP |
---|
[2086] | 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 ! |
---|
[2303] | 61 | .TP |
---|
[3166] | 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 |
---|
[2303] | 70 | \fB\-s\fR | \fB\-\-sum\fR |
---|
| 71 | Summarize the selected datas. |
---|
| 72 | ONLY AVAILABLE WITH \fB\-\-data\fR history or payments |
---|
[2086] | 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 |
---|
[2228] | 92 | .TP |
---|
| 93 | hostname |
---|
| 94 | Client's hostname |
---|
| 95 | .TP |
---|
[3094] | 96 | jobid |
---|
| 97 | Job's Id |
---|
| 98 | .TP |
---|
[2228] | 99 | billingcode |
---|
| 100 | Job's billing code |
---|
[2266] | 101 | .TP |
---|
| 102 | start |
---|
| 103 | Job's date of printing |
---|
| 104 | .TP |
---|
| 105 | end |
---|
| 106 | Job's date of printing |
---|
[2086] | 107 | .IP |
---|
[3094] | 108 | Dates formatting with 'start' and 'end' filter keys : |
---|
| 109 | .IP |
---|
| 110 | YYYY : year boundaries |
---|
| 111 | YYYYMM : month boundaries |
---|
| 112 | YYYYMMDD : day boundaries |
---|
| 113 | YYYYMMDDhh : hour boundaries |
---|
| 114 | YYYYMMDDhhmm : minute boundaries |
---|
| 115 | YYYYMMDDhhmmss : 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) |
---|
| 120 | .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 :\-) |
---|
| 125 | .IP |
---|
[2086] | 126 | Contrary to other PyKota management tools, wildcard characters are not |
---|
| 127 | expanded, so you can't use them. |
---|
| 128 | .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 : |
---|
| 133 | .IP |
---|
[3263] | 134 | \f(CW$ dumpykota \-\-data history \-\-format csv >myfile.csv\fR |
---|
[2086] | 135 | .IP |
---|
| 136 | This dumps the history in a comma separated values file, for possible |
---|
| 137 | use in a spreadsheet. |
---|
| 138 | .IP |
---|
[3263] | 139 | \f(CW$ dumpykota \-\-data users \-\-format xml -o users.xml\fR |
---|
[2086] | 140 | .IP |
---|
| 141 | Dumps all users datas to the users.xml file. |
---|
| 142 | .IP |
---|
[3263] | 143 | \f(CW$ dumpykota \-\-data history printername=HP2100 username=jerome\fR |
---|
[2086] | 144 | .IP |
---|
| 145 | Dumps the job history for user jerome on printer HP2100 only. |
---|
[2266] | 146 | .IP |
---|
[3263] | 147 | \f(CW$ dumpykota \-\-data history start=200503 end=20050730234615\fR |
---|
[2266] | 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. |
---|
[2086] | 151 | .PP |
---|
[3259] | 152 | (c) 2003, 2004, 2005, 2006, 2007 Jerome Alet <alet@librelogiciel.com> |
---|
| 153 | This program is free software: you can redistribute it and/or modify |
---|
[2086] | 154 | it under the terms of the GNU General Public License as published by |
---|
[3259] | 155 | the Free Software Foundation, either version 3 of the License, or |
---|
[2086] | 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 |
---|
| 163 | You should have received a copy of the GNU General Public License |
---|
[3259] | 164 | along with this program. If not, see <http://www.gnu.org/licenses/>. |
---|
[2086] | 165 | .PP |
---|
[2344] | 166 | Please report bugs to : Jerome Alet \- alet@librelogiciel.com |
---|