[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:
<p style="margin-left: 5.0em; text-indent: -5.0em">-c class
<br>
<br>
Adds the named <i>printer</i> to <i>class</i>.  If <i>class</i> does
not exist it is created automatically.
<p style="margin-left: 5.0em; text-indent: -5.0em">-i interface
<br>
<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.
<p style="margin-left: 5.0em; text-indent: -5.0em">-m model
<br>
<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.
<p style="margin-left: 5.0em; text-indent: -5.0em">-o cupsIPPSupplies=true
<br>
<p style="margin-left: 5.0em; text-indent: -5.0em">-o cupsIPPSupplies=false
<br>
<br>
Specifies whether IPP supply level values should be reported.
<p style="margin-left: 5.0em; text-indent: -5.0em">-o cupsSNMPSupplies=true
<br>
<p style="margin-left: 5.0em; text-indent: -5.0em">-o cupsSNMPSupplies=false
<br>
<br>
Specifies whether SNMP supply level (RFC 3805) values should be reported.
<p style="margin-left: 5.0em; text-indent: -5.0em">-o job-k-limit=value
<br>
<br>
Sets the kilobyte limit for per-user quotas. The value is an
integer number of kilobytes; one kilobyte is 1024 bytes.
<p style="margin-left: 5.0em; text-indent: -5.0em">-o job-page-limit=value
<br>
<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.
<p style="margin-left: 5.0em; text-indent: -5.0em">-o job-quota-period=value
<br>
<br>
Sets the accounting period for per-user quotas. The value is an
integer number of seconds; 86,400 seconds are in one day.
<p style="margin-left: 5.0em; text-indent: -5.0em">-o job-sheets-default=banner
<br>
<p style="margin-left: 5.0em; text-indent: -5.0em">-o job-sheets-default=banner,banner
<br>
<br>
Sets the default banner page(s) to use for print jobs.
<p style="margin-left: 5.0em; text-indent: -5.0em">-o name=value
<br>
<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.
<p style="margin-left: 5.0em; text-indent: -5.0em">-o name-default=value
<br>
<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.
<p style="margin-left: 5.0em; text-indent: -5.0em">-o port-monitor=name
<br>
<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.
<p style="margin-left: 5.0em; text-indent: -5.0em">-o printer-error-policy=name
<br>
<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.
<p style="margin-left: 5.0em; text-indent: -5.0em">-o printer-is-shared=true/false
<br>
<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".
<p style="margin-left: 5.0em; text-indent: -5.0em">-o printer-op-policy=name
<br>
<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".
<p style="margin-left: 5.0em; text-indent: -5.0em">-R name-default
<br>
<br>
Deletes the named option from <i>printer</i>.
<p style="margin-left: 5.0em; text-indent: -5.0em">-r class
<br>
<br>
Removes the named <i>printer</i> from <i>class</i>.  If the
resulting class becomes empty it is removed.
<p style="margin-left: 5.0em; text-indent: -5.0em">-u allow:user,user,@group
<br>
<p style="margin-left: 5.0em; text-indent: -5.0em">-u deny:user,user,@group
<br>
<p style="margin-left: 5.0em; text-indent: -5.0em">-u allow:all
<br>
<p style="margin-left: 5.0em; text-indent: -5.0em">-u deny:none
<br>
<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.
<p style="margin-left: 5.0em; text-indent: -5.0em">-v "device-uri"
<br>
<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.
<p style="margin-left: 5.0em; text-indent: -5.0em">-D "info"
<br>
<br>
Provides a textual description of the destination.
<p style="margin-left: 5.0em; text-indent: -5.0em">-E
<br>
<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.
<p style="margin-left: 5.0em; text-indent: -5.0em">-L "location"
<br>
<br>
Provides a textual location of the destination.
<p style="margin-left: 5.0em; text-indent: -5.0em">-P ppd-file
<br>
<br>
Specifies a PostScript Printer Description file to use with the
printer. If specified, this option overrides the <i>-i</i> option
(interface script).
<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:
c277f98c MS	61	<p style="margin-left: 5.0em; text-indent: -5.0em">-c class
	62	<br>
	63	<br>
	64	Adds the named <i>printer</i> to <i>class</i>. If <i>class</i> does
94436c5a	65	not exist it is created automatically.
c277f98c MS	66	<p style="margin-left: 5.0em; text-indent: -5.0em">-i interface
	67	<br>
	68	<br>
	69	Sets a System V style interface script for the printer. This
94436c5a MS	70	option cannot be specified with the <i>-P</i> option (PPD file)
94436c5a MS	71	and is intended for providing support for legacy printer drivers.
c277f98c MS	72	<p style="margin-left: 5.0em; text-indent: -5.0em">-m model
	73	<br>
	74	<br>
	75	Sets a standard System V interface script or PPD file for the printer from the
94436c5a	76	<i>model</i> directory or using one of the driver interfaces. Use the <i>-m</i>
c277f98c MS	77	option with the <i>lpinfo(8)</i> command to get a list of supported models.
	78	<p style="margin-left: 5.0em; text-indent: -5.0em">-o cupsIPPSupplies=true
	79	<br>
	80	<p style="margin-left: 5.0em; text-indent: -5.0em">-o cupsIPPSupplies=false
	81	<br>
	82	<br>
	83	Specifies whether IPP supply level values should be reported.
	84	<p style="margin-left: 5.0em; text-indent: -5.0em">-o cupsSNMPSupplies=true
	85	<br>
	86	<p style="margin-left: 5.0em; text-indent: -5.0em">-o cupsSNMPSupplies=false
	87	<br>
	88	<br>
	89	Specifies whether SNMP supply level (RFC 3805) values should be reported.
	90	<p style="margin-left: 5.0em; text-indent: -5.0em">-o job-k-limit=value
	91	<br>
	92	<br>
	93	Sets the kilobyte limit for per-user quotas. The value is an
94436c5a	94	integer number of kilobytes; one kilobyte is 1024 bytes.
c277f98c MS	95	<p style="margin-left: 5.0em; text-indent: -5.0em">-o job-page-limit=value
	96	<br>
	97	<br>
	98	Sets the page limit for per-user quotas. The value is the integer
94436c5a MS	99	number of pages that can be printed; double-sided pages are
94436c5a MS	100	counted as two pages.
c277f98c MS	101	<p style="margin-left: 5.0em; text-indent: -5.0em">-o job-quota-period=value
	102	<br>
	103	<br>
	104	Sets the accounting period for per-user quotas. The value is an
94436c5a	105	integer number of seconds; 86,400 seconds are in one day.
c277f98c MS	106	<p style="margin-left: 5.0em; text-indent: -5.0em">-o job-sheets-default=banner
	107	<br>
	108	<p style="margin-left: 5.0em; text-indent: -5.0em">-o job-sheets-default=banner,banner
	109	<br>
	110	<br>
	111	Sets the default banner page(s) to use for print jobs.
	112	<p style="margin-left: 5.0em; text-indent: -5.0em">-o name=value
	113	<br>
	114	<br>
	115	Sets a PPD option for the printer. PPD options can be listed using the <i>-l</i>
	116	option with the <i>lpoptions(1)</i> command.
	117	<p style="margin-left: 5.0em; text-indent: -5.0em">-o name-default=value
	118	<br>
	119	<br>
	120	Sets a default server-side option for the destination. Any print-time
94436c5a MS	121	option can be defaulted, e.g. "-o cpi-default=17" to set the default
94436c5a MS	122	"cpi" option value to 17.
c277f98c MS	123	<p style="margin-left: 5.0em; text-indent: -5.0em">-o port-monitor=name
	124	<br>
	125	<br>
	126	Sets the binary communications program to use when printing,
94436c5a MS	127	"none", "bcp", or "tbcp". The default program is "none". The
94436c5a MS	128	specified port monitor must be listed in the printer's PPD file.
c277f98c MS	129	<p style="margin-left: 5.0em; text-indent: -5.0em">-o printer-error-policy=name
	130	<br>
	131	<br>
	132	Sets the error policy to be used when the printer backend is
94436c5a MS	133	unable to send the job to the printer. The name must be one of
	134	"abort-job", "retry-job", "retry-current-job", or "stop-printer". The default
	135	error policy is "stop-printer" for printers and "retry-current-job" for
	136	classes.
c277f98c MS	137	<p style="margin-left: 5.0em; text-indent: -5.0em">-o printer-is-shared=true/false
	138	<br>
	139	<br>
	140	Sets the destination to shared/published or unshared/unpublished.
94436c5a MS	141	Shared/published destinations are publicly announced by the server
	142	on the LAN based on the browsing configuration in
	143	<b>cupsd.conf</b>, while unshared/unpublished destinations are not
	144	announced. The default value is "true".
c277f98c MS	145	<p style="margin-left: 5.0em; text-indent: -5.0em">-o printer-op-policy=name
	146	<br>
	147	<br>
	148	Sets the IPP operation policy associated with the destination. The
94436c5a MS	149	name must be defined in the <b>cupsd.conf</b> in a Policy section.
94436c5a MS	150	The default operation policy is "default".
c277f98c MS	151	<p style="margin-left: 5.0em; text-indent: -5.0em">-R name-default
	152	<br>
	153	<br>
	154	Deletes the named option from <i>printer</i>.
	155	<p style="margin-left: 5.0em; text-indent: -5.0em">-r class
	156	<br>
	157	<br>
	158	Removes the named <i>printer</i> from <i>class</i>. If the
94436c5a	159	resulting class becomes empty it is removed.
c277f98c MS	160	<p style="margin-left: 5.0em; text-indent: -5.0em">-u allow:user,user,@group
	161	<br>
	162	<p style="margin-left: 5.0em; text-indent: -5.0em">-u deny:user,user,@group
	163	<br>
	164	<p style="margin-left: 5.0em; text-indent: -5.0em">-u allow:all
	165	<br>
	166	<p style="margin-left: 5.0em; text-indent: -5.0em">-u deny:none
	167	<br>
	168	<br>
	169	Sets user-level access control on a destination. Names starting with
94436c5a MS	170	"@" are interpreted as UNIX groups. The latter two forms turn
94436c5a MS	171	user-level access control off.
c277f98c MS	172	<p style="margin-left: 5.0em; text-indent: -5.0em">-v "device-uri"
	173	<br>
	174	<br>
	175	Sets the <i>device-uri</i> attribute of the printer queue. Use the <i>-v</i>
	176	option with the <i>lpinfo(8)</i> command to get a list of supported device URIs
94436c5a	177	and schemes.
c277f98c MS	178	<p style="margin-left: 5.0em; text-indent: -5.0em">-D "info"
	179	<br>
	180	<br>
	181	Provides a textual description of the destination.
	182	<p style="margin-left: 5.0em; text-indent: -5.0em">-E
	183	<br>
	184	<br>
	185	Enables the destination and accepts jobs; this is the same as running the
	186	<i>cupsaccept(8)</i> and <i>cupsenable(8)</i> programs on the destination.
	187	<p style="margin-left: 5.0em; text-indent: -5.0em">-L "location"
	188	<br>
	189	<br>
	190	Provides a textual location of the destination.
	191	<p style="margin-left: 5.0em; text-indent: -5.0em">-P ppd-file
	192	<br>
	193	<br>
	194	Specifies a PostScript Printer Description file to use with the
94436c5a MS	195	printer. If specified, this option overrides the <i>-i</i> option
94436c5a MS	196	(interface script).
94436c5a MS	197	<h2 class="title"><a name="COMPATIBILITY">Compatibility</a></h2>
	198	Unlike the System V printing system, CUPS allows printer names to
	199	contain any printable character except SPACE, TAB, "/", or "#".
	200	Also, printer and class names are <i>not</i> case-sensitive.
	201	Finally, the CUPS version of <i>lpadmin</i> may ask the user for
	202	an access password depending on the printing system
	203	configuration. This differs from the System V version which
	204	requires the root user to execute this command.
	205	<h2 class="title"><a name="LIMITATIONS">Limitations</a></h2>
	206	The CUPS version of <i>lpadmin</i> does not support all of the
	207	System V or Solaris printing system configuration options.
	208	<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
c277f98c MS	209	<i>cupsaccept(8)</i>, <i>cupsenable(8)</i>, <i>lpinfo(8)</i>,
c277f98c MS	210	<i>lpoptions(1)</i>,
94436c5a	211	<br>
c277f98c	212	<a href="http://localhost:631/help">http://localhost:631/help</a>
94436c5a MS	213	<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
	214	Copyright 2007-2013 by Apple Inc.
	215
	216	</body>
	217	</html>