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