man/lpadmin.man

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