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

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