]> git.ipfire.org Git - thirdparty/cups.git/blob - doc/help/man-lpstat.html
Final sync-up with cups.org trunk repository
[thirdparty/cups.git] / doc / help / man-lpstat.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
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
14 </b>[ -E ] [ -H ] [ -U
15 <i>username
16 </i>] [ -h
17 <i>hostname[:port]
18 </i>] [ -l ] [ -W
19 <i>which-jobs
20 </i>] [ -a [
21 <i>destination(s)
22 </i>] ] [ -c [
23 <i>class(es)
24 </i>] ] [ -d ] [ -o [
25 <i>destination(s)
26 </i>] ] [ -p [
27 <i>printer(s)
28 </i>] ] [ -r ] [ -R ] [ -s ] [ -t ] [ -u [
29 <i>user(s)
30 </i>] ] [ -v [
31 <i>printer(s)
32 </i>] ]
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 <dl>
40 <dt>-E
41 </dt>
42 <dd></dd>
43 <dd>Forces encryption when connecting to the server.
44 </dd>
45 <dt>-H
46 </dt>
47 <dd></dd>
48 <dd>Shows the server hostname and port.
49 </dd>
50 <dt>-R
51 </dt>
52 <dd></dd>
53 <dd>Shows the ranking of print jobs.
54 </dd>
55 <dt>-U username
56 </dt>
57 <dd></dd>
58 <dd>Specifies an alternate username.
59 </dd>
60 <dt>-W which-jobs
61 </dt>
62 <dd></dd>
63 <dd>Specifies which jobs to show, <i>completed</i> or
64 <i>not-completed</i> (the default). This option <i>must</i> appear
65 before the <i>-o</i> option and/or any printer names, otherwise
66 the default (not-completed) value will be used in the request to
67 the scheduler.
68 </dd>
69 <dt>-a [printer(s)]
70 </dt>
71 <dd></dd>
72 <dd>Shows the accepting state of printer queues. If no printers are
73 specified then all printers are listed.
74 </dd>
75 <dt>-c [class(es)]
76 </dt>
77 <dd></dd>
78 <dd>Shows the printer classes and the printers that belong to them.
79 If no classes are specified then all classes are listed.
80 </dd>
81 <dt>-d
82 </dt>
83 <dd></dd>
84 <dd>Shows the current default destination.
85 </dd>
86 <dt>-h server[:port]
87 </dt>
88 <dd></dd>
89 <dd>Specifies an alternate server.
90 </dd>
91 <dt>-l
92 </dt>
93 <dd></dd>
94 <dd>Shows a long listing of printers, classes, or jobs.
95 </dd>
96 <dt>-o [destination(s)]
97 </dt>
98 <dd></dd>
99 <dd>Shows the jobs queue on the specified destinations. If no destinations are
100 specified all jobs are shown.
101 </dd>
102 <dt>-p [printer(s)]
103 </dt>
104 <dd></dd>
105 <dd>Shows the printers and whether or not they are enabled for printing. If
106 no printers are specified then all printers are listed.
107 </dd>
108 <dt>-r
109 </dt>
110 <dd></dd>
111 <dd>Shows whether the CUPS server is running.
112 </dd>
113 <dt>-s
114 </dt>
115 <dd></dd>
116 <dd>Shows a status summary, including the default destination, a
117 list of classes and their member printers, and a list of printers and
118 their associated devices. This is equivalent to using the "-d", "-c",
119 and "-v" options.
120 </dd>
121 <dt>-t
122 </dt>
123 <dd></dd>
124 <dd>Shows all status information. This is equivalent to using the "-r",
125 "-d", "-c", "-v", "-a", "-p", and "-o" options.
126 </dd>
127 <dt>-u [user(s)]
128 </dt>
129 <dd></dd>
130 <dd>Shows a list of print jobs queued by the specified users. If no users
131 are specified, lists the jobs queued by the current user.
132 </dd>
133 <dt>-v [printer(s)]
134 </dt>
135 <dd></dd>
136 <dd>Shows the printers and what device they are attached to. If no printers
137 are specified then all printers are listed.
138 </dd>
139 </dl>
140 <h2 class="title"><a name="COMPATIBILITY">Compatibility</a></h2>
141 Unlike the System V printing system, CUPS allows printer names to
142 contain any printable character except SPACE, TAB, "/", and "#".
143 Also, printer and class names are <i>not</i> case-sensitive.
144 <p>The "-h", "-E", "-U", and "-W" options are unique to CUPS.
145 <p>The Solaris "-f", "-P", and "-S" options are silently ignored.
146 <h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
147 <a href='man-cancel.html?TOPIC=Man+Pages'>cancel(1)</a>, <a href='man-lp.html?TOPIC=Man+Pages'>lp(1)</a>,
148 <br>
149 <a href='http://localhost:631/help'>http://localhost:631/help</a>
150 <h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
151 Copyright 2007-2013 by Apple Inc.
152
153 </body>
154 </html>