[thirdparty/cups.git] / doc / help / man-lpadmin.html

<!DOCTYPE HTML>
<html>
<!-- SECTION: Man Pages -->
<head>
	<link rel="stylesheet" type="text/css" href="../cups-printable.css">
	<title>lpadmin(8)</title>
</head>
<body>
<h1 class="title">lpadmin(8)</h1>
<h2 class="title"><a name="NAME">Name</a></h2>
lpadmin - configure cups printers and classes
<h2 class="title"><a name="SYNOPSIS">Synopsis</a></h2>
<b>lpadmin</b>
[ -E ] [-U
<i>username</i>
] [ -h
<i>server[:port]</i>
] -d
<i>destination</i>
<br>
<b>lpadmin</b>
[ -E ] [-U
<i>username</i>
] [ -h
<i>server[:port]</i>
] -p
<i>destination</i>
[ -R
<i>name-default</i>
]
<i>option(s)</i>
<br>
<b>lpadmin</b>
[ -E ] [-U
<i>username</i>
] [ -h
<i>server[:port]</i>
] -x
<i>destination</i>
<h2 class="title"><a name="DESCRIPTION">Description</a></h2>
<i>lpadmin</i> configures printer and class queues provided by
CUPS. It can also be used to set the server default printer or
class.
<p>When specified before the <i>-d</i>, <i>-p</i>, or <i>-x</i>
options, the <i>-E</i> option forces encryption when connecting to
the server.
<p>The first form of the command (<i>-d</i>) sets the default printer
or class to <i>destination</i>.  Subsequent print jobs submitted
via the <i>lp(1)</i> or <i>lpr(1)</i> commands will use this
destination unless the user specifies otherwise with the
<i>lpoptions(1)</i> command.
<p>The second form of the command (<i>-p</i>) configures the named
printer or class.  The additional options are described below.
<p>The third form of the command (<i>-x</i>) deletes the printer or
class <i>destination</i>. Any jobs that are pending for the
destination will be removed and any job that is currently printed
will be aborted.
<h2 class="title"><a name="CONFIGURATION_OPTIONS">Configuration Options</a></h2>
The following options are recognized when configuring a printer
queue:
<dl class="man">
<dt>-c class
<dd style="margin-left: 5.0em"><br>
Adds the named <i>printer</i> to <i>class</i>.  If <i>class</i> does
not exist it is created automatically.
<dt>-i interface
<dd style="margin-left: 5.0em"><br>
Sets a System V style interface script for the printer. This
option cannot be specified with the <i>-P</i> option (PPD file)
and is intended for providing support for legacy printer drivers.
<dt>-m model
<dd style="margin-left: 5.0em"><br>
Sets a standard System V interface script or PPD file for the printer from the
<i>model</i> directory or using one of the driver interfaces. Use the <i>-m</i>
option with the <i>lpinfo(8)</i> command to get a list of supported models.
<dt>-o cupsIPPSupplies=true
<dd style="margin-left: 5.0em"><dt>-o cupsIPPSupplies=false
<dd style="margin-left: 5.0em"><br>
Specifies whether IPP supply level values should be reported.
<dt>-o cupsSNMPSupplies=true
<dd style="margin-left: 5.0em"><dt>-o cupsSNMPSupplies=false
<dd style="margin-left: 5.0em"><br>
Specifies whether SNMP supply level (RFC 3805) values should be reported.
<dt>-o job-k-limit=value
<dd style="margin-left: 5.0em"><br>
Sets the kilobyte limit for per-user quotas. The value is an
integer number of kilobytes; one kilobyte is 1024 bytes.
<dt>-o job-page-limit=value
<dd style="margin-left: 5.0em"><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.
<dt>-o job-quota-period=value
<dd style="margin-left: 5.0em"><br>
Sets the accounting period for per-user quotas. The value is an
integer number of seconds; 86,400 seconds are in one day.
<dt>-o job-sheets-default=banner
<dd style="margin-left: 5.0em"><dt>-o job-sheets-default=banner,banner
<dd style="margin-left: 5.0em"><br>
Sets the default banner page(s) to use for print jobs.
<dt>-o name=value
<dd style="margin-left: 5.0em"><br>
Sets a PPD option for the printer. PPD options can be listed using the <i>-l</i>
option with the <i>lpoptions(1)</i> command.
<dt>-o name-default=value
<dd style="margin-left: 5.0em"><br>
Sets a default server-side option for the destination. Any print-time
option can be defaulted, e.g. "-o cpi-default=17" to set the default
"cpi" option value to 17.
<dt>-o port-monitor=name
<dd style="margin-left: 5.0em"><br>
Sets the binary communications program to use when printing,
"none", "bcp", or "tbcp". The default program is "none". The
specified port monitor must be listed in the printer's PPD file.
<dt>-o printer-error-policy=name
<dd style="margin-left: 5.0em"><br>
Sets the error policy to be used when the printer backend is
unable to send the job to the printer. The name must be one of
"abort-job", "retry-job", "retry-current-job", or "stop-printer". The default
error policy is "stop-printer" for printers and "retry-current-job" for
classes.
<dt>-o printer-is-shared=true/false
<dd style="margin-left: 5.0em"><br>
Sets the destination to shared/published or unshared/unpublished.
Shared/published destinations are publicly announced by the server
on the LAN based on the browsing configuration in
<b>cupsd.conf</b>, while unshared/unpublished destinations are not
announced. The default value is "true".
<dt>-o printer-op-policy=name
<dd style="margin-left: 5.0em"><br>
Sets the IPP operation policy associated with the destination. The
name must be defined in the <b>cupsd.conf</b> in a Policy section.
The default operation policy is "default".
<dt>-R name-default
<dd style="margin-left: 5.0em"><br>
Deletes the named option from <i>printer</i>.
<dt>-r class
<dd style="margin-left: 5.0em"><br>
Removes the named <i>printer</i> from <i>class</i>.  If the
resulting class becomes empty it is removed.
<dt>-u allow:user,user,@group
<dd style="margin-left: 5.0em"><dt>-u deny:user,user,@group
<dd style="margin-left: 5.0em"><dt>-u allow:all
<dd style="margin-left: 5.0em"><dt>-u deny:none
<dd style="margin-left: 5.0em"><br>
Sets user-level access control on a destination. Names starting with
"@" are interpreted as UNIX groups. The latter two forms turn
user-level access control off.
<dt>-v "device-uri"
<dd style="margin-left: 5.0em"><br>
Sets the <i>device-uri</i> attribute of the printer queue. Use the <i>-v</i>
option with the <i>lpinfo(8)</i> command to get a list of supported device URIs
and schemes.
<dt>-D "info"
<dd style="margin-left: 5.0em"><br>
Provides a textual description of the destination.
<dt>-E
<dd style="margin-left: 5.0em"><br>
Enables the destination and accepts jobs; this is the same as running the
<i>cupsaccept(8)</i> and <i>cupsenable(8)</i> programs on the destination.
<dt>-L "location"
<dd style="margin-left: 5.0em"><br>
Provides a textual location of the destination.
<dt>-P ppd-file
<dd style="margin-left: 5.0em"><br>
Specifies a PostScript Printer Description file to use with the
printer. If specified, this option overrides the <i>-i</i> option
(interface script).
</dl>
<h2 class="title"><a name="COMPATIBILITY">Compatibility</a></h2>
Unlike the System V printing system, CUPS allows printer names to
contain any printable character except SPACE, TAB, "/", or "#".
Also, printer and class names are <i>not</i> case-sensitive.
Finally, the CUPS version of <i>lpadmin</i> 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.
<h2 class="title"><a name="LIMITATIONS">Limitations</a></h2>
The CUPS version of <i>lpadmin</i> does not support all of the
System V or Solaris printing system configuration options.
<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
<i>cupsaccept(8)</i>, <i>cupsenable(8)</i>, <i>lpinfo(8)</i>,
<i>lpoptions(1)</i>,
<br>
<a href="http://localhost:631/help">http://localhost:631/help</a>
<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
Copyright 2007-2013 by Apple Inc.

