[thirdparty/cups.git] / man / cups-files.conf.man.in

.\"
.\" "$Id$"
.\"
.\" cupsd.conf man page for CUPS.
.\"
.\" Copyright 2007-2014 by Apple Inc.
.\" Copyright 1997-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 cups-files.conf 5 "CUPS" "6 February 2014" "Apple Inc."
.SH NAME
cups-files.conf \- file and directory configuration file for cups
.SH DESCRIPTION
The \fIcups-files.conf\fR file configures the files and directories used by the
CUPS scheduler, \fIcupsd(8)\fR.  It is normally located in the
\fI/etc/cups\fR directory.
.LP
Each line in the file can be a configuration directive, a blank line,
or a comment. Comment lines start with the # character.
.SH DIRECTIVES
The following directives are understood by \fIcupsd(8)\fR. Consult the
on-line help for detailed descriptions:
.TP 5
AccessLog filename
.TP 5
AccessLog syslog
.br
Defines the access log filename.
.TP 5
ConfigFilePerm mode
.br
Specifies the permissions for all configuration files that the scheduler
writes.
.TP 5
DataDir path
.br
Specified the directory where data files can be found.
.TP 5
DocumentRoot directory
.br
Specifies the root directory for the internal web server documents.
.TP 5
ErrorLog filename
.TP 5
ErrorLog syslog
.br
Specifies the error log filename.
.TP 5
FatalErrors none
.TP 5
FatalErrors all -kind [... -kind]
.TP 5
FatalErrors kind [... kind]
.br
Specifies which errors are fatal, causing the scheduler to exit. "Kind" is
"browse", "config", "listen", "log", or "permissions".
.TP 5
FileDevice Yes
.TP 5
FileDevice No
.br
Specifies whether the file pseudo-device can be used for new
printer queues.
.TP 5
FontPath directory[:directory:...]
.br
Specifies the search path for fonts.
.TP 5
Group group-name-or-number
.br
Specifies the group name or ID that will be used when executing
external programs.
.TP 5
LogFilePerm mode
.br
Specifies the permissions for all log files that the scheduler writes.
.TP 5
PageLog filename
.TP 5
PageLog syslog
.br
Specifies the page log filename.
.TP 5
Printcap
.TP 5
Printcap filename
.br
Specifies the filename for a printcap file that is updated
automatically with a list of available printers (needed for
legacy applications); specifying Printcap with no filename
disables printcap generation.
.TP 5
RemoteRoot user-name
.br
Specifies the username that is associated with unauthenticated root
accesses.
.TP 5
RequestRoot directory
.br
Specifies the directory to store print jobs and other HTTP request
data.
.TP 5
Sandboxing off
.TP 5
Sandboxing relaxed
.TP 5
Sandboxing strict
Specifies the level of security sandboxing that is applied to print filters, backends, and other child processes of the scheduler. The default is "strict". (OS X only)
.TP 5
ServerBin directory
.br
Specifies the directory where backends, CGIs, daemons, and filters may
be found.
.TP 5
ServerKeychain path
.br
Specifies the location of TLS certificates and private keys.
.TP 5
ServerRoot directory
.br
Specifies the directory where the server configuration files can be found.
.TP 5
SyncOnClose Yes
.TP 5
SyncOnClose No
Specifies whether the scheduler calls \fIfsync(2)\fR after writing configuration
or state files. The default is No.
.TP 5
SystemGroup group-name [group-name ...]
.br
Specifies the group(s) to use for System class authentication.
.TP 5
TempDir directory
.br
Specifies the directory where temporary files are stored.
.TP 5
User user-name
.br
Specifies the user name or ID that is used when running external programs.
.SH SEE ALSO
\fIclasses.conf(5)\fR, \fIcupsd(8)\fR, \fIcupsd.conf(5)\fR, \fImime.convs(5)\fR,
\fImime.types(5)\fR, \fIprinters.conf(5)\fR,
\fIsubscriptions.conf(5)\fR,
.br
http://localhost:631/help
.SH COPYRIGHT
Copyright 2007-2014 by Apple Inc.
.\"
.\" End of "$Id$".
.\"
Commit	Line	Data
c41769ff MS	1	.\"
	2	.\" "$Id$"
	3	.\"
8fe0183a	4	.\" cupsd.conf man page for CUPS.
c41769ff	5	.\"
8fe0183a MS	6	.\" Copyright 2007-2014 by Apple Inc.
8fe0183a MS	7	.\" Copyright 1997-2006 by Easy Software Products.
c41769ff	8	.\"
8fe0183a 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/".
c41769ff	14	.\"
8fe0183a	15	.TH cups-files.conf 5 "CUPS" "6 February 2014" "Apple Inc."
c41769ff MS	16	.SH NAME
	17	cups-files.conf \- file and directory configuration file for cups
	18	.SH DESCRIPTION
db8b865d	19	The \fIcups-files.conf\fR file configures the files and directories used by the
c41769ff	20	CUPS scheduler, \fIcupsd(8)\fR. It is normally located in the
ffa2ca90	21	\fI/etc/cups\fR directory.
c41769ff MS	22	.LP
	23	Each line in the file can be a configuration directive, a blank line,
	24	or a comment. Comment lines start with the # character.
	25	.SH DIRECTIVES
	26	The following directives are understood by \fIcupsd(8)\fR. Consult the
	27	on-line help for detailed descriptions:
	28	.TP 5
	29	AccessLog filename
	30	.TP 5
	31	AccessLog syslog
	32	.br
	33	Defines the access log filename.
	34	.TP 5
	35	ConfigFilePerm mode
	36	.br
	37	Specifies the permissions for all configuration files that the scheduler
	38	writes.
	39	.TP 5
	40	DataDir path
	41	.br
	42	Specified the directory where data files can be found.
	43	.TP 5
	44	DocumentRoot directory
	45	.br
	46	Specifies the root directory for the internal web server documents.
	47	.TP 5
	48	ErrorLog filename
	49	.TP 5
	50	ErrorLog syslog
	51	.br
	52	Specifies the error log filename.
	53	.TP 5
	54	FatalErrors none
	55	.TP 5
	56	FatalErrors all -kind [... -kind]
	57	.TP 5
	58	FatalErrors kind [... kind]
	59	.br
	60	Specifies which errors are fatal, causing the scheduler to exit. "Kind" is
	61	"browse", "config", "listen", "log", or "permissions".
	62	.TP 5
	63	FileDevice Yes
	64	.TP 5
	65	FileDevice No
	66	.br
	67	Specifies whether the file pseudo-device can be used for new
	68	printer queues.
	69	.TP 5
	70	FontPath directory[:directory:...]
	71	.br
	72	Specifies the search path for fonts.
	73	.TP 5
	74	Group group-name-or-number
	75	.br
	76	Specifies the group name or ID that will be used when executing
	77	external programs.
	78	.TP 5
	79	LogFilePerm mode
	80	.br
	81	Specifies the permissions for all log files that the scheduler writes.
	82	.TP 5
	83	PageLog filename
	84	.TP 5
	85	PageLog syslog
86	.br
87	Specifies the page log filename.
88	.TP 5
89	Printcap
90	.TP 5
91	Printcap filename
92	.br
93	Specifies the filename for a printcap file that is updated
94	automatically with a list of available printers (needed for
95	legacy applications); specifying Printcap with no filename
96	disables printcap generation.
97	.TP 5
98	RemoteRoot user-name
99	.br
100	Specifies the username that is associated with unauthenticated root
101	accesses.
102	.TP 5
103	RequestRoot directory
104	.br
105	Specifies the directory to store print jobs and other HTTP request
106	data.
107	.TP 5
8fe0183a MS	108	Sandboxing off
	109	.TP 5
	110	Sandboxing relaxed
	111	.TP 5
	112	Sandboxing strict
	113	Specifies the level of security sandboxing that is applied to print filters, backends, and other child processes of the scheduler. The default is "strict". (OS X only)
	114	.TP 5
c41769ff MS	115	ServerBin directory
	116	.br
	117	Specifies the directory where backends, CGIs, daemons, and filters may
	118	be found.
	119	.TP 5
8fe0183a	120	ServerKeychain path
c41769ff	121	.br
8fe0183a	122	Specifies the location of TLS certificates and private keys.
c41769ff MS	123	.TP 5
	124	ServerRoot directory
	125	.br
	126	Specifies the directory where the server configuration files can be found.
	127	.TP 5
8a259669 MS	128	SyncOnClose Yes
	129	.TP 5
	130	SyncOnClose No
	131	Specifies whether the scheduler calls \fIfsync(2)\fR after writing configuration
	132	or state files. The default is No.
	133	.TP 5
c41769ff MS	134	SystemGroup group-name [group-name ...]
	135	.br
	136	Specifies the group(s) to use for System class authentication.
	137	.TP 5
	138	TempDir directory
	139	.br
	140	Specifies the directory where temporary files are stored.
	141	.TP 5
	142	User user-name
	143	.br
	144	Specifies the user name or ID that is used when running external programs.
	145	.SH SEE ALSO
	146	\fIclasses.conf(5)\fR, \fIcupsd(8)\fR, \fIcupsd.conf(5)\fR, \fImime.convs(5)\fR,
	147	\fImime.types(5)\fR, \fIprinters.conf(5)\fR,
	148	\fIsubscriptions.conf(5)\fR,
	149	.br
	150	http://localhost:631/help
	151	.SH COPYRIGHT
8fe0183a	152	Copyright 2007-2014 by Apple Inc.
c41769ff MS	153	.\"
	154	.\" End of "$Id$".
	155	.\"