]> git.ipfire.org Git - thirdparty/cups.git/blob - doc/help/man-lpstat.html
Save work.
[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 [ -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 <dl class="man">
40 <dt>-E
41 <dd style="margin-left: 5.0em"><br>
42 Forces encryption when connecting to the server.
43 <dt>-H
44 <dd style="margin-left: 5.0em"><br>
45 Shows the server hostname and port.
46 <dt>-R
47 <dd style="margin-left: 5.0em"><br>
48 Shows the ranking of print jobs.
49 <dt>-U username
50 <dd style="margin-left: 5.0em"><br>
51 Specifies an alternate username.
52 <dt>-W which-jobs
53 <dd style="margin-left: 5.0em"><br>
54 Specifies which jobs to show, <i>completed</i> or
55 <i>not-completed</i> (the default). This option <i>must</i> appear
56 before the <i>-o</i> option and/or any printer names, otherwise
57 the default (not-completed) value will be used in the request to
58 the scheduler.
59 <dt>-a [printer(s)]
60 <dd style="margin-left: 5.0em"><br>
61 Shows the accepting state of printer queues. If no printers are
62 specified then all printers are listed.
63 <dt>-c [class(es)]
64 <dd style="margin-left: 5.0em"><br>
65 Shows the printer classes and the printers that belong to them.
66 If no classes are specified then all classes are listed.
67 <dt>-d
68 <dd style="margin-left: 5.0em"><br>
69 Shows the current default destination.
70 <dt>-h server[:port]
71 <dd style="margin-left: 5.0em"><br>
72 Specifies an alternate server.
73 <dt>-l
74 <dd style="margin-left: 5.0em"><br>
75 Shows a long listing of printers, classes, or jobs.
76 <dt>-o [destination(s)]
77 <dd style="margin-left: 5.0em"><br>
78 Shows the jobs queue on the specified destinations. If no destinations are
79 specified all jobs are shown.
80 <dt>-p [printer(s)]
81 <dd style="margin-left: 5.0em"><br>
82 Shows the printers and whether or not they are enabled for printing. If
83 no printers are specified then all printers are listed.
84 <dt>-r
85 <dd style="margin-left: 5.0em"><br>
86 Shows whether the CUPS server is running.
87 <dt>-s
88 <dd style="margin-left: 5.0em"><br>
89 Shows a status summary, including the default destination, a
90 list of classes and their member printers, and a list of printers and
91 their associated devices. This is equivalent to using the "-d", "-c",
92 and "-v" options.
93 <dt>-t
94 <dd style="margin-left: 5.0em"><br>
95 Shows all status information. This is equivalent to using the "-r",
96 "-d", "-c", "-v", "-a", "-p", and "-o" options.
97 <dt>-u [user(s)]
98 <dd style="margin-left: 5.0em"><br>
99 Shows a list of print jobs queued by the specified users. If no users
100 are specified, lists the jobs queued by the current user.
101 <dt>-v [printer(s)]
102 <dd style="margin-left: 5.0em"><br>
103 Shows the printers and what device they are attached to. If no printers
104 are specified then all printers are listed.
105 </dl>
106 <h2 class="title"><a name="COMPATIBILITY">Compatibility</a></h2>
107 Unlike the System V printing system, CUPS allows printer names to
108 contain any printable character except SPACE, TAB, "/", and "#".
109 Also, printer and class names are <i>not</i> case-sensitive.
110 <p>The "-h", "-E", "-U", and "-W" options are unique to CUPS.
111 <p>The Solaris "-f", "-P", and "-S" options are silently ignored.
112 <h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
113 <i>cancel(1)</i>, <i>lp(1)</i>,
114 <br>
115 <a href="http://localhost:631/help">http://localhost:631/help</a>
116 <h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
117 Copyright 2007-2013 by Apple Inc.
118
119 </body>
120 </html>