8322 nl: misleading-indentation
[unleashed/tickless.git] / usr / src / man / man1b / lprm.1b
blob2213d2ba8b3f4b1505da8d5b35f7503e978b97f5
1 '\" te
2 .\" Copyright (c) 1983 Regents of the University of California.  All rights reserved.  The Berkeley software License Agreement  specifies the terms and conditions for redistribution.
3 .\" Copyright (C) 2006, Sun Microsystems, Inc. All Rights Reserved
4 .TH LPRM 1B "Feb 25, 2017"
5 .SH NAME
6 lprm \- remove print requests from the print queue
7 .SH SYNOPSIS
8 .LP
9 .nf
10 \fB/usr/ucb/lprm\fR [\fB-P\fR \fIdestination\fR] [\fB-\fR] [\fIrequest-ID\fR]...
11      [\fIuser\fR]...
12 .fi
14 .SH DESCRIPTION
15 .LP
16 The  \fBlprm\fR utility removes print requests  (\fIrequest-ID\fR) from the
17 print queue.
18 .sp
19 .LP
20 Without arguments, \fBlprm\fR deletes the current print request. \fBlprm\fR
21 reports the  name of the file associated with print requests that it removes.
22 \fBlprm\fR is silent if there are no applicable print requests to remove.
23 .sp
24 .LP
25 Users can only remove print requests associated with their user name. See
26 Notes. If a superuser executes \fBlprm\fR and specifies the \fIuser\fR operand,
27 \fBlprm\fR removes all print requests belonging to the specified user.
28 .sp
29 .LP
30 The print client commands locate destination information using the "printers"
31 database in the name service switch. See \fBnsswitch.conf\fR(4),
32 \fBprinters\fR(4), and \fBprinters.conf\fR(4) for details.
33 .SH OPTIONS
34 .LP
35 The following options are supported:
36 .sp
37 .ne 2
38 .na
39 \fB\fB-P\fR \fIdestination\fR\fR
40 .ad
41 .RS 18n
42 The name of the printer or class of printers (see \fBlpadmin\fR(1M)) from which
43 to remove print requests. Specify destination using atomic, URI-style
44 (\fIscheme\fR\fB://\fR\fBendpoint\fR), or POSIX-style
45 (\fIserver\fR\fB:\fR\fIdestination\fR) names. See \fBprinters.conf\fR(4) for
46 information regarding the naming naming conventions for destination names.
47 .RE
49 .sp
50 .ne 2
51 .na
52 \fB\fB\(mi\fR\fR
53 .ad
54 .RS 18n
55 If a user specifies this option,  removes all print requests owned by that
56 user. If a superuser specifies this option, removes all requests in the print
57 queue.  Job ownership is determined by the user's login name and host name on
58 the machine from which \fBlpr\fR was executed. See Notes.
59 .RE
61 .SH OPERANDS
62 .LP
63 The following operands are supported.
64 .sp
65 .ne 2
66 .na
67 \fB\fIrequest-ID\fR\fR
68 .ad
69 .RS 14n
70 Removes a specific print request. Specify  \fIrequest-ID\fR as the job number
71 (\fBJob\fR) associated with a print request and  reported by \fBlpq\fR. See
72 \fBlpq\fR(1B).
73 .RE
75 .sp
76 .ne 2
77 .na
78 \fB\fIuser\fR\fR
79 .ad
80 .RS 14n
81 Removes print requests associated with  a specific user. Specify \fIuser\fR as
82 a valid user name. This option can only be used by a superuser.
83 .RE
85 .SH EXAMPLES
86 .LP
87 \fBExample 1 \fRRemoving a Print Request
88 .sp
89 .LP
90 The following example removes request-ID \fB385\fR from destination
91 \fBkilltree\fR:
93 .sp
94 .in +2
95 .nf
96 example% \fBlprm \(miP killtree 385\fR
97 .fi
98 .in -2
99 .sp
101 .SH EXIT STATUS
103 The following exit values are returned:
105 .ne 2
107 \fB\fB0\fR\fR
109 .RS 12n
110 Successful completion.
114 .ne 2
116 \fBnon-zero\fR
118 .RS 12n
119 An error occurred.
122 .SH FILES
123 .ne 2
125 \fB\fB$HOME/.printers\fR\fR
127 .RS 24n
128 User-configurable printer database
132 .ne 2
134 \fB\fB/etc/printers.conf\fR\fR
136 .RS 24n
137 System printer configuration database
141 .ne 2
143 \fB\fBprinters.conf.byname\fR\fR
145 .RS 24n
146 NIS version of \fB/etc/printers.conf\fR
150 .ne 2
152 \fB\fBou=printers\fR\fR
154 .RS 24n
155 LDAP version of \fB/etc/printers.conf\fR
158 .SH ATTRIBUTES
160 See \fBattributes\fR(5) for descriptions of the following attributes:
165 box;
166 c | c
167 l | l .
168 ATTRIBUTE TYPE  ATTRIBUTE VALUE
170 Interface Stability     Standard
173 .SH SEE ALSO
175 \fBlp\fR(1), \fBlpc\fR(1B), \fBlpq\fR(1B), \fBlpr\fR(1B), \fBlpstat\fR(1),
176 \fBlpadmin\fR(1M), \fBnsswitch.conf\fR(4), \fBprinters\fR(4),
177 \fBprinters.conf\fR(4), \fBattributes\fR(5), \fBstandards\fR(5)
178 .SH NOTES
180 Users can only remove print requests associated with their user name. By
181 default, users can only remove print requests on the host from which the print
182 request was submitted. If a superuser has set \fBuser-equivalence=true\fR in
183 \fB/etc/printers.conf\fR on the print server, users can remove print requests
184 associated with their user name on any host. Superusers can remove print
185 requests on the host from which the print request was submitted. Superusers can
186 also remove print requests from the print server.
189 Some print servers send cancelation notification to job owners when their print
190 jobs have been cancelled. This notification usually comes in the form of an
191 email message. Cancelation notices cannot be disabled on a Solaris server.
192 .SH NOTES
194 When IPP is in use, the user is prompted for a passphrase if the remote print
195 service is configured to require authentication.