Load cups into easysw/current.

[thirdparty/cups.git] / man / lpadmin.man

.\"
.\" "$Id: lpadmin.man 4841 2005-11-15 20:39:31Z mike $"
.\"
.\"   lpadmin man page for the Common UNIX Printing System (CUPS).
.\"
.\"   Copyright 1997-2005 by Easy Software Products.
.\"
.\"   These coded instructions, statements, and computer programs are the
.\"   property of Easy Software Products and are protected by Federal
.\"   copyright law.  Distribution and use rights are outlined in the file
.\"   "LICENSE.txt" which should have been included with this file.  If this
.\"   file is missing or damaged please contact Easy Software Products
.\"   at:
.\"
.\"       Attn: CUPS Licensing Information
.\"       Easy Software Products
.\"       44141 Airport View Drive, Suite 204
.\"       Hollywood, Maryland 20636 USA
.\"
.\"       Voice: (301) 373-9600
.\"       EMail: cups-info@cups.org
.\"         WWW: http://www.cups.org
.\"
.TH lpadmin 8 "Common UNIX Printing System" "21 October 2002" "Easy Software Products"
.SH NAME
lpadmin \- configure cups printers and classes
.SH SYNOPSIS
.B lpadmin
[ -E ] [ -h
.I server
] \-d
.I destination
.br
.B lpadmin
[ -E ] [ -h
.I server
] \-p
.I printer
.I option(s)
.br
.B lpadmin
[ -E ] [ -h
.I server
] \-x
.I destination
.SH DESCRIPTION
\fIlpadmin\fR configures printer and class queues provided by
CUPS. It can also be used to set the server default printer or
class.
.LP
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.
.LP
The first form of the command (\fI-d\fR) sets the default printer or class to
\fIdestination\fR.  Subsequent print jobs submitted via the \fIlp(1)\fR or
\fIlpr(1)\fR commands will use this destination unless the user specifies
otherwise with the \fIlpoptions(1)\fR command.
.LP
The second form of the command (\fI-p\fR) configures the named printer.  The additional
options are described below.
.LP
The third form of the command (\fI-x\fR) deletes the printer or class \fIdestination\fR.
Any jobs that are pending for the destination will be removed and any job that
is currently printed will be aborted.
.SH CONFIGURATION OPTIONS
The following options are recognized when configuring a printer queue:
.TP 5
\-c \fIclass\fR
.br
Adds the named \fIprinter\fR to \fIclass\fR.  If \fIclass\fR does not
exist it is created automatically.
.TP 5
\-i \fIinterface\fR
.br
Sets a System V style interface script for the printer.  This option cannot
be specified with the \fI\-P\fR option (PPD file) and is intended for
providing support for legacy printer drivers.
.TP 5
\-m \fImodel\fR
.br
Sets a standard System V interface script or PPD file from the model
directory.
.TP 5
\-o \fIname=value\fR
.br
Sets a PPD or server option for the printer. PPD options can be listed
using the \fI-l\fR option with the \fIlpoptions(1)\fR command.
.TP 5
\-o \fIjob-k-limit=value\fR
.br
Sets the kilobyte limit for per-user quotas. The value is an integer number
of kilobytes; one kilobyte is 1024 bytes.
.TP 5
\-o \fIjob-page-limit=value\fR
.br
Sets the page limit for per-user quotas. The value is the integer number of
pages that can be printed; double-sided pages are counted as two pages.
.TP 5
\-o \fIjob-quota-period=value\fR
.br
Sets the accounting period for per-user quotas. The value is an integer number
of seconds; 86,400 seconds are in one day.
.TP 5
\-o \fIprotocol=name\fR
.br
Sets the binary communications protocol to use when printing,
None, BCP, or TBCP. The default protocol is None.
.TP 5
\-r \fIclass\fR
.br
Removes the named \fIprinter\fR from \fIclass\fR.  If the resulting class
becomes empty it is removed.
.TP 5
\-u \fIallow:user,user,@group\fR
\-u \fIdeny:user,user,@group\fR
\-u \fIallow:all\fR
\-u \fIdeny:none\fR
.br
Sets user-level access control on a printer. Names starting with
"@" are interpreted as UNIX groups. The latter two forms turn
user-level access control off.
.TP 5
\-v \fIdevice-uri\fR
.br
Sets the \fIdevice-uri\fR attribute of the printer queue.  If \fIdevice-uri\fR
is a filename it is automatically converted to the form \fBfile:/file/name\fR.
.TP 5
\-D \fIinfo\fR
.br
Provides a textual description of the printer.
.TP 5
\-E
.br
Enables the printer and accepts jobs; this is the same as running the
\fIaccept(8)\fR and \fIenable(8)\fR programs on the printer.
.TP 5
\-L \fIlocation\fR
.br
Provides a textual location of the printer.
.TP 5
\-P \fIppd-file\fR
.br
Specifies a PostScript Printer Description file to use with the printer. If
specified, this option overrides the \fI-i\fR option (interface script).
.SH COMPATIBILITY
Unlike the System V printing system, CUPS allows printer names to contain
any printable character except SPACE and TAB. Also, printer and class names are
\fBnot\fR case-sensitive. Finally, the CUPS version of \fIlpadmin\fR may ask the
user for an access password depending on the printing system configuration.
This differs from the System V version which requires the root user to execute
this command.
.SH LIMITATIONS
The CUPS version of \fIlpadmin\fR does not support all of the System V or
Solaris printing system configuration options.
.SH SEE ALSO
accept(8), cancel(1), disable(8), enable(8), lp(1), lpstat(1), reject(8),
CUPS Software Administrators Manual,
http://localhost:631/documentation.html
.SH COPYRIGHT
Copyright 1993-2005 by Easy Software Products, All Rights Reserved.
.\"
.\" End of "$Id: lpadmin.man 4841 2005-11-15 20:39:31Z mike $".
.\"