]> git.ipfire.org Git - thirdparty/cups.git/blobdiff - man/lpstat.man
Import CUPS v2.0b1
[thirdparty/cups.git] / man / lpstat.man
index 021be700c4eb7afa3de4025e44971bbd61c6da50..7a8cce48301c347bfb7b0a459790853b89be6e0e 100644 (file)
 .\"
-.\" "$Id: lpstat.man 11022 2013-06-06 22:14:09Z msweet $"
+.\" "$Id: lpstat.man 11924 2014-06-12 19:10:33Z msweet $"
 .\"
-.\"   lpstat man page for CUPS.
+.\" lpstat man page for CUPS.
 .\"
-.\"   Copyright 2007-2013 by Apple Inc.
-.\"   Copyright 1997-2006 by Easy Software Products.
+.\" Copyright 2007-2014 by Apple Inc.
+.\" Copyright 1997-2006 by Easy Software Products.
 .\"
-.\"   These coded instructions, statements, and computer programs are the
-.\"   property of Apple Inc. and are protected by Federal copyright
-.\"   law.  Distribution and use rights are outlined in the file "LICENSE.txt"
-.\"   which should have been included with this file.  If this file is
-.\"   file is missing or damaged, see the license at "http://www.cups.org/".
+.\" These coded instructions, statements, and computer programs are the
+.\" property of Apple Inc. and are protected by Federal copyright
+.\" law.  Distribution and use rights are outlined in the file "LICENSE.txt"
+.\" which should have been included with this file.  If this file is
+.\" file is missing or damaged, see the license at "http://www.cups.org/".
 .\"
-.TH lpstat 1 "CUPS" "10 September 2008" "Apple Inc."
+.TH lpstat 1 "CUPS" "12 June 2014" "Apple Inc."
 .SH NAME
 lpstat \- print cups status information
 .SH SYNOPSIS
 .B lpstat
-[ -E ] [ -H ] [ -U
+[
+.B \-E
+] [
+.B \-H
+] [
+.B \-U
 .I username
-] [ -h
-.I hostname[:port]
-] [ -l ] [ -W
+] [
+\fB\-h \fIhostname\fR[\fB:\fIport\fR]
+] [
+.B \-l
+] [
+.B \-W
 .I which-jobs
-] [ -a [
+] [
+.B \-a
+[
 .I destination(s)
-] ] [ -c [
+] ] [
+.B \-c
+[
 .I class(es)
-] ] [ -d ] [ -o [
+] ] [
+.B \-d
+] [
+.B \-o
+[
 .I destination(s)
-] ] [ -p [
+] ] [
+.B \-p
+[
 .I printer(s)
-] ] [ -r ] [ -R ] [ -s ] [ -t ] [ -u [
+] ] [
+.B \-r
+] [
+.B \-R
+] [
+.B \-s
+] [
+.B \-t
+] [
+.B \-u
+[
 .I user(s)
-] ] [ -v [
+] ] [
+.B \-v
+[
 .I printer(s)
 ] ]
 .SH DESCRIPTION
-\fIlpstat\fR displays status information about the current
-classes, jobs, and printers. When run with no arguments,
-\fIlpstat\fR will list jobs queued by the current user.
+\fBlpstat\fR displays status information about the current classes, jobs, and printers.
+When run with no arguments, \fBlpstat\fR will list active jobs queued by the current user.
 .SH OPTIONS
-The \fIlpstat\fR command supports the following options:
+The \fBlpstat\fR command supports the following options:
 .TP 5
--E
-.br
+.B \-E
 Forces encryption when connecting to the server.
 .TP 5
--H
-.br
+.B \-H
 Shows the server hostname and port.
 .TP 5
--R
-.br
+.B \-R
 Shows the ranking of print jobs.
 .TP 5
--U username
-.br
+\fB\-U \fIusername\fR
 Specifies an alternate username.
 .TP 5
--W which-jobs
-.br
-Specifies which jobs to show, \fIcompleted\fR or
-\fInot-completed\fR (the default). 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.
-.TP 5
--a [printer(s)]
-.br
-Shows the accepting state of printer queues. If no printers are
-specified then all printers are listed.
-.TP 5
--c [class(es)]
-.br
+\fB\-W \fIwhich-jobs\fR
+Specifies which jobs to show, "completed" or "not-completed" (the default).
+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.
+.TP 5
+\fB\-a \fR[\fIprinter(s)\fR]
+Shows the accepting state of printer queues.
+If no printers are specified then all printers are listed.
+.TP 5
+\fB\-c \fR[\fIclass(es)\fR]
 Shows the printer classes and the printers that belong to them.
 If no classes are specified then all classes are listed.
 .TP 5
--d
-.br
+.B \-d
 Shows the current default destination.
 .TP 5
--h server[:port]
-.br
+\fB\-h \fIserver\fR[\fB:\fIport\fR]
 Specifies an alternate server.
 .TP 5
--l
-.br
+.B \-l
 Shows a long listing of printers, classes, or jobs.
 .TP 5
--o [destination(s)]
-.br
-Shows the jobs queue on the specified destinations. If no destinations are
-specified all jobs are shown.
+\fB\-o \fR[\fIdestination(s)\fR]
+Shows the jobs queued on the specified destinations.
+If no destinations are specified all jobs are shown.
 .TP 5
--p [printer(s)]
-.br
-Shows the printers and whether or not they are enabled for printing. If
-no printers are specified then all printers are listed.
+\fB\-p \fR[\fIprinter(s)\fR]
+Shows the printers and whether they are enabled for printing.
+If no printers are specified then all printers are listed.
 .TP 5
--r
-.br
+.B \-r
 Shows whether the CUPS server is running.
 .TP 5
--s
-.br
-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. This is equivalent to using the "-d", "-c",
-and "-v" options.
-.TP 5
--t
-.br
-Shows all status information. This is equivalent to using the "-r",
-"-d", "-c", "-v", "-a", "-p", and "-o" options.
-.TP 5
--u [user(s)]
-.br
-Shows a list of print jobs queued by the specified users. If no users
-are specified, lists the jobs queued by the current user.
-.TP 5
--v [printer(s)]
-.br
-Shows the printers and what device they are attached to. If no printers
-are specified then all printers are listed.
-.SH COMPATIBILITY
-Unlike the System V printing system, CUPS allows printer names to
-contain any printable character except SPACE, TAB, "/", and "#".
+.B \-s
+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.
+This is equivalent to using the \fI\-d\fR, \fI\-c\fR, and \fI\-v\fR options.
+.TP 5
+.B \-t
+Shows all status information.
+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.
+.TP 5
+\fB\-u \fR[\fIuser(s)\fR]
+Shows a list of print jobs queued by the specified users.
+If no users are specified, lists the jobs queued by the current user.
+.TP 5
+\fB\-v \fR[\fIprinter(s)\fR]
+Shows the printers and what device they are attached to.
+If no printers are specified then all printers are listed.
+.SH CONFORMING TO
+Unlike the System V printing system, CUPS allows printer names to contain any printable character except SPACE, TAB, "/", and "#".
 Also, printer and class names are \fInot\fR case-sensitive.
 .LP
-The "-h", "-E", "-U", and "-W" options are unique to CUPS.
+The \fI\-h\fR, \fI\-E\fR, \fI\-U\fR, and \fI\-W\fR options are unique to CUPS.
 .LP
-The Solaris "-f", "-P", and "-S" options are silently ignored.
+The Solaris \fI\-f\fR, \fI\-P\fR, and \fI\-S\fR options are silently ignored.
 .SH SEE ALSO
-\fIcancel(1)\fR, \fIlp(1)\fR,
-.br
-http://localhost:631/help
+.BR cancel (1),
+.BR lp (1),
+.BR lpq (1),
+.BR lpr (1),
+.BR lprm (1),
+CUPS Online Help (http://localhost:631/help)
 .SH COPYRIGHT
-Copyright 2007-2013 by Apple Inc.
+Copyright \[co] 2007-2014 by Apple Inc.
 .\"
-.\" End of "$Id: lpstat.man 11022 2013-06-06 22:14:09Z msweet $".
+.\" End of "$Id: lpstat.man 11924 2014-06-12 19:10:33Z msweet $".
 .\"