man/lpadmin.man

   1 .\"
   2 .\" "$Id$"
   3 .\"
   4 .\"   lpadmin man page for CUPS.
   5 .\"
   6 .\"   Copyright 2007-2013 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" "16 July 2012" "Apple Inc."
  16 .SH NAME
  17 lpadmin \- configure cups printers and classes
  18 .SH SYNOPSIS
  19 .B lpadmin
  20 [ -E ] [-U
  21 .I username
  22 ] [ -h
  23 .I server[:port]
  24 ] -d
  25 .I destination
  26 .br
  27 .B lpadmin
  28 [ -E ] [-U
  29 .I username
  30 ] [ -h
  31 .I server[:port]
  32 ] -p
  33 .I destination
  34 [ -R
  35 .I name-default
  36 ]
  37 .I option(s)
  38 .br
  39 .B lpadmin
  40 [ -E ] [-U
  41 .I username
  42 ] [ -h
  43 .I server[:port]
  44 ] -x
  45 .I destination
  46 .SH DESCRIPTION
  47 \fIlpadmin\fR configures printer and class queues provided by
  48 CUPS. It can also be used to set the server default printer or
  49 class.
  50 .LP
  51 When specified before the \fI-d\fR, \fI-p\fR, or \fI-x\fR
  52 options, the \fI-E\fR option forces encryption when connecting to
  53 the server.
  54 .LP
  55 The first form of the command (\fI-d\fR) sets the default printer
  56 or class to \fIdestination\fR.  Subsequent print jobs submitted
  57 via the \fIlp(1)\fR or \fIlpr(1)\fR commands will use this
  58 destination unless the user specifies otherwise with the
  59 \fIlpoptions(1)\fR command.
  60 .LP
  61 The second form of the command (\fI-p\fR) configures the named
  62 printer or class.  The additional options are described below.
  63 .LP
  64 The third form of the command (\fI-x\fR) deletes the printer or
  65 class \fIdestination\fR. Any jobs that are pending for the
  66 destination will be removed and any job that is currently printed
  67 will be aborted.
  68 .SH CONFIGURATION OPTIONS
  69 The following options are recognized when configuring a printer
  70 queue:
  71 .TP 5
  72 -c class
  73 .br
  74 Adds the named \fIprinter\fR to \fIclass\fR.  If \fIclass\fR does
  75 not exist it is created automatically.
  76 .TP 5
  77 -i interface
  78 .br
  79 Sets a System V style interface script for the printer. This
  80 option cannot be specified with the \fI-P\fR option (PPD file)
  81 and is intended for providing support for legacy printer drivers.
  82 .TP 5
  83 -m model
  84 .br
  85 Sets a standard System V interface script or PPD file for the printer from the
  86 \fImodel\fR directory or using one of the driver interfaces. Use the \fI-m\fR
  87 option with the \fIlpinfo(8)\fR command to get a list of supported models.
  88 .TP 5
  89 -o cupsIPPSupplies=true
  90 .TP 5
  91 -o cupsIPPSupplies=false
  92 .br
  93 Specifies whether IPP supply level values should be reported.
  94 .TP 5
  95 -o cupsSNMPSupplies=true
  96 .TP 5
  97 -o cupsSNMPSupplies=false
  98 .br
  99 Specifies whether SNMP supply level (RFC 3805) values should be reported.
 100 .TP 5
 101 -o job-k-limit=value
 102 .br
 103 Sets the kilobyte limit for per-user quotas. The value is an
 104 integer number of kilobytes; one kilobyte is 1024 bytes.
 105 .TP 5
 106 -o job-page-limit=value
 107 .br
 108 Sets the page limit for per-user quotas. The value is the integer
 109 number of pages that can be printed; double-sided pages are
 110 counted as two pages.
 111 .TP 5
 112 -o job-quota-period=value
 113 .br
 114 Sets the accounting period for per-user quotas. The value is an
 115 integer number of seconds; 86,400 seconds are in one day.
 116 .TP 5
 117 -o job-sheets-default=banner
 118 .TP 5
 119 -o job-sheets-default=banner,banner
 120 .br
 121 Sets the default banner page(s) to use for print jobs.
 122 .TP 5
 123 -o name=value
 124 .br
 125 Sets a PPD option for the printer. PPD options can be listed using the \fI-l\fR
 126 option with the \fIlpoptions(1)\fR command.
 127 .TP 5
 128 -o name-default=value
 129 .br
 130 Sets a default server-side option for the destination. Any print-time
 131 option can be defaulted, e.g. "-o cpi-default=17" to set the default
 132 "cpi" option value to 17.
 133 .TP 5
 134 -o port-monitor=name
 135 .br
 136 Sets the binary communications program to use when printing,
 137 "none", "bcp", or "tbcp". The default program is "none". The
 138 specified port monitor must be listed in the printer's PPD file.
 139 .TP 5
 140 -o printer-error-policy=name
 141 .br
 142 Sets the error policy to be used when the printer backend is
 143 unable to send the job to the printer. The name must be one of
 144 "abort-job", "retry-job", "retry-current-job", or "stop-printer". The default
 145 error policy is "stop-printer" for printers and "retry-current-job" for
 146 classes.
 147 .TP 5
 148 -o printer-is-shared=true/false
 149 .br
 150 Sets the destination to shared/published or unshared/unpublished.
 151 Shared/published destinations are publicly announced by the server
 152 on the LAN based on the browsing configuration in
 153 \fBcupsd.conf\fR, while unshared/unpublished destinations are not
 154 announced. The default value is "true".
 155 .TP 5
 156 -o printer-op-policy=name
 157 .br
 158 Sets the IPP operation policy associated with the destination. The
 159 name must be defined in the \fBcupsd.conf\fR in a Policy section.
 160 The default operation policy is "default".
 161 .TP 5
 162 -R name-default
 163 .br
 164 Deletes the named option from \fIprinter\fR.
 165 .TP 5
 166 -r class
 167 .br
 168 Removes the named \fIprinter\fR from \fIclass\fR.  If the
 169 resulting class becomes empty it is removed.
 170 .TP 5
 171 -u allow:user,user,@group
 172 .TP 5
 173 -u deny:user,user,@group
 174 .TP 5
 175 -u allow:all
 176 .TP 5
 177 -u deny:none
 178 .br
 179 Sets user-level access control on a destination. Names starting with
 180 "@" are interpreted as UNIX groups. The latter two forms turn
 181 user-level access control off.
 182 .TP 5
 183 -v "device-uri"
 184 .br
 185 Sets the \fIdevice-uri\fR attribute of the printer queue. Use the \fI-v\fR
 186 option with the \fIlpinfo(8)\fR command to get a list of supported device URIs
 187 and schemes.
 188 .TP 5
 189 -D "info"
 190 .br
 191 Provides a textual description of the destination.
 192 .TP 5
 193 -E
 194 .br
 195 Enables the destination and accepts jobs; this is the same as running the
 196 \fIcupsaccept(8)\fR and \fIcupsenable(8)\fR programs on the destination.
 197 .TP 5
 198 -L "location"
 199 .br
 200 Provides a textual location of the destination.
 201 .TP 5
 202 -P ppd-file
 203 .br
 204 Specifies a PostScript Printer Description file to use with the
 205 printer. If specified, this option overrides the \fI-i\fR option
 206 (interface script).
 207 .SH COMPATIBILITY
 208 Unlike the System V printing system, CUPS allows printer names to
 209 contain any printable character except SPACE, TAB, "/", or "#".
 210 Also, printer and class names are \fInot\fR case-sensitive.
 211 Finally, the CUPS version of \fIlpadmin\fR may ask the user for
 212 an access password depending on the printing system
 213 configuration. This differs from the System V version which
 214 requires the root user to execute this command.
 215 .SH LIMITATIONS
 216 The CUPS version of \fIlpadmin\fR does not support all of the
 217 System V or Solaris printing system configuration options.
 218 .SH SEE ALSO
 219 \fIcupsaccept(8)\fR, \fIcupsenable(8)\fR, \fIlpinfo(8)\fR,
 220 \fIlpoptions(1)\fR,
 221 .br
 222 http://localhost:631/help
 223 .SH COPYRIGHT
 224 Copyright 2007-2013 by Apple Inc.
 225 .\"
 226 .\" End of "$Id$".
 227 .\"