]> git.ipfire.org Git - thirdparty/cups.git/blob - man/cupsctl.man
Update .gitignore to ignore compressed man pages.
[thirdparty/cups.git] / man / cupsctl.man
1 .\"
2 .\" cupsctl man page for CUPS.
3 .\"
4 .\" Copyright 2007-2016 by Apple Inc.
5 .\" Copyright 2007 by Easy Software Products.
6 .\"
7 .\" Licensed under Apache License v2.0. See the file "LICENSE" for more information.
8 .\"
9 .TH cupsctl 8 "CUPS" "30 May 2016" "Apple Inc."
10 .SH NAME
11 cupsctl \- configure cupsd.conf options
12 .SH SYNOPSIS
13 .B cupsctl
14 [
15 .B \-E
16 ] [
17 .B \-U
18 .I username
19 ] [
20 .B \-h
21 \fIserver\fR[\fB:\fIport\fR]
22 ] [
23 \fB\-\-\fR[\fBno\-\fR]\fBdebug\-logging\fR
24 ] [
25 \fB\-\-\fR[\fBno\-\fR]\fBremote\-admin\fR
26 ] [
27 \fB\-\-\fR[\fBno\-\fR]\fBremote\-any\fR
28 ] [
29 \fB\-\-\fR[\fBno\-\fR]\fBshare\-printers\fR
30 ] [
31 \fB\-\-\fR[\fBno\-\fR]\fBuser\-cancel\-any\fR
32 ] [
33 .I name=value
34 ]
35 .SH DESCRIPTION
36 \fBcupsctl\fR updates or queries the \fIcupsd.conf\fR file for a server. When
37 no changes are requested, the current configuration values are written to the
38 standard output in the format "name=value", one per line.
39 .SH OPTIONS
40 The following options are recognized:
41 .TP 5
42 .B \-E
43 Enables encryption on the connection to the scheduler.
44 .TP 5
45 \fB\-U \fIusername\fR
46 Specifies an alternate username to use when authenticating with the scheduler.
47 .TP 5
48 \fB\-h \fIserver\fR[\fB:\fIport\fR]
49 Specifies the server address.
50 .TP 5
51 \fB\-\-\fR[\fBno\-\fR]\fBdebug\-logging\fR
52 Enables (disables) debug logging to the \fIerror_log\fR file.
53 .TP 5
54 \fB\-\-\fR[\fBno\-\fR]\fBremote\-admin\fR
55 Enables (disables) remote administration.
56 .TP 5
57 \fB\-\-\fR[\fBno\-\fR]\fBremote\-any\fR
58 Enables (disables) printing from any address, e.g., the Internet.
59 .TP 5
60 \fB\-\-\fR[\fBno\-\fR]\fBshare\-printers\fR
61 Enables (disables) sharing of local printers with other computers.
62 .TP 5
63 \fB\-\-\fR[\fBno\-\fR]\fBuser\-cancel\-any\fR
64 Allows (prevents) users to cancel jobs owned by others.
65 .SH EXAMPLES
66 Display the current settings:
67 .nf
68
69 cupsctl
70
71 .fi
72 Enable debug logging:
73 .nf
74
75 cupsctl --debug-logging
76
77 .fi
78 Get the current debug logging state:
79 .nf
80
81 cupsctl | grep '^_debug_logging' | awk -F= '{print $2}'
82
83 .fi
84 Disable printer sharing:
85 .nf
86
87 cupsctl --no-share-printers
88 .fi
89 .SH KNOWN ISSUES
90 You cannot set the Listen or Port directives using \fBcupsctl\fR.
91 .SH SEE ALSO
92 .BR cupsd.conf (5),
93 .BR cupsd (8),
94 .br
95 CUPS Online Help (http://localhost:631/help)
96 .SH COPYRIGHT
97 Copyright \[co] 2007-2018 by Apple Inc.