Clarify meaning of printer errors (Issue #5404)

[thirdparty/cups.git] / man / lprm.man

diff --git a/man/lprm.man b/man/lprm.man
index b4b02cfe506c559418679d0ac29533dc2fea4b87..d2ab6c2665d505c2b8e2cafbd833a99ab74b438f 100644 (file)
--- a/man/lprm.man
+++ b/man/lprm.man
@@ -1,54 +1,81 @@
 .\"
-.\" "$Id: lprm.man 4493 2005-02-18 02:09:53Z mike $"
+.\" lprm man page for CUPS.
 .\"
-.\"   lprm man page for the Common UNIX Printing System (CUPS).
+.\" Copyright 2007-2014 by Apple Inc.
+.\" Copyright 1997-2006 by Easy Software Products.
 .\"
-.\"   Copyright 1997-2005 by Easy Software Products.
+.\" Licensed under Apache License v2.0.  See the file "LICENSE" for more information.
 .\"
-.\"   These coded instructions, statements, and computer programs are the
-.\"   property of Easy Software Products and are protected by Federal
-.\"   copyright law.  Distribution and use rights are outlined in the file
-.\"   "LICENSE.txt" which should have been included with this file.  If this
-.\"   file is missing or damaged please contact Easy Software Products
-.\"   at:
-.\"
-.\"       Attn: CUPS Licensing Information
-.\"       Easy Software Products
-.\"       44141 Airport View Drive, Suite 204
-.\"       Hollywood, Maryland 20636 USA
-.\"
-.\"       Voice: (301) 373-9600
-.\"       EMail: cups-info@cups.org
-.\"         WWW: http://www.cups.org
-.\"
-.TH lprm 1 "Common UNIX Printing System" "16 December 2004" "Easy Software Products"
+.TH lprm 1 "CUPS" "22 May 2014" "Apple Inc."
 .SH NAME
 lprm \- cancel print jobs
 .SH SYNOPSIS
 .B lprm
-[ -E ] [ -P
-.I destination
-]  [ - ] [
-.I job ID(s)
+[
+.B \-E
+] [
+.B \-U
+.I username
+] [
+.B \-h
+.IR server [ :port ]
+] [
+.B \-P
+.IR destination [ /instance ]
+] [
+.B \-
+] [
+.I job-id(s)
 ]
 .SH DESCRIPTION
-\fBlprm\fR cancels print jobs that have been queued for printing. The \fI-P\fR
-option specifies the destination printer or class.
-.LP
-If no arguments are supplied, the current job on the default destination is
-cancelled. You can specify one or more job ID numbers to cancel those jobs,
-or use the \fI\-\fR option to cancel all jobs.
-.LP
-The \fI-E\fR option forces encryption when connecting to the server.
-.SH COMPATIBILITY
-The CUPS version of \fIlprm\fR is compatible with the standard Berkeley
-\fIlprm\fR command.
+.B lprm
+cancels print jobs that have been queued for printing.
+If no arguments are supplied, the current job on the default destination is canceled.
+You can specify one or more job ID numbers to cancel those jobs or use the \fI\-\fR option to cancel all jobs.
+.SH OPTIONS
+The
+.B lprm
+command supports the following options:
+.TP 5
+.B \-E
+Forces encryption when connecting to the server.
+.TP 5
+\fB\-P \fIdestination\fR[\fI/instance\fR]
+Specifies the destination printer or class.
+.TP 5
+\fB\-U \fIusername\fR
+Specifies an alternate username.
+.TP 5
+\fB\-h \fIserver\fR[\fI:port\fR]
+Specifies an alternate server.
+.SH CONFORMING TO
+The CUPS version of
+.B lprm
+is compatible with the standard Berkeley command of the same name.
+.SH EXAMPLES
+Cancel the current job on the default printer:
+.nf
+
+    lprm
+
+.fi
+Cancel job 1234:
+.nf
+
+    lprm 1234
+
+.fi
+Cancel all jobs:
+.nf
+
+    lprm \-
+.fi
 .SH SEE ALSO
-cancel(1), lp(1), lpstat(1), lpr(1),
-CUPS Software Users Manual,
-http://localhost:631/documentation.html
+.BR cancel (1),
+.BR lp (1),
+.BR lpq (1),
+.BR lpr (1),
+.BR lpstat (1),
+CUPS Online Help (http://localhost:631/help)
 .SH COPYRIGHT
-Copyright 1993-2005 by Easy Software Products, All Rights Reserved.
-.\"
-.\" End of "$Id: lprm.man 4493 2005-02-18 02:09:53Z mike $".
-.\"
+Copyright \[co] 2007-2018 by Apple Inc.