</body>
</html>
Commit	Line	Data
c277f98c	1	<!DOCTYPE HTML>
94436c5a MS	2	<html>
	3	<!-- SECTION: Man Pages -->
	4	<head>
	5	<link rel="stylesheet" type="text/css" href="../cups-printable.css">
	6	<title>lpadmin(8)</title>
	7	</head>
	8	<body>
	9	<h1 class="title">lpadmin(8)</h1>
	10	<h2 class="title"><a name="NAME">Name</a></h2>
	11	lpadmin - configure cups printers and classes
	12	<h2 class="title"><a name="SYNOPSIS">Synopsis</a></h2>
c277f98c MS	13	<b>lpadmin</b>
	14	[ -E ] [-U
	15	<i>username</i>
	16	] [ -h
	17	<i>server[:port]</i>
	18	] -d
	19	<i>destination</i>
	20	<br>
	21	<b>lpadmin</b>
	22	[ -E ] [-U
	23	<i>username</i>
	24	] [ -h
	25	<i>server[:port]</i>
	26	] -p
	27	<i>destination</i>
	28	[ -R
	29	<i>name-default</i>
	30	]
	31	<i>option(s)</i>
	32	<br>
	33	<b>lpadmin</b>
	34	[ -E ] [-U
	35	<i>username</i>
	36	] [ -h
	37	<i>server[:port]</i>
	38	] -x
	39	<i>destination</i>
	40	<h2 class="title"><a name="DESCRIPTION">Description</a></h2>
