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