man/lpadmin.man

   1 .\"
   2 .\" lpadmin man page for CUPS.
   3 .\"
   4 .\" Copyright © 2007-2018 by Apple Inc.
   5 .\" Copyright © 1997-2006 by Easy Software Products.
   6 .\"
   7 .\" These coded instructions, statements, and computer programs are the
   8 .\" property of Apple Inc. and are protected by Federal copyright
   9 .\" law.  Distribution and use rights are outlined in the file "LICENSE.txt"
  10 .\" which should have been included with this file.  If this file is
  11 .\" file is missing or damaged, see the license at "http://www.cups.org/".
  12 .\"
  13 .TH lpadmin 8 "CUPS" "19 August 2018" "Apple Inc."
  14 .SH NAME
  15 lpadmin \- configure cups printers and classes
  16 .SH SYNOPSIS
  17 .B lpadmin
  18 [
  19 .B \-E
  20 ] [
  21 .B \-U
  22 .I username
  23 ] [
  24 \fB\-h \fIserver\fR[\fB:\fIport\fR]
  25 ]
  26 .B \-d
  27 .I destination
  28 .br
  29 .B lpadmin
  30 [
  31 .B \-E
  32 ] [
  33 .B \-U
  34 .I username
  35 ] [
  36 \fB\-h \fIserver\fR[\fB:\fIport\fR]
  37 ]
  38 .B \-p
  39 .I destination
  40 [
  41 .B \-R
  42 .I name-default
  43 ]
  44 .I option(s)
  45 .br
  46 .B lpadmin
  47 [
  48 .B \-E
  49 ] [
  50 .B \-U
  51 .I username
  52 ] [
  53 \fB\-h \fIserver\fR[\fB:\fIport\fR]
  54 ]
  55 .B \-x
  56 .I destination
  57 .SH DESCRIPTION
  58 \fBlpadmin\fR configures printer and class queues provided by CUPS.
  59 It can also be used to set the server default printer or class.
  60 .LP
  61 When specified before the \fI-d\fR, \fI-p\fR, or \fI-x\fR options, the \fI-E\fR option forces encryption when connecting to the server.
  62 .LP
  63 The first form of the command (\fI-d\fR) sets the default printer or class to \fIdestination\fR.
  64 Subsequent print jobs submitted via the
  65 .BR lp (1)
  66 or
  67 .BR lpr (1)
  68 commands will use this destination unless the user specifies otherwise with the
  69 .BR lpoptions (1)
  70 command.
  71 .LP
  72 The second form of the command (\fI-p\fR) configures the named printer or class.  The additional options are described below.
  73 .LP
  74 The third form of the command (\fI-x\fR) deletes the printer or class \fIdestination\fR.
  75 Any jobs that are pending for the destination will be removed and any job that is currently printed will be aborted.
  76 .SH OPTIONS
  77 The following options are recognized when configuring a printer queue:
  78 .TP 5
  79 \fB\-c \fIclass\fR
  80 Adds the named \fIprinter\fR to \fIclass\fR.
  81 If \fIclass\fR does not exist it is created automatically.
  82 .TP 5
  83 \fB\-i \fIppd-file\fR
  84 .TP 5
  85 \fB\-P \fIppd-file\fR
  86 Specifies a PostScript Printer Description (PPD) file to use with the printer.
  87 .TP 5
  88 \fB\-m \fImodel\fR
  89 Sets a standard PPD file for the printer from the \fImodel\fR directory or using one of the driver interfaces.
  90 Use the \fI-m\fR option with the
  91 .BR lpinfo (8)
  92 command to get a list of supported models.
  93 The model "raw" clears any existing PPD file and the model "everywhere" queries the printer referred to by the specified IPP \fIdevice-uri\fR.
  94 Note: The "raw" model is deprecated and will not be supported in a future version of CUPS.
  95 .TP 5
  96 \fB\-o cupsIPPSupplies=true\fR
  97 .TP 5
  98 \fB\-o cupsIPPSupplies=false\fR
  99 Specifies whether IPP supply level values should be reported.
 100 .TP 5
 101 \fB\-o cupsSNMPSupplies=true\fR
 102 .TP 5
 103 \fB\-o cupsSNMPSupplies=false\fR
 104 Specifies whether SNMP supply level (RFC 3805) values should be reported.
 105 .TP 5
 106 \fB\-o job\-k\-limit=\fIvalue\fR
 107 Sets the kilobyte limit for per-user quotas.
 108 The value is an integer number of kilobytes; one kilobyte is 1024 bytes.
 109 .TP 5
 110 \fB\-o job\-page\-limit=\fIvalue\fR
 111 Sets the page limit for per-user quotas.
 112 The value is the integer number of pages that can be printed; double-sided pages are counted as two pages.
 113 .TP 5
 114 \fB-o job\-quota\-period=\fIvalue\fR
 115 Sets the accounting period for per-user quotas.
 116 The value is an integer number of seconds; 86,400 seconds are in one day.
 117 .TP 5
 118 \fB\-o job\-sheets\-default=\fIbanner\fR
 119 .TP 5
 120 \fB\-o job\-sheets\-default=\fIbanner\fB,\fIbanner\fR
 121 Sets the default banner page(s) to use for print jobs.
 122 .TP 5
 123 \fB\-o \fIname\fB=\fIvalue\fR
 124 Sets a PPD option for the printer.
 125 PPD options can be listed using the \fI-l\fR option with the
 126 .BR lpoptions (1)
 127 command.
 128 .TP 5
 129 \fB\-o \fIname\fB-default=\fIvalue\fR
 130 Sets a default server-side option for the destination.
 131 Any print-time option can be defaulted, e.g., "-o number-up-default=2" to set the default "number-up" option value to 2.
 132 .TP 5
 133 \fB\-o port\-monitor=\fIname\fR
 134 Sets the binary communications program to use when printing, "none", "bcp", or "tbcp".
 135 The default program is "none".
 136 The specified port monitor must be listed in the printer's PPD file.
 137 .TP 5
 138 \fB\-o printer-error-policy=\fIname\fR
 139 Sets the error policy to be used when the printer backend is unable to send the job to the printer.
 140 The name must be one of "abort-job", "retry-job", "retry-current-job", or "stop-printer".
 141 The default error policy is "stop-printer" for printers and "retry-current-job" for
 142 classes.
 143 .TP 5
 144 \fB\-o printer\-is\-shared=true\fR
 145 .TP 5
 146 \fB\-o printer\-is\-shared=false\fR
 147 Sets the destination to shared/published or unshared/unpublished.
 148 Shared/published destinations are publicly announced by the server on the LAN based on the browsing configuration in \fIcupsd.conf\fR, while unshared/unpublished destinations are not announced.
 149 The default value is "true".
 150 .TP 5
 151 \fB\-o printer-op-policy=\fIname\fR
 152 Sets the IPP operation policy associated with the destination.
 153 The name must be defined in the \fIcupsd.conf\fR in a Policy section.
 154 The default operation policy is "default".
 155 .TP 5
 156 \fB\-R \fIname\fB\-default\fR
 157 Deletes the named option from \fIprinter\fR.
 158 .TP 5
 159 \fB\-r \fIclass\fR
 160 Removes the named \fIprinter\fR from \fIclass\fR.
 161 If the resulting class becomes empty it is removed.
 162 .TP 5
 163 \fB-u allow:\fR{\fIuser\fR|\fB@\fIgroup\fR}{\fB,\fIuser\fR|\fB,@\fIgroup\fR}*
 164 .TP 5
 165 \fB-u deny:\fR{\fIuser\fR|\fB@\fIgroup\fR}{\fB,\fIuser\fR|\fB,@\fIgroup\fR}*
 166 .TP 5
 167 \fB\-u allow:all\fR
 168 .TP 5
 169 \fB\-u deny:none\fR
 170 Sets user-level access control on a destination.
 171 Names starting with "@" are interpreted as UNIX groups.
 172 The latter two forms turn user-level access control off.
 173 Note: The user 'root' is not granted special access - using "-u allow:foo,bar" will allow users 'foo' and 'bar' to access the printer but NOT 'root'.
 174 .TP 5
 175 \fB\-v "\fIdevice-uri\fB"\fR
 176 Sets the \fIdevice-uri\fR attribute of the printer queue.
 177 Use the \fI-v\fR option with the
 178 .BR lpinfo (8)
 179 command to get a list of supported device URIs and schemes.
 180 .TP 5
 181 \fB\-D "\fIinfo\fB"\fR
 182 Provides a textual description of the destination.
 183 .TP 5
 184 .B \-E
 185 When specified before the \fB\-d\fR, \fB\-p\fR, or \fB\-x\fR options, forces the use of TLS encryption on the connection to the scheduler.
 186 Otherwise, enables the destination and accepts jobs; this is the same as running the
 187 .BR cupsaccept (8)
 188 and
 189 .BR cupsenable (8)
 190 programs on the destination.
 191 .TP 5
 192 \fB\-L "\fIlocation\fB"\fR
 193 Provides a textual location of the destination.
 194 .SH CONFORMING TO
 195 Unlike the System V printing system, CUPS allows printer names to contain any printable character except SPACE, TAB, "/", or "#".
 196 Also, printer and class names are \fInot\fR case-sensitive.
 197 Finally, the CUPS version of \fBlpadmin\fR may ask the user for an access password depending on the printing system configuration.
 198 This differs from the System V version which requires the root user to execute this command.
 199 .SH NOTES
 200 The CUPS version of \fBlpadmin\fR does not support all of the System V or Solaris printing system configuration options.
 201 .PP
 202 The double meaning of the \fB\-E\fR option is an unfortunate historical oddity.
 203 .SH EXAMPLE
 204 Create an IPP Everywhere print queue:
 205 .nf
 206
 207     lpadmin -p myprinter -E -v ipp://myprinter.local/ipp/print -m everywhere
 208
 209 .fi
 210 .SH SEE ALSO
 211 .BR cupsaccept (8),
 212 .BR cupsenable (8),
 213 .BR lpinfo (8),
 214 .BR lpoptions (1),
 215 CUPS Online Help (http://localhost:631/help)
 216 .SH COPYRIGHT
 217 Copyright \[co] 2007-2018 by Apple Inc.