xref: /freebsd/usr.sbin/lpr/lpq/lpq.1 (revision ce834215a70ff69e7e222827437116eee2f9ac6f)
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.\"
34.Dd April 28, 1995
35.Dt LPQ 1
36.Os BSD 4.2
37.Sh NAME
38.Nm lpq
39.Nd spool queue examination program
40.Sh SYNOPSIS
41.Nm lpq
42.Op Fl a
43.Op Fl l
44.Op Fl P Ns Ar printer
45.Op  job # ...
46.Op  user ...
47.Sh DESCRIPTION
48.Nm Lpq
49examines the spooling area used by
50.Xr lpd  8
51for printing files on the line printer, and reports the status of the
52specified jobs or all jobs associated with a user.
53.Nm Lpq
54invoked
55without any arguments reports on any jobs currently in the queue.
56.Pp
57Options:
58.Pp
59.Bl -tag -width indent
60.It Fl P
61Specify a particular printer, otherwise the default
62line printer is used (or the value of the
63.Ev PRINTER
64variable in the
65environment). All other arguments supplied are interpreted as user
66names or job numbers to filter out only those jobs of interest.
67.It Fl l
68Information about each of the files comprising the job entry
69is printed.
70Normally, only as much information as will fit on one line is displayed.
71.It Fl a
72Report on the local queues for all printers,
73rather than just the specified printer.
74.El
75.Pp
76For each job submitted (i.e. invocation of
77.Xr lpr  1  )
78.Nm lpq
79reports the user's name, current rank in the queue, the
80names of files comprising the job, the job identifier (a number which
81may be supplied to
82.Xr lprm  1
83for removing a specific job), and the total size in bytes.
84Job ordering is dependent on
85the algorithm used to scan the spooling directory and is supposed
86to be
87.Tn FIFO
88(First in First Out).
89File names comprising a job may be unavailable
90(when
91.Xr lpr  1
92is used as a sink in a pipeline) in which case the file
93is indicated as ``(standard input)''.
94.Pp
95If
96.Nm lpq
97warns that there is no daemon present (i.e. due to some malfunction),
98the
99.Xr lpc  8
100command can be used to restart the printer daemon.
101.Sh ENVIRONMENT
102If the following environment variable exists, it is used by
103.Nm lpq :
104.Bl -tag -width PRINTER
105.It Ev PRINTER
106Specifies an alternate default printer.
107.El
108.Sh FILES
109.Bl -tag -width "/var/spool/*/lock" -compact
110.It Pa /etc/printcap
111To determine printer characteristics.
112.It Pa /var/spool/*
113The spooling directory, as determined from printcap.
114.It Pa /var/spool/*/cf*
115Control files specifying jobs.
116.It Pa /var/spool/*/lock
117The lock file to obtain the currently active job.
118.El
119.Sh SEE ALSO
120.Xr lpr 1 ,
121.Xr lprm 1 ,
122.Xr lpc 8 ,
123.Xr lpd 8
124.Sh HISTORY
125.Nm Lpq
126appeared in
127.Bx 3 .
128.Sh BUGS
129Due to the dynamic nature of the information in the spooling directory
130.Nm lpq
131may report unreliably.
132Output formatting is sensitive to the line length of the terminal;
133this can results in widely spaced columns.
134.Sh DIAGNOSTICS
135Unable to open various files.  The lock file being malformed.  Garbage
136files when there is no daemon active, but files in the spooling directory.
137