Sun Microsystems, Inc. gratefully acknowledges The Open Group for
permission to reproduce portions of its copyrighted documentation.
Original documentation from The Open Group can be obtained online at
http://www.opengroup.org/bookstore/.
The Institute of Electrical and Electronics Engineers and The Open
Group, have given us permission to reprint portions of their
documentation.
In the following statement, the phrase ``this text'' refers to portions
of the system documentation.
Portions of this text are reprinted and reproduced in electronic form
in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
Standard for Information Technology -- Portable Operating System
Interface (POSIX), The Open Group Base Specifications Issue 6,
Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
Engineers, Inc and The Open Group. In the event of any discrepancy
between these versions and the original IEEE and The Open Group
Standard, the original IEEE and The Open Group Standard is the referee
document. The original Standard can be obtained online at
http://www.opengroup.org/unix/online.html.
This notice shall appear on any product containing this material.
The contents of this file are subject to the terms of the
Common Development and Distribution License (the "License").
You may not use this file except in compliance with the License.
You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
or http://www.opensolaris.org/os/licensing.
See the License for the specific language governing permissions
and limitations under the License.
When distributing Covered Code, include this CDDL HEADER in each
file and include the License file at usr/src/OPENSOLARIS.LICENSE.
If applicable, add the following below this CDDL HEADER, with the
fields enclosed by brackets "[]" replaced with your own identifying
information: Portions Copyright [yyyy] [name of copyright owner]
Copyright 1989 AT&T
Portions Copyright (c) 1992, X/Open Company Limited All Rights Reserved
Copyright (C) 2009, Sun Microsystems, Inc. All Rights Reserved
lpstat [-d] [-r] [-R] [-s] [-t] [-a [list]] [-c [list]] [-f [list]] [-o [list]] [-p [list] [-D]] [-S [list]] [-u [login- ID -list]] [-v [list]] [-l level]
The lpstat utility displays information about the current status of the LP print service to standard output.
If no options are given, lpstat prints the status of all the user's print requests made by lp. See lp(1). Any arguments that are not options are assumed to be request-IDs as returned by lp. The lpstat command prints the status of such requests. options appears in any order and can be repeated and intermixed with other arguments. Some key letters can be followed by an optional list that can be in one of two forms: a list of items separated from one another by a comma, or a list of items separated from one another by spaces enclosed in quotes. For example:
example% lpstat -u "user1 user2 user3"
Specifying all after any key letter that takes list as an argument causes all information relevant to the key letter to be printed. For example, the command:
example% lpstat -o all
prints the status of all output requests.
The omission of a list following such key letters causes all information relevant to the key letter to be printed. For example, the command:
example% lpstat -o
prints the status of all output requests.
The print client commands locate destination information using the "printers" database in the name service switch. See nsswitch.conf(5), printers(5), and printers.conf(5) for details.
The following options are supported: -a [list]
Reports whether print destinations are accepting requests. list is a list of intermixed printer names and class names. If the print queue is remote and IPP is in use, the information provided is very close to that reported for local queues. If the print queue is remote and IPP is not in use (the print server is older than Solaris 9, Update 6 or another RFC-1179-based print service), this option does not report any useful information.
Prints name of all classes and their members. list is a list of class names. If the print queue is remote and IPP is in use, the information provided is very close to that reported for local queues. If the print queue is remote and IPP is not in use (the print server is older than Solaris 9, Update 6 or another RFC-1179-based print service), this option does not report any useful information.
Prints the default destination for output requests.
Prints a verification that the forms in list are recognized by the LP print service. list is a list of forms; the default is all. The -l option lists the form descriptions. If the print queue is remote and IPP is in use, the information provided is very close to that reported for local queues. If the print queue is remote and IPP is not in use (the print server is older than Solaris 9, Update 6 or another RFC-1179-based print service), this option does not report any useful information.
Specifies the verbosity level for extended reporting of printer or job objects (-o, -p, -r, -u). Without this option, a level of 0 is used, which reports summary information. When no level is specified, a level of 1is used, which provides more information about the object. A level of 2 or more enumerates all of the object's attributes. If the print queue is remote and IPP is in use, the information provided is very close to that reported for local queues. If the print queue is remote and IPP is not in use (the print server is older than Solaris 9, Update 6 or another RFC-1179-based print service), this option does not report any useful information.
Prints the status of output requests. list is a list of intermixed printer names, class names, and request-IDs. The key letter -o can be omitted. Specify printer and class names using atomic, URI-style (scheme://endpoint), or POSIX-style (server:destination) names. See printers.conf(5) for more information.
Prints the status of printers. list is a list of printer names. If the -D option is given, a brief description is printed for each printer in list. If the -l option is given and the printer is on the local machine, a full description of each printer's configuration is returned, including the form mounted, the acceptable content and printer types, a printer description, and the interface used. If the print queue is remote and IPP is in use, correct job id is reported. If the print queue is remote and IPP is not in use (the print server is older than Solaris 9, Update 6 or another RFC-1179-based print service), -p [list] always reports the first job in the queue irrespective of its status.
Prints the status of the LP request scheduler.
Prints a number showing the position of each request in the print queue.
Prints a status summary, including the status of the LP scheduler, the default destination, a list of printers and their associated devices, a list of the machines sharing print services, a list of all forms currently mounted, and a list of all recognized character sets and print wheels.
Prints a verification that the character sets or the print wheels specified in list are recognized by the LP print service. Items in list can be character sets or print wheels; the default for the list is all. If the -l option is given, each line is appended by a list of printers that can handle the print wheel or character set. The list also shows whether the print wheel or character set is mounted, or specifies the built-in character set into which it maps. If the print queue is remote and IPP is in use, the information provided is very close to that reported for local queues. If the print queue is remote and IPP is not in use (the print server is older than Solaris 9, Update 6 or another RFC-1179-based print service), this option does not report any useful information.
Prints all status information. This includes all the information obtained with the -s option, plus the acceptance and idle/busy status of all printers.
Prints the status of output requests for users. The login-ID-list argument can include any or all of the following constructs: login-ID
a user on any system
a user on system system_name
all users on system system_name
a user on all systems
all users on all systems
Prints the names of printers and the path names of the devices associated with them or remote system names for network printers. list is a list of printer names.
The following exit values are returned: 0
Successful completion.
An error occurred.
System printer configuration database
User-configurable printer database
LDAP version of /etc/printers.conf
NIS version of /etc/printers.conf
See attributes(7) for descriptions of the following attributes:
| ATTRIBUTE TYPE ATTRIBUTE VALUE |
| Interface Stability Standard |
cancel (1), lp (1), lpq (1B), lpr (1B), lprm (1B), nsswitch.conf (5), printers (5), printers.conf (5), attributes (7), standards (7)
For remote print queues, the BSD print protocol provides a very limited set of information. The Internet Print Protocol (IPP) is preferred.
When IPP is in use, the user is prompted for a passphrase if the remote print service is configured to require authentication.