BSD 4_3_Net_2 release

[unix-history] / usr / src / usr.sbin / lpr / lprm / lprm.1

diff --git a/usr/src/usr.sbin/lpr/lprm/lprm.1 b/usr/src/usr.sbin/lpr/lprm/lprm.1
index 34aeb0c..9149fb5 100644 (file)
--- a/usr/src/usr.sbin/lpr/lprm/lprm.1
+++ b/usr/src/usr.sbin/lpr/lprm/lprm.1
@@ -1,111 +1,145 @@
-.\" Copyright (c) 1983 The Regents of the University of California.
+.\" Copyright (c) 1983, 1990 The Regents of the University of California.

 .\" All rights reserved.
 .\"
 .\" All rights reserved.
 .\"

-.\" Redistribution and use in source and binary forms are permitted
-.\" provided that the above copyright notice and this paragraph are
-.\" duplicated in all such forms and that any documentation,
-.\" advertising materials, and other materials related to such
-.\" distribution and use acknowledge that the software was developed
-.\" by the University of California, Berkeley.  The name of the
-.\" University may not be used to endorse or promote products derived
-.\" from this software without specific prior written permission.
-.\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
-.\" IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
-.\" WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\" 3. All advertising materials mentioning features or use of this software
+.\"    must display the following acknowledgement:
+.\"    This product includes software developed by the University of
+.\"    California, Berkeley and its contributors.
+.\" 4. Neither the name of the University nor the names of its contributors
+.\"    may be used to endorse or promote products derived from this software
+.\"    without specific prior written permission.

 .\"
 .\"

-.\"    @(#)lprm.1      6.3 (Berkeley) %G%
+.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.

 .\"
 .\"

-.TH LPRM 1 ""
-.UC 5
-.SH NAME
-lprm \- remove jobs from the line printer spooling queue
-.SH SYNOPSIS
-.B lprm
-[
-.BI \-P printer
-] [
-.B \-
-] [
-job # ...
-] [
-user ...
-]
-.SH DESCRIPTION
-.I Lprm
+.\"     @(#)lprm.1     6.7 (Berkeley) 5/9/91
+.\"
+.Dd May 9, 1991
+.Dt LPRM 1
+.Os BSD 4.2
+.Sh NAME
+.Nm lprm
+.Nd remove jobs from the line printer spooling queue
+.Sh SYNOPSIS
+.Nm lprm
+.Op Fl P Ns Ar printer
+.Op Fl
+.Op job # ...
+.Op Ar user ...
+.Sh DESCRIPTION
+.Nm Lprm

 will remove a job, or jobs, from a printer's spool queue.
 Since the spooling directory is protected from users, using
 will remove a job, or jobs, from a printer's spool queue.
 Since the spooling directory is protected from users, using

-.I lprm
+.Nm lprm

 is normally the only method by which a user may remove a job.
 is normally the only method by which a user may remove a job.

-.PP
-.I Lprm
-without any arguments will delete the currently active job if it is
-owned by the user who invoked
-.IR lprm .
-.PP
-If the
-.B \-
-flag is specified, 
-.I lprm
-will remove all jobs which a user
-owns.  If the super-user employs this flag, the spool queue will
-be emptied entirely. The owner is determined by the user's login name
+The owner of a job is determined by the user's login name

 and host name on the machine where the
 and host name on the machine where the

-.I lpr
+.Xr lpr 1

 command was invoked.
 command was invoked.

-.PP
-Specifying a user's name, or list of user names, will cause
-.I lprm
+.Pp
+Options and arguments:
+.Bl -tag -width indent
+.It Fl P Ns Ar printer
+Specify the queue associated with a specific
+.Ar printer
+(otherwise the default printer is used).
+.It Fl
+If a single
+.Sq Fl
+is given,
+.Nm lprm
+will remove all jobs which a user
+owns.  If the super-user employs this flag, the spool queue will
+be emptied entirely.
+.It Ar user
+Causes
+.Nm lprm

 to attempt to remove any jobs queued belonging to that user
 (or users).  This form of invoking
 to attempt to remove any jobs queued belonging to that user
 (or users).  This form of invoking

