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" "1 November 2017" "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\-P \fIppd-file\fR
  80 Specifies a PostScript Printer Description (PPD) file to use with the printer.
  81 .TP 5
  82 \fB\-m \fImodel\fR
  83 Sets a standard PPD file for the printer from the \fImodel\fR directory or using one of the driver interfaces.
  84 Use the \fI-m\fR option with the
  85 .BR lpinfo (8)
  86 command to get a list of supported models.
  87 The model "raw" clears any existing PPD file and the model "everywhere" queries the printer referred to by the specified IPP \fIdevice-uri\fR.
  88 .TP 5
  89 \fB\-o cupsIPPSupplies=true\fR
  90 .TP 5
  91 \fB\-o cupsIPPSupplies=false\fR
  92 Specifies whether IPP supply level values should be reported.
  93 .TP 5
  94 \fB\-o cupsSNMPSupplies=true\fR
  95 .TP 5
  96 \fB\-o cupsSNMPSupplies=false\fR
  97 Specifies whether SNMP supply level (RFC 3805) values should be reported.
  98 .TP 5
  99 \fB\-o job\-k\-limit=\fIvalue\fR
 100 Sets the kilobyte limit for per-user quotas.
 101 The value is an integer number of kilobytes; one kilobyte is 1024 bytes.
 102 .TP 5
 103 \fB\-o job\-page\-limit=\fIvalue\fR
 104 Sets the page limit for per-user quotas.
 105 The value is the integer number of pages that can be printed; double-sided pages are counted as two pages.
 106 .TP 5
 107 \fB-o job\-quota\-period=\fIvalue\fR
 108 Sets the accounting period for per-user quotas.
 109 The value is an integer number of seconds; 86,400 seconds are in one day.
 110 .TP 5
 111 \fB\-o job\-sheets\-default=\fIbanner\fR
 112 .TP 5
 113 \fB\-o job\-sheets\-default=\fIbanner\fB,\fIbanner\fR
 114 Sets the default banner page(s) to use for print jobs.
 115 .TP 5
 116 \fB\-o \fIname\fB=\fIvalue\fR
 117 Sets a PPD option for the printer.
 118 PPD options can be listed using the \fI-l\fR option with the
 119 .BR lpoptions (1)
 120 command.
 121 .TP 5
 122 \fB\-o \fIname\fB-default=\fIvalue\fR
 123 Sets a default server-side option for the destination.
 124 Any print-time option can be defaulted, e.g., "-o number-up-default=2" to set the default "number-up" option value to 2.
 125 .TP 5
 126 \fB\-o port\-monitor=\fIname\fR
 127 Sets the binary communications program to use when printing, "none", "bcp", or "tbcp".
 128 The default program is "none".
 129 The specified port monitor must be listed in the printer's PPD file.
 130 .TP 5
 131 \fB\-o printer-error-policy=\fIname\fR
 132 Sets the error policy to be used when the printer backend is unable to send the job to the printer.
 133 The name must be one of "abort-job", "retry-job", "retry-current-job", or "stop-printer".
 134 The default error policy is "stop-printer" for printers and "retry-current-job" for
 135 classes.
 136 .TP 5
 137 \fB\-o printer\-is\-shared=true\fR
 138 .TP 5
 139 \fB\-o printer\-is\-shared=false\fR
 140 Sets the destination to shared/published or unshared/unpublished.
 141 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.
 142 The default value is "true".
 143 .TP 5
 144 \fB\-o printer-op-policy=\fIname\fR
 145 Sets the IPP operation policy associated with the destination.
 146 The name must be defined in the \fIcupsd.conf\fR in a Policy section.
 147 The default operation policy is "default".
 148 .TP 5
 149 \fB\-R \fIname\fB\-default\fR
 150 Deletes the named option from \fIprinter\fR.
 151 .TP 5
 152 \fB\-r \fIclass\fR
 153 Removes the named \fIprinter\fR from \fIclass\fR.
 154 If the resulting class becomes empty it is removed.
 155 .TP 5
 156 \fB-u allow:\fR{\fIuser\fR|\fB@\fIgroup\fR}{\fB,\fIuser\fR|\fB,@\fIgroup\fR}*
 157 .TP 5
 158 \fB-u deny:\fR{\fIuser\fR|\fB@\fIgroup\fR}{\fB,\fIuser\fR|\fB,@\fIgroup\fR}*
 159 .TP 5
 160 \fB\-u allow:all\fR
 161 .TP 5
 162 \fB\-u deny:none\fR
 163 Sets user-level access control on a destination.
 164 Names starting with "@" are interpreted as UNIX groups.
 165 The latter two forms turn user-level access control off.
 166 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'.
 167 .TP 5
 168 \fB\-v "\fIdevice-uri\fB"\fR
 169 Sets the \fIdevice-uri\fR attribute of the printer queue.
 170 Use the \fI-v\fR option with the
 171 .BR lpinfo (8)
 172 command to get a list of supported device URIs and schemes.
 173 .TP 5
 174 \fB\-D "\fIinfo\fB"\fR
 175 Provides a textual description of the destination.
 176 .TP 5
 177 .B \-E
 178 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 Since interface scripts are no longer supported, the \fI-P\fR option is preferred for providing a PPD file for a printer.
 192 .SH CONFORMING TO
 193 Unlike the System V printing system, CUPS allows printer names to contain any printable character except SPACE, TAB, "/", or "#".
 194 Also, printer and class names are \fInot\fR case-sensitive.
 195 Finally, the CUPS version of \fBlpadmin\fR may ask the user for an access password depending on the printing system configuration.
 196 This differs from the System V version which requires the root user to execute this command.
 197 .SH NOTES
 198 The CUPS version of \fBlpadmin\fR does not support all of the System V or Solaris printing system configuration options.
 199 Interface scripts are not supported for security reasons.
 200 .SH EXAMPLE
 201 Create an IPP Everywhere print queue:
 202 .nf
 203
 204     lpadmin -p myprinter -E -v ipp://myprinter.local/ipp/print -m everywhere
 205
 206 .fi
 207 .SH SEE ALSO
 208 .BR cupsaccept (8),
 209 .BR cupsenable (8),
 210 .BR lpinfo (8),
 211 .BR lpoptions (1),
 212 CUPS Online Help (http://localhost:631/help)
 213 .SH COPYRIGHT
 214 Copyright \[co] 2007-2018 by Apple Inc.