| 1 | .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.41.1. |
|---|
| 2 | .TH PKPRINTERS "1" "January 2013" "C@LL - Conseil Internet & Logiciels Libres" "User Commands" |
|---|
| 3 | .SH NAME |
|---|
| 4 | pkprinters \- manual page for pkprinters (PyKota) 1.27alpha14_unofficial |
|---|
| 5 | .SH SYNOPSIS |
|---|
| 6 | .B pkprinters |
|---|
| 7 | [\fIoptions\fR] \fIprinter1 printer2 \fR... \fIprinterN\fR |
|---|
| 8 | .SH DESCRIPTION |
|---|
| 9 | Manages PyKota printers. |
|---|
| 10 | .SH OPTIONS |
|---|
| 11 | .TP |
|---|
| 12 | \fB\-h\fR, \fB\-\-help\fR |
|---|
| 13 | show this help message and exit. |
|---|
| 14 | .TP |
|---|
| 15 | \fB\-v\fR, \fB\-\-version\fR |
|---|
| 16 | show the version number and exit. |
|---|
| 17 | .TP |
|---|
| 18 | \fB\-A\fR ARGUMENTSFILE, \fB\-\-arguments\fR=\fIARGUMENTSFILE\fR |
|---|
| 19 | loads additional options and arguments from a file, |
|---|
| 20 | one per line. |
|---|
| 21 | .TP |
|---|
| 22 | \fB\-a\fR, \fB\-\-add\fR |
|---|
| 23 | Add new, or modify existing, printers. |
|---|
| 24 | .TP |
|---|
| 25 | \fB\-c\fR CHARGE, \fB\-\-charge\fR=\fICHARGE\fR |
|---|
| 26 | Set the cost per page, and optionally per job, for |
|---|
| 27 | printing to the specified printers. If both are to be |
|---|
| 28 | set, separate them with a comma. Floating point and |
|---|
| 29 | negative values are allowed. |
|---|
| 30 | .TP |
|---|
| 31 | \fB\-C\fR, \fB\-\-cups\fR |
|---|
| 32 | Tell CUPS to either start or stop managing the |
|---|
| 33 | specified printers with PyKota. |
|---|
| 34 | .TP |
|---|
| 35 | \fB\-d\fR, \fB\-\-delete\fR |
|---|
| 36 | Delete the specified printers. Also purge the print |
|---|
| 37 | quota entries and printing history matching the |
|---|
| 38 | specified printers. |
|---|
| 39 | .TP |
|---|
| 40 | \fB\-D\fR DESCRIPTION, \fB\-\-description\fR=\fIDESCRIPTION\fR |
|---|
| 41 | Set a textual description for the specified printers. |
|---|
| 42 | .TP |
|---|
| 43 | \fB\-g\fR GROUPS, \fB\-\-groups\fR=\fIGROUPS\fR |
|---|
| 44 | If the \fB\-\-remove\fR option is not used, the default action |
|---|
| 45 | is to add the specified printers to the specified |
|---|
| 46 | printers groups. Otherwise they are removed from these |
|---|
| 47 | groups. The specified printers groups must already |
|---|
| 48 | exist, and should be created beforehand just like |
|---|
| 49 | normal printers with this very command. |
|---|
| 50 | .TP |
|---|
| 51 | \fB\-l\fR, \fB\-\-list\fR |
|---|
| 52 | Display detailed informations about the specified |
|---|
| 53 | printers. |
|---|
| 54 | .TP |
|---|
| 55 | \fB\-m\fR MAXJOBSIZE, \fB\-\-maxjobsize\fR=\fIMAXJOBSIZE\fR |
|---|
| 56 | Set the maximum job size in pages allowed on the |
|---|
| 57 | specified printers. Accepted values are '0' to forbid |
|---|
| 58 | printing, 'unlimited' to allow unrestricted printing, |
|---|
| 59 | or any positive integer value. |
|---|
| 60 | .TP |
|---|
| 61 | \fB\-n\fR, \fB\-\-nopassthrough\fR |
|---|
| 62 | Deactivate passthrough mode for the specified |
|---|
| 63 | printers. This is the normal mode of operations, in |
|---|
| 64 | which print jobs are accounted for, and are checked |
|---|
| 65 | against printing quotas and available credits. |
|---|
| 66 | .TP |
|---|
| 67 | \fB\-p\fR, \fB\-\-passthrough\fR |
|---|
| 68 | Activate passthrough mode for the specified printers. |
|---|
| 69 | In this mode, jobs sent to these printers are not |
|---|
| 70 | accounted for. This can be useful for exams during |
|---|
| 71 | which no user should be charged for his printouts. |
|---|
| 72 | .TP |
|---|
| 73 | \fB\-r\fR, \fB\-\-remove\fR |
|---|
| 74 | When combined with the \fB\-\-groups\fR option, remove |
|---|
| 75 | printers from the specified printers groups. |
|---|
| 76 | .TP |
|---|
| 77 | \fB\-s\fR, \fB\-\-skipexisting\fR |
|---|
| 78 | If \fB\-\-add\fR is used, ensure that existing printers won't |
|---|
| 79 | be modified. |
|---|
| 80 | .SS "examples:" |
|---|
| 81 | .IP |
|---|
| 82 | pkprinters \fB\-\-add\fR \fB\-\-cups\fR \fB\-D\fR "HP Printer" \fB\-\-charge\fR 0.05,0.1 hp2100 hp2200 |
|---|
| 83 | Would create three printers named 'hp2100', and 'hp2200' in PyKota's |
|---|
| 84 | database, while telling CUPS to route all print jobs through PyKota for |
|---|
| 85 | these printers. Each of them would have 'HP Printer' as its description. |
|---|
| 86 | Printing to any of them would cost 0.05 credit per page, plus 0.1 credit |
|---|
| 87 | for each job. |
|---|
| 88 | .IP |
|---|
| 89 | pkprinters \fB\-\-delete\fR "*" |
|---|
| 90 | Would delete all existing printers and matching print quota entries and |
|---|
| 91 | printing history from PyKota's database. USE WITH CARE. |
|---|
| 92 | .IP |
|---|
| 93 | pkprinters \fB\-\-groups\fR Laser,HP "hp*" |
|---|
| 94 | Would add all printers which name begins with 'hp' to the 'Laser' and 'HP' |
|---|
| 95 | printers groups, which must already exist. |
|---|
| 96 | .IP |
|---|
| 97 | pkprinters \fB\-\-groups\fR Lexmark \fB\-\-remove\fR hp2200 |
|---|
| 98 | Would remove printer 'hp2200' from the 'Lexmark' printers group. |
|---|
| 99 | .SS "licensing terms:" |
|---|
| 100 | .IP |
|---|
| 101 | (c) 2003\-2013 Jerome Alet \- alet@librelogiciel.com |
|---|
| 102 | This program is free software: you can redistribute it and/or modify it |
|---|
| 103 | under the terms of the GNU General Public License as published by the Free |
|---|
| 104 | Software Foundation, either version 3 of the License, or (at your option) |
|---|
| 105 | any later version. |
|---|
| 106 | .IP |
|---|
| 107 | This program is distributed in the hope that it will be useful, but |
|---|
| 108 | WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY |
|---|
| 109 | or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
|---|
| 110 | for more details. |
|---|
| 111 | .IP |
|---|
| 112 | You should have received a copy of the GNU General Public License along |
|---|
| 113 | with this program. If not, see <http://www.gnu.org/licenses/>. |
|---|
