man/lpstat.man

   1 .\"
   2 .\" lpstat man page for CUPS.
   3 .\"
   4 .\" Copyright 2007-2017 by Apple Inc.
   5 .\" Copyright 1997-2006 by Easy Software Products.
   6 .\"
   7 .\" These coded instructions, statements, and computer programs are the
   8 .\" property of Apple Inc. and are protected by Federal copyright
   9 .\" law.  Distribution and use rights are outlined in the file "LICENSE.txt"
  10 .\" which should have been included with this file.  If this file is
  11 .\" file is missing or damaged, see the license at "http://www.cups.org/".
  12 .\"
  13 .TH lpstat 1 "CUPS" "26 May 2017" "Apple Inc."
  14 .SH NAME
  15 lpstat \- print cups status information
  16 .SH SYNOPSIS
  17 .B lpstat
  18 [
  19 .B \-E
  20 ] [
  21 .B \-H
  22 ] [
  23 .B \-U
  24 .I username
  25 ] [
  26 \fB\-h \fIhostname\fR[\fB:\fIport\fR]
  27 ] [
  28 .B \-l
  29 ] [
  30 .B \-W
  31 .I which-jobs
  32 ] [
  33 .B \-a
  34 [
  35 .I destination(s)
  36 ] ] [
  37 .B \-c
  38 [
  39 .I class(es)
  40 ] ] [
  41 .B \-d
  42 ] [
  43 .B \-e
  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 .B \-e
 103 Shows all available destinations on the local network.
 104 .TP 5
 105 \fB\-h \fIserver\fR[\fB:\fIport\fR]
 106 Specifies an alternate server.
 107 .TP 5
 108 .B \-l
 109 Shows a long listing of printers, classes, or jobs.
 110 .TP 5
 111 \fB\-o \fR[\fIdestination(s)\fR]
 112 Shows the jobs queued on the specified destinations.
 113 If no destinations are specified all jobs are shown.
 114 .TP 5
 115 \fB\-p \fR[\fIprinter(s)\fR]
 116 Shows the printers and whether they are enabled for printing.
 117 If no printers are specified then all printers are listed.
 118 .TP 5
 119 .B \-r
 120 Shows whether the CUPS server is running.
 121 .TP 5
 122 .B \-s
 123 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.
 124 This is equivalent to using the \fI\-d\fR, \fI\-c\fR, and \fI\-v\fR options.
 125 .TP 5
 126 .B \-t
 127 Shows all status information.
 128 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.
 129 .TP 5
 130 \fB\-u \fR[\fIuser(s)\fR]
 131 Shows a list of print jobs queued by the specified users.
 132 If no users are specified, lists the jobs queued by the current user.
 133 .TP 5
 134 \fB\-v \fR[\fIprinter(s)\fR]
 135 Shows the printers and what device they are attached to.
 136 If no printers are specified then all printers are listed.
 137 .SH CONFORMING TO
 138 Unlike the System V printing system, CUPS allows printer names to contain any printable character except SPACE, TAB, "/", and "#".
 139 Also, printer and class names are \fInot\fR case-sensitive.
 140 .LP
 141 The \fI\-h\fR, \fI-e\fR, \fI\-E\fR, \fI\-U\fR, and \fI\-W\fR options are unique to CUPS.
 142 .LP
 143 The Solaris \fI\-f\fR, \fI\-P\fR, and \fI\-S\fR options are silently ignored.
 144 .SH SEE ALSO
 145 .BR cancel (1),
 146 .BR lp (1),
 147 .BR lpq (1),
 148 .BR lpr (1),
 149 .BR lprm (1),
 150 CUPS Online Help (http://localhost:631/help)
 151 .SH COPYRIGHT
 152 Copyright \[co] 2007-2017 by Apple Inc.