BSD 4_3_Reno release

[unix-history] / usr / src / usr.sbin / lpr / lpq / lpq.1

diff --git a/usr/src/usr.sbin/lpr/lpq/lpq.1 b/usr/src/usr.sbin/lpr/lpq/lpq.1
index e96c38a..ba99ba4 100644 (file)
--- a/usr/src/usr.sbin/lpr/lpq/lpq.1
+++ b/usr/src/usr.sbin/lpr/lpq/lpq.1
@@ -1,91 +1,119 @@
-.\" Copyright (c) 1983 Regents of the University of California.
-.\" All rights reserved.  The Berkeley software License Agreement
-.\" specifies the terms and conditions for redistribution.
+.\" Copyright (c) 1983, 1990 The Regents of the University of California.
+.\" All rights reserved.

 .\"
 .\"

-.\"    @(#)lpq.1       6.1 (Berkeley) %G%
+.\" Redistribution and use in source and binary forms are permitted provided
+.\" that: (1) source distributions retain this entire copyright notice and
+.\" comment, and (2) distributions including binaries display the following
+.\" acknowledgement:  ``This product includes software developed by the
+.\" University of California, Berkeley and its contributors'' in the
+.\" documentation or other materials provided with the distribution and in
+.\" all advertising materials mentioning features or use of this software.
+.\" Neither the name of the University nor the names of its contributors may
+.\" be used to endorse or promote products derived from this software without
+.\" specific prior written permission.
+.\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
+.\" WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
+.\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.

 .\"
 .\"

-.TH LPQ 1 ""
-.UC 5
-.SH NAME
-lpq \- spool queue examination program
-.SH SYNOPSIS
-.B lpq
-[ +[ n ] ] [ -l ] [ \-Pprinter ] [ job # ... ] [ user ... ]
-.SH DESCRIPTION
-.I lpq
+.\"     @(#)lpq.1      6.8 (Berkeley) 7/24/90
+.\"
+.Dd July 24, 1990
+.Dt LPQ 1
+.Os BSD 4.2
+.Sh NAME
+.Nm lpq
+.Nd spool queue examination program
+.Sh SYNOPSIS
+.Nm lpq
+.Op Fl l
+.Oo
+.Op Fl P Ar printer
+.Oo
+.Op  job # ...
+.Op  user ...
+.Sh DESCRIPTION
+.Nm Lpq

 examines the spooling area used by
 examines the spooling area used by

-.IR lpd (8)
-for printing
-files on the line printer, and reports the status of the specified jobs or
-all jobs associated with a user. 
-.I lpq
-invoked without any arguments
-reports on any jobs currently in the queue.  A
-.B \-P
-flag may be used
-to specify a particular printer, otherwise the default line printer
-is used (or the value of the PRINTER variable in the environment).
-If a
-.B \+
-argument is supplied,
-.I lpq
-displays the spool queue until it empties.  Supplying a number
-immediately after the
-.B \+
-sign indicates that
-.I lpq
-should sleep \fIn\fR seconds in between scans of the queue.
-All other arguments supplied are
-interpreted as user names or job numbers to filter out only those
-jobs of interest.
-.PP
-For each job submitted (i.e. invocation of 
-.IR lpr (1))
-.I lpq
+.Xr lpd  8
+for printing files on the line printer, and reports the status of the
+specified jobs or all jobs associated with a user.
+.Nm Lpq
+invoked
+without any arguments reports on any jobs currently in the queue.
+.Pp
+Options:
+.Pp
+.Tw Ds
+.Tp Fl P
+Specify a particular printer, otherwise the default
+line printer is used (or the value of the
+.Ev PRINTER
+variable in the
+environment). All other arguments supplied are interpreted as user
+names or job numbers to filter out only those jobs of interest.
+.Tp Fl l
+Information about each of the files comprising the job entry
+is printed.
+Normally, only as much information as will fit on one line is displayed.
+.Tp
+.Pp
+For each job submitted (i.e. invocation of
+.Xr lpr  1  )
+.Nm lpq

 reports the user's name, current rank in the queue, the
 names of files comprising the job, the job identifier (a number which
 may be supplied to
 reports the user's name, current rank in the queue, the
 names of files comprising the job, the job identifier (a number which
 may be supplied to

-.IR lprm (1)
+.Xr lprm  1

 for removing a specific job), and the total size in bytes.
 for removing a specific job), and the total size in bytes.

-The
-.B \-l
-option causes information about each of the files comprising the job
-to be printed.
-Normally, only as much information as will fit on one line is displayed.

 Job ordering is dependent on
 the algorithm used to scan the spooling directory and is supposed
 to be FIFO (First in First Out).
 File names comprising a job may be unavailable
 (when
 Job ordering is dependent on
 the algorithm used to scan the spooling directory and is supposed
 to be FIFO (First in First Out).
 File names comprising a job may be unavailable
 (when

-.IR lpr (1)
+.Xr lpr  1

 is used as a sink in a pipeline) in which case the file
 is indicated as ``(standard input)".
 is used as a sink in a pipeline) in which case the file
 is indicated as ``(standard input)".

-.PP
+.Pp

 If
 If

-.I lpq
+.Nm lpq

 warns that there is no daemon present (i.e. due to some malfunction),
 the
 warns that there is no daemon present (i.e. due to some malfunction),
 the

-.IR lpc (8)
+.Xr lpc  8

 command can be used to restart the printer daemon.
 command can be used to restart the printer daemon.

-.SH FILES
-.nf
-.ta \w'/etc/termcap            'u
-/etc/termcap   for manipulating the screen for repeated display
-/etc/printcap  to determine printer characteristics
-/usr/spool/*   the spooling directory, as determined from printcap
-/usr/spool/*/cf*       control files specifying jobs
-/usr/spool/*/lock      the lock file to obtain the currently active job 
-.fi
-.SH "SEE ALSO"
-lpr(1),
-lprm(1),
-lpc(8),
-lpd(8)
-.SH BUGS
+.Sh ENVIRONMENT
+If the following environment variable exists, it is used by
+.Nm lpq :
+.Tw Fl
+.Tp Ev PRINTER
+Specifies an alternate default printer.
+.Tp
+.Sh FILES
+.Dw /usr/share/misc/termcap
+.Di L
+.Dp Pa /usr/share/misc/termcap
+for manipulating the screen for repeated display
+.Dp Pa /etc/printcap
+to determine printer characteristics
+.Dp Pa /var/spool/*
+the spooling directory, as determined from printcap
+.Dp Pa /var/spool/*/cf*
+control files specifying jobs
+.Dp Pa /var/spool/*/lock
+the lock file to obtain the currently active job
+.Dp
+.Sh SEE ALSO
+.Xr lpr 1 ,
+.Xr lprm 1 ,
+.Xr lpc 8 ,
+.Xr lpd 8
+.Sh HISTORY
+.Nm Lpq
+appeared in 3 BSD.
+.Sh BUGS

 Due to the dynamic nature of the information in the spooling directory
 lpq may report unreliably.
 Output formatting is sensitive to the line length of the terminal;
 this can results in widely spaced columns.
 Due to the dynamic nature of the information in the spooling directory
 lpq may report unreliably.
 Output formatting is sensitive to the line length of the terminal;
 this can results in widely spaced columns.

-.SH DIAGNOSTICS
+.Sh DIAGNOSTICS

 Unable to open various files.  The lock file being malformed.  Garbage
 files when there is no daemon active, but files in the spooling directory.
 Unable to open various files.  The lock file being malformed.  Garbage
 files when there is no daemon active, but files in the spooling directory.