0b5c00b37c11045c1bfdaad986658d3965975b9a
[thirdparty/cups.git] / man / lpstat.1
1 .\"
2 .\" lpstat man page for CUPS.
3 .\"
4 .\" Copyright 2007-2019 by Apple Inc.
5 .\" Copyright 1997-2006 by Easy Software Products.
6 .\"
7 .\" Licensed under Apache License v2.0.  See the file "LICENSE" for more information.
8 .\"
9 .TH lpstat 1 "CUPS" "26 April 2019" "Apple Inc."
10 .SH NAME
11 lpstat \- print cups status information
12 .SH SYNOPSIS
13 .B lpstat
14 [
15 .B \-E
16 ] [
17 .B \-H
18 ] [
19 .B \-U
20 .I username
21 ] [
22 \fB\-h \fIhostname\fR[\fB:\fIport\fR]
23 ] [
24 .B \-l
25 ] [
26 .B \-W
27 .I which-jobs
28 ] [
29 .B \-a
30 [
31 .I destination(s)
32 ] ] [
33 .B \-c
34 [
35 .I class(es)
36 ] ] [
37 .B \-d
38 ] [
39 .B \-e
40 ] [
41 .B \-o
42 [
43 .I destination(s)
44 ] ] [
45 .B \-p
46 [
47 .I printer(s)
48 ] ] [
49 .B \-r
50 ] [
51 .B \-R
52 ] [
53 .B \-s
54 ] [
55 .B \-t
56 ] [
57 .B \-u
58 [
59 .I user(s)
60 ] ] [
61 .B \-v
62 [
63 .I printer(s)
64 ] ]
65 .SH DESCRIPTION
66 \fBlpstat\fR displays status information about the current classes, jobs, and printers.
67 When run with no arguments, \fBlpstat\fR will list active jobs queued by the current user.
68 .SH OPTIONS
69 The \fBlpstat\fR command supports the following options:
70 .TP 5
71 .B \-E
72 Forces encryption when connecting to the server.
73 .TP 5
74 .B \-H
75 Shows the server hostname and port.
76 .TP 5
77 .B \-R
78 Shows the ranking of print jobs.
79 .TP 5
80 \fB\-U \fIusername\fR
81 Specifies an alternate username.
82 .TP 5
83 \fB\-W \fIwhich-jobs\fR
84 Specifies which jobs to show, "completed" or "not-completed" (the default).
85 This option \fImust\fR appear before the \fI-o\fR option and/or any printer names, otherwise the default ("not-completed") value will be used in the request to the scheduler.
86 .TP 5
87 \fB\-a \fR[\fIprinter(s)\fR]
88 Shows the accepting state of printer queues.
89 If no printers are specified then all printers are listed.
90 .TP 5
91 \fB\-c \fR[\fIclass(es)\fR]
92 Shows the printer classes and the printers that belong to them.
93 If no classes are specified then all classes are listed.
94 .TP 5
95 .B \-d
96 Shows the current default destination.
97 .TP 5
98 .B \-e
99 Shows all available destinations on the local network.
100 .TP 5
101 \fB\-h \fIserver\fR[\fB:\fIport\fR]
102 Specifies an alternate server.
103 .TP 5
104 .B \-l
105 Shows a long listing of printers, classes, or jobs.
106 .TP 5
107 \fB\-o \fR[\fIdestination(s)\fR]
108 Shows the jobs queued on the specified destinations.
109 If no destinations are specified all jobs are shown.
110 .TP 5
111 \fB\-p \fR[\fIprinter(s)\fR]
112 Shows the printers and whether they are enabled for printing.
113 If no printers are specified then all printers are listed.
114 .TP 5
115 .B \-r
116 Shows whether the CUPS server is running.
117 .TP 5
118 .B \-s
119 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.
120 This is equivalent to using the \fI\-d\fR, \fI\-c\fR, and \fI\-v\fR options.
121 .TP 5
122 .B \-t
123 Shows all status information.
124 This is equivalent to using the \fI\-r\fR, \fI\-d\fR, \fI\-c\fR, \fI\-v\fR, \fI\-a\fR, \fI\-p\fR, and \fI\-o\fR options.
125 .TP 5
126 \fB\-u \fR[\fIuser(s)\fR]
127 Shows a list of print jobs queued by the specified users.
128 If no users are specified, lists the jobs queued by the current user.
129 .TP 5
130 \fB\-v \fR[\fIprinter(s)\fR]
131 Shows the printers and what device they are attached to.
132 If no printers are specified then all printers are listed.
133 .SH CONFORMING TO
134 Unlike the System V printing system, CUPS allows printer names to contain any printable character except SPACE, TAB, "/", and "#".
135 Also, printer and class names are \fInot\fR case-sensitive.
136 .LP
137 The \fI\-h\fR, \fI-e\fR, \fI\-E\fR, \fI\-U\fR, and \fI\-W\fR options are unique to CUPS.
138 .LP
139 The Solaris \fI\-f\fR, \fI\-P\fR, and \fI\-S\fR options are silently ignored.
140 .SH SEE ALSO
141 .BR cancel (1),
142 .BR lp (1),
143 .BR lpq (1),
144 .BR lpr (1),
145 .BR lprm (1),
146 CUPS Online Help (http://localhost:631/help)
147 .SH COPYRIGHT
148 Copyright \[co] 2007-2019 by Apple Inc.