Greatly simplify the man page handling.
[thirdparty/cups.git] / doc / help / man-cupsctl.html
1 <!DOCTYPE HTML>
2 <html>
3 <!-- SECTION: Man Pages -->
4 <head>
5         <link rel="stylesheet" type="text/css" href="../cups-printable.css">
6         <title>cupsctl(8)</title>
7 </head>
8 <body>
9 <h1 class="title">cupsctl(8)</h1>
10 <h2 class="title"><a name="NAME">Name</a></h2>
11 cupsctl - configure cupsd.conf options
12 <h2 class="title"><a name="SYNOPSIS">Synopsis</a></h2>
13 <b>cupsctl</b>
14 [
15 <b>-E</b>
16 ] [
17 <b>-U</b>
18 <i>username</i>
19 ] [
20 <b>-h</b>
21 <i>server</i>[<b>:</b><i>port</i>]
22 ] [
23 <b>--</b>[<b>no-</b>]<b>debug-logging</b>
24 ] [
25 <b>--</b>[<b>no-</b>]<b>remote-admin</b>
26 ] [
27 <b>--</b>[<b>no-</b>]<b>remote-any</b>
28 ] [
29 <b>--</b>[<b>no-</b>]<b>share-printers</b>
30 ] [
31 <b>--</b>[<b>no-</b>]<b>user-cancel-any</b>
32 ] [
33 <i>name=value</i>
34 ]
35 <h2 class="title"><a name="DESCRIPTION">Description</a></h2>
36 <b>cupsctl</b> updates or queries the <i>cupsd.conf</i> 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 <h2 class="title"><a name="OPTIONS">Options</a></h2>
40 The following options are recognized:
41 <dl class="man">
42 <dt><b>-E</b>
43 <dd style="margin-left: 5.0em">Enables encryption on the connection to the scheduler.
44 <dt><b>-U </b><i>username</i>
45 <dd style="margin-left: 5.0em">Specifies an alternate username to use when authenticating with the scheduler.
46 <dt><b>-h </b><i>server</i>[<b>:</b><i>port</i>]
47 <dd style="margin-left: 5.0em">Specifies the server address.
48 <dt><b>--</b>[<b>no-</b>]<b>debug-logging</b>
49 <dd style="margin-left: 5.0em">Enables (disables) debug logging to the <i>error_log</i> file.
50 <dt><b>--</b>[<b>no-</b>]<b>remote-admin</b>
51 <dd style="margin-left: 5.0em">Enables (disables) remote administration.
52 <dt><b>--</b>[<b>no-</b>]<b>remote-any</b>
53 <dd style="margin-left: 5.0em">Enables (disables) printing from any address, e.g., the Internet.
54 <dt><b>--</b>[<b>no-</b>]<b>share-printers</b>
55 <dd style="margin-left: 5.0em">Enables (disables) sharing of local printers with other computers.
56 <dt><b>--</b>[<b>no-</b>]<b>user-cancel-any</b>
57 <dd style="margin-left: 5.0em">Allows (prevents) users to cancel jobs owned by others.
58 </dl>
59 <h2 class="title"><a name="EXAMPLES">Examples</a></h2>
60 Display the current settings:
61 <pre class="man">
62
63     cupsctl
64
65 </pre>
66 Enable debug logging:
67 <pre class="man">
68
69     cupsctl --debug-logging
70
71 </pre>
72 Get the current debug logging state:
73 <pre class="man">
74
75     cupsctl | grep '^_debug_logging' | awk -F= '{print $2}'
76
77 </pre>
78 Disable printer sharing:
79 <pre class="man">
80
81     cupsctl --no-share-printers
82 </pre>
83 <h2 class="title"><a name="KNOWN_ISSUES">Known Issues</a></h2>
84 You cannot set the Listen or Port directives using <b>cupsctl</b>.
85 <h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
86 <b>cupsd.conf</b>(5),
87 <b>cupsd</b>(8),
88 <br>
89 CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>)
90 <h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
91 Copyright &copy; 2007-2019 by Apple Inc.
92
93 </body>
94 </html>