[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>
[
<b>-E</b>
] [
<b>-H</b>
] [
<b>-U</b>
<i>username</i>
] [
<b>-h </b><i>hostname</i>[<b>:</b><i>port</i>]
] [
<b>-l</b>
] [
<b>-W</b>
<i>which-jobs</i>
] [
<b>-a</b>
[
<i>destination(s)</i>
] ] [
<b>-c</b>
[
<i>class(es)</i>
] ] [
<b>-d</b>
] [
<b>-o</b>
[
<i>destination(s)</i>
] ] [
<b>-p</b>
[
<i>printer(s)</i>
] ] [
<b>-r</b>
] [
<b>-R</b>
] [
<b>-s</b>
] [
<b>-t</b>
] [
<b>-u</b>
[
<i>user(s)</i>
] ] [
<b>-v</b>
[
<i>printer(s)</i>
] ]
<h2 class="title"><a name="DESCRIPTION">Description</a></h2>
<b>lpstat</b> displays status information about the current classes, jobs, and printers.
When run with no arguments, <b>lpstat</b> will list active jobs queued by the current user.
<h2 class="title"><a name="OPTIONS">Options</a></h2>
The <b>lpstat</b> command supports the following options:
<dl class="man">
<dt><b>-E</b>
<dd style="margin-left: 5.0em">Forces encryption when connecting to the server.
<dt><b>-H</b>
<dd style="margin-left: 5.0em">Shows the server hostname and port.
<dt><b>-R</b>
<dd style="margin-left: 5.0em">Shows the ranking of print jobs.
<dt><b>-U </b><i>username</i>
<dd style="margin-left: 5.0em">Specifies an alternate username.
<dt><b>-W </b><i>which-jobs</i>
<dd style="margin-left: 5.0em">Specifies which jobs to show, "completed" or "not-completed" (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.
<dt><b>-a </b>[<i>printer(s)</i>]
<dd style="margin-left: 5.0em">Shows the accepting state of printer queues.
If no printers are specified then all printers are listed.
<dt><b>-c </b>[<i>class(es)</i>]
<dd style="margin-left: 5.0em">Shows the printer classes and the printers that belong to them.
If no classes are specified then all classes are listed.
<dt><b>-d</b>
<dd style="margin-left: 5.0em">Shows the current default destination.
<dt><b>-h </b><i>server</i>[<b>:</b><i>port</i>]
<dd style="margin-left: 5.0em">Specifies an alternate server.
<dt><b>-l</b>
<dd style="margin-left: 5.0em">Shows a long listing of printers, classes, or jobs.
<dt><b>-o </b>[<i>destination(s)</i>]
<dd style="margin-left: 5.0em">Shows the jobs queued on the specified destinations.
If no destinations are specified all jobs are shown.
<dt><b>-p </b>[<i>printer(s)</i>]
<dd style="margin-left: 5.0em">Shows the printers and whether they are enabled for printing.
If no printers are specified then all printers are listed.
<dt><b>-r</b>
<dd style="margin-left: 5.0em">Shows whether the CUPS server is running.
<dt><b>-s</b>
<dd style="margin-left: 5.0em">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 <i>-d</i>, <i>-c</i>, and <i>-v</i> options.
<dt><b>-t</b>
<dd style="margin-left: 5.0em">Shows all status information.
This is equivalent to using the <i>-r</i>, <i>-d</i>, <i>-c</i>, <i>-v</i>, <i>-a</i>, <i>-p</i>, and <i>-o</i> options.
<dt><b>-u </b>[<i>user(s)</i>]
<dd style="margin-left: 5.0em">Shows a list of print jobs queued by the specified users.
If no users are specified, lists the jobs queued by the current user.
<dt><b>-v </b>[<i>printer(s)</i>]
<dd style="margin-left: 5.0em">Shows the printers and what device they are attached to.
If no printers are specified then all printers are listed.
</dl>
<h2 class="title"><a name="CONFORMING_TO">Conforming To</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 <i>-h</i>, <i>-E</i>, <i>-U</i>, and <i>-W</i> options are unique to CUPS.
<p>The Solaris <i>-f</i>, <i>-P</i>, and <i>-S</i> options are silently ignored.
<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
<a href="man-cancel.html?TOPIC=Man+Pages"><b>cancel</b>(1),</a>
<a href="man-lp.html?TOPIC=Man+Pages"><b>lp</b>(1),</a>
<a href="man-lpq.html?TOPIC=Man+Pages"><b>lpq</b>(1),</a>
<a href="man-lpr.html?TOPIC=Man+Pages"><b>lpr</b>(1),</a>
<a href="man-lprm.html?TOPIC=Man+Pages"><b>lprm</b>(1),</a>
CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>)
<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
Copyright &copy; 2007-2016 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>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>
c277f98c	13	<b>lpstat</b>
27e0d6f8 MS	14	[
	15	<b>-E</b>
	16	] [
	17	<b>-H</b>
	18	] [
	19	<b>-U</b>
c277f98c	20	<i>username</i>
27e0d6f8 MS	21	] [
	22	<b>-h </b><i>hostname</i>[<b>:</b><i>port</i>]
	23	] [
	24	<b>-l</b>
	25	] [
	26	<b>-W</b>
c277f98c	27	<i>which-jobs</i>
27e0d6f8 MS	28	] [
	29	<b>-a</b>
	30	[
c277f98c	31	<i>destination(s)</i>
27e0d6f8 MS	32	] ] [
	33	<b>-c</b>
	34	[
c277f98c	35	<i>class(es)</i>
27e0d6f8 MS	36	] ] [
	37	<b>-d</b>
	38	] [
	39	<b>-o</b>
	40	[
c277f98c	41	<i>destination(s)</i>
27e0d6f8 MS	42	] ] [
	43	<b>-p</b>
	44	[
c277f98c	45	<i>printer(s)</i>
27e0d6f8 MS	46	] ] [
	47	<b>-r</b>
	48	] [
	49	<b>-R</b>
	50	] [
	51	<b>-s</b>
	52	] [
	53	<b>-t</b>
	54	] [
	55	<b>-u</b>
	56	[
c277f98c	57	<i>user(s)</i>
27e0d6f8 MS	58	] ] [
	59	<b>-v</b>
	60	[
c277f98c MS	61	<i>printer(s)</i>
c277f98c MS	62	] ]
94436c5a	63	<h2 class="title"><a name="DESCRIPTION">Description</a></h2>
27e0d6f8 MS	64	<b>lpstat</b> displays status information about the current classes, jobs, and printers.
27e0d6f8 MS	65	When run with no arguments, <b>lpstat</b> will list active jobs queued by the current user.
94436c5a	66	<h2 class="title"><a name="OPTIONS">Options</a></h2>
27e0d6f8	67	The <b>lpstat</b> command supports the following options:
2909c66c	68	<dl class="man">
27e0d6f8 MS	69	<dt><b>-E</b>
	70	<dd style="margin-left: 5.0em">Forces encryption when connecting to the server.
	71	<dt><b>-H</b>
	72	<dd style="margin-left: 5.0em">Shows the server hostname and port.
	73	<dt><b>-R</b>
	74	<dd style="margin-left: 5.0em">Shows the ranking of print jobs.
	75	<dt><b>-U </b><i>username</i>
	76	<dd style="margin-left: 5.0em">Specifies an alternate username.
	77	<dt><b>-W </b><i>which-jobs</i>
	78	<dd style="margin-left: 5.0em">Specifies which jobs to show, "completed" or "not-completed" (the default).
	79	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.
	80	<dt><b>-a </b>[<i>printer(s)</i>]
	81	<dd style="margin-left: 5.0em">Shows the accepting state of printer queues.
	82	If no printers are specified then all printers are listed.
	83	<dt><b>-c </b>[<i>class(es)</i>]
	84	<dd style="margin-left: 5.0em">Shows the printer classes and the printers that belong to them.
94436c5a	85	If no classes are specified then all classes are listed.
27e0d6f8 MS	86	<dt><b>-d</b>
	87	<dd style="margin-left: 5.0em">Shows the current default destination.
	88	<dt><b>-h </b><i>server</i>[<b>:</b><i>port</i>]
	89	<dd style="margin-left: 5.0em">Specifies an alternate server.
	90	<dt><b>-l</b>
	91	<dd style="margin-left: 5.0em">Shows a long listing of printers, classes, or jobs.
	92	<dt><b>-o </b>[<i>destination(s)</i>]
	93	<dd style="margin-left: 5.0em">Shows the jobs queued on the specified destinations.
	94	If no destinations are specified all jobs are shown.
	95	<dt><b>-p </b>[<i>printer(s)</i>]
	96	<dd style="margin-left: 5.0em">Shows the printers and whether they are enabled for printing.
	97	If no printers are specified then all printers are listed.
	98	<dt><b>-r</b>
	99	<dd style="margin-left: 5.0em">Shows whether the CUPS server is running.
	100	<dt><b>-s</b>
	101	<dd style="margin-left: 5.0em">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.
	102	This is equivalent to using the <i>-d</i>, <i>-c</i>, and <i>-v</i> options.
	103	<dt><b>-t</b>
	104	<dd style="margin-left: 5.0em">Shows all status information.
	105	This is equivalent to using the <i>-r</i>, <i>-d</i>, <i>-c</i>, <i>-v</i>, <i>-a</i>, <i>-p</i>, and <i>-o</i> options.
	106	<dt><b>-u </b>[<i>user(s)</i>]
	107	<dd style="margin-left: 5.0em">Shows a list of print jobs queued by the specified users.
	108	If no users are specified, lists the jobs queued by the current user.
	109	<dt><b>-v </b>[<i>printer(s)</i>]
	110	<dd style="margin-left: 5.0em">Shows the printers and what device they are attached to.
	111	If no printers are specified then all printers are listed.
2909c66c	112	</dl>
27e0d6f8 MS	113	<h2 class="title"><a name="CONFORMING_TO">Conforming To</a></h2>
27e0d6f8 MS	114	Unlike the System V printing system, CUPS allows printer names to contain any printable character except SPACE, TAB, "/", and "#".
94436c5a	115	Also, printer and class names are <i>not</i> case-sensitive.
27e0d6f8 MS	116	<p>The <i>-h</i>, <i>-E</i>, <i>-U</i>, and <i>-W</i> options are unique to CUPS.
27e0d6f8 MS	117	<p>The Solaris <i>-f</i>, <i>-P</i>, and <i>-S</i> options are silently ignored.
94436c5a	118	<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
27e0d6f8 MS	119	<a href="man-cancel.html?TOPIC=Man+Pages"><b>cancel</b>(1),</a>
	120	<a href="man-lp.html?TOPIC=Man+Pages"><b>lp</b>(1),</a>
	121	<a href="man-lpq.html?TOPIC=Man+Pages"><b>lpq</b>(1),</a>
	122	<a href="man-lpr.html?TOPIC=Man+Pages"><b>lpr</b>(1),</a>
	123	<a href="man-lprm.html?TOPIC=Man+Pages"><b>lprm</b>(1),</a>
	124	CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>)
94436c5a	125	<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
d58c2629	126	Copyright © 2007-2016 by Apple Inc.
94436c5a MS	127
	128	</body>
	129	</html>