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