[thirdparty/cups.git] / man / client.conf.man.in

.\"
.\" "$Id: client.conf.man.in 11851 2014-05-07 23:55:35Z msweet $"
.\"
.\" client.conf man page for CUPS.
.\"
.\" Copyright 2007-2014 by Apple Inc.
.\" Copyright 2006 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 client.conf 5 "CUPS" "7 May 2014" "Apple Inc."
.SH NAME
client.conf \- client configuration file for cups (deprecated)
.SH DESCRIPTION
The \fBclient.conf\fR file configures the CUPS client and is normally located in the \fI/etc/cups\fR and/or \fI~/.cups\fR directories.
Each line in the file can be a configuration directive, a blank line, or a comment. Comment lines start with the # character.
.LP
\fBNote:\fR Starting with OS X 10.7, this file is only used by command-line and X11 applications.
The \fBServerName\fR directive is not supported on OS X at all.
.SS DIRECTIVES
The following directives are understood by the client. Consult the online help for detailed descriptions:
.TP 5
\fBAllowAnyRoot Yes\fR
.TP 5
\fBAllowAnyRoot No\fR
Specifies whether to allow TLS with certificates that have not been signed by a trusted Certificate Authority.
The default is "Yes".
.TP 5
\fBAllowExpiredCerts Yes\fR
.TP 5
\fBAllowExpiredCerts No\fR
Specifies whether to allow TLS with expired certificates.
The default is "Yes".
.TP 5
\fBEncryption IfRequested\fR
.TP 5
\fBEncryption Never\fR
.TP 5
\fBEncryption Required\fR
Specifies the level of encryption that should be used.
.TP 5
\fBGSSServiceName \fIname\fR
Specifies the Kerberos service name that is used for authentication, typically "host", "http", or "ipp".
CUPS adds the remote hostname ("name@server.example.com") for you. The default name is "http".
.TP 5
\fBServerName \fIhostname-or-ip-address\fR[\fI:port\fR]
.TP 5
\fBServerName \fI/domain/socket\fR
Specifies the address and optionally the port to use when connecting to the server.
\fBNote: This directive it not supported on OS X 10.7 or later.\fR
.TP 5
\fBServerName \fIhostname-or-ip-address\fR[\fI:port\fR]\fB/version=1.1\fR
Specifies the address and optionally the port to use when connecting to a server running CUPS 1.3.12 and earlier.
.TP 5
\fBUser \fIname\fR
Specifies the default user name to use for requests.
.TP 5
\fBValidateCerts Yes\fR
.TP 5
\fBValidateCerts No\fR
Specifies whether to only allow TLS with certificates whose common name matches the hostname.
The default is "No".
.SH NOTES
The \fBclient.conf\fR file is deprecated and will no longer be supported in a future version of CUPS.
.SH SEE ALSO
.BR cups (1),
CUPS Online Help (http://localhost:631/help)
.SH COPYRIGHT
Copyright \[co] 2007-2014 by Apple Inc.
.\"
.\" End of "$Id: client.conf.man.in 11851 2014-05-07 23:55:35Z msweet $".
.\"
Commit	Line	Data
b423cd4c	1	.\"
1a18c85c	2	.\" "$Id: client.conf.man.in 11851 2014-05-07 23:55:35Z msweet $"
b423cd4c	3	.\"
1a18c85c	4	.\" client.conf man page for CUPS.
b423cd4c	5	.\"
1a18c85c MS	6	.\" Copyright 2007-2014 by Apple Inc.
1a18c85c MS	7	.\" Copyright 2006 by Easy Software Products.
b423cd4c	8	.\"
1a18c85c MS	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/".
b423cd4c	14	.\"
1a18c85c	15	.TH client.conf 5 "CUPS" "7 May 2014" "Apple Inc."
b423cd4c	16	.SH NAME
1a18c85c	17	client.conf \- client configuration file for cups (deprecated)
b423cd4c	18	.SH DESCRIPTION
1a18c85c MS	19	The \fBclient.conf\fR file configures the CUPS client and is normally located in the \fI/etc/cups\fR and/or \fI~/.cups\fR directories.
	20	Each line in the file can be a configuration directive, a blank line, or a comment. Comment lines start with the # character.
	21	.LP
	22	\fBNote:\fR Starting with OS X 10.7, this file is only used by command-line and X11 applications.
	23	The \fBServerName\fR directive is not supported on OS X at all.
	24	.SS DIRECTIVES
	25	The following directives are understood by the client. Consult the online help for detailed descriptions:
b423cd4c	26	.TP 5
1a18c85c	27	\fBAllowAnyRoot Yes\fR
b423cd4c	28	.TP 5
1a18c85c MS	29	\fBAllowAnyRoot No\fR
	30	Specifies whether to allow TLS with certificates that have not been signed by a trusted Certificate Authority.
	31	The default is "Yes".
b423cd4c	32	.TP 5
1a18c85c	33	\fBAllowExpiredCerts Yes\fR
b423cd4c	34	.TP 5
1a18c85c MS	35	\fBAllowExpiredCerts No\fR
	36	Specifies whether to allow TLS with expired certificates.
	37	The default is "Yes".
07ed0e9a	38	.TP 5
1a18c85c	39	\fBEncryption IfRequested\fR
b423cd4c	40	.TP 5
1a18c85c	41	\fBEncryption Never\fR
3e7fe0ca	42	.TP 5
1a18c85c MS	43	\fBEncryption Required\fR
1a18c85c MS	44	Specifies the level of encryption that should be used.
3699c637	45	.TP 5
1a18c85c MS	46	\fBGSSServiceName \fIname\fR
	47	Specifies the Kerberos service name that is used for authentication, typically "host", "http", or "ipp".
	48	CUPS adds the remote hostname ("name@server.example.com") for you. The default name is "http".
	49	.TP 5
	50	\fBServerName \fIhostname-or-ip-address\fR[\fI:port\fR]
	51	.TP 5
	52	\fBServerName \fI/domain/socket\fR
	53	Specifies the address and optionally the port to use when connecting to the server.
	54	\fBNote: This directive it not supported on OS X 10.7 or later.\fR
	55	.TP 5
	56	\fBServerName \fIhostname-or-ip-address\fR[\fI:port\fR]\fB/version=1.1\fR
	57	Specifies the address and optionally the port to use when connecting to a server running CUPS 1.3.12 and earlier.
	58	.TP 5
	59	\fBUser \fIname\fR
3e7fe0ca	60	Specifies the default user name to use for requests.
1a18c85c MS	61	.TP 5
	62	\fBValidateCerts Yes\fR
	63	.TP 5
	64	\fBValidateCerts No\fR
	65	Specifies whether to only allow TLS with certificates whose common name matches the hostname.
	66	The default is "No".
	67	.SH NOTES
	68	The \fBclient.conf\fR file is deprecated and will no longer be supported in a future version of CUPS.
b423cd4c	69	.SH SEE ALSO
1a18c85c MS	70	.BR cups (1),
1a18c85c MS	71	CUPS Online Help (http://localhost:631/help)
b423cd4c	72	.SH COPYRIGHT
1a18c85c	73	Copyright \[co] 2007-2014 by Apple Inc.
b423cd4c	74	.\"
1a18c85c	75	.\" End of "$Id: client.conf.man.in 11851 2014-05-07 23:55:35Z msweet $".
b423cd4c	76	.\"