94436c5a MS	41	<i>lpadmin</i> configures printer and class queues provided by
	42	CUPS. It can also be used to set the server default printer or
	43	class.
	44	<p>When specified before the <i>-d</i>, <i>-p</i>, or <i>-x</i>
	45	options, the <i>-E</i> option forces encryption when connecting to
	46	the server.
	47	<p>The first form of the command (<i>-d</i>) sets the default printer
	48	or class to <i>destination</i>. Subsequent print jobs submitted
c277f98c	49	via the <i>lp(1)</i> or <i>lpr(1)</i> commands will use this
94436c5a	50	destination unless the user specifies otherwise with the
c277f98c	51	<i>lpoptions(1)</i> command.
94436c5a MS	52	<p>The second form of the command (<i>-p</i>) configures the named
	53	printer or class. The additional options are described below.
	54	<p>The third form of the command (<i>-x</i>) deletes the printer or
	55	class <i>destination</i>. Any jobs that are pending for the
	56	destination will be removed and any job that is currently printed
	57	will be aborted.
	58	<h2 class="title"><a name="CONFIGURATION_OPTIONS">Configuration Options</a></h2>
	59	The following options are recognized when configuring a printer
	60	queue:
2909c66c MS	61	<dl class="man">
	62	<dt>-c class
	63	<dd style="margin-left: 5.0em"><br>
c277f98c	64	Adds the named <i>printer</i> to <i>class</i>. If <i>class</i> does
94436c5a	65	not exist it is created automatically.
2909c66c MS	66	<dt>-i interface
2909c66c MS	67	<dd style="margin-left: 5.0em"><br>
c277f98c	68	Sets a System V style interface script for the printer. This
94436c5a MS	69	option cannot be specified with the <i>-P</i> option (PPD file)
94436c5a MS	70	and is intended for providing support for legacy printer drivers.
2909c66c MS	71	<dt>-m model
2909c66c MS	72	<dd style="margin-left: 5.0em"><br>
c277f98c	73	Sets a standard System V interface script or PPD file for the printer from the
94436c5a	74	<i>model</i> directory or using one of the driver interfaces. Use the <i>-m</i>
c277f98c	75	option with the <i>lpinfo(8)</i> command to get a list of supported models.
2909c66c MS	76	<dt>-o cupsIPPSupplies=true
	77	<dd style="margin-left: 5.0em"><dt>-o cupsIPPSupplies=false
	78	<dd style="margin-left: 5.0em"><br>
