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