Debian Codegraph @

upstream/debian-unstable/man1/lprm.1

raw
1 .TH LPRM 1 2006-12-09 "LPRng" "lprm command"
2 .SH NAME
3 lprm \- remove jobs from the line printer spooling queue
4 .SH SYNOPSIS
5 .B lprm
6 [
7 .B \-a
8 ]
9 [
10 .B \-A
11 ]
12 [
13 .BI \-D debugopt
14 ]
15 [
16 .BI \-P printer
17 ]
18 [
19 .B \-V
20 ]
21 [
22 .BI \-U user
23 ]
24 .ti +5n
25 [
26 .IR jobid \|.\|.\|.
27 ]
28 [
29 .I all
30 ]
31 .SH DESCRIPTION
32 .PP
33 .I Lprm
34 will send a request to the LPD server to remove jobs
35 from a spool queue.
36 (See
37 .IR clean (1)
38 for an
39 .IR lp (1)
40 compatible interface.)
41 .I Lprm
42 is normally the only method by which a user may remove a job.
43 The jobs to be removed are specified by the job number or user name;
44 with no specifiers the first removable in a queue will be
45 selected for removal.
46 Usually users may only remove jobs submitted by themselves from
47 the host which originated the original lpr request.
48 .PP
49 The spool queue is searched first for jobs that the user has permissions to
50 remove,
51 then for jobs that match any of the specified set of tags.
52 If no tags are specified,
53 only the first job in the queue that the user has permissions to remove
54 will be removed.
55 If the
56 .B \-a
57 flag or the
58 .I all
59 spool queue is specified,
60 .I lprm
61 will search all available spool queues.
62 .LP
63 The
64 .I all
65 wildcard jobid is used to match all jobs in a spool queue;
66 however unless the user has
67 .I control
68 permissions for the spool queue only the user's jobs will be removed.
69 See the
70 .BR lpd (1)
71 man page for details about control permissions.
72 .PP
73 A jobid can be a job number,
74 a user name,
75 a job identifier,
76 or a pattern for a
77 .I glob
78 based wild card match.
79 This match is applied to the job identifier information.
80 .PP
81 .I Lprm
82 will announce the names of any files it removes and is silent if
83 there are no jobs in the queue which match the request list.
84 If the job being removed is active,
85 the LPD server will stop printing the job and then
86 restart printing operations.
87 .SH EXAMPLES
88 .TP
89 Remove the last job I submitted if it is in the queue:
90 .sp
91 lprm
92 .TP
93 Remove job 25 in spool queue p1:
94 .sp
95 lprm -Pp1 25
96 .TP
97 Remove job 25 and 30 in spool queue p1:
98 .sp
99 lprm -Pp1 25 30
100 .TP
101 Remove all of user john's jobs in spool queue p1:
102 .sp
103 lprm -Pp1 john
104 .TP
105 Remove all jobs in spool queue p1:
106 .sp
107 lprm -Pp1 all
108 .TP
109 Remove all jobs in all spool queues:
110 .sp
111 lprm -a all
112 .TP
113 Remove the jobs with identifier nobody@system in spool queue p1.
114 Note that the quotes around the pattern are needed to suppress
115 shell glob expansion.
116 .sp
117 lprm -Pp1 'nobody@system*'
118 .SH OPTIONS
119 .IP "\fB\-A\fR" 5
120 Use authentication specified by the value of the AUTH environment variable.
121 .IP "\fB\-a\fR" 5
122 Remove files from all spool queues available to the user.
123 .IP "\fB\-P\fIprinter\fR" 5
124 Specifies printer queue.
125 By default,
126 the destination printer
127 is taken from
128 the command line
129 .I dest
130 value,
131 then
132 the environment variables
133 PRINTER,
134 LPDEST,
135 NPRINTER,
136 NGPRINTER,
137 then first entry in the printcap information,
138 and and finally the default_printer entry from the
139 configuration file,
140 and then the compile time default.
141 .IP "\fB\-U\fIuser\fR" 5
142 Explicitly provide a userid for doing the removal to the LPD server.
143 This can be done only by ROOT or userids listed in the
144 .I allow_user_setting
145 configuration or printcap option.
146 This facility is provided to allow printing front end systems such
147 as SAMBA to submit job removal requests on behalf of users.
148 .IP "\fB\-D\fIdebugopts\fR" 5
149 Debugging is controlled using the
150 .B \-D
151 option. This accepts a comma-separated list of debugging
152 settings. These settings take one of two forms:
153 .B facility=value ,
154 or
155 .B value
156 to set an overall default value.
157 .IP "\fB\-V\fR" 5
158 The \-V option prints the version information for the program and
159 verbose information about activities.
160 .SH WARNINGS
161 .PP
162 Users with
163 CONTROL (i.e.- administrative) permissions on spool queues
164 can remove any or all jobs.
165 The
166 .I all
167 wildcard defaults to all user jobs,
168 not just those submitted by the user.
169 This allows administrators to purge a spool queue easily.
170 .SH ENVIRONMENT
171 .PP
172 By default,
173 the destination printer
174 is taken from
175 the command line
176 .I dest
177 value,
178 then
179 the environment variables
180 PRINTER,
181 LPDEST,
182 NPRINTER,
183 NGPRINTER,
184 then first entry in the printcap information,
185 and and finally the default_printer entry from the
186 configuration file,
187 and then the compile time default.
188 .SH "EXIT STATUS"
189 .PP
190 The following exit values are returned:
191 .TP 15
192 .B "zero (0)"
193 Successful completion.
194 .TP
195 .B "non-zero (!=0)"
196 An error occurred.
197 .SH FILES
198 .PP
199 The files used by LPRng are set by values in the
200 printer configuration file.
201 The following are a commonly used set of default values.
202 .nf
203 .ta \w'/var/spool/lpd/printcap.<hostname> 'u
204 /etc/lprng/lpd.conf LPRng configuration file
205 ${HOME}/.printcap user printer description file
206 /etc/printcap printer description file
207 /etc/lprng/lpd.perms permissions
208 /var/run/lprng/lpd lock file for queue control
209 /var/spool/lpd spool directories
210 /var/spool/lpd/QUEUE/control queue control
211 /var/spool/lpd/QUEUE/log trace or debug log file
212 /var/spool/lpd/QUEUE/acct accounting file
213 /var/spool/lpd/QUEUE/status status file
214 .fi
215 .SH "SEE ALSO"
216 lpd.conf(5),
217 lpc(8),
218 lpd(8),
219 checkpc(8),
220 lpr(1),
221 lpq(1),
222 lprm(1),
223 printcap(5),
224 lpd.conf(5),
225 pr(1), lprng_certs(1), lprng_index_certs(1).
226 .SH "AUTHOR"
227 Patrick Powell <[email protected]>.
228 .SH DIAGNOSTICS
229 Most of the diagnostics are self explanatory.
230 If you are puzzled over the exact cause of failure,
231 set the debugging level on (-D5) and run again.
232 The debugging information will
233 help you to pinpoint the exact cause of failure.
234 .SH "HISTORY"
235 LPRng is a enhanced printer spooler system
236 with functionality similar to the Berkeley LPR software.
237 The LPRng developer mailing list is [email protected];
238 subscribe by visiting
239 .B https://lists.sourceforge.net/lists/listinfo/lprng-devel
240 or sending mail to
241 .B [email protected]
242 with
243 the word
244 .I subscribe
245 in the body.
246 .br
247 The software is available via
248 .B http://lprng.sourceforge.net