9070 Remove wanboot from gate
[unleashed.git] / usr / src / man / man1 / cancel.1
blob7db11ba4ce3e393b139c321cf13bd84b8c9c07fb
1 '\" te
2 .\" Copyright 1989 AT&T
3 .\" Copyright (C) 2005, 2006 Sun Microsystems, Inc. All Rights Reserved
4 .\" 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.
5 .\" 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.
6 .\" 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]
7 .TH CANCEL 1 "Nov 26, 2017"
8 .SH NAME
9 cancel \- cancel print request
10 .SH SYNOPSIS
11 .LP
12 .nf
13 \fBcancel\fR [\fIrequest-ID\fR...] [\fIdestination\fR]...
14 .fi
16 .LP
17 .nf
18 \fBcancel\fR \fB-u\fR \fIuser\fR... [\fIdestination\fR]...
19 .fi
21 .SH DESCRIPTION
22 .LP
23 The \fBcancel\fR utility cancels print requests. There are two forms of the
24 \fBcancel\fR command.
25 .sp
26 .LP
27 The first form of \fBcancel\fR has two optional arguments: print requests
28 (\fIrequest-ID\fR) and destinations (\fIdestination\fR). Specifying
29 \fIrequest-ID\fR with \fIdestination\fR cancels \fIrequest-ID\fR on
30 \fIdestination\fR. Specifying only the destination cancels the current print
31 request on \fIdestination\fR. If \fIdestination\fR is not specified,
32 \fBcancel\fR cancels the requested print request on all destinations.
33 .sp
34 .LP
35 The second form of \fBcancel\fR cancels a user's print requests on specific
36 destinations.
37 .sp
38 .LP
39 Users can only cancel print requests associated with their username. By
40 default, users can only cancel print requests on the host from which the print
41 request was submitted. If a super-user has set \fBuser-equivalence=true\fR in
42 \fB/etc/printers.conf\fR on the print server, users can cancel print requests
43 associated with their username on any host. Super-users can cancel print
44 requests on the host from which the print request was submitted. Superusers can
45 also cancel print requests from the print server.
46 .sp
47 .LP
48 The print client commands locate destination information using the
49 \fBprinters\fR database in the name service switch. See \fBnsswitch.conf\fR(4),
50 \fBprinters\fR(4), and \fBprinters.conf\fR(4) for details.
51 .SH OPTIONS
52 .LP
53 The following options are supported:
54 .sp
55 .ne 2
56 .na
57 \fB\fB-u\fR \fIuser\fR\fR
58 .ad
59 .RS 11n
60 The name of the user for which print requests are to be cancelled. Specify
61 \fIuser\fR as a username.
62 .RE
64 .SH OPERANDS
65 .LP
66 The following operands are supported:
67 .sp
68 .ne 2
69 .na
70 \fB\fIdestination\fR\fR
71 .ad
72 .RS 15n
73 The destination on which the print requests are to be canceled.
74 \fIdestination\fR is the name of a printer or class of printers (see
75 \fBlpadmin\fR(1M)). If \fIdestination\fR is not specified, \fBcancel\fR cancels
76 the requested print request on all destinations. Specify \fIdestination\fR
77 using atomic, URI-style (\fIscheme\fR\fB://\fR\fIendpoint\fR), or POSIX-style
78 (\fIserver\fR\fB:\fR\fIdestination\fR), names. See Notes for information
79 regarding using URI-style or POSIX-style destination names with \fBcancel\fR.
80 See \fBprinters.conf\fR(4) for more information.
81 .RE
83 .sp
84 .ne 2
85 .na
86 \fB\fIrequest-ID\fR\fR
87 .ad
88 .RS 15n
89 The print request to be canceled. Specify \fIrequest-ID\fR using \fBLP-style\fR
90 request \fBIDs\fR (\fIdestination\fR-\fInumber\fR).
91 .RE
93 .sp
94 .ne 2
95 .na
96 \fB\fIuser\fR\fR
97 .ad
98 .RS 15n
99 The name of the user for which the print requests are to be cancelled. Specify
100 \fIuser\fR as a username.
103 .SH EXIT STATUS
105 The following exit values are returned:
107 .ne 2
109 \fB\fB0\fR\fR
111 .RS 12n
112 Successful completion.
116 .ne 2
118 \fBnon-zero\fR
120 .RS 12n
121 An error occurred.
124 .SH FILES
125 .ne 2
127 \fB\fB/etc/printers.conf\fR\fR
129 .RS 24n
130 System printer configuration database
134 .ne 2
136 \fB\fB$HOME/.printers\fR\fR
138 .RS 24n
139 User-configurable printer database
143 .ne 2
145 \fB\fBou=printers\fR\fR
147 .RS 24n
148 LDAP version of \fB/etc/printers.conf\fR
152 .ne 2
154 \fB\fBprinters.conf.byname\fR\fR
156 .RS 24n
157 \fBNIS\fR version of \fB/etc/printers.conf\fR
160 .SH ATTRIBUTES
162 See \fBattributes\fR(5) for descriptions of the following attributes:
167 box;
168 c | c
169 l | l .
170 ATTRIBUTE TYPE  ATTRIBUTE VALUE
172 Interface Stability     Obsolete
175 .SH SEE ALSO
177 \fBlp\fR(1), \fBlpq\fR(1B), \fBlpr\fR(1B), \fBlprm\fR(1B), \fBlpstat\fR(1),
178 \fBlpadmin\fR(1M), \fBnsswitch.conf\fR(4), \fBprinters\fR(4),
179 \fBprinters.conf\fR(4), \fBattributes\fR(5), \fBstandards\fR(5)
180 .SH NOTES
182 URI-style and POSIX-style destination names (\fIserver\fR:\fIdestination\fR)
183 are treated as print requests if \fIdestination\fR has the same format as an
184 \fBLP-style\fR \fIrequest-ID\fR. See \fBstandards\fR(5).
187 Some print servers send cancellation notifications to job owners when their
188 print jobs have been cancelled. This notification usually comes in the form of
189 an email message. Cancellation notices cannot be disabled on a Solaris server.
192 When IPP is in use, the user is prompted for a passphrase if the remote print
193 service is configured to require authentication.