[thirdparty/cups.git] / doc / help / man-cupsctl.html

<!DOCTYPE HTML>
<html>
<!-- SECTION: Man Pages -->
<head>
	<link rel="stylesheet" type="text/css" href="../cups-printable.css">
	<title>cupsctl(8)</title>
</head>
<body>
<h1 class="title">cupsctl(8)</h1>
<h2 class="title"><a name="NAME">Name</a></h2>
cupsctl - configure cupsd.conf options
<h2 class="title"><a name="SYNOPSIS">Synopsis</a></h2>
<b>cupsctl</b>
[
<b>-E</b>
] [
<b>-U</b>
<i>username</i>
] [
<b>-h</b>
<i>server</i>[<b>:</b><i>port</i>]
] [
<b>--</b>[<b>no-</b>]<b>debug-logging</b>
] [
<b>--</b>[<b>no-</b>]<b>remote-admin</b>
] [
<b>--</b>[<b>no-</b>]<b>remote-any</b>
] [
<b>--</b>[<b>no-</b>]<b>share-printers</b>
] [
<b>--</b>[<b>no-</b>]<b>user-cancel-any</b>
] [
<i>name=value</i>
]
<h2 class="title"><a name="DESCRIPTION">Description</a></h2>
<b>cupsctl</b> updates or queries the <i>cupsd.conf</i> file for a server. When
no changes are requested, the current configuration values are written to the
standard output in the format "name=value", one per line.
<h2 class="title"><a name="OPTIONS">Options</a></h2>
The following options are recognized:
<dl class="man">
<dt><b>-E</b>
<dd style="margin-left: 5.0em">Enables encryption on the connection to the scheduler.
<dt><b>-U </b><i>username</i>
<dd style="margin-left: 5.0em">Specifies an alternate username to use when authenticating with the scheduler.
<dt><b>-h </b><i>server</i>[<b>:</b><i>port</i>]
<dd style="margin-left: 5.0em">Specifies the server address.
<dt><b>--</b>[<b>no-</b>]<b>debug-logging</b>
<dd style="margin-left: 5.0em">Enables (disables) debug logging to the <i>error_log</i> file.
<dt><b>--</b>[<b>no-</b>]<b>remote-admin</b>
<dd style="margin-left: 5.0em">Enables (disables) remote administration.
<dt><b>--</b>[<b>no-</b>]<b>remote-any</b>
<dd style="margin-left: 5.0em">Enables (disables) printing from any address, e.g., the Internet.
<dt><b>--</b>[<b>no-</b>]<b>share-printers</b>
<dd style="margin-left: 5.0em">Enables (disables) sharing of local printers with other computers.
<dt><b>--</b>[<b>no-</b>]<b>user-cancel-any</b>
<dd style="margin-left: 5.0em">Allows (prevents) users to cancel jobs owned by others.
</dl>
<h2 class="title"><a name="EXAMPLES">Examples</a></h2>
Display the current settings:
<pre class="man">

    cupsctl

</pre>
Enable debug logging:
<pre class="man">

    cupsctl --debug-logging

</pre>
Get the current debug logging state:
<pre class="man">

    cupsctl | grep '^_debug_logging' | awk -F= '{print $2}'

</pre>
Disable printer sharing:
<pre class="man">

    cupsctl --no-share-printers
</pre>
<h2 class="title"><a name="KNOWN_ISSUES">Known Issues</a></h2>
You cannot set the Listen or Port directives using <b>cupsctl</b>.
<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
<b>cupsd.conf</b>(5),
<b>cupsd</b>(8),
<br>
CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>)
<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
Copyright &copy; 2007-2019 by Apple Inc.

</body>
</html>
Commit	Line	Data
c277f98c	1	<!DOCTYPE HTML>
94436c5a MS	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>
c277f98c	13	<b>cupsctl</b>
94436c5a	14	[
bf1bc4c6 MS	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	] [
c277f98c MS	33	<i>name=value</i>
c277f98c MS	34	]
94436c5a	35	<h2 class="title"><a name="DESCRIPTION">Description</a></h2>
bf1bc4c6	36	<b>cupsctl</b> updates or queries the <i>cupsd.conf</i> file for a server. When
94436c5a MS	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:
2909c66c	41	<dl class="man">
bf1bc4c6 MS	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.
3bd2e630	48	<dt><b>--</b>[<b>no-</b>]<b>debug-logging</b>
bf1bc4c6	49	<dd style="margin-left: 5.0em">Enables (disables) debug logging to the <i>error_log</i> file.
3bd2e630	50	<dt><b>--</b>[<b>no-</b>]<b>remote-admin</b>
bf1bc4c6	51	<dd style="margin-left: 5.0em">Enables (disables) remote administration.
3bd2e630	52	<dt><b>--</b>[<b>no-</b>]<b>remote-any</b>
bf1bc4c6	53	<dd style="margin-left: 5.0em">Enables (disables) printing from any address, e.g., the Internet.
3bd2e630	54	<dt><b>--</b>[<b>no-</b>]<b>share-printers</b>
bf1bc4c6	55	<dd style="margin-left: 5.0em">Enables (disables) sharing of local printers with other computers.
3bd2e630	56	<dt><b>--</b>[<b>no-</b>]<b>user-cancel-any</b>
bf1bc4c6	57	<dd style="margin-left: 5.0em">Allows (prevents) users to cancel jobs owned by others.
2909c66c	58	</dl>
94436c5a MS	59	<h2 class="title"><a name="EXAMPLES">Examples</a></h2>
94436c5a MS	60	Display the current settings:
2909c66c	61	<pre class="man">
bf1bc4c6	62
94436c5a	63	cupsctl
bf1bc4c6	64
94436c5a	65	</pre>
bf1bc4c6	66	Enable debug logging:
2909c66c	67	<pre class="man">
bf1bc4c6	68
94436c5a	69	cupsctl --debug-logging
bf1bc4c6	70
94436c5a	71	</pre>
bf1bc4c6	72	Get the current debug logging state:
2909c66c	73	<pre class="man">
bf1bc4c6	74
94436c5a	75	cupsctl \| grep '^_debug_logging' \| awk -F= '{print $2}'
bf1bc4c6	76
94436c5a	77	</pre>
bf1bc4c6	78	Disable printer sharing:
2909c66c	79	<pre class="man">
bf1bc4c6	80
94436c5a MS	81	cupsctl --no-share-printers
	82	</pre>
	83	<h2 class="title"><a name="KNOWN_ISSUES">Known Issues</a></h2>
bf1bc4c6	84	You cannot set the Listen or Port directives using <b>cupsctl</b>.
94436c5a	85	<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
87030afb MS	86	<b>cupsd.conf</b>(5),
87030afb MS	87	<b>cupsd</b>(8),
94436c5a	88	<br>
bf1bc4c6	89	CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>)
94436c5a	90	<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
87030afb	91	Copyright © 2007-2019 by Apple Inc.
94436c5a MS	92
	93	</body>
	94	</html>