c277f98c	79	Specifies whether IPP supply level values should be reported.
2909c66c MS	80	<dt>-o cupsSNMPSupplies=true
	81	<dd style="margin-left: 5.0em"><dt>-o cupsSNMPSupplies=false
	82	<dd style="margin-left: 5.0em"><br>
c277f98c	83	Specifies whether SNMP supply level (RFC 3805) values should be reported.
2909c66c MS	84	<dt>-o job-k-limit=value
2909c66c MS	85	<dd style="margin-left: 5.0em"><br>
c277f98c	86	Sets the kilobyte limit for per-user quotas. The value is an
94436c5a	87	integer number of kilobytes; one kilobyte is 1024 bytes.
2909c66c MS	88	<dt>-o job-page-limit=value
2909c66c MS	89	<dd style="margin-left: 5.0em"><br>
c277f98c	90	Sets the page limit for per-user quotas. The value is the integer
94436c5a MS	91	number of pages that can be printed; double-sided pages are
94436c5a MS	92	counted as two pages.
2909c66c MS	93	<dt>-o job-quota-period=value
2909c66c MS	94	<dd style="margin-left: 5.0em"><br>
c277f98c	95	Sets the accounting period for per-user quotas. The value is an
94436c5a	96	integer number of seconds; 86,400 seconds are in one day.
2909c66c MS	97	<dt>-o job-sheets-default=banner
	98	<dd style="margin-left: 5.0em"><dt>-o job-sheets-default=banner,banner
	99	<dd style="margin-left: 5.0em"><br>
c277f98c	100	Sets the default banner page(s) to use for print jobs.
2909c66c MS	101	<dt>-o name=value
2909c66c MS	102	<dd style="margin-left: 5.0em"><br>
c277f98c MS	103	Sets a PPD option for the printer. PPD options can be listed using the <i>-l</i>
c277f98c MS	104	option with the <i>lpoptions(1)</i> command.
2909c66c MS	105	<dt>-o name-default=value
2909c66c MS	106	<dd style="margin-left: 5.0em"><br>
c277f98c	107	Sets a default server-side option for the destination. Any print-time
94436c5a MS	108	option can be defaulted, e.g. "-o cpi-default=17" to set the default
94436c5a MS	109	"cpi" option value to 17.
2909c66c MS	110	<dt>-o port-monitor=name
2909c66c MS	111	<dd style="margin-left: 5.0em"><br>
c277f98c	112	Sets the binary communications program to use when printing,
94436c5a MS	113	"none", "bcp", or "tbcp". The default program is "none". The
94436c5a MS	114	specified port monitor must be listed in the printer's PPD file.
2909c66c MS	115	<dt>-o printer-error-policy=name
2909c66c MS	116	<dd style="margin-left: 5.0em"><br>
c277f98c	117	Sets the error policy to be used when the printer backend is
94436c5a MS	118	unable to send the job to the printer. The name must be one of
	119	"abort-job", "retry-job", "retry-current-job", or "stop-printer". The default
	120	error policy is "stop-printer" for printers and "retry-current-job" for
	121	classes.
2909c66c MS	122	<dt>-o printer-is-shared=true/false
2909c66c MS	123	<dd style="margin-left: 5.0em"><br>
c277f98c	124	Sets the destination to shared/published or unshared/unpublished.
94436c5a MS	125	Shared/published destinations are publicly announced by the server
	126	on the LAN based on the browsing configuration in
	127	<b>cupsd.conf</b>, while unshared/unpublished destinations are not
	128	announced. The default value is "true".
2909c66c MS	129	<dt>-o printer-op-policy=name
2909c66c MS	130	<dd style="margin-left: 5.0em"><br>
c277f98c	131	Sets the IPP operation policy associated with the destination. The
94436c5a MS	132	name must be defined in the <b>cupsd.conf</b> in a Policy section.
94436c5a MS	133	The default operation policy is "default".
2909c66c MS	134	<dt>-R name-default
2909c66c MS	135	<dd style="margin-left: 5.0em"><br>
c277f98c	136	Deletes the named option from <i>printer</i>.
2909c66c MS	137	<dt>-r class
2909c66c MS	138	<dd style="margin-left: 5.0em"><br>
c277f98c	139	Removes the named <i>printer</i> from <i>class</i>. If the
94436c5a	140	resulting class becomes empty it is removed.
2909c66c MS	141	<dt>-u allow:user,user,@group
	142	<dd style="margin-left: 5.0em"><dt>-u deny:user,user,@group
	143	<dd style="margin-left: 5.0em"><dt>-u allow:all
	144	<dd style="margin-left: 5.0em"><dt>-u deny:none
	145	<dd style="margin-left: 5.0em"><br>
c277f98c	146	Sets user-level access control on a destination. Names starting with
94436c5a MS	147	"@" are interpreted as UNIX groups. The latter two forms turn
94436c5a MS	148	user-level access control off.
2909c66c MS	149	<dt>-v "device-uri"
2909c66c MS	150	<dd style="margin-left: 5.0em"><br>
c277f98c MS	151	Sets the <i>device-uri</i> attribute of the printer queue. Use the <i>-v</i>
c277f98c MS	152	option with the <i>lpinfo(8)</i> command to get a list of supported device URIs
94436c5a	153	and schemes.
2909c66c MS	154	<dt>-D "info"
2909c66c MS	155	<dd style="margin-left: 5.0em"><br>
c277f98c	156	Provides a textual description of the destination.
2909c66c MS	157	<dt>-E
2909c66c MS	158	<dd style="margin-left: 5.0em"><br>
c277f98c MS	159	Enables the destination and accepts jobs; this is the same as running the
c277f98c MS	160	<i>cupsaccept(8)</i> and <i>cupsenable(8)</i> programs on the destination.
2909c66c MS	161	<dt>-L "location"
2909c66c MS	162	<dd style="margin-left: 5.0em"><br>
c277f98c	163	Provides a textual location of the destination.
2909c66c MS	164	<dt>-P ppd-file
2909c66c MS	165	<dd style="margin-left: 5.0em"><br>
c277f98c	166	Specifies a PostScript Printer Description file to use with the
94436c5a MS	167	printer. If specified, this option overrides the <i>-i</i> option
94436c5a MS	168	(interface script).
2909c66c	169	</dl>
94436c5a MS	170	<h2 class="title"><a name="COMPATIBILITY">Compatibility</a></h2>
	171	Unlike the System V printing system, CUPS allows printer names to
	172	contain any printable character except SPACE, TAB, "/", or "#".
	173	Also, printer and class names are <i>not</i> case-sensitive.
	174	Finally, the CUPS version of <i>lpadmin</i> may ask the user for
	175	an access password depending on the printing system
	176	configuration. This differs from the System V version which
	177	requires the root user to execute this command.
	178	<h2 class="title"><a name="LIMITATIONS">Limitations</a></h2>
	179	The CUPS version of <i>lpadmin</i> does not support all of the
	180	System V or Solaris printing system configuration options.
	181	<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
c277f98c MS	182	<i>cupsaccept(8)</i>, <i>cupsenable(8)</i>, <i>lpinfo(8)</i>,
c277f98c MS	183	<i>lpoptions(1)</i>,
94436c5a	184	<br>
c277f98c	185	<a href="http://localhost:631/help">http://localhost:631/help</a>
94436c5a MS	186	<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
	187	Copyright 2007-2013 by Apple Inc.
	188
	189	</body>
	190	</html>