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