Sweep-fix man page section order to match mdoc(7), part 5/5.
[dragonfly.git] / usr.sbin / lpr / lpq / lpq.1
1 .\" Copyright (c) 1983, 1990, 1993
2 .\"     The Regents of the University of California.  All rights reserved.
3 .\"
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
6 .\" are met:
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\"    notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\"    notice, this list of conditions and the following disclaimer in the
11 .\"    documentation and/or other materials provided with the distribution.
12 .\" 3. All advertising materials mentioning features or use of this software
13 .\"    must display the following acknowledgement:
14 .\"     This product includes software developed by the University of
15 .\"     California, Berkeley and its contributors.
16 .\" 4. Neither the name of the University nor the names of its contributors
17 .\"    may be used to endorse or promote products derived from this software
18 .\"    without specific prior written permission.
19 .\"
20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 .\" SUCH DAMAGE.
31 .\"
32 .\"     @(#)lpq.1       8.2 (Berkeley) 4/28/95
33 .\" $FreeBSD: src/usr.sbin/lpr/lpq/lpq.1,v 1.5.2.4 2002/06/21 16:40:46 charnier Exp $
34 .\" $DragonFly: src/usr.sbin/lpr/lpq/lpq.1,v 1.3 2006/02/17 19:40:16 swildner Exp $
35 .\"
36 .Dd April 28, 1995
37 .Dt LPQ 1
38 .Os
39 .Sh NAME
40 .Nm lpq
41 .Nd spool queue examination program
42 .Sh SYNOPSIS
43 .Nm
44 .Op Fl a
45 .Op Fl l
46 .Op Fl P Ns Ar printer
47 .Op  job # ...\&
48 .Op  user ...\&
49 .Sh DESCRIPTION
50 The
51 .Nm
52 utility examines the spooling area used by
53 .Xr lpd  8
54 for printing files on the line printer, and reports the status of the
55 specified jobs or all jobs associated with a user.
56 The
57 .Nm
58 utility invoked
59 without any arguments reports on any jobs currently in the queue.
60 .Pp
61 Options:
62 .Pp
63 .Bl -tag -width indent
64 .It Fl P
65 Specify a particular printer, otherwise the default
66 line printer is used (or the value of the
67 .Ev PRINTER
68 variable in the
69 environment). All other arguments supplied are interpreted as user
70 names or job numbers to filter out only those jobs of interest.
71 .It Fl l
72 Information about each of the files comprising the job entry
73 is printed.
74 Normally, only as much information as will fit on one line is displayed.
75 .It Fl a
76 Report on the local queues for all printers,
77 rather than just the specified printer.
78 .El
79 .Pp
80 For each job submitted (i.e. invocation of
81 .Xr lpr  1  )
82 .Nm
83 reports the user's name, current rank in the queue, the
84 names of files comprising the job, the job identifier (a number which
85 may be supplied to
86 .Xr lprm  1
87 for removing a specific job), and the total size in bytes.
88 Job ordering is dependent on
89 the algorithm used to scan the spooling directory and is supposed
90 to be
91 .Tn FIFO
92 (First in First Out).
93 File names comprising a job may be unavailable
94 (when
95 .Xr lpr  1
96 is used as a sink in a pipeline) in which case the file
97 is indicated as ``(standard input)''.
98 .Pp
99 If
100 .Nm
101 warns that there is no daemon present (i.e. due to some malfunction),
102 the
103 .Xr lpc  8
104 command can be used to restart the printer daemon.
105 .Sh ENVIRONMENT
106 If the following environment variable exists, it is used by
107 .Nm :
108 .Bl -tag -width PRINTER
109 .It Ev PRINTER
110 Specifies an alternate default printer.
111 .El
112 .Sh FILES
113 .Bl -tag -width "/var/spool/*/lock" -compact
114 .It Pa /etc/printcap
115 To determine printer characteristics.
116 .It Pa /var/spool/*
117 The spooling directory, as determined from printcap.
118 .It Pa /var/spool/*/cf*
119 Control files specifying jobs.
120 .It Pa /var/spool/*/lock
121 The lock file to obtain the currently active job.
122 .El
123 .Sh DIAGNOSTICS
124 Unable to open various files.  The lock file being malformed.  Garbage
125 files when there is no daemon active, but files in the spooling directory.
126 .Sh SEE ALSO
127 .Xr lpr 1 ,
128 .Xr lprm 1 ,
129 .Xr lpc 8 ,
130 .Xr lpd 8
131 .Sh HISTORY
132 A
133 .Nm
134 utility appeared in
135 .Bx 3 .
136 .Sh BUGS
137 Due to the dynamic nature of the information in the spooling directory
138 .Nm
139 may report unreliably.
140 Output formatting is sensitive to the line length of the terminal;
141 this can results in widely spaced columns.