]> git.ipfire.org Git - thirdparty/cups.git/blob - man/lpstat.man
Load cups into easysw/current.
[thirdparty/cups.git] / man / lpstat.man
1 .\"
2 .\" "$Id: lpstat.man 4493 2005-02-18 02:09:53Z mike $"
3 .\"
4 .\" lpstat man page for the Common UNIX Printing System (CUPS).
5 .\"
6 .\" Copyright 1997-2005 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" "3 January 2005" "Easy Software Products"
25 .SH NAME
26 lpstat \- print cups status information
27 .SH SYNOPSIS
28 .B lpstat
29 [ -E ] [ -h
30 .I server
31 ] [ -l ] [ -W
32 .I which-jobs
33 ] [ -a [
34 .I destination(s)
35 ] ] [ -c [
36 .I class(es)
37 ] [ -d ] [ -o [
38 .I destination(s)
39 ] ] [ -p [
40 .I printer(s)
41 ] ] [ -r ] [ -R ] [ -s ] [ -t ] [ -u [
42 .I user(s)
43 ] ] [ -v [
44 .I printer(s)
45 ] ]
46 .SH DESCRIPTION
47 \fBlpstat\fR displays status information about the current classes, jobs, and
48 printers. When run with no arguments, \fBlpstat\fR will list jobs queued by
49 the user. Other options include:
50 .TP 5
51 \-E
52 .br
53 Forces encryption when connecting to the server.
54 .TP 5
55 \-a [\fIprinter(s)\fR]
56 .br
57 Shows the accepting state of printer queues. If no printers are
58 specified then all printers are listed.
59 .TP 5
60 \-c [\fIclass(es)\fR]
61 .br
62 Shows the printer classes and the printers that belong to them. If no
63 classes are specified then all classes are listed.
64 .TP 5
65 \-d
66 .br
67 Shows the current default destination.
68 .TP 5
69 \-h \fIserver\fR
70 .br
71 Specifies the CUPS server to communicate with.
72 .TP 5
73 \-l
74 .br
75 Shows a long listing of printers, classes, or jobs.
76 .TP 5
77 \-o [\fIdestination(s)\fR]
78 .br
79 Shows the jobs queue on the specified destinations. If no destinations are
80 specified all jobs are shown.
81 .TP 5
82 \-p [\fIprinter(s)\fR]
83 .br
84 Shows the printers and whether or not they are enabled for printing. If
85 no printers are specified then all printers are listed.
86 .TP 5
87 \-r
88 .br
89 Shows whether or not the CUPS server is running.
90 .TP 5
91 \-R
92 .br
93 Shows the ranking of print jobs.
94 .TP 5
95 \-s
96 .br
97 Shows a status summary, including the default destination, a
98 list of classes and their member printers, and a list of printers and
99 their associated devices. This is equivalent to using the "-d", "-c",
100 and "-v" options.
101 .TP 5
102 \-t
103 .br
104 Shows all status information. This is equivalent to using the "-r",
105 "-d", "-c", "-v", "-a", "-p", and "-o" options.
106 .TP 5
107 \-u [\fIuser(s)\fR]
108 .br
109 Shows a list of print jobs queued by the specified users. If no users
110 are specified, lists the jobs queued by the current user.
111 .TP 5
112 \-v [\fIprinter(s)\fR]
113 .br
114 Shows the printers and what device they are attached to. If no printers
115 are specified then all printers are listed.
116 .TP 5
117 \-W [\fIwhich-jobs\fR]
118 .br
119 Specifies which jobs to show, \fIcompleted\fR or
120 \fInot-completed\fR (the default). This option \fBmust\fR appear
121 before the \fI-o\fR option and/or any printer names, otherwise
122 the default (not-completed) value will be used in the request to
123 the scheduler.
124 .SH COMPATIBILITY
125 Unlike the System V printing system, CUPS allows printer names
126 to contain any printable character except SPACE and TAB. Also,
127 printer and class names are \fBnot\fR case-sensitive.
128 .LP
129 The "-h" and "-W" options are unique to CUPS.
130 .LP
131 The Solaris "-f", "-P", and "-S" options are silently ignored.
132 .SH SEE ALSO
133 cancel(1), lp(1),
134 CUPS Software Users Manual,
135 http://localhost:631/documentation.html
136 .SH COPYRIGHT
137 Copyright 1993-2005 by Easy Software Products, All Rights Reserved.
138 .\"
139 .\" End of "$Id: lpstat.man 4493 2005-02-18 02:09:53Z mike $".
140 .\"