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

.\"
.\" cupsctl man page for CUPS.
.\"
.\" Copyright 2007-2014 by Apple Inc.
.\" Copyright 2007 by Easy Software Products.
.\"
.\" 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 "CUPS" "11 June 2014" "Apple Inc."
.SH NAME
cupsctl \- configure cupsd.conf options
.SH SYNOPSIS
.B cupsctl
[
.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
\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
.B \-E
Enables encryption on the connection to the scheduler.
.TP 5
\fB\-U \fIusername\fR
Specifies an alternate username to use when authenticating with the scheduler.
.TP 5
\fB\-h \fIserver\fR[\fB:\fIport\fR]
Specifies the server address.
.TP 5
.B \-\-\fR[\fBno\-\fR]\fBdebug\-logging
Enables (disables) debug logging to the \fIerror_log\fR file.
.TP 5
.B \-\-\fR[\fBno\-\fR]\fBremote\-admin
Enables (disables) remote administration.
.TP 5
.B \-\-\fR[\fBno\-\fR]\fBremote\-any
Enables (disables) printing from any address, e.g., the Internet.
.TP 5
.B \-\-\fR[\fBno\-\fR]\fBshare\-printers
Enables (disables) sharing of local printers with other computers.
.TP 5
.B \-\-\fR[\fBno\-\fR]\fBuser\-cancel\-any
Allows (prevents) users to cancel jobs owned by others.
.SH EXAMPLES
Display the current settings:
.nf

    cupsctl

.fi
Enable debug logging:
.nf

    cupsctl --debug-logging

.fi
Get the current debug logging state:
.nf

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

.fi
Disable printer sharing:
.nf

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