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/pkprinters.1

    r3279 r3485  
    11.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.36. 
    2 .TH PKPRINTERS "1" "January 2008" "C@LL - Conseil Internet & Logiciels Libres" "User Commands" 
     2.TH PKPRINTERS "1" "January 2009" "C@LL - Conseil Internet & Logiciels Libres" "User Commands" 
    33.SH NAME 
    4 pkprinters \- manual page for pkprinters 1.27alpha3_BROKEN_unofficial 
     4pkprinters \- manual page for pkprinters (PyKota) 1.27alpha7_unofficial 
     5.SH SYNOPSIS 
     6.B pkprinters 
     7[\fIoptions\fR] \fIprinter1 printer2 \fR... \fIprinterN\fR 
    58.SH DESCRIPTION 
    6 pkprinters v1.27alpha3_BROKEN_unofficial (c) 2003, 2004, 2005, 2006, 2007, 2008 Jerome Alet \- alet@librelogiciel.com 
    7 .PP 
    8 A Printers Manager for PyKota. 
    9 .PP 
    10 command line usage : 
     9Manages PyKota printers. 
     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\-a\fR, \fB\-\-add\fR 
     23Add new, or modify existing, printers. 
     24.TP 
     25\fB\-c\fR CHARGE, \fB\-\-charge\fR=\fICHARGE\fR 
     26Set the cost per page, and optionally per job, for 
     27printing to the specified printers. If both are to be 
     28set, separate them with a comma. Floating point and 
     29negative values are allowed. 
     30.TP 
     31\fB\-C\fR, \fB\-\-cups\fR 
     32Tell CUPS to either start or stop managing the 
     33specified printers with PyKota. 
     34.TP 
     35\fB\-d\fR, \fB\-\-delete\fR 
     36Delete the specified printers. Also purge the print 
     37quota entries and printing history matching the 
     38specified printers. 
     39.TP 
     40\fB\-D\fR DESCRIPTION, \fB\-\-description\fR=\fIDESCRIPTION\fR 
     41Set a textual description for the specified printers. 
     42.TP 
     43\fB\-g\fR GROUPS, \fB\-\-groups\fR=\fIGROUPS\fR 
     44If the \fB\-\-remove\fR option is not used, the default action 
     45is to add the specified printers to the specified 
     46printers groups. Otherwise they are removed from these 
     47groups. The specified printers groups must already 
     48exist, and should be created beforehand just like 
     49normal printers with this very command. 
     50.TP 
     51\fB\-l\fR, \fB\-\-list\fR 
     52Display detailed informations about the specified 
     53printers. 
     54.TP 
     55\fB\-m\fR MAXJOBSIZE, \fB\-\-maxjobsize\fR=\fIMAXJOBSIZE\fR 
     56Set the maximum job size in pages allowed on the 
     57specified printers. 
     58.TP 
     59\fB\-n\fR, \fB\-\-nopassthrough\fR 
     60Deactivate passthrough mode for the specified 
     61printers. This is the normal mode of operations, in 
     62which print jobs are accounted for, and are checked 
     63against printing quotas and available credits. 
     64.TP 
     65\fB\-p\fR, \fB\-\-passthrough\fR 
     66Activate passthrough mode for the specified printers. 
     67In this mode, jobs sent to these printers are not 
     68accounted for. This can be useful for exams during 
     69which no user should be charged for his printouts. 
     70.TP 
     71\fB\-r\fR, \fB\-\-remove\fR 
     72When combined with the \fB\-\-groups\fR option, remove 
     73printers from the specified printers groups. 
     74.TP 
     75\fB\-s\fR, \fB\-\-skipexisting\fR 
     76If \fB\-\-add\fR is used, ensure that existing printers won't 
     77be modified. 
     78.SS "examples:" 
    1179.IP 
    12 pkprinters [options] printer1 printer2 printer3 ... printerN 
    13 .PP 
    14 options : 
    15 .TP 
    16 \fB\-v\fR | \fB\-\-version\fR 
    17 Prints pkprinters's version number then exits. 
    18 .TP 
    19 \fB\-h\fR | \fB\-\-help\fR 
    20 Prints this message then exits. 
    21 .TP 
    22 \fB\-a\fR | \fB\-\-add\fR 
    23 Adds printers if they don't exist on the Quota 
    24 Storage Server. If they exist, they are modified 
    25 unless \fB\-s\fR|\-\-skipexisting is also used. 
    26 .TP 
    27 \fB\-d\fR | \fB\-\-delete\fR 
    28 Deletes printers from the quota storage. 
    29 .HP 
    30 \fB\-D\fR | \fB\-\-description\fR d Adds a textual description to printers. 
    31 .TP 
    32 \fB\-C\fR | \fB\-\-cups\fR 
    33 Also modifies the DeviceURI in CUPS' printers.conf 
    34 .TP 
    35 \fB\-c\fR | \fB\-\-charge\fR p[,j] 
    36 Sets the price per page and per job to charge. 
    37 Job price is optional. 
    38 If both are to be set, separate them with a comma. 
    39 Floating point and negative values are allowed. 
    40 .TP 
    41 \fB\-g\fR | \fB\-\-groups\fR pg1[,pg2...] Adds or Remove the printer(s) to the printer 
    42 groups pg1, pg2, etc... which must already exist. 
    43 A printer group is just like a normal printer, 
    44 only that it is usually unknown from the printing 
    45 system. Create printer groups exactly the same 
    46 way that you create printers, then add other 
    47 printers to them with this option. 
    48 Accounting is done on a printer and on all 
    49 the printer groups it belongs to, quota checking 
    50 is done on a printer and on all the printer groups 
    51 it belongs to. 
    52 If the \fB\-\-remove\fR option below is not used, the 
    53 default action is to add printers to the specified 
    54 printer groups. 
    55 .TP 
    56 \fB\-l\fR | \fB\-\-list\fR 
    57 List informations about the printer(s) and the 
    58 printers groups it is a member of. 
    59 .TP 
    60 \fB\-r\fR | \fB\-\-remove\fR 
    61 In combination with the \fB\-\-groups\fR option above, 
    62 remove printers from the specified printers groups. 
    63 .TP 
    64 \fB\-s\fR | \fB\-\-skipexisting\fR 
    65 In combination with the \fB\-\-add\fR option above, tells 
    66 pkprinters to not modify existing printers. 
    67 .TP 
    68 \fB\-m\fR | \fB\-\-maxjobsize\fR s 
    69 Sets the maximum job size allowed on the printer 
    70 to s pages. 
    71 .TP 
    72 \fB\-p\fR | \fB\-\-passthrough\fR 
    73 Activate passthrough mode for the printer. In this 
    74 mode, users are allowed to print without any impact 
    75 on their quota or account balance. 
    76 .TP 
    77 \fB\-n\fR | \fB\-\-nopassthrough\fR Deactivate passthrough mode for the printer. 
    78 Without \fB\-p\fR or \fB\-n\fR, printers are created in 
    79 normal mode, i.e. no passthrough. 
     80pkprinters \fB\-\-add\fR \fB\-\-cups\fR \fB\-D\fR "HP Printer" \fB\-\-charge\fR 0.05,0.1 hp2100 hp2200 
     81Would create three printers named 'hp2100', and 'hp2200' in PyKota's 
     82database, while telling CUPS to route all print jobs through PyKota for 
     83these printers. Each of them would have 'HP Printer' as its description. 
     84Printing to any of them would cost 0.05 credit per page, plus 0.1 credit 
     85for each job. 
    8086.IP 
    81 printer1 through printerN can contain wildcards if the \fB\-\-add\fR option 
    82 is not set. 
    83 .PP 
    84 examples : 
     87pkprinters \fB\-\-delete\fR "*" 
     88Would delete all existing printers and matching print quota entries and 
     89printing history from PyKota's database. USE WITH CARE. 
    8590.IP 
    86 \f(CW$ pkprinters \-\-add -D "HP Printer" \-\-charge 0.05,0.1 hp2100 hp2200 hp8000\fR 
     91pkprinters \fB\-\-groups\fR Laser,HP "hp*" 
     92Would add all printers which name begins with 'hp' to the 'Laser' and 'HP' 
     93printers groups, which must already exist. 
    8794.IP 
    88 Will create three printers named hp2100, hp2200 and hp8000. 
    89 Their price per page will be set at 0.05 unit, and their price 
    90 per job will be set at 0.1 unit. Units are in your own currency, 
    91 or whatever you want them to mean. 
    92 All of their descriptions will be set to the string "HP Printer". 
    93 If any of these printers already exists, it will also be modified 
    94 unless the \fB\-s\fR|\-\-skipexisting command line option is also used. 
     95pkprinters \fB\-\-groups\fR Lexmark \fB\-\-remove\fR hp2200 
     96Would remove printer 'hp2200' from the 'Lexmark' printers group. 
     97.SS "licensing terms:" 
    9598.IP 
    96 \f(CW$ pkprinters \-\-delete "*"\fR 
     99(c) 2003\-2009 Jerome Alet \- alet@librelogiciel.com 
     100This program is free software: you can redistribute it and/or modify it 
     101under the terms of the GNU General Public License as published by the Free 
     102Software Foundation, either version 3 of the License, or (at your option) 
     103any later version. 
    97104.IP 
    98 This will completely delete all printers and associated quota information, 
    99 as well as their job history. USE WITH CARE ! 
     105This program is distributed in the hope that it will be useful, but 
     106WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY 
     107or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License 
     108for more details. 
    100109.IP 
    101 \f(CW$ pkprinters \-\-groups Laser,HP "hp*"\fR 
    102 .IP 
    103 This will put all printers which name matches "hp*" into printers groups 
    104 Laser and HP, which MUST already exist. 
    105 .IP 
    106 \f(CW$ pkprinters \-\-groups LexMark \-\-remove hp2200\fR 
    107 .IP 
    108 This will remove the hp2200 printer from the LexMark printer group. 
    109 .PP 
    110 (c) 2003, 2004, 2005, 2006, 2007, 2008 Jerome Alet <alet@librelogiciel.com> 
    111 This program is free software: you can redistribute it and/or modify 
    112 it under the terms of the GNU General Public License as published by 
    113 the Free Software Foundation, either version 3 of the License, or 
    114 (at your option) any later version. 
    115 .PP 
    116 This program is distributed in the hope that it will be useful, 
    117 but WITHOUT ANY WARRANTY; without even the implied warranty of 
    118 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the 
    119 GNU General Public License for more details. 
    120 .PP 
    121 You should have received a copy of the GNU General Public License 
    122 along with this program.  If not, see <http://www.gnu.org/licenses/>. 
    123 .PP 
    124 Please report bugs to : Jerome Alet \- alet@librelogiciel.com 
     110You should have received a copy of the GNU General Public License along 
     111with this program.  If not, see <http://www.gnu.org/licenses/>.