Greatly simplify the man page handling.
[thirdparty/cups.git] / man / cupsenable.8
1 .\"
2 .\" cupsenable/cupsdisable man page for CUPS.
3 .\"
4 .\" Copyright © 2007-2019 by Apple Inc.
5 .\" Copyright © 1997-2006 by Easy Software Products.
6 .\"
7 .\" Licensed under Apache License v2.0.  See the file "LICENSE" for more
8 .\" information.
9 .\"
10 .TH cupsenable 8 "CUPS" "26 April 2019" "Apple Inc."
11 .SH NAME
12 cupsdisable, cupsenable \- stop/start printers and classes
13 .SH SYNOPSIS
14 .B cupsdisable
15 [
16 .B \-E
17 ] [
18 .B \-U
19 .I username
20 ] [
21 .B \-c
22 ] [
23 \fB\-h \fIserver\fR[\fB:\fIport\fR]
24 ] [
25 .B \-r
26 .I reason
27 ] [
28 .B \-\-hold
29 ]
30 .I destination(s)
31 .br
32 .B cupsenable
33 [
34 .B \-E
35 ] [
36 .B \-U
37 .I username
38 ] [
39 .B \-c
40 ] [
41 \fB\-h \fIserver\fR[\fB:\fIport\fR]
42 ] [
43 .B \-\-release
44 ]
45 .I destination(s)
46 .SH DESCRIPTION
47 .B cupsenable
48 starts the named printers or classes while
49 .B cupsdisable
50 stops the named printers or classes.
51 .SH OPTIONS
52 The following options may be used:
53 .TP 5
54 .B \-E
55 Forces encryption of the connection to the server.
56 .TP 5
57 \fB\-U \fIusername\fR
58 Uses the specified username when connecting to the server.
59 .TP 5
60 .B \-c
61 Cancels all jobs on the named destination.
62 .TP 5
63 \fB\-h \fIserver\fR[\fB:\fIport\fR]
64 Uses the specified server and port.
65 .TP 5
66 .B \-\-hold
67 Holds remaining jobs on the named printer.
68 Useful for allowing the current job to complete before performing maintenance.
69 .TP 5
70 \fB\-r "\fIreason\fB"\fR
71 Sets the message associated with the stopped state.
72 If no reason is specified then the message is set to "Reason Unknown".
73 .TP 5
74 .B \-\-release
75 Releases pending jobs for printing.
76 Use after running \fBcupsdisable\fR with the \fI\-\-hold\fR option to resume printing.
77 .SH CONFORMING TO
78 Unlike the System V printing system, CUPS allows printer names to contain any printable character except SPACE, TAB, "/", or "#".
79 Also, printer and class names are \fInot\fR case-sensitive.
80 .LP
81 The System V versions of these commands are \fBdisable\fR and \fBenable\fR, respectively.
82 They have been renamed to avoid conflicts with the
83 .BR bash (1)
84 build-in commands of the same names.
85 .LP
86 The CUPS versions of \fBdisable\fR and \fBenable\fR may ask the user for an access password depending on the printing system configuration.
87 This differs from the System V versions which require the root user to execute these commands.
88 .SH SEE ALSO
89 .BR cupsaccept (8),
90 .BR cupsreject (8),
91 .BR cancel (1),
92 .BR lp (1),
93 .BR lpadmin (8),
94 .BR lpstat (1),
95 CUPS Online Help (http://localhost:631/help)
96 .SH COPYRIGHT
97 Copyright \[co] 2007-2019 by Apple Inc.