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