man/lpadmin.8

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