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