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

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