Document indirect changing of configuration files (Issue #5403)

[thirdparty/cups.git] / man / cupsctl.man

diff --git a/man/cupsctl.man b/man/cupsctl.man
index f88fee99cb6b7d770c6f735168d2b14170b496ff..6fab9036de4195983acff073406ab726326e9dd5 100644 (file)
--- a/man/cupsctl.man
+++ b/man/cupsctl.man
@@ -1,105 +1,97 @@
 .\"
-.\" "$Id$"
+.\" cupsctl man page for CUPS.
 .\"
-.\"   cupsctl man page for the Common UNIX Printing System (CUPS).
+.\" Copyright 2007-2016 by Apple Inc.
+.\" Copyright 2007 by Easy Software Products.
 .\"
-.\"   Copyright 2007 by Apple Inc.
-.\"   Copyright 2007 by Easy Software Products.
+.\" Licensed under Apache License v2.0.  See the file "LICENSE" for more information.
 .\"
-.\"   These coded instructions, statements, and computer programs are the
-.\"   property of Apple Inc. and are protected by Federal copyright
-.\"   law.  Distribution and use rights are outlined in the file "LICENSE.txt"
-.\"   which should have been included with this file.  If this file is
-.\"   file is missing or damaged, see the license at "http://www.cups.org/".
-.\"
-.TH cupsctl 8 "Common UNIX Printing System" "5 July 2007" "Apple Inc."
+.TH cupsctl 8 "CUPS" "30 May 2016" "Apple Inc."
 .SH NAME
 cupsctl \- configure cupsd.conf options
 .SH SYNOPSIS
 .B cupsctl
-[ -E ] [-U
-.I username
-] [ -h
-.I server[:port]
-] [ --[no-]debug-logging ] [ --[no-]remote-admin ] [ --[no-]remote-any ]
-[ --[no-]remote-printers ] [ --[no-]share-printers ] [ --[no-]user-cancel-any ]
 [
+.B \-E
+] [
+.B \-U
+.I username
+] [
+.B \-h
+\fIserver\fR[\fB:\fIport\fR]
+] [
+\fB\-\-\fR[\fBno\-\fR]\fBdebug\-logging\fR
+] [
+\fB\-\-\fR[\fBno\-\fR]\fBremote\-admin\fR
+] [
+\fB\-\-\fR[\fBno\-\fR]\fBremote\-any\fR
+] [
+\fB\-\-\fR[\fBno\-\fR]\fBshare\-printers\fR
+] [
+\fB\-\-\fR[\fBno\-\fR]\fBuser\-cancel\-any\fR
+] [
 .I name=value
 ]
 .SH DESCRIPTION
-\fIcupsctl\fR updates or queries the \fBcupsd.conf\fR file for a server. When
+\fBcupsctl\fR updates or queries the \fIcupsd.conf\fR 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.
 .SH OPTIONS
 The following options are recognized:
 .TP 5
--E
-.br
+.B \-E
 Enables encryption on the connection to the scheduler.
 .TP 5
--U \fIusername\fR
-.br
+\fB\-U \fIusername\fR
 Specifies an alternate username to use when authenticating with the scheduler.
 .TP 5
--h \fIserver[:port]\fR
-.br
+\fB\-h \fIserver\fR[\fB:\fIport\fR]
 Specifies the server address.
 .TP 5
---[no-]debug-logging
-.br
-Enables or disables debug logging in the \fBerror_log\fR file.
+\fB\-\-\fR[\fBno\-\fR]\fBdebug\-logging\fR
+Enables (disables) debug logging to the \fIerror_log\fR file.
 .TP 5
---[no-]remote-admin
-.br
-Enables or disables remote administration.
+\fB\-\-\fR[\fBno\-\fR]\fBremote\-admin\fR
+Enables (disables) remote administration.
 .TP 5
---[no-]remote-any
-.br
-Enables or disables printing from any address, e.g. the Internet.
+\fB\-\-\fR[\fBno\-\fR]\fBremote\-any\fR
+Enables (disables) printing from any address, e.g., the Internet.
 .TP 5
---[no-]remote-printers
-.br
-Enables or disables the display of remote printers shared via the CUPS, LDAP,
-or SLP protocols.
-.TP 5
---[no-]share-printers
-.br
-Enables or disables sharing of local printers with other computers.
+\fB\-\-\fR[\fBno\-\fR]\fBshare\-printers\fR
+Enables (disables) sharing of local printers with other computers.
 .TP 5
---[no-]user-cancel-any
-.br
-Allows or prevents users from canceling jobs owned by others.
+\fB\-\-\fR[\fBno\-\fR]\fBuser\-cancel\-any\fR
+Allows (prevents) users to cancel jobs owned by others.
 .SH EXAMPLES
 Display the current settings:
 .nf
+
     cupsctl
+
 .fi
-.LP
 Enable debug logging:
 .nf
+
     cupsctl --debug-logging
+
 .fi
-.LP
 Get the current debug logging state:
 .nf
+
     cupsctl | grep '^_debug_logging' | awk -F= '{print $2}'
+
 .fi
-.LP
 Disable printer sharing:
 .nf
-    cupsctl --no-shared-printers
-.fi
-.LP
-Enable printing using the file: pseudo-device:
-.nf
-    cupsctl FileDevice=Yes
+
+    cupsctl --no-share-printers
 .fi
+.SH KNOWN ISSUES
+You cannot set the Listen or Port directives using \fBcupsctl\fR.
 .SH SEE ALSO
-\fIcupsd.conf(5)\fR, \fIcupsd(8)\fR,
+.BR cupsd.conf (5),
+.BR cupsd (8),
 .br
-http://localhost:631/help
+CUPS Online Help (http://localhost:631/help)
 .SH COPYRIGHT
-Copyright 2007 by Apple Inc.
-.\"
-.\" End of "$Id$".
-.\"
+Copyright \[co] 2007-2018 by Apple Inc.