xref: /dragonfly/usr.sbin/lpr/lprm/lprm.1 (revision e0b1d537)
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. Neither the name of the University nor the names of its contributors
13.\"    may be used to endorse or promote products derived from this software
14.\"    without specific prior written permission.
15.\"
16.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26.\" SUCH DAMAGE.
27.\"
28.\"     @(#)lprm.1	8.1 (Berkeley) 6/6/93
29.\" $FreeBSD: src/usr.sbin/lpr/lprm/lprm.1,v 1.5.2.5 2002/06/21 16:40:54 charnier Exp $
30.\" $DragonFly: src/usr.sbin/lpr/lprm/lprm.1,v 1.4 2008/05/02 02:05:08 swildner Exp $
31.\"
32.Dd June 6, 1993
33.Dt LPRM 1
34.Os
35.Sh NAME
36.Nm lprm
37.Nd remove jobs from the line printer spooling queue
38.Sh SYNOPSIS
39.Nm
40.Op Fl P Ns Ar printer
41.Op Fl
42.Op job # ...\&
43.Op Ar user ...\&
44.Sh DESCRIPTION
45The
46.Nm
47utility will remove a job, or jobs, from a printer's spool queue.
48Since the spooling directory is protected from users, using
49.Nm
50is normally the only method by which a user may remove a job.
51The owner of a job is determined by the user's login name
52and host name on the machine where the
53.Xr lpr 1
54command was invoked.
55.Pp
56Options and arguments:
57.Bl -tag -width indent
58.It Fl P Ns Ar printer
59Specify the queue associated with a specific
60.Ar printer
61(otherwise the default printer is used).
62.It Fl
63If a single
64.Sq Fl
65is given,
66.Nm
67will remove all jobs which a user
68owns.  If the super-user employs this flag, the spool queue will
69be emptied entirely.
70.It Ar user
71Cause
72.Nm
73to attempt to remove any jobs queued belonging to that user
74(or users).  This form of invoking
75.Nm
76is useful only to the super-user.
77.It Ar job\ \&#
78A user may dequeue an individual job by specifying its job number.
79This number may be obtained from the
80.Xr lpq  1
81program, e.g.\&
82.Bd -literal -offset indent
83\&% lpq \-l
84
851st:ken				[job #013ucbarpa]
86	(standard input)	100 bytes
87% lprm 13
88.Ed
89.El
90.Pp
91If neither arguments or options are given,
92.Nm
93will delete the currently active job if it is
94owned by the user who invoked
95.Nm .
96.Pp
97The
98.Nm
99utility announces the names of any files it removes and is silent if
100there are no jobs in the queue which match the request list.
101.Pp
102The
103.Nm
104utility will 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 .
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 DIAGNOSTICS
132``Permission denied" if the user tries to remove files other than his
133own.
134.Sh SEE ALSO
135.Xr lpq 1 ,
136.Xr lpr 1 ,
137.Xr lpd 8
138.Sh HISTORY
139The
140.Nm
141command appeared in
142.Bx 3.0 .
143.Sh BUGS
144Since there are race conditions possible in the update of the lock file,
145the currently active job may be incorrectly identified.
146