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