man/lpadmin.man

   1 .\"
   2 .\" "$Id: lpadmin.man 5969 2006-09-19 20:09:24Z mike $"
   3 .\"
   4 .\"   lpadmin man page for the Common UNIX Printing System (CUPS).
   5 .\"
   6 .\"   Copyright 1997-2006 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" "13 July 2006" "Easy Software Products"
  25 .SH NAME
  26 lpadmin \- configure cups printers and classes
  27 .SH SYNOPSIS
  28 .B lpadmin
  29 [ -E ] [-U
  30 .I username
  31 ] [ -h
  32 .I server[:port]
  33 ] -d
  34 .I destination
  35 .br
  36 .B lpadmin
  37 [ -E ] [-U
  38 .I username
  39 ] [ -h
  40 .I server[:port]
  41 ] -p
  42 .I printer option(s)
  43 .br
  44 .B lpadmin
  45 [ -E ] [-U
  46 .I username
  47 ] [ -h
  48 .I server[:port]
  49 ] -x
  50 .I destination
  51 .SH DESCRIPTION
  52 \fIlpadmin\fR configures printer and class queues provided by
  53 CUPS. It can also be used to set the server default printer or
  54 class.
  55 .LP
  56 When specified before the \fI-d\fR, \fI-p\fR, or \fI-x\fR
  57 options, the \fI-E\fR option forces encryption when connecting to
  58 the server.
  59 .LP
  60 The first form of the command (\fI-d\fR) sets the default printer
  61 or class to \fIdestination\fR.  Subsequent print jobs submitted
  62 via the \fIlp(1)\fR or \fIlpr(1)\fR commands will use this
  63 destination unless the user specifies otherwise with the
  64 \fIlpoptions(1)\fR command.
  65 .LP
  66 The second form of the command (\fI-p\fR) configures the named
  67 printer.  The additional options are described below.
  68 .LP
  69 The third form of the command (\fI-x\fR) deletes the printer or
  70 class \fIdestination\fR. Any jobs that are pending for the
  71 destination will be removed and any job that is currently printed
  72 will be aborted.
  73 .SH CONFIGURATION OPTIONS
  74 The following options are recognized when configuring a printer
  75 queue:
  76 .TP 5
  77 -c class
  78 .br
  79 Adds the named \fIprinter\fR to \fIclass\fR.  If \fIclass\fR does
  80 not exist it is created automatically.
  81 .TP 5
  82 -i interface
  83 .br
  84 Sets a System V style interface script for the printer. This
  85 option cannot be specified with the \fI-P\fR option (PPD file)
  86 and is intended for providing support for legacy printer drivers.
  87 .TP 5
  88 -m model
  89 .br
  90 Sets a standard System V interface script or PPD file from the
  91 \fImodel\fR directory.
  92 .TP 5
  93 -o name=value
  94 .br
  95 Sets a PPD or server option for the printer. PPD options can be
  96 listed using the \fI-l\fR option with the \fIlpoptions(1)\fR
  97 command.
  98 .TP 5
  99 -o job-k-limit=value
 100 .br
 101 Sets the kilobyte limit for per-user quotas. The value is an
 102 integer number of kilobytes; one kilobyte is 1024 bytes.
 103 .TP 5
 104 -o job-page-limit=value
 105 .br
 106 Sets the page limit for per-user quotas. The value is the integer
 107 number of pages that can be printed; double-sided pages are
 108 counted as two pages.
 109 .TP 5
 110 -o job-quota-period=value
 111 .br
 112 Sets the accounting period for per-user quotas. The value is an
 113 integer number of seconds; 86,400 seconds are in one day.
 114 .TP 5
 115 -o job-sheets-default=banner
 116 .TP 5
 117 -o job-sheets-default=banner,banner
 118 .br
 119 Sets the default banner page(s) to use for print jobs.
 120 .TP 5
 121 -o port-monitor=name
 122 .br
 123 Sets the binary communications program to use when printing,
 124 "none", "bcp", or "tbcp". The default program is "none".
 125 .TP 5
 126 -o printer-error-policy=name
 127 .br
 128 Sets the error policy to be used when the printer backend is
 129 unable to send the job to the printer. The name must be one of
 130 "abort-job", "retry-job" or "stop-printer". The default error
 131 policy is "stop-printer".
 132 .TP 5
 133 -o printer-is-shared=true/false
 134 .br
 135 Sets the printer to shared/published or unshared/unpublished.
 136 Shared/published printers are publically announced by the server
 137 on the LAN based on the browsing configuration in
 138 \fBcupsd.conf\fR, while unshared/unpublished printers are not
 139 announced. The default value is "true".
 140 .TP 5
 141 -o printer-op-policy=name
 142 .br
 143 Sets the IPP operation policy associated with the printer. The
 144 name must be defined in the \fBcupsd.conf\fR in a Policy section.
 145 The default operation policy is "default".
 146 .TP 5
 147 -r class
 148 .br
 149 Removes the named \fIprinter\fR from \fIclass\fR.  If the
 150 resulting class becomes empty it is removed.
 151 .TP 5
 152 -u allow:user,user,@group
 153 .TP 5
 154 -u deny:user,user,@group
 155 .TP 5
 156 -u allow:all
 157 .TP 5
 158 -u deny:none
 159 .br
 160 Sets user-level access control on a printer. Names starting with
 161 "@" are interpreted as UNIX groups. The latter two forms turn
 162 user-level access control off.
 163 .TP 5
 164 -v "device-uri"
 165 .br
 166 Sets the \fIdevice-uri\fR attribute of the printer queue.  If
 167 \fIdevice-uri\fR is a filename it is automatically converted to
 168 the form \fIfile:///file/name\fR. Use the \fIlpinfo(8)\fR command
 169 to get a list of supported device URIs and schemes.
 170 .TP 5
 171 -D "info"
 172 .br
 173 Provides a textual description of the printer.
 174 .TP 5
 175 -E
 176 .br
 177 Enables the printer and accepts jobs; this is the same as running the
 178 \fIaccept(8)\fR and \fIcupsenable(8)\fR programs on the printer.
 179 .TP 5
 180 -L "location"
 181 .br
 182 Provides a textual location of the printer.
 183 .TP 5
 184 -P ppd-file
 185 .br
 186 Specifies a PostScript Printer Description file to use with the
 187 printer. If specified, this option overrides the \fI-i\fR option
 188 (interface script).
 189 .SH COMPATIBILITY
 190 Unlike the System V printing system, CUPS allows printer names to
 191 contain any printable character except SPACE, TAB, "/", or "#".
 192 Also, printer and class names are \fInot\fR case-sensitive.
 193 Finally, the CUPS version of \fIlpadmin\fR may ask the user for
 194 an access password depending on the printing system
 195 configuration. This differs from the System V version which
 196 requires the root user to execute this command.
 197 .SH LIMITATIONS
 198 The CUPS version of \fIlpadmin\fR does not support all of the
 199 System V or Solaris printing system configuration options.
 200 .SH SEE ALSO
 201 \fIaccept(8)\fR, \fIcupsenable(8)\fR, \fIlpinfo(8)\fR,
 202 \fIlpoptions(1)\fR,
 203 .br
 204 http://localhost:631/help
 205 .SH COPYRIGHT
 206 Copyright 1997-2006 by Easy Software Products, All Rights Reserved.
 207 .\"
 208 .\" End of "$Id: lpadmin.man 5969 2006-09-19 20:09:24Z mike $".
 209 .\"