usr/src/man/man1/cancel.1

   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 "May 26, 2006"
   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
  15
  16 .LP
  17 .nf
  18 \fBcancel\fR \fB-u\fR \fIuser\fR... [\fIdestination\fR]...
  19 .fi
  20
  21 .SH DESCRIPTION
  22 .sp
  23 .LP
  24 The \fBcancel\fR utility cancels print requests. There are two forms of the
  25 \fBcancel\fR command.
  26 .sp
  27 .LP
  28 The first form of \fBcancel\fR has two optional arguments: print requests
  29 (\fIrequest-ID\fR) and destinations (\fIdestination\fR). Specifying
  30 \fIrequest-ID\fR with \fIdestination\fR cancels \fIrequest-ID\fR on
  31 \fIdestination\fR. Specifying only the destination cancels the current print
  32 request on \fIdestination\fR. If \fIdestination\fR is not specified,
  33 \fBcancel\fR cancels the requested print request on all destinations.
  34 .sp
  35 .LP
  36 The second form of \fBcancel\fR cancels a user's print requests on specific
  37 destinations.
  38 .sp
  39 .LP
  40 Users can only cancel print requests associated with their username. By
  41 default, users can only cancel print requests on the host from which the print
  42 request was submitted. If a super-user has set \fBuser-equivalence=true\fR in
  43 \fB/etc/printers.conf\fR on the print server, users can cancel print requests
  44 associated with their username on any host. Super-users can cancel print
  45 requests on the host from which the print request was submitted. Superusers can
  46 also cancel print requests from the print server.
  47 .sp
  48 .LP
  49 The print client commands locate destination information using the
  50 \fBprinters\fR database in the name service switch. See \fBnsswitch.conf\fR(4),
  51 \fBprinters\fR(4), and \fBprinters.conf\fR(4) for details.
  52 .SH OPTIONS
  53 .sp
  54 .LP
  55 The following options are supported:
  56 .sp
  57 .ne 2
  58 .na
  59 \fB\fB-u\fR \fIuser\fR\fR
  60 .ad
  61 .RS 11n
  62 The name of the user for which print requests are to be cancelled. Specify
  63 \fIuser\fR as a username.
  64 .RE
  65
  66 .SH OPERANDS
  67 .sp
  68 .LP
  69 The following operands are supported:
  70 .sp
  71 .ne 2
  72 .na
  73 \fB\fIdestination\fR\fR
  74 .ad
  75 .RS 15n
  76 The destination on which the print requests are to be canceled.
  77 \fIdestination\fR is the name of a printer or class of printers (see
  78 \fBlpadmin\fR(1M)). If \fIdestination\fR is not specified, \fBcancel\fR cancels
  79 the requested print request on all destinations. Specify \fIdestination\fR
  80 using atomic, URI-style (\fIscheme\fR\fB://\fR\fIendpoint\fR), or POSIX-style
  81 (\fIserver\fR\fB:\fR\fIdestination\fR), names. See Notes for information
  82 regarding using URI-style or POSIX-style destination names with \fBcancel\fR.
  83 See \fBprinters.conf\fR(4) for more information.
  84 .RE
  85
  86 .sp
  87 .ne 2
  88 .na
  89 \fB\fIrequest-ID\fR\fR
  90 .ad
  91 .RS 15n
  92 The print request to be canceled. Specify \fIrequest-ID\fR using \fBLP-style\fR
  93 request \fBIDs\fR (\fIdestination\fR-\fInumber\fR).
  94 .RE
  95
  96 .sp
  97 .ne 2
  98 .na
  99 \fB\fIuser\fR\fR
 100 .ad
 101 .RS 15n
 102 The name of the user for which the print requests are to be cancelled. Specify
 103 \fIuser\fR as a username.
 104 .RE
 105
 106 .SH EXIT STATUS
 107 .sp
 108 .LP
 109 The following exit values are returned:
 110 .sp
 111 .ne 2
 112 .na
 113 \fB\fB0\fR\fR
 114 .ad
 115 .RS 12n
 116 Successful completion.
 117 .RE
 118
 119 .sp
 120 .ne 2
 121 .na
 122 \fBnon-zero\fR
 123 .ad
 124 .RS 12n
 125 An error occurred.
 126 .RE
 127
 128 .SH FILES
 129 .sp
 130 .ne 2
 131 .na
 132 \fB\fB/etc/printers.conf\fR\fR
 133 .ad
 134 .RS 24n
 135 System printer configuration database
 136 .RE
 137
 138 .sp
 139 .ne 2
 140 .na
 141 \fB\fB$HOME/.printers\fR\fR
 142 .ad
 143 .RS 24n
 144 User-configurable printer database
 145 .RE
 146
 147 .sp
 148 .ne 2
 149 .na
 150 \fB\fBou=printers\fR\fR
 151 .ad
 152 .RS 24n
 153 LDAP version of \fB/etc/printers.conf\fR
 154 .RE
 155
 156 .sp
 157 .ne 2
 158 .na
 159 \fB\fBprinters.conf.byname\fR\fR
 160 .ad
 161 .RS 24n
 162 \fBNIS\fR version of \fB/etc/printers.conf\fR
 163 .RE
 164
 165 .sp
 166 .ne 2
 167 .na
 168 \fB\fBprinters.org_dir\fR\fR
 169 .ad
 170 .RS 24n
 171 \fBNIS+\fR version of \fB/etc/printers.conf\fR
 172 .RE
 173
 174 .SH ATTRIBUTES
 175 .sp
 176 .LP
 177 See \fBattributes\fR(5) for descriptions of the following attributes:
 178 .sp
 179
 180 .sp
 181 .TS
 182 box;
 183 c | c
 184 l | l .
 185 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 186 _
 187 Interface Stability     Obsolete
 188 .TE
 189
 190 .SH SEE ALSO
 191 .sp
 192 .LP
 193 \fBlp\fR(1), \fBlpq\fR(1B), \fBlpr\fR(1B), \fBlprm\fR(1B), \fBlpstat\fR(1),
 194 \fBlpadmin\fR(1M), \fBnsswitch.conf\fR(4), \fBprinters\fR(4),
 195 \fBprinters.conf\fR(4), \fBattributes\fR(5), \fBstandards\fR(5)
 196 .SH NOTES
 197 .sp
 198 .LP
 199 URI-style and POSIX-style destination names (\fIserver\fR:\fIdestination\fR)
 200 are treated as print requests if \fIdestination\fR has the same format as an
 201 \fBLP-style\fR \fIrequest-ID\fR. See \fBstandards\fR(5).
 202 .sp
 203 .LP
 204 Some print servers send cancelation notification to job owners when their print
 205 jobs have been cancelled. This notification usually comes in the form of an
 206 email message. Cancelation notices cannot be disabled on a Solaris server.
 207 .sp
 208 .LP
 209 When IPP is in use, the user is prompted for a passphsrase if the remote print
 210 service is configured to require authentication.