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