Merge changes from CUPS 1.4svn-r7696.

[thirdparty/cups.git] / man / lpstat.man

diff --git a/man/lpstat.man b/man/lpstat.man
index 45934918e1ef505216126b937e5991b73b1612d4..47294c5a5978a1e113b9aa30f3654e6e64869277 100644 (file)
--- a/man/lpstat.man
+++ b/man/lpstat.man
@@ -1,27 +1,18 @@
 .\"
 .\"

-.\" "$Id: lpstat.man 4948 2006-01-19 03:23:41Z mike $"
+.\" "$Id: lpstat.man 7600 2008-05-20 21:06:23Z mike $"

 .\"
 .\"   lpstat man page for the Common UNIX Printing System (CUPS).
 .\"
 .\"
 .\"   lpstat man page for the Common UNIX Printing System (CUPS).
 .\"

+.\"   Copyright 2007 by Apple Inc.

 .\"   Copyright 1997-2006 by Easy Software Products.
 .\"
 .\"   These coded instructions, statements, and computer programs are the
 .\"   Copyright 1997-2006 by Easy Software Products.
 .\"
 .\"   These coded instructions, statements, and computer programs are the

-.\"   property of Easy Software Products 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 missing or damaged please contact Easy Software Products
-.\"   at:
+.\"   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/".

 .\"
 .\"

-.\"       Attn: CUPS Licensing Information
-.\"       Easy Software Products
-.\"       44141 Airport View Drive, Suite 204
-.\"       Hollywood, Maryland 20636 USA
-.\"
-.\"       Voice: (301) 373-9600
-.\"       EMail: cups-info@cups.org
-.\"         WWW: http://www.cups.org
-.\"
-.TH lpstat 1 "Common UNIX Printing System" "18 January 2006" "Easy Software Products"
+.TH lpstat 1 "Common UNIX Printing System" "23 March 2006" "Apple Inc."

 .SH NAME
 lpstat \- print cups status information
 .SH SYNOPSIS
 .SH NAME
 lpstat \- print cups status information
 .SH SYNOPSIS


@@ -36,7 +27,7 @@ lpstat \- print cups status information
 .I destination(s)
 ] ] [ -c [
 .I class(es)
 .I destination(s)
 ] ] [ -c [
 .I class(es)

-] [ -d ] [ -o [
+] ] [ -d ] [ -o [

 .I destination(s)
 ] ] [ -p [
 .I printer(s)
 .I destination(s)
 ] ] [ -p [
 .I printer(s)


@@ -46,97 +37,103 @@ lpstat \- print cups status information
 .I printer(s)
 ] ]
 .SH DESCRIPTION
 .I printer(s)
 ] ]
 .SH DESCRIPTION

-\fBlpstat\fR displays status information about the current classes, jobs, and
-printers. When run with no arguments, \fBlpstat\fR will list jobs queued by
-the user. Other options include:
+\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.
+.SH OPTIONS
+The \fIlpstat\fR command supports the following options:

 .TP 5
 .TP 5

-\-E
+-E

 .br
 Forces encryption when connecting to the server.
 .TP 5
 .br
 Forces encryption when connecting to the server.
 .TP 5

-\-a [\fIprinter(s)\fR]
+-R
+.br
+Shows the ranking of print jobs.
+.TP 5
+-U username
+.br
+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
 .br
 Shows the accepting state of printer queues. If no printers are
 specified then all printers are listed.
 .TP 5

-\-c [\fIclass(es)\fR]
+-c [class(es)]

 .br
 .br

-Shows the printer classes and the printers that belong to them. If no
-classes are specified then all classes are listed.
+Shows the printer classes and the printers that belong to them.
+If no classes are specified then all classes are listed.

 .TP 5
 .TP 5

-\-d
+-d

 .br
 Shows the current default destination.
 .TP 5
 .br
 Shows the current default destination.
 .TP 5

-\-h \fIserver\fR
+-h server[:port]

 .br
 .br

-Specifies the CUPS server to communicate with.
+Specifies an alternate server.

 .TP 5
 .TP 5

-\-l
+-l

 .br
 Shows a long listing of printers, classes, or jobs.
 .TP 5
 .br
 Shows a long listing of printers, classes, or jobs.
 .TP 5

-\-o [\fIdestination(s)\fR]
+-o [destination(s)]

 .br
 Shows the jobs queue on the specified destinations. If no destinations are
 specified all jobs are shown.
 .TP 5
 .br
 Shows the jobs queue on the specified destinations. If no destinations are
 specified all jobs are shown.
 .TP 5

-\-p [\fIprinter(s)\fR]
+-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.
 .TP 5
 .br
 Shows the printers and whether or not they are enabled for printing. If
 no printers are specified then all printers are listed.
 .TP 5

-\-r
-.br
-Shows whether or not the CUPS server is running.
-.TP 5
-\-R
+-r

 .br
 .br

-Shows the ranking of print jobs.
+Shows whether the CUPS server is running.

 .TP 5
 .TP 5

-\-s
+-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
 .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
+-t

 .br
 Shows all status information. This is equivalent to using the "-r",
 "-d", "-c", "-v", "-a", "-p", and "-o" options.
 .TP 5
 .br
 Shows all status information. This is equivalent to using the "-r",
 "-d", "-c", "-v", "-a", "-p", and "-o" options.
 .TP 5

-\-u [\fIuser(s)\fR]
+-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
 .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 [\fIprinter(s)\fR]
+-v [printer(s)]

 .br
 Shows the printers and what device they are attached to. If no printers
 are specified then all printers are listed.
 .br
 Shows the printers and what device they are attached to. If no printers
 are specified then all printers are listed.

-.TP 5
-\-W [\fIwhich-jobs\fR]
-.br
-Specifies which jobs to show, \fIcompleted\fR or
-\fInot-completed\fR (the default). This option \fBmust\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.

 .SH COMPATIBILITY
 .SH COMPATIBILITY

-Unlike the System V printing system, CUPS allows printer names
-to contain any printable character except SPACE and TAB. Also,
-printer and class names are \fBnot\fR case-sensitive.
+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
 .LP

-The "-h" and "-W" options are unique to CUPS.
+The "-h", "-E", "-U", and "-W" options are unique to CUPS.

 .LP
 The Solaris "-f", "-P", and "-S" options are silently ignored.
 .SH SEE ALSO
 .LP
 The Solaris "-f", "-P", and "-S" options are silently ignored.
 .SH SEE ALSO

-cancel(1), lp(1),
+\fIcancel(1)\fR, \fIlp(1)\fR,

 .br
 http://localhost:631/help
 .SH COPYRIGHT
 .br
 http://localhost:631/help
 .SH COPYRIGHT

-Copyright 1993-2006 by Easy Software Products, All Rights Reserved.
+Copyright 2007 by Apple Inc.

 .\"
 .\"

-.\" End of "$Id: lpstat.man 4948 2006-01-19 03:23:41Z mike $".
+.\" End of "$Id: lpstat.man 7600 2008-05-20 21:06:23Z mike $".

 .\"
 .\"