man/lpadmin.man

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