man/lpstat.man

   1 .\"
   2 .\" "$Id: lpstat.man 7600 2008-05-20 21:06:23Z mike $"
   3 .\"
   4 .\"   lpstat man page for the Common UNIX Printing System (CUPS).
   5 .\"
   6 .\"   Copyright 2007 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" "23 March 2006" "Apple Inc."
  16 .SH NAME
  17 lpstat \- print cups status information
  18 .SH SYNOPSIS
  19 .B lpstat
  20 [ -E ] [ -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 -R
  51 .br
  52 Shows the ranking of print jobs.
  53 .TP 5
  54 -U username
  55 .br
  56 Specifies an alternate username.
  57 .TP 5
  58 -W which-jobs
  59 .br
  60 Specifies which jobs to show, \fIcompleted\fR or
  61 \fInot-completed\fR (the default). This option \fImust\fR appear
  62 before the \fI-o\fR option and/or any printer names, otherwise
  63 the default (not-completed) value will be used in the request to
  64 the scheduler.
  65 .TP 5
  66 -a [printer(s)]
  67 .br
  68 Shows the accepting state of printer queues. If no printers are
  69 specified then all printers are listed.
  70 .TP 5
  71 -c [class(es)]
  72 .br
  73 Shows the printer classes and the printers that belong to them.
  74 If no classes are specified then all classes are listed.
  75 .TP 5
  76 -d
  77 .br
  78 Shows the current default destination.
  79 .TP 5
  80 -h server[:port]
  81 .br
  82 Specifies an alternate server.
  83 .TP 5
  84 -l
  85 .br
  86 Shows a long listing of printers, classes, or jobs.
  87 .TP 5
  88 -o [destination(s)]
  89 .br
  90 Shows the jobs queue on the specified destinations. If no destinations are
  91 specified all jobs are shown.
  92 .TP 5
  93 -p [printer(s)]
  94 .br
  95 Shows the printers and whether or not they are enabled for printing. If
  96 no printers are specified then all printers are listed.
  97 .TP 5
  98 -r
  99 .br
 100 Shows whether the CUPS server is running.
 101 .TP 5
 102 -s
 103 .br
 104 Shows a status summary, including the default destination, a
 105 list of classes and their member printers, and a list of printers and
 106 their associated devices. This is equivalent to using the "-d", "-c",
 107 and "-v" options.
 108 .TP 5
 109 -t
 110 .br
 111 Shows all status information. This is equivalent to using the "-r",
 112 "-d", "-c", "-v", "-a", "-p", and "-o" options.
 113 .TP 5
 114 -u [user(s)]
 115 .br
 116 Shows a list of print jobs queued by the specified users. If no users
 117 are specified, lists the jobs queued by the current user.
 118 .TP 5
 119 -v [printer(s)]
 120 .br
 121 Shows the printers and what device they are attached to. If no printers
 122 are specified then all printers are listed.
 123 .SH COMPATIBILITY
 124 Unlike the System V printing system, CUPS allows printer names to
 125 contain any printable character except SPACE, TAB, "/", and "#".
 126 Also, printer and class names are \fInot\fR case-sensitive.
 127 .LP
 128 The "-h", "-E", "-U", and "-W" options are unique to CUPS.
 129 .LP
 130 The Solaris "-f", "-P", and "-S" options are silently ignored.
 131 .SH SEE ALSO
 132 \fIcancel(1)\fR, \fIlp(1)\fR,
 133 .br
 134 http://localhost:631/help
 135 .SH COPYRIGHT
 136 Copyright 2007 by Apple Inc.
 137 .\"
 138 .\" End of "$Id: lpstat.man 7600 2008-05-20 21:06:23Z mike $".
 139 .\"