8322 nl: misleading-indentation
[unleashed/tickless.git] / usr / src / man / man1b / lpq.1b
blobb12197f7ca43ca63d33cd49136b1a4e072e0fd49
1 '\" te
2 .\" Copyright (C) 2006, Sun Microsystems, Inc. All Rights Reserved
3 .\" 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.
4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
5 .\" 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 the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
6 .TH LPQ 1B "Feb 25, 2017"
7 .SH NAME
8 lpq \- display the content of a print queue
9 .SH SYNOPSIS
10 .LP
11 .nf
12 \fB/usr/ucb/lpq\fR [\fB-P\fR \fIdestination\fR] [\fB-l\fR] [+ [\fIinterval\fR]]
13      [\fIrequest-ID\fR...] [\fIuser\fR]...
14 .fi
16 .SH DESCRIPTION
17 .LP
18 The \fBlpq\fR utility displays the information about the contents of a print
19 queue. A print queue is comprised of print requests that are waiting  in the
20 process of being printed.
21 .sp
22 .LP
23 \fBlpq\fR displays the following information to the standard output:
24 .RS +4
25 .TP
26 .ie t \(bu
27 .el o
28 the username of the person associated with a print request,
29 .RE
30 .RS +4
31 .TP
32 .ie t \(bu
33 .el o
34 the position of a print request in the print queue,
35 .RE
36 .RS +4
37 .TP
38 .ie t \(bu
39 .el o
40 the name of file or files comprising a print request,
41 .RE
42 .RS +4
43 .TP
44 .ie t \(bu
45 .el o
46 the job number of a print request, and
47 .RE
48 .RS +4
49 .TP
50 .ie t \(bu
51 .el o
52 the size of the file requested by a print request. File size is reported in
53 bytes.
54 .RE
55 .sp
56 .LP
57 Normally, only as much information as will fit on one line is displayed. If the
58 name of the input file associated with a print request is not available, the
59 input file field indicates the standard input.
60 .sp
61 .LP
62 The print client commands locate destination information using the
63 \fBprinters\fR database in the name service switch. See \fBnsswitch.conf\fR(4),
64 \fBprinters\fR(4), and \fBprinters.conf\fR(4) for details.
65 .SH OPTIONS
66 .LP
67 The following options are supported:
68 .sp
69 .ne 2
70 .na
71 \fB\fB-l\fR\fR
72 .ad
73 .RS 18n
74 Displays information in long format. Long format includes the name of the host
75 from which a print request originated in the display.
76 .RE
78 .sp
79 .ne 2
80 .na
81 \fB\fB-P\fR \fIdestination\fR\fR
82 .ad
83 .RS 18n
84 Displays information about printer or class of printers (see \fBlpadmin\fR(1M))
85 \fI\&.\fR Specify \fIdestination\fR using atomic, URI-style
86 (\fIscheme\fR\fB://\fR\fBendpoint\fR), or POSIX-style
87 (\fIserver\fR\fB:\fR\fIdestination\fR) names. See \fBprinters.conf\fR(4) for
88 information regarding destination names.
89 .RE
91 .sp
92 .ne 2
93 .na
94 \fB\fB+\fR [\fIinterval\fR]\fR
95 .ad
96 .RS 18n
97 Displays information at specific time intervals. Stops displaying information
98 when the print queue is empty. Clears the screen before reporting displaying
99 the print queue. Specify \fIinterval\fR as the number of seconds between
100 displays. If  \fIinterval\fR is not specified only executes once.
103 .SH OPERANDS
105 The following operands are supported:
107 .ne 2
109 \fB\fIrequest-ID\fR\fR
111 .RS 14n
112 The job number associated with a print request.
116 .ne 2
118 \fB\fIuser\fR\fR
120 .RS 14n
121 The name of the user about whose jobs  \fBlpq\fR reports information. Specify
122 \fIuser\fR as a valid username.
125 .SH EXIT STATUS
127 The following exit values are returned:
129 .ne 2
131 \fB\fB0\fR\fR
133 .RS 12n
134 Successful completion.
138 .ne 2
140 \fBnon-zero\fR
142 .RS 12n
143 An error occurred.
146 .SH FILES
147 .ne 2
149 \fB\fB$HOME/.printers\fR\fR
151 .RS 24n
152 User-configurable printer database
156 .ne 2
158 \fB\fB/etc/printers.conf\fR\fR
160 .RS 24n
161 System printer configuration database
165 .ne 2
167 \fB\fBprinters.conf.byname\fR\fR
169 .RS 24n
170 NIS version of \fB/etc/printers.conf\fR
174 .ne 2
176 \fB\fBou=printers\fR\fR
178 .RS 24n
179 LDAP version of \fB/etc/printers.conf\fR
182 .SH ATTRIBUTES
184 See \fBattributes\fR(5) for descriptions of the following attributes:
189 box;
190 c | c
191 l | l .
192 ATTRIBUTE TYPE  ATTRIBUTE VALUE
194 Interface Stability     Standard
197 .SH SEE ALSO
199 \fBlp\fR(1), \fBlpc\fR(1B), \fBlpr\fR(1B), \fBlprm\fR(1B), \fBlpstat\fR(1),
200 \fBlpadmin\fR(1M), \fBnsswitch.conf\fR(4), \fBprinters\fR(4),
201 \fBprinters.conf\fR(4), \fBattributes\fR(5), \fBstandards\fR(5)
202 .SH NOTES
204 When IPP is in use, the user is prompted for a passphrase if the remote print
205 service is configured to require authentication.