xref: /dragonfly/usr.sbin/lpr/lprm/lprm.1 (revision bb8c85ff) 
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.\"
31.Dd June 6, 1993
32.Dt LPRM 1
33.Os
34.Sh NAME
35.Nm lprm
36.Nd remove jobs from the line printer spooling queue
37.Sh SYNOPSIS
38.Nm
39.Op Fl P Ns Ar printer
40.Op Fl
41.Op job # ...\&
42.Op Ar user ...\&
43.Sh DESCRIPTION
44The
45.Nm
46utility will remove a job, or jobs, from a printer's spool queue.
47Since the spooling directory is protected from users, using
48.Nm
49is normally the only method by which a user may remove a job.
50The owner of a job is determined by the user's login name
51and host name on the machine where the
52.Xr lpr 1
53command was invoked.
54.Pp
55Options and arguments:
56.Bl -tag -width indent
57.It Fl P Ns Ar printer
58Specify the queue associated with a specific
59.Ar printer
60(otherwise the default printer is used).
61.It Fl
62If a single
63.Sq Fl
64is given,
65.Nm
66will remove all jobs which a user
67owns.  If the super-user employs this flag, the spool queue will
68be emptied entirely.
69.It Ar user
70Cause
71.Nm
72to attempt to remove any jobs queued belonging to that user
73(or users).  This form of invoking
74.Nm
75is useful only to the super-user.
76.It Ar job\ \&#
77A user may dequeue an individual job by specifying its job number.
78This number may be obtained from the
79.Xr lpq 1
80program, e.g.\&
81.Bd -literal -offset indent
82\&% lpq \-l
83
841st:ken				[job #013ucbarpa]
85	(standard input)	100 bytes
86% lprm 13
87.Ed
88.El
89.Pp
90If neither arguments or options are given,
91.Nm
92will delete the currently active job if it is
93owned by the user who invoked
94.Nm .
95.Pp
96The
97.Nm
98utility announces the names of any files it removes and is silent if
99there are no jobs in the queue which match the request list.
100.Pp
101The
102.Nm
103utility will kill off an active daemon, if necessary, before removing
104any spooling files.  If a daemon is killed, a new one is
105automatically restarted upon completion of file removals.
106.Sh ENVIRONMENT
107If the following environment variable exists, it is utilized by
108.Nm .
109.Bl -tag -width PRINTER
110.It Ev PRINTER
111If the environment variable
112.Ev PRINTER
113exists,
114and a printer has not been specified with the
115.Fl P
116option,
117the default printer is assumed from
118.Ev PRINTER .
119.El
120.Sh FILES
121.Bl -tag -width /var/spool/*/lock/ -compact
122.It Pa /etc/printcap
123Printer characteristics file.
124.It Pa /var/spool/*
125Spooling directories.
126.It Pa /var/spool/*/lock
127Lock file used to obtain the pid of the current
128daemon and the job number of the currently active job.
129.El
130.Sh DIAGNOSTICS
131``Permission denied" if the user tries to remove files other than his
132own.
133.Sh SEE ALSO
134.Xr lpq 1 ,
135.Xr lpr 1 ,
136.Xr lpd 8
137.Sh HISTORY
138The
139.Nm
140command appeared in
141.Bx 3.0 .
142.Sh BUGS
143Since there are race conditions possible in the update of the lock file,
144the currently active job may be incorrectly identified.
145