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

<!DOCTYPE HTML>
<html>
<!-- SECTION: Man Pages -->
<head>
	<link rel="stylesheet" type="text/css" href="../cups-printable.css">
	<title>lpstat(1)</title>
</head>
<body>
<h1 class="title">lpstat(1)</h1>
<h2 class="title"><a name="NAME">Name</a></h2>
lpstat - print cups status information
<h2 class="title"><a name="SYNOPSIS">Synopsis</a></h2>
<b>lpstat</b>
[ -E ] [ -H ] [ -U
<i>username</i>
] [ -h
<i>hostname[:port]</i>
] [ -l ] [ -W
<i>which-jobs</i>
] [ -a [
<i>destination(s)</i>
] ] [ -c [
<i>class(es)</i>
] ] [ -d ] [ -o [
<i>destination(s)</i>
] ] [ -p [
<i>printer(s)</i>
] ] [ -r ] [ -R ] [ -s ] [ -t ] [ -u [
<i>user(s)</i>
] ] [ -v [
<i>printer(s)</i>
] ]
<h2 class="title"><a name="DESCRIPTION">Description</a></h2>
<i>lpstat</i> displays status information about the current
classes, jobs, and printers. When run with no arguments,
<i>lpstat</i> will list jobs queued by the current user.
<h2 class="title"><a name="OPTIONS">Options</a></h2>
The <i>lpstat</i> command supports the following options:
<p style="margin-left: 5.0em; text-indent: -5.0em">-E
<br>
<br>
Forces encryption when connecting to the server.
<p style="margin-left: 5.0em; text-indent: -5.0em">-H
<br>
<br>
Shows the server hostname and port.
<p style="margin-left: 5.0em; text-indent: -5.0em">-R
<br>
<br>
Shows the ranking of print jobs.
<p style="margin-left: 5.0em; text-indent: -5.0em">-U username
<br>
<br>
Specifies an alternate username.
<p style="margin-left: 5.0em; text-indent: -5.0em">-W which-jobs
<br>
<br>
Specifies which jobs to show, <i>completed</i> or
<i>not-completed</i> (the default). This option <i>must</i> appear
before the <i>-o</i> option and/or any printer names, otherwise
the default (not-completed) value will be used in the request to
the scheduler.
<p style="margin-left: 5.0em; text-indent: -5.0em">-a [printer(s)]
<br>
<br>
Shows the accepting state of printer queues. If no printers are
specified then all printers are listed.
<p style="margin-left: 5.0em; text-indent: -5.0em">-c [class(es)]
<br>
<br>
Shows the printer classes and the printers that belong to them.
If no classes are specified then all classes are listed.
<p style="margin-left: 5.0em; text-indent: -5.0em">-d
<br>
<br>
Shows the current default destination.
<p style="margin-left: 5.0em; text-indent: -5.0em">-h server[:port]
<br>
<br>
Specifies an alternate server.
<p style="margin-left: 5.0em; text-indent: -5.0em">-l
<br>
<br>
Shows a long listing of printers, classes, or jobs.
<p style="margin-left: 5.0em; text-indent: -5.0em">-o [destination(s)]
<br>
<br>
Shows the jobs queue on the specified destinations. If no destinations are
specified all jobs are shown.
<p style="margin-left: 5.0em; text-indent: -5.0em">-p [printer(s)]
<br>
<br>
Shows the printers and whether or not they are enabled for printing. If
no printers are specified then all printers are listed.
<p style="margin-left: 5.0em; text-indent: -5.0em">-r
<br>
<br>
Shows whether the CUPS server is running.
<p style="margin-left: 5.0em; text-indent: -5.0em">-s
<br>
<br>
Shows a status summary, including the default destination, a
list of classes and their member printers, and a list of printers and
their associated devices. This is equivalent to using the "-d", "-c",
and "-v" options.
<p style="margin-left: 5.0em; text-indent: -5.0em">-t
<br>
<br>
Shows all status information. This is equivalent to using the "-r",
"-d", "-c", "-v", "-a", "-p", and "-o" options.
<p style="margin-left: 5.0em; text-indent: -5.0em">-u [user(s)]
<br>
<br>
Shows a list of print jobs queued by the specified users. If no users
are specified, lists the jobs queued by the current user.
<p style="margin-left: 5.0em; text-indent: -5.0em">-v [printer(s)]
<br>
<br>
Shows the printers and what device they are attached to. If no printers
are specified then all printers are listed.
<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, "/", and "#".
Also, printer and class names are <i>not</i> case-sensitive.
<p>The "-h", "-E", "-U", and "-W" options are unique to CUPS.
<p>The Solaris "-f", "-P", and "-S" options are silently ignored.
<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
<i>cancel(1)</i>, <i>lp(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
	1	<!DOCTYPE HTML>
	2	<html>
	3	<!-- SECTION: Man Pages -->
	4	<head>
	5	<link rel="stylesheet" type="text/css" href="../cups-printable.css">
	6	<title>lpstat(1)</title>
	7	</head>
	8	<body>
	9	<h1 class="title">lpstat(1)</h1>
	10	<h2 class="title"><a name="NAME">Name</a></h2>
	11	lpstat - print cups status information
	12	<h2 class="title"><a name="SYNOPSIS">Synopsis</a></h2>
	13	<b>lpstat</b>
	14	[ -E ] [ -H ] [ -U
	15	<i>username</i>
	16	] [ -h
	17	<i>hostname[:port]</i>
	18	] [ -l ] [ -W
	19	<i>which-jobs</i>
	20	] [ -a [
	21	<i>destination(s)</i>
	22	] ] [ -c [
	23	<i>class(es)</i>
	24	] ] [ -d ] [ -o [
	25	<i>destination(s)</i>
	26	] ] [ -p [
	27	<i>printer(s)</i>
	28	] ] [ -r ] [ -R ] [ -s ] [ -t ] [ -u [
	29	<i>user(s)</i>
	30	] ] [ -v [
	31	<i>printer(s)</i>
	32	] ]
	33	<h2 class="title"><a name="DESCRIPTION">Description</a></h2>
	34	<i>lpstat</i> displays status information about the current
	35	classes, jobs, and printers. When run with no arguments,
	36	<i>lpstat</i> will list jobs queued by the current user.
	37	<h2 class="title"><a name="OPTIONS">Options</a></h2>
	38	The <i>lpstat</i> command supports the following options:
	39	<p style="margin-left: 5.0em; text-indent: -5.0em">-E
	40	<br>
	41	<br>
	42	Forces encryption when connecting to the server.
	43	<p style="margin-left: 5.0em; text-indent: -5.0em">-H
	44	<br>
	45	<br>
	46	Shows the server hostname and port.
	47	<p style="margin-left: 5.0em; text-indent: -5.0em">-R
	48	<br>
	49	<br>
	50	Shows the ranking of print jobs.
	51	<p style="margin-left: 5.0em; text-indent: -5.0em">-U username
	52	<br>
	53	<br>
	54	Specifies an alternate username.
	55	<p style="margin-left: 5.0em; text-indent: -5.0em">-W which-jobs
	56	<br>
	57	<br>
	58	Specifies which jobs to show, <i>completed</i> or
	59	<i>not-completed</i> (the default). This option <i>must</i> appear
	60	before the <i>-o</i> option and/or any printer names, otherwise
	61	the default (not-completed) value will be used in the request to
	62	the scheduler.
	63	<p style="margin-left: 5.0em; text-indent: -5.0em">-a [printer(s)]
	64	<br>
	65	<br>
	66	Shows the accepting state of printer queues. If no printers are
	67	specified then all printers are listed.
	68	<p style="margin-left: 5.0em; text-indent: -5.0em">-c [class(es)]
	69	<br>
	70	<br>
	71	Shows the printer classes and the printers that belong to them.
	72	If no classes are specified then all classes are listed.
	73	<p style="margin-left: 5.0em; text-indent: -5.0em">-d
	74	<br>
	75	<br>
	76	Shows the current default destination.
	77	<p style="margin-left: 5.0em; text-indent: -5.0em">-h server[:port]
	78	<br>
	79	<br>
	80	Specifies an alternate server.
	81	<p style="margin-left: 5.0em; text-indent: -5.0em">-l
	82	<br>
	83	<br>
	84	Shows a long listing of printers, classes, or jobs.
	85	<p style="margin-left: 5.0em; text-indent: -5.0em">-o [destination(s)]
	86	<br>
	87	<br>
	88	Shows the jobs queue on the specified destinations. If no destinations are
	89	specified all jobs are shown.
	90	<p style="margin-left: 5.0em; text-indent: -5.0em">-p [printer(s)]
	91	<br>
	92	<br>
	93	Shows the printers and whether or not they are enabled for printing. If
	94	no printers are specified then all printers are listed.
	95	<p style="margin-left: 5.0em; text-indent: -5.0em">-r
	96	<br>
	97	<br>
	98	Shows whether the CUPS server is running.
	99	<p style="margin-left: 5.0em; text-indent: -5.0em">-s
	100	<br>
	101	<br>
	102	Shows a status summary, including the default destination, a
	103	list of classes and their member printers, and a list of printers and
	104	their associated devices. This is equivalent to using the "-d", "-c",
	105	and "-v" options.
	106	<p style="margin-left: 5.0em; text-indent: -5.0em">-t
	107	<br>
	108	<br>
	109	Shows all status information. This is equivalent to using the "-r",
	110	"-d", "-c", "-v", "-a", "-p", and "-o" options.
	111	<p style="margin-left: 5.0em; text-indent: -5.0em">-u [user(s)]
	112	<br>
	113	<br>
	114	Shows a list of print jobs queued by the specified users. If no users
	115	are specified, lists the jobs queued by the current user.
	116	<p style="margin-left: 5.0em; text-indent: -5.0em">-v [printer(s)]
	117	<br>
	118	<br>
	119	Shows the printers and what device they are attached to. If no printers
	120	are specified then all printers are listed.
	121	<h2 class="title"><a name="COMPATIBILITY">Compatibility</a></h2>
	122	Unlike the System V printing system, CUPS allows printer names to
	123	contain any printable character except SPACE, TAB, "/", and "#".
	124	Also, printer and class names are <i>not</i> case-sensitive.
	125	<p>The "-h", "-E", "-U", and "-W" options are unique to CUPS.
	126	<p>The Solaris "-f", "-P", and "-S" options are silently ignored.
	127	<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
	128	<i>cancel(1)</i>, <i>lp(1)</i>,
	129	<br>
	130	<a href="http://localhost:631/help">http://localhost:631/help</a>
	131	<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
	132	Copyright 2007-2013 by Apple Inc.
	133
	134	</body>
	135	</html>