xref: /freebsd/usr.sbin/lpr/lprm/lprm.1 (revision 380a989b3223d455375b4fae70fd0b9bdd43bafb)
1.\" Copyright (c) 1983, 1990, 1993
2.\"	The Regents of the University of California.  All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\" 3. All advertising materials mentioning features or use of this software
13.\"    must display the following acknowledgement:
14.\"	This product includes software developed by the University of
15.\"	California, Berkeley and its contributors.
16.\" 4. Neither the name of the University nor the names of its contributors
17.\"    may be used to endorse or promote products derived from this software
18.\"    without specific prior written permission.
19.\"
20.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30.\" SUCH DAMAGE.
31.\"
32.\"     @(#)lprm.1	8.1 (Berkeley) 6/6/93
33.\"
34.Dd June 6, 1993
35.Dt LPRM 1
36.Os BSD 4.2
37.Sh NAME
38.Nm lprm
39.Nd remove jobs from the line printer spooling queue
40.Sh SYNOPSIS
41.Nm lprm
42.Op Fl P Ns Ar printer
43.Op Fl
44.Op job # ...
45.Op Ar user ...
46.Sh DESCRIPTION
47.Nm Lprm
48will remove a job, or jobs, from a printer's spool queue.
49Since the spooling directory is protected from users, using
50.Nm
51is normally the only method by which a user may remove a job.
52The owner of a job is determined by the user's login name
53and host name on the machine where the
54.Xr lpr 1
55command was invoked.
56.Pp
57Options and arguments:
58.Bl -tag -width indent
59.It Fl P Ns Ar printer
60Specify the queue associated with a specific
61.Ar printer
62(otherwise the default printer is used).
63.It Fl
64If a single
65.Sq Fl
66is given,
67.Nm
68will remove all jobs which a user
69owns.  If the super-user employs this flag, the spool queue will
70be emptied entirely.
71.It Ar user
72Cause
73.Nm
74to attempt to remove any jobs queued belonging to that user
75(or users).  This form of invoking
76.Nm
77is useful only to the super-user.
78.It Ar job\ \&#
79A user may dequeue an individual job by specifying its job number.
80This number may be obtained from the
81.Xr lpq  1
82program, e.g.
83.Pp
84.Bd -literal -offset indent
85\&% lpq \-l
86
871st:ken				[job #013ucbarpa]
88	(standard input)	100 bytes
89% lprm 13
90.Ed
91.El
92.Pp
93If neither arguments or options are given,
94.Nm
95will delete the currently active job if it is
96owned by the user who invoked
97.Nm lprm  .
98.Pp
99.Nm Lprm
100announces the names of any files it removes and is silent if
101there are no jobs in the queue which match the request list.
102.Pp
103.Nm Lprm
104will kill off an active daemon, if necessary, before removing
105any spooling files.  If a daemon is killed, a new one is
106automatically restarted upon completion of file removals.
107.Sh ENVIRONMENT
108If the following environment variable exists, it is utilized by
109.Nm lprm .
110.Bl -tag -width PRINTER
111.It Ev PRINTER
112If the environment variable
113.Ev PRINTER
114exists,
115and a printer has not been specified with the
116.Fl P
117option,
118the default printer is assumed from
119.Ev PRINTER .
120.El
121.Sh FILES
122.Bl -tag -width /var/spool/*/lock/ -compact
123.It Pa /etc/printcap
124Printer characteristics file.
125.It Pa /var/spool/*
126Spooling directories.
127.It Pa /var/spool/*/lock
128Lock file used to obtain the pid of the current
129daemon and the job number of the currently active job.
130.El
131.Sh SEE ALSO
132.Xr lpq 1 ,
133.Xr lpr 1 ,
134.Xr lpd 8
135.Sh DIAGNOSTICS
136``Permission denied" if the user tries to remove files other than his
137own.
138.Sh BUGS
139Since there are race conditions possible in the update of the lock file,
140the currently active job may be incorrectly identified.
141.Sh HISTORY
142The
143.Nm
144command appeared in
145.Bx 3.0 .
146