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