man/lpadmin.man

   1 .\"
   2 .\" "$Id: lpadmin.man 4841 2005-11-15 20:39:31Z mike $"
   3 .\"
   4 .\"   lpadmin man page for the Common UNIX Printing System (CUPS).
   5 .\"
   6 .\"   Copyright 1997-2005 by Easy Software Products.
   7 .\"
   8 .\"   These coded instructions, statements, and computer programs are the
   9 .\"   property of Easy Software Products and are protected by Federal
  10 .\"   copyright law.  Distribution and use rights are outlined in the file
  11 .\"   "LICENSE.txt" which should have been included with this file.  If this
  12 .\"   file is missing or damaged please contact Easy Software Products
  13 .\"   at:
  14 .\"
  15 .\"       Attn: CUPS Licensing Information
  16 .\"       Easy Software Products
  17 .\"       44141 Airport View Drive, Suite 204
  18 .\"       Hollywood, Maryland 20636 USA
  19 .\"
  20 .\"       Voice: (301) 373-9600
  21 .\"       EMail: cups-info@cups.org
  22 .\"         WWW: http://www.cups.org
  23 .\"
  24 .TH lpadmin 8 "Common UNIX Printing System" "21 October 2002" "Easy Software Products"
  25 .SH NAME
  26 lpadmin \- configure cups printers and classes
  27 .SH SYNOPSIS
  28 .B lpadmin
  29 [ -E ] [ -h
  30 .I server
  31 ] \-d
  32 .I destination
  33 .br
  34 .B lpadmin
  35 [ -E ] [ -h
  36 .I server
  37 ] \-p
  38 .I printer
  39 .I option(s)
  40 .br
  41 .B lpadmin
  42 [ -E ] [ -h
  43 .I server
  44 ] \-x
  45 .I destination
  46 .SH DESCRIPTION
  47 \fIlpadmin\fR configures printer and class queues provided by
  48 CUPS. It can also be used to set the server default printer or
  49 class.
  50 .LP
  51 When specified before the \fI-d\fR, \fI-p\fR, or \fI-x\fR options,
  52 the \fI-E\fR option forces encryption when connecting to the server.
  53 .LP
  54 The first form of the command (\fI-d\fR) sets the default printer or class to
  55 \fIdestination\fR.  Subsequent print jobs submitted via the \fIlp(1)\fR or
  56 \fIlpr(1)\fR commands will use this destination unless the user specifies
  57 otherwise with the \fIlpoptions(1)\fR command.
  58 .LP
  59 The second form of the command (\fI-p\fR) configures the named printer.  The additional
  60 options are described below.
  61 .LP
  62 The third form of the command (\fI-x\fR) deletes the printer or class \fIdestination\fR.
  63 Any jobs that are pending for the destination will be removed and any job that
  64 is currently printed will be aborted.
  65 .SH CONFIGURATION OPTIONS
  66 The following options are recognized when configuring a printer queue:
  67 .TP 5
  68 \-c \fIclass\fR
  69 .br
  70 Adds the named \fIprinter\fR to \fIclass\fR.  If \fIclass\fR does not
  71 exist it is created automatically.
  72 .TP 5
  73 \-i \fIinterface\fR
  74 .br
  75 Sets a System V style interface script for the printer.  This option cannot
  76 be specified with the \fI\-P\fR option (PPD file) and is intended for
  77 providing support for legacy printer drivers.
  78 .TP 5
  79 \-m \fImodel\fR
  80 .br
  81 Sets a standard System V interface script or PPD file from the model
  82 directory.
  83 .TP 5
  84 \-o \fIname=value\fR
  85 .br
  86 Sets a PPD or server option for the printer. PPD options can be listed
  87 using the \fI-l\fR option with the \fIlpoptions(1)\fR command.
  88 .TP 5
  89 \-o \fIjob-k-limit=value\fR
  90 .br
  91 Sets the kilobyte limit for per-user quotas. The value is an integer number
  92 of kilobytes; one kilobyte is 1024 bytes.
  93 .TP 5
  94 \-o \fIjob-page-limit=value\fR
  95 .br
  96 Sets the page limit for per-user quotas. The value is the integer number of
  97 pages that can be printed; double-sided pages are counted as two pages.
  98 .TP 5
  99 \-o \fIjob-quota-period=value\fR
 100 .br
 101 Sets the accounting period for per-user quotas. The value is an integer number
 102 of seconds; 86,400 seconds are in one day.
 103 .TP 5
 104 \-o \fIprotocol=name\fR
 105 .br
 106 Sets the binary communications protocol to use when printing,
 107 None, BCP, or TBCP. The default protocol is None.
 108 .TP 5
 109 \-r \fIclass\fR
 110 .br
 111 Removes the named \fIprinter\fR from \fIclass\fR.  If the resulting class
 112 becomes empty it is removed.
 113 .TP 5
 114 \-u \fIallow:user,user,@group\fR
 115 \-u \fIdeny:user,user,@group\fR
 116 \-u \fIallow:all\fR
 117 \-u \fIdeny:none\fR
 118 .br
 119 Sets user-level access control on a printer. Names starting with
 120 "@" are interpreted as UNIX groups. The latter two forms turn
 121 user-level access control off.
 122 .TP 5
 123 \-v \fIdevice-uri\fR
 124 .br
 125 Sets the \fIdevice-uri\fR attribute of the printer queue.  If \fIdevice-uri\fR
 126 is a filename it is automatically converted to the form \fBfile:/file/name\fR.
 127 .TP 5
 128 \-D \fIinfo\fR
 129 .br
 130 Provides a textual description of the printer.
 131 .TP 5
 132 \-E
 133 .br
 134 Enables the printer and accepts jobs; this is the same as running the
 135 \fIaccept(8)\fR and \fIenable(8)\fR programs on the printer.
 136 .TP 5
 137 \-L \fIlocation\fR
 138 .br
 139 Provides a textual location of the printer.
 140 .TP 5
 141 \-P \fIppd-file\fR
 142 .br
 143 Specifies a PostScript Printer Description file to use with the printer. If
 144 specified, this option overrides the \fI-i\fR option (interface script).
 145 .SH COMPATIBILITY
 146 Unlike the System V printing system, CUPS allows printer names to contain
 147 any printable character except SPACE and TAB. Also, printer and class names are
 148 \fBnot\fR case-sensitive. Finally, the CUPS version of \fIlpadmin\fR may ask the
 149 user for an access password depending on the printing system configuration.
 150 This differs from the System V version which requires the root user to execute
 151 this command.
 152 .SH LIMITATIONS
 153 The CUPS version of \fIlpadmin\fR does not support all of the System V or
 154 Solaris printing system configuration options.
 155 .SH SEE ALSO
 156 accept(8), cancel(1), disable(8), enable(8), lp(1), lpstat(1), reject(8),
 157 CUPS Software Administrators Manual,
 158 http://localhost:631/documentation.html
 159 .SH COPYRIGHT
 160 Copyright 1993-2005 by Easy Software Products, All Rights Reserved.
 161 .\"
 162 .\" End of "$Id: lpadmin.man 4841 2005-11-15 20:39:31Z mike $".
 163 .\"