-.I lprm
+.Nm lprm

 is useful only to the super-user.
 is useful only to the super-user.

-.PP
+.It Ar job\ \&#

 A user may dequeue an individual job by specifying its job number.
 This number may be obtained from the
 A user may dequeue an individual job by specifying its job number.
 This number may be obtained from the

-.IR lpq (1)
+.Xr lpq  1

 program, e.g.
 program, e.g.

-.PP
-.nf
-.in +0.5i
-.ta \w'k0-k9  'u +\w'Type  'u +\w'"/usr/lib/lpd"  'u
-.ta \w'1st: 'u +\w'(standard input)                    'u
-% lpq \-l
+.Pp
+.Bd -literal -offset indent
+\&% lpq \-l

 
 

-1st: ken       [job #013ucbarpa]
+1st:ken                                [job #013ucbarpa]

        (standard input)        100 bytes
 % lprm 13
        (standard input)        100 bytes
 % lprm 13

-.in -0.5i
-.fi
-.PP
-.I Lprm
-will announce the names of any files it removes and is silent if
+.Ed
+.El
+.Pp
+If neither arguments or options are given,
+.Nm Lprm
+will delete the currently active job if it is
+owned by the user who invoked
+.Nm lprm  .
+.Pp
+.Nm Lprm
+announces the names of any files it removes and is silent if

 there are no jobs in the queue which match the request list.
 there are no jobs in the queue which match the request list.

-.PP
-.I Lprm
+.Pp
+.Nm Lprm

 will kill off an active daemon, if necessary, before removing
 any spooling files.  If a daemon is killed, a new one is
 automatically restarted upon completion of file removals.
 will kill off an active daemon, if necessary, before removing
 any spooling files.  If a daemon is killed, a new one is
 automatically restarted upon completion of file removals.

-.PP
-The
-.B \-P
-option may be usd to specify the queue associated with a specific
-printer (otherwise the default printer, or the value of the PRINTER
-variable in the environment is used).
-.SH FILES
-.nf
-.ta \w'/usr/spool/*/lock   'u
-/etc/printcap  printer characteristics file
-/usr/spool/*   spooling directories
-/usr/spool/*/lock      lock file used to obtain the pid of the current
-       daemon and the job number of the currently active job
-.fi
-.SH "SEE ALSO"
-lpr(1),
-lpq(1),
-lpd(8)
-.SH DIAGNOSTICS
+.Sh ENVIRONMENT
+If the following environment variable exists, it is utilized by
+.Nm lprm .
+.Bl -tag -width PRINTER
+.It Ev PRINTER
+If the environment variable
+.Ev PRINTER
+exists,
+and a printer has not been specified with the
+.Fl P
+option,
+the default printer is assumed from 
+.Ev PRINTER .
+.El
+.Sh FILES
+.Bl -tag -width /var/spool/*/lock/ -compact
+.It Pa /etc/printcap
+Printer characteristics file.
+.It Pa /var/spool/*
+Spooling directories.
+.It Pa /var/spool/*/lock
+Lock file used to obtain the pid of the current
+daemon and the job number of the currently active job.
+.El
+.Sh SEE ALSO
+.Xr lpr 1 ,
+.Xr lpq 1 ,
+.Xr lpd 8
+.Sh DIAGNOSTICS

 ``Permission denied" if the user tries to remove files other than his
 own.
 ``Permission denied" if the user tries to remove files other than his
 own.

-.SH BUGS
+.Sh BUGS

 Since there are race conditions possible in the update of the lock file,
 the currently active job may be incorrectly identified.
 Since there are race conditions possible in the update of the lock file,
 the currently active job may be incorrectly identified.

+.Sh HISTORY
+The
+.Nm lprm
+command appeared in
+.Bx 3.0 .