man/lpstat.man

   1 .\"
   2 .\" "$Id$"
   3 .\"
   4 .\" lpstat man page for CUPS.
   5 .\"
   6 .\" Copyright 2007-2014 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 "CUPS" "12 June 2014" "Apple Inc."
  16 .SH NAME
  17 lpstat \- print cups status information
  18 .SH SYNOPSIS
  19 .B lpstat
  20 [
  21 .B \-E
  22 ] [
  23 .B \-H
  24 ] [
  25 .B \-U
  26 .I username
  27 ] [
  28 \fB\-h \fIhostname\fR[\fB:\fIport\fR]
  29 ] [
  30 .B \-l
  31 ] [
  32 .B \-W
  33 .I which-jobs
  34 ] [
  35 .B \-a
  36 [
  37 .I destination(s)
  38 ] ] [
  39 .B \-c
  40 [
  41 .I class(es)
  42 ] ] [
  43 .B \-d
  44 ] [
  45 .B \-o
  46 [
  47 .I destination(s)
  48 ] ] [
  49 .B \-p
  50 [
  51 .I printer(s)
  52 ] ] [
  53 .B \-r
  54 ] [
  55 .B \-R
  56 ] [
  57 .B \-s
  58 ] [
  59 .B \-t
  60 ] [
  61 .B \-u
  62 [
  63 .I user(s)
  64 ] ] [
  65 .B \-v
  66 [
  67 .I printer(s)
  68 ] ]
  69 .SH DESCRIPTION
  70 \fBlpstat\fR displays status information about the current classes, jobs, and printers.
  71 When run with no arguments, \fBlpstat\fR will list active jobs queued by the current user.
  72 .SH OPTIONS
  73 The \fBlpstat\fR command supports the following options:
  74 .TP 5
  75 .B \-E
  76 Forces encryption when connecting to the server.
  77 .TP 5
  78 .B \-H
  79 Shows the server hostname and port.
  80 .TP 5
  81 .B \-R
  82 Shows the ranking of print jobs.
  83 .TP 5
  84 \fB\-U \fIusername\fR
  85 Specifies an alternate username.
  86 .TP 5
  87 \fB\-W \fIwhich-jobs\fR
  88 Specifies which jobs to show, "completed" or "not-completed" (the default).
  89 This option \fImust\fR appear before the \fI-o\fR option and/or any printer names, otherwise the default ("not-completed") value will be used in the request to the scheduler.
  90 .TP 5
  91 \fB\-a \fR[\fIprinter(s)\fR]
  92 Shows the accepting state of printer queues.
  93 If no printers are specified then all printers are listed.
  94 .TP 5
  95 \fB\-c \fR[\fIclass(es)\fR]
  96 Shows the printer classes and the printers that belong to them.
  97 If no classes are specified then all classes are listed.
  98 .TP 5
  99 .B \-d
 100 Shows the current default destination.
 101 .TP 5
 102 \fB\-h \fIserver\fR[\fB:\fIport\fR]
 103 Specifies an alternate server.
 104 .TP 5
 105 .B \-l
 106 Shows a long listing of printers, classes, or jobs.
 107 .TP 5
 108 \fB\-o \fR[\fIdestination(s)\fR]
 109 Shows the jobs queued on the specified destinations.
 110 If no destinations are specified all jobs are shown.
 111 .TP 5
 112 \fB\-p \fR[\fIprinter(s)\fR]
 113 Shows the printers and whether they are enabled for printing.
 114 If no printers are specified then all printers are listed.
 115 .TP 5
 116 .B \-r
 117 Shows whether the CUPS server is running.
 118 .TP 5
 119 .B \-s
 120 Shows a status summary, including the default destination, a list of classes and their member printers, and a list of printers and their associated devices.
 121 This is equivalent to using the \fI\-d\fR, \fI\-c\fR, and \fI\-v\fR options.
 122 .TP 5
 123 .B \-t
 124 Shows all status information.
 125 This is equivalent to using the \fI\-r\fR, \fI\-d\fR, \fI\-c\fR, \fI\-v\fR, \fI\-a\fR, \fI\-p\fR, and \fI\-o\fR options.
 126 .TP 5
 127 \fB\-u \fR[\fIuser(s)\fR]
 128 Shows a list of print jobs queued by the specified users.
 129 If no users are specified, lists the jobs queued by the current user.
 130 .TP 5
 131 \fB\-v \fR[\fIprinter(s)\fR]
 132 Shows the printers and what device they are attached to.
 133 If no printers are specified then all printers are listed.
 134 .SH CONFORMING TO
 135 Unlike the System V printing system, CUPS allows printer names to contain any printable character except SPACE, TAB, "/", and "#".
 136 Also, printer and class names are \fInot\fR case-sensitive.
 137 .LP
 138 The \fI\-h\fR, \fI\-E\fR, \fI\-U\fR, and \fI\-W\fR options are unique to CUPS.
 139 .LP
 140 The Solaris \fI\-f\fR, \fI\-P\fR, and \fI\-S\fR options are silently ignored.
 141 .SH SEE ALSO
 142 .BR cancel (1),
 143 .BR lp (1),
 144 .BR lpq (1),
 145 .BR lpr (1),
 146 .BR lprm (1),
 147 CUPS Online Help (http://localhost:631/help)
 148 .SH COPYRIGHT
 149 Copyright \[co] 2007-2015 by Apple Inc.
 150 .\"
 151 .\" End of "$Id$".
 152 .\"