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