| blob | f8938c2846de01776a801ab953f39e92c9dbc8e7 |
1 '\" te
2 .\" Copyright 1989 AT&T
3 .\" Copyright (C) 2009, Sun Microsystems, Inc. All Rights Reserved
4 .\" Portions Copyright (c) 1992, X/Open Company Limited All Rights Reserved
5 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at http://www.opengroup.org/bookstore/.
6 .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text
7 .\" are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical
8 .\" and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html.
9 .\" This notice shall appear on any product containing this material.
10 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.
11 .\" See the License for the specific language governing permissions and limitations under the License. When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with
12 .\" the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
13 .TH LPSTAT 1 "Feb 25, 2017"
14 .SH NAME
15 lpstat \- print information about the status of the print service
16 .SH SYNOPSIS
17 .LP
18 .nf
19 \fBlpstat\fR [\fB-d\fR] [\fB-r\fR] [\fB-R\fR] [\fB-s\fR] [\fB-t\fR] [\fB-a\fR [\fIlist\fR]] [\fB-c\fR [\fIlist\fR]]
20 [\fB-f\fR [\fIlist\fR]] [\fB-o\fR [\fIlist\fR]] [\fB-p\fR [\fIlist\fR] [\fB-D\fR]] [\fB-S\fR [\fIlist\fR]]
21 [\fB-u\fR [\fIlogin-\fR \fIID\fR \fI-list\fR]] [\fB-v\fR [\fIlist\fR]] [\fB-l\fR \fIlevel\fR]
22 .fi
24 .SH DESCRIPTION
25 .LP
26 The \fBlpstat\fR utility displays information about the current status of the
27 \fBLP\fR print service to standard output.
28 .sp
29 .LP
30 If no options are given, \fBlpstat\fR prints the status of all the user's print
31 requests made by \fBlp\fR. See \fBlp\fR(1). Any arguments that are not
32 \fIoptions\fR are assumed to be \fIrequest-IDs\fR as returned by \fBlp\fR. The
33 \fBlpstat\fR command prints the status of such requests. \fIoptions\fR appears
34 in any order and can be repeated and intermixed with other arguments. Some key
35 letters can be followed by an optional \fIlist\fR that can be in one of two
36 forms: a list of items separated from one another by a comma, or a list of
37 items separated from one another by spaces enclosed in quotes. For example:
38 .sp
39 .in +2
40 .nf
41 example% \fBlpstat -u "user1 user2 user3"\fR
42 .fi
43 .in -2
44 .sp
46 .sp
47 .LP
48 Specifying \fBall\fR after any key letter that takes \fIlist\fR as an argument
49 causes all information relevant to the key letter to be printed. For example,
50 the command:
51 .sp
52 .in +2
53 .nf
54 example% \fBlpstat -o all\fR
55 .fi
56 .in -2
57 .sp
59 .sp
60 .LP
61 prints the status of all output requests.
62 .sp
63 .LP
64 The omission of a \fIlist\fR following such key letters causes all information
65 relevant to the key letter to be printed. For example, the command:
66 .sp
67 .in +2
68 .nf
69 example% \fBlpstat -o\fR
70 .fi
71 .in -2
72 .sp
74 .sp
75 .LP
76 prints the status of all output requests.
77 .sp
78 .LP
79 The print client commands locate destination information using the "printers"
80 database in the name service switch. See \fBnsswitch.conf\fR(4),
81 \fBprinters\fR(4), and \fBprinters.conf\fR(4) for details.
82 .SH OPTIONS
83 .LP
84 The following options are supported:
85 .sp
86 .ne 2
87 .na
88 \fB\fB-a\fR [\fIlist\fR]\fR
89 .ad
90 .RS 22n
91 Reports whether print destinations are accepting requests. \fIlist\fR is a list
92 of intermixed printer names and class names.
93 .sp
94 If the print queue is remote and IPP is in use, the information provided is
95 very close to that reported for local queues. If the print queue is remote and
96 IPP is not in use (the print server is older than Solaris 9, Update 6 or
97 another RFC-1179-based print service), this option does not report any useful
98 information.
99 .RE
101 .sp
102 .ne 2
103 .na
104 \fB\fB-c\fR [\fIlist\fR]\fR
105 .ad
106 .RS 22n
107 Prints name of all classes and their members. \fIlist\fR is a list of class
108 names.
109 .sp
110 If the print queue is remote and IPP is in use, the information provided is
111 very close to that reported for local queues. If the print queue is remote and
112 IPP is not in use (the print server is older than Solaris 9, Update 6 or
113 another RFC-1179-based print service), this option does not report any useful
114 information.
115 .RE
117 .sp
118 .ne 2
119 .na
120 \fB\fB-d\fR\fR
121 .ad
122 .RS 22n
123 Prints the default destination for output requests.
124 .RE
126 .sp
127 .ne 2
128 .na
129 \fB\fB\fR\fB-f\fR[\fIlist\fR] [\fB-l\fR]\fR
130 .ad
131 .RS 22n
132 Prints a verification that the forms in \fIlist\fR are recognized by the
133 \fBLP\fR print service. \fIlist\fR is a list of forms; the default is
134 \fBall\fR. The \fB-l\fR option lists the form descriptions.
135 .sp
136 If the print queue is remote and IPP is in use, the information provided is
137 very close to that reported for local queues. If the print queue is remote and
138 IPP is not in use (the print server is older than Solaris 9, Update 6 or
139 another RFC-1179-based print service), this option does not report any useful
140 information.
141 .RE
143 .sp
144 .ne 2
145 .na
146 \fB\fB-l\fR [\fIlevel\fR]\fR
147 .ad
148 .RS 22n
149 Specifies the verbosity level for extended reporting of printer or job objects
150 (\fB-o\fR, \fB-p\fR, \fB-r\fR, \fB-u\fR). Without this option, a level of
151 \fB0\fR is used, which reports summary information. When no level is specified,
152 a level of \fB1\fRis used, which provides more information about the object. A
153 level of \fB2\fR or more enumerates all of the object's attributes.
154 .sp
155 If the print queue is remote and IPP is in use, the information provided is
156 very close to that reported for local queues. If the print queue is remote and
157 IPP is not in use (the print server is older than Solaris 9, Update 6 or
158 another RFC-1179-based print service), this option does not report any useful
159 information.
160 .RE
162 .sp
163 .ne 2
164 .na
165 \fB\fB-o\fR [\fIlist\fR]\fR
166 .ad
167 .RS 22n
168 Prints the status of output requests. \fIlist\fR is a list of intermixed
169 printer names, class names, and request-IDs. The key letter \fB-o\fR can be
170 omitted.
171 .sp
172 Specify printer and class names using atomic, URI-style (scheme://endpoint), or
173 POSIX-style (\fIserver\fR\fB:\fR\fIdestination\fR) names. See
174 \fBprinters.conf\fR(4) for more information.
175 .RE
177 .sp
178 .ne 2
179 .na
180 \fB\fB-p\fR [\fIlist\fR] [\fB-D\fR]\fR
181 .ad
182 .RS 22n
183 Prints the status of printers. \fIlist\fR is a list of printer names. If the
184 \fB-D\fR option is given, a brief description is printed for each printer in
185 \fIlist\fR. If the \fB-l\fR option is given and the printer is on the local
186 machine, a full description of each printer's configuration is returned,
187 including the form mounted, the acceptable content and printer types, a printer
188 description, and the interface used.
189 .sp
190 If the print queue is remote and IPP is in use, correct job id is reported. If
191 the print queue is remote and IPP is not in use (the print server is older than
192 Solaris 9, Update 6 or another RFC-1179-based print service), \fB-p
193 [\fIlist\fR]\fR always reports the first job in the queue irrespective of its
194 status.
195 .RE
197 .sp
198 .ne 2
199 .na
200 \fB\fB-r\fR\fR
201 .ad
202 .RS 22n
203 Prints the status of the \fBLP\fR request scheduler.
204 .RE
206 .sp
207 .ne 2
208 .na
209 \fB\fB-R\fR\fR
210 .ad
211 .RS 22n
212 Prints a number showing the position of each request in the print queue.
213 .RE
215 .sp
216 .ne 2
217 .na
218 \fB\fB-s\fR\fR
219 .ad
220 .RS 22n
221 Prints a status summary, including the status of the \fBLP\fR scheduler, the
222 default destination, a list of printers and their associated devices, a list of
223 the machines sharing print services, a list of all forms currently mounted, and
224 a list of all recognized character sets and print wheels.
225 .RE
227 .sp
228 .ne 2
229 .na
230 \fB\fB-S\fR [\fIlist\fR]\fR
231 .ad
232 .RS 22n
233 Prints a verification that the character sets or the print wheels specified in
234 \fIlist\fR are recognized by the \fBLP\fR print service. Items in \fIlist\fR
235 can be character sets or print wheels; the default for the list is \fBall\fR.
236 If the \fB-l\fR option is given, each line is appended by a list of printers
237 that can handle the print wheel or character set. The list also shows whether
238 the print wheel or character set is mounted, or specifies the built-in
239 character set into which it maps.
240 .sp
241 If the print queue is remote and IPP is in use, the information provided is
242 very close to that reported for local queues. If the print queue is remote and
243 IPP is not in use (the print server is older than Solaris 9, Update 6 or
244 another RFC-1179-based print service), this option does not report any useful
245 information.
246 .RE
248 .sp
249 .ne 2
250 .na
251 \fB\fB-t\fR\fR
252 .ad
253 .RS 22n
254 Prints all status information. This includes all the information obtained with
255 the \fB-s\fR option, plus the acceptance and idle/busy status of all printers.
256 .RE
258 .sp
259 .ne 2
260 .na
261 \fB\fB-u\fR [\fIlogin-ID-list\fR]\fR
262 .ad
263 .RS 22n
264 Prints the status of output requests for users. The \fIlogin-ID-list\fR
265 argument can include any or all of the following constructs:
266 .sp
267 .ne 2
268 .na
269 \fB\fIlogin-ID\fR\fR
270 .ad
271 .RS 24n
272 a user on any system
273 .RE
275 .sp
276 .ne 2
277 .na
278 \fB\fIsystem_name\fR\fB!\fR\fIlogin-ID\fR\fR
279 .ad
280 .RS 24n
281 a user on system \fIsystem_name\fR
282 .RE
284 .sp
285 .ne 2
286 .na
287 \fB\fIsystem_name\fR\fB!all\fR\fR
288 .ad
289 .RS 24n
290 all users on system \fIsystem_name\fR
291 .RE
293 .sp
294 .ne 2
295 .na
296 \fB\fBall!\fR\fIlogin-ID\fR\fR
297 .ad
298 .RS 24n
299 a user on all systems
300 .RE
302 .sp
303 .ne 2
304 .na
305 \fB\fBall\fR\fR
306 .ad
307 .RS 24n
308 all users on all systems
309 .RE
311 .RE
313 .sp
314 .ne 2
315 .na
316 \fB\fB-v\fR [\fIlist\fR]\fR
317 .ad
318 .RS 22n
319 Prints the names of printers and the path names of the devices associated with
320 them or remote system names for network printers. \fIlist\fR is a list of
321 printer names.
322 .RE
324 .SH EXIT STATUS
325 .LP
326 The following exit values are returned:
327 .sp
328 .ne 2
329 .na
330 \fB\fB0\fR\fR
331 .ad
332 .RS 12n
333 Successful completion.
334 .RE
336 .sp
337 .ne 2
338 .na
339 \fBnon-zero\fR
340 .ad
341 .RS 12n
342 An error occurred.
343 .RE
345 .SH FILES
346 .ne 2
347 .na
348 \fB\fB/etc/printers.conf\fR\fR
349 .ad
350 .RS 24n
351 System printer configuration database
352 .RE
354 .sp
355 .ne 2
356 .na
357 \fB\fB$HOME/.printers\fR\fR
358 .ad
359 .RS 24n
360 User-configurable printer database
361 .RE
363 .sp
364 .ne 2
365 .na
366 \fB\fBou=printers\fR\fR
367 .ad
368 .RS 24n
369 LDAP version of \fB/etc/printers.conf\fR
370 .RE
372 .sp
373 .ne 2
374 .na
375 \fB\fBprinters.conf.byname\fR\fR
376 .ad
377 .RS 24n
378 \fBNIS\fR version of \fB/etc/printers.conf\fR
379 .RE
381 .SH ATTRIBUTES
382 .LP
383 See \fBattributes\fR(5) for descriptions of the following attributes:
384 .sp
386 .sp
387 .TS
388 box;
389 c | c
390 l | l .
391 ATTRIBUTE TYPE ATTRIBUTE VALUE
392 _
393 Interface Stability Standard
394 .TE
396 .SH SEE ALSO
397 .LP
398 \fBcancel\fR(1), \fBlp\fR(1), \fBlpq\fR(1B), \fBlpr\fR(1B), \fBlprm\fR(1B),
399 \fBnsswitch.conf\fR(4), \fBprinters\fR(4), \fBprinters.conf\fR(4),
400 \fBattributes\fR(5), \fBstandards\fR(5)
401 .SH NOTES
402 .LP
403 For remote print queues, the BSD print protocol provides a very limited set of
404 information. The Internet Print Protocol (IPP) is preferred.
405 .sp
406 .LP
407 When IPP is in use, the user is prompted for a passphrase if the remote print
408 service is configured to require authentication.