man/lpadmin.man

   1 .\"
   2 .\" "$Id: lpadmin.man 7600 2008-05-20 21:06:23Z mike $"
   3 .\"
   4 .\"   lpadmin man page for the Common UNIX Printing System (CUPS).
   5 .\"
   6 .\"   Copyright 2007-2008 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 "Common UNIX Printing System" "2 January 2008" "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 printer 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.  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 from the
  82 \fImodel\fR directory.
  83 .TP 5
  84 -o job-k-limit=value
  85 .br
  86 Sets the kilobyte limit for per-user quotas. The value is an
  87 integer number of kilobytes; one kilobyte is 1024 bytes.
  88 .TP 5
  89 -o job-page-limit=value
  90 .br
  91 Sets the page limit for per-user quotas. The value is the integer
  92 number of pages that can be printed; double-sided pages are
  93 counted as two pages.
  94 .TP 5
  95 -o job-quota-period=value
  96 .br
  97 Sets the accounting period for per-user quotas. The value is an
  98 integer number of seconds; 86,400 seconds are in one day.
  99 .TP 5
 100 -o job-sheets-default=banner
 101 .TP 5
 102 -o job-sheets-default=banner,banner
 103 .br
 104 Sets the default banner page(s) to use for print jobs.
 105 .TP 5
 106 -o name=value
 107 .br
 108 Sets a PPD option for the printer. PPD options can be
 109 listed using the \fI-l\fR option with the \fIlpoptions(1)\fR
 110 command.
 111 .TP 5
 112 -o name-default=value
 113 .br
 114 Sets a default server-side option for the printer. 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" or "stop-printer". The default error
 129 policy is "stop-printer".
 130 .TP 5
 131 -o printer-is-shared=true/false
 132 .br
 133 Sets the printer to shared/published or unshared/unpublished.
 134 Shared/published printers are publically announced by the server
 135 on the LAN based on the browsing configuration in
 136 \fBcupsd.conf\fR, while unshared/unpublished printers are not
 137 announced. The default value is "true".
 138 .TP 5
 139 -o printer-op-policy=name
 140 .br
 141 Sets the IPP operation policy associated with the printer. The
 142 name must be defined in the \fBcupsd.conf\fR in a Policy section.
 143 The default operation policy is "default".
 144 .TP 5
 145 -r class
 146 .br
 147 Removes the named \fIprinter\fR from \fIclass\fR.  If the
 148 resulting class becomes empty it is removed.
 149 .TP 5
 150 -u allow:user,user,@group
 151 .TP 5
 152 -u deny:user,user,@group
 153 .TP 5
 154 -u allow:all
 155 .TP 5
 156 -u deny:none
 157 .br
 158 Sets user-level access control on a printer. Names starting with
 159 "@" are interpreted as UNIX groups. The latter two forms turn
 160 user-level access control off.
 161 .TP 5
 162 -v "device-uri"
 163 .br
 164 Sets the \fIdevice-uri\fR attribute of the printer queue.  If
 165 \fIdevice-uri\fR is a filename it is automatically converted to
 166 the form \fIfile:///file/name\fR. Use the \fIlpinfo(8)\fR command
 167 to get a list of supported device URIs and schemes.
 168 .TP 5
 169 -D "info"
 170 .br
 171 Provides a textual description of the printer.
 172 .TP 5
 173 -E
 174 .br
 175 Enables the printer and accepts jobs; this is the same as running the
 176 \fIaccept(8)\fR and \fIcupsenable(8)\fR programs on the printer.
 177 .TP 5
 178 -L "location"
 179 .br
 180 Provides a textual location of the printer.
 181 .TP 5
 182 -P ppd-file
 183 .br
 184 Specifies a PostScript Printer Description file to use with the
 185 printer. If specified, this option overrides the \fI-i\fR option
 186 (interface script).
 187 .SH COMPATIBILITY
 188 Unlike the System V printing system, CUPS allows printer names to
 189 contain any printable character except SPACE, TAB, "/", or "#".
 190 Also, printer and class names are \fInot\fR case-sensitive.
 191 Finally, the CUPS version of \fIlpadmin\fR may ask the user for
 192 an access password depending on the printing system
 193 configuration. This differs from the System V version which
 194 requires the root user to execute this command.
 195 .SH LIMITATIONS
 196 The CUPS version of \fIlpadmin\fR does not support all of the
 197 System V or Solaris printing system configuration options.
 198 .SH SEE ALSO
 199 \fIaccept(8)\fR, \fIcupsenable(8)\fR, \fIlpinfo(8)\fR,
 200 \fIlpoptions(1)\fR,
 201 .br
 202 http://localhost:631/help
 203 .SH COPYRIGHT
 204 Copyright 2007-2008 by Apple Inc.
 205 .\"
 206 .\" End of "$Id: lpadmin.man 7600 2008-05-20 21:06:23Z mike $".
 207 .\"