man/lpadmin.man

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