man/lpstat.man

   1 .\"
   2 .\" "$Id: lpstat.man 7921 2008-09-10 15:42:24Z mike $"
   3 .\"
   4 .\"   lpstat man page for the Common UNIX Printing System (CUPS).
   5 .\"
   6 .\"   Copyright 2007-2008 by Apple Inc.
   7 .\"   Copyright 1997-2006 by Easy Software Products.
   8 .\"
   9 .\"   These coded instructions, statements, and computer programs are the
  10 .\"   property of Apple Inc. and are protected by Federal copyright
  11 .\"   law.  Distribution and use rights are outlined in the file "LICENSE.txt"
  12 .\"   which should have been included with this file.  If this file is
  13 .\"   file is missing or damaged, see the license at "http://www.cups.org/".
  14 .\"
  15 .TH lpstat 1 "Common UNIX Printing System" "10 September 2008" "Apple Inc."
  16 .SH NAME
  17 lpstat \- print cups status information
  18 .SH SYNOPSIS
  19 .B lpstat
  20 [ -E ] [ -H ] [ -U
  21 .I username
  22 ] [ -h
  23 .I hostname[:port]
  24 ] [ -l ] [ -W
  25 .I which-jobs
  26 ] [ -a [
  27 .I destination(s)
  28 ] ] [ -c [
  29 .I class(es)
  30 ] ] [ -d ] [ -o [
  31 .I destination(s)
  32 ] ] [ -p [
  33 .I printer(s)
  34 ] ] [ -r ] [ -R ] [ -s ] [ -t ] [ -u [
  35 .I user(s)
  36 ] ] [ -v [
  37 .I printer(s)
  38 ] ]
  39 .SH DESCRIPTION
  40 \fIlpstat\fR displays status information about the current
  41 classes, jobs, and printers. When run with no arguments,
  42 \fIlpstat\fR will list jobs queued by the current user.
  43 .SH OPTIONS
  44 The \fIlpstat\fR command supports the following options:
  45 .TP 5
  46 -E
  47 .br
  48 Forces encryption when connecting to the server.
  49 .TP 5
  50 -H
  51 .br
  52 Shows the server hostname and port.
  53 .TP 5
  54 -R
  55 .br
  56 Shows the ranking of print jobs.
  57 .TP 5
  58 -U username
  59 .br
  60 Specifies an alternate username.
  61 .TP 5
  62 -W which-jobs
  63 .br
  64 Specifies which jobs to show, \fIcompleted\fR or
  65 \fInot-completed\fR (the default). This option \fImust\fR appear
  66 before the \fI-o\fR option and/or any printer names, otherwise
  67 the default (not-completed) value will be used in the request to
  68 the scheduler.
  69 .TP 5
  70 -a [printer(s)]
  71 .br
  72 Shows the accepting state of printer queues. If no printers are
  73 specified then all printers are listed.
  74 .TP 5
  75 -c [class(es)]
  76 .br
  77 Shows the printer classes and the printers that belong to them.
  78 If no classes are specified then all classes are listed.
  79 .TP 5
  80 -d
  81 .br
  82 Shows the current default destination.
  83 .TP 5
  84 -h server[:port]
  85 .br
  86 Specifies an alternate server.
  87 .TP 5
  88 -l
  89 .br
  90 Shows a long listing of printers, classes, or jobs.
  91 .TP 5
  92 -o [destination(s)]
  93 .br
  94 Shows the jobs queue on the specified destinations. If no destinations are
  95 specified all jobs are shown.
  96 .TP 5
  97 -p [printer(s)]
  98 .br
  99 Shows the printers and whether or not they are enabled for printing. If
 100 no printers are specified then all printers are listed.
 101 .TP 5
 102 -r
 103 .br
 104 Shows whether the CUPS server is running.
 105 .TP 5
 106 -s
 107 .br
 108 Shows a status summary, including the default destination, a
 109 list of classes and their member printers, and a list of printers and
 110 their associated devices. This is equivalent to using the "-d", "-c",
 111 and "-v" options.
 112 .TP 5
 113 -t
 114 .br
 115 Shows all status information. This is equivalent to using the "-r",
 116 "-d", "-c", "-v", "-a", "-p", and "-o" options.
 117 .TP 5
 118 -u [user(s)]
 119 .br
 120 Shows a list of print jobs queued by the specified users. If no users
 121 are specified, lists the jobs queued by the current user.
 122 .TP 5
 123 -v [printer(s)]
 124 .br
 125 Shows the printers and what device they are attached to. If no printers
 126 are specified then all printers are listed.
 127 .SH COMPATIBILITY
 128 Unlike the System V printing system, CUPS allows printer names to
 129 contain any printable character except SPACE, TAB, "/", and "#".
 130 Also, printer and class names are \fInot\fR case-sensitive.
 131 .LP
 132 The "-h", "-E", "-U", and "-W" options are unique to CUPS.
 133 .LP
 134 The Solaris "-f", "-P", and "-S" options are silently ignored.
 135 .SH SEE ALSO
 136 \fIcancel(1)\fR, \fIlp(1)\fR,
 137 .br
 138 http://localhost:631/help
 139 .SH COPYRIGHT
 140 Copyright 2007-2008 by Apple Inc.
 141 .\"
 142 .\" End of "$Id: lpstat.man 7921 2008-09-10 15:42:24Z mike $".
 143 .\"