From 4985dfbd4152c3c24f71142bf641478b9a961f14 Mon Sep 17 00:00:00 2001
From: Saul Wold The /etc/cups/cups-files.conf file contains configuration directives that control the files, directories. users. and groups that are used by the CUPS scheduler, The The server name can be included in the filename by using
-+ The special name "syslog" can be used to send the access
-+information to the system log instead of a plain file. The default access log file is
-+@CUPS_LOGDIR@/access_log. The The permissions for the printers.conf file are always masked to only allow access from the scheduler user (typically root). This is done because printer device URIs sometimes contain sensitive authentication information that should not be generally known on the system. There is no way to disable this security feature. The The The Documents are first looked up in a sub-directory for the
-+primary language requested by the client (e.g.
-+@CUPS_DOCROOT@/fr/...) and then directly under
-+the The The server name can be included in the filename by using
-+ The special name "syslog" can be used to send the error
-+information to the system log instead of a plain file. The Multiple errors can be listed, and the form "-kind" can be used with
-+ The The default setting is File devices are managed by the scheduler. Since the
-+scheduler normally runs as the root user, file devices
-+can be used to overwrite system files and potentially
-+gain unauthorized access to the system. If you must
-+create printers using file devices, we recommend that
-+you set the The The The The The server name can be included in the filename by using
-+ The special name "syslog" can be used to send the page
-+information to the system log instead of a plain file. The When a filename is specified (e.g. @CUPS_DEFAULT_PRINTCAP@),
-+the printcap file is written whenever a printer is added or
-+removed. The printcap file can then be used by applications that
-+are hardcoded to look at the printcap file for the available
-+printers. The The The The The The default certificate file is
-+/etc/cups/ssl/server.crt. The The default key file is
-+/etc/cups/ssl/server.crt. The The The Temporary directories must be world-writable and should have
-+the "sticky" permission bit enabled so that other users cannot
-+delete filter temporary files. The following commands will create
-+an appropriate temporary directory called
-+/foo/bar/tmp: The You may not use user cups-files.conf
-+
-+cupsd(8)
. Each directive is listed on a line by itself followed by its value. Comments are introduced using the number sign ("#") character at the beginning of a line.AccessLog
-+
-+Examples
-+
-+
-+AccessLog /var/log/cups/access_log
-+AccessLog /var/log/cups/access_log-%s
-+AccessLog syslog
-+
-+
-+Description
-+
-+AccessLog
directive sets the name of the
-+access log file. If the filename is not absolute then it is
-+assumed to be relative to the ServerRoot
directory. The
-+access log file is stored in "common log format" and can be used
-+by any web access reporting tool to generate a report on CUPS
-+server activity.%s
in the name.CUPS 1.1.15ConfigFilePerm
-+
-+Examples
-+
-+
-+ConfigFilePerm 0644
-+ConfigFilePerm 0640
-+
-+
-+Description
-+
-+ConfigFilePerm
directive specifies the permissions to use when the scheduler writes configuration and cache files, typically in response to IPP or HTTP requests. The default is @CUPS_CONFIG_FILE_PERM@.Note:
-+
-+
-+
-+
-+DataDir
-+
-+Examples
-+
-+
-+DataDir /usr/share/cups
-+
-+
-+Description
-+
-+DataDir
directive sets the directory to use
-+for data files.CUPS 1.2/OS X 10.5DefaultAuthType
-+
-+Examples
-+
-+
-+DefaultAuthType Basic
-+DefaultAuthType BasicDigest
-+DefaultAuthType Digest
-+DefaultAuthType Negotiate
-+
-+
-+Description
-+
-+DefaultAuthType
directive specifies the type
-+of authentication to use for IPP operations that require a
-+username. The default is Basic
.DocumentRoot
-+
-+Examples
-+
-+
-+DocumentRoot /usr/share/doc/cups
-+DocumentRoot /foo/bar/doc/cups
-+
-+
-+Description
-+
-+DocumentRoot
directive specifies the location
-+of web content for the HTTP server in CUPS. If an absolute path
-+is not specified then it is assumed to be relative to the ServerRoot
directory. The
-+default directory is @CUPS_DOCROOT@.DocumentRoot
directory (e.g.
-+@CUPS_DOCROOT@/...), so it is possible to
-+localize the web content by providing subdirectories for each
-+language needed.ErrorLog
-+
-+Examples
-+
-+
-+ErrorLog /var/log/cups/error_log
-+ErrorLog /var/log/cups/error_log-%s
-+ErrorLog syslog
-+
-+
-+Description
-+
-+ErrorLog
directive sets the name of the error
-+log file. If the filename is not absolute then it is assumed to
-+be relative to the ServerRoot
directory. The
-+default error log file is @CUPS_LOGDIR@/error_log.%s
in the name.CUPS 1.4/OS X 10.6FatalErrors
-+
-+Examples
-+
-+
-+FatalErrors none
-+FatalErrors all
-+FatalErrors browse
-+FatalErrors config
-+FatalErrors listen
-+FatalErrors log
-+FatalErrors permissions
-+FatalErrors all -permissions
-+FatalErrors config permissions log
-+
-+
-+Description
-+
-+FatalErrors
directive determines whether certain kinds of
-+errors are fatal. The following kinds of errors are currently recognized:
-+
-+
-+
-+none
- No errors are fatalall
- All of the errors below are fatalbrowse
- Browsing initialization errors are fatal,
-+ for example failed binding to the CUPS browse port or failed connections
-+ to LDAP serversconfig
- Configuration file syntax errors are
-+ fatallisten
- Listen or Port errors are fatal, except for
-+ IPv6 failures on the loopback or "any" addresseslog
- Log file creation or write errors are fatalpermissions
- Bad startup file permissions are
-+ fatal, for example shared SSL certificate and key files with world-
-+ read permissionsall
to remove specific kinds of errors. The default setting is
-+@CUPS_FATAL_ERRORS@
.CUPS 1.1.18FileDevice
-+
-+Examples
-+
-+
-+FileDevice Yes
-+FileDevice No
-+
-+
-+Description
-+
-+FileDevice
directive determines whether the
-+scheduler allows new printers to be added using device URIs of
-+the form file:/filename
. File devices are most often
-+used to test new printer drivers and do not support raw file
-+printing.No
.Note:
-+
-+
-+
-+
-+FileDevice
directive to
-+Yes
for only as long as you need to add the
-+printers to the system, and then reset the directive to
-+No
.CUPS 1.1.3FontPath
-+
-+Examples
-+
-+
-+FontPath /foo/bar/fonts
-+FontPath /usr/share/cups/fonts:/foo/bar/fonts
-+
-+
-+Description
-+
-+FontPath
directive specifies the font path to
-+use when searching for fonts. The default font path is
-+/usr/share/cups/fonts
.Group
-+
-+Examples
-+
-+
-+Group lp
-+Group nobody
-+
-+
-+Description
-+
-+Group
directive specifies the UNIX group that
-+filter and CGI programs run as. The default group is
-+system-specific but is usually lp
or
-+nobody
.CUPS 1.1.15LogFilePerm
-+
-+Examples
-+
-+
-+LogFilePerm 0644
-+LogFilePerm 0600
-+
-+
-+Description
-+
-+LogFilePerm
directive specifies the
-+permissions to use when writing log files. The default
-+is @CUPS_LOG_FILE_PERM@.PageLog
-+
-+Examples
-+
-+
-+PageLog /var/log/cups/page_log
-+PageLog /var/log/cups/page_log-%s
-+PageLog syslog
-+
-+
-+Description
-+
-+PageLog
directive sets the name of the page
-+log file. If the filename is not absolute then it is assumed to
-+be relative to the ServerRoot
directory. The
-+default page log file is @CUPS_LOGDIR@/page_log.%s
in the name.Printcap
-+
-+Examples
-+
-+
-+Printcap
-+Printcap /etc/printcap
-+Printcap /etc/printers.conf
-+Printcap /Library/Preferences/org.cups.printers.plist
-+
-+
-+Description
-+
-+Printcap
directive controls whether or not a
-+printcap file is automatically generated and updated with a list
-+of available printers. If specified with no value, then no
-+printcap file will be generated. The default is to generate a
-+file named @CUPS_DEFAULT_PRINTCAP@.PrintcapFormat
-+
-+Examples
-+
-+
-+PrintcapFormat BSD
-+PrintcapFormat Solaris
-+PrintcapFormat plist
-+
-+
-+Description
-+
-+PrintcapFormat
directive controls the output format of the
-+printcap file. The default is to generate the plist format on OS X, the
-+Solaris format on Solaris, and the BSD format on other operating systems.CUPS 1.1.3RemoteRoot
-+
-+Examples
-+
-+
-+RemoteRoot remroot
-+RemoteRoot root
-+
-+
-+Description
-+
-+RemoteRoot
directive sets the username for
-+unauthenticated root requests from remote hosts. The default
-+username is remroot. Setting RemoteRoot
-+to root effectively disables this security
-+mechanism.RequestRoot
-+
-+Examples
-+
-+
-+RequestRoot /var/spool/cups
-+RequestRoot /foo/bar/spool/cups
-+
-+
-+Description
-+
-+RequestRoot
directive sets the directory for
-+incoming IPP requests and HTML forms. If an absolute path is not
-+provided then it is assumed to be relative to the ServerRoot
directory. The
-+default request directory is @CUPS_REQUESTS@.ServerBin
-+
-+Examples
-+
-+
-+ServerBin /usr/lib/cups
-+ServerBin /foo/bar/lib/cups
-+
-+
-+Description
-+
-+ServerBin
directive sets the directory for
-+server-run executables. If an absolute path is not provided then
-+it is assumed to be relative to the ServerRoot
directory. The
-+default executable directory is /usr/lib/cups,
-+/usr/lib32/cups, or /usr/libexec/cups
-+depending on the operating system.ServerCertificate
-+
-+Examples
-+
-+
-+ServerCertificate /etc/cups/ssl/server.crt
-+
-+
-+Description
-+
-+ServerCertificate
directive specifies the
-+location of the SSL certificate file used by the server when
-+negotiating encrypted connections. The certificate must not be
-+encrypted (password protected) since the scheduler normally runs
-+in the background and will be unable to ask for a password.ServerKey
-+
-+Examples
-+
-+
-+ServerKey /etc/cups/ssl/server.key
-+
-+
-+Description
-+
-+ServerKey
directive specifies the location of
-+the SSL private key file used by the server when negotiating
-+encrypted connections.ServerRoot
-+
-+Examples
-+
-+
-+ServerRoot /etc/cups
-+ServerRoot /foo/bar/cups
-+
-+
-+Description
-+
-+ServerRoot
directive specifies the absolute
-+path to the server configuration and state files. It is also used
-+to resolve relative paths in the cupsd.conf file. The
-+default server directory is /etc/cups.SystemGroup
-+
-+Examples
-+
-+
-+SystemGroup lpadmin
-+SystemGroup sys
-+SystemGroup system
-+SystemGroup root
-+SystemGroup root lpadmin
-+
-+
-+Description
-+
-+SystemGroup
directive specifies the system
-+administration group for System
authentication.
-+Multiple groups can be listed, separated with spaces. The default
-+group list is @CUPS_SYSTEM_GROUPS@
.TempDir
-+
-+Examples
-+
-+
-+TempDir /var/tmp
-+TempDir /foo/bar/tmp
-+
-+
-+Description
-+
-+TempDir
directive specifies an absolute path
-+for the directory to use for temporary files. The default
-+directory is @CUPS_REQUESTS@/tmp.
-+mkdir /foo/bar/tmp
-+chmod a+rwxt /foo/bar/tmp
-+
-+
-+
-+User
-+
-+Examples
-+
-+
-+User lp
-+User guest
-+
-+
-+Description
-+
-+User
directive specifies the UNIX user that
-+filter and CGI programs run as. The default user is
-+@CUPS_USER@
.Note:
-+
-+
-+
-+
-+
-+
-diff -urNad '--exclude=CVS' '--exclude=.svn' '--exclude=.git' '--exclude=.arch' '--exclude=.hg' '--exclude=_darcs' '--exclude=.bzr' cups~/doc/help/ref-cupsd-conf.html.in cups/doc/help/ref-cupsd-conf.html.in
---- cups~/doc/help/ref-cupsd-conf.html.in 2012-12-07 13:00:48.000000000 +0100
-+++ cups/doc/help/ref-cupsd-conf.html.in 2012-12-08 00:29:10.000000000 +0100
-@@ -191,82 +191,6 @@
- HREF="#Limit">root
, as that would expose
-+the system to unacceptable security risks. The scheduler will
-+automatically choose user nobody
if you specify a
-+user whose ID is 0.Limit
section.
--<Location /path> -- ... -- AuthClass Anonymous -- AuthClass User -- AuthClass System -- AuthClass Group --</Location> ---- --
The AuthClass
directive defines what level of
--authentication is required:
Anonymous
- No authentication should be
-- performed (default)User
- A valid username and password is
-- requiredSystem
- A valid username and password
-- is required, and the username must belong to the "sys"
-- group; this can be changed using the SystemGroup
-- directiveGroup
- A valid username and password is
-- required, and the username must belong to the group named
-- by the AuthGroupName
-- directiveThe AuthClass
directive must appear inside a Location
or Limit
section.
This directive is deprecated and will be removed from a
--future release of CUPS. Consider using the more flexible Require
directive instead.
--<Location /path> -- ... -- AuthGroupName mygroup -- AuthGroupName lp --</Location> ---- --
The AuthGroupName
directive sets the group to use
--for Group
authentication.
The AuthGroupName
directive must appear inside a
--Location
or Limit
section.
This directive is deprecated and will be removed from a
--future release of CUPS. Consider using the more flexible Require
directive instead.
--Printcap --Printcap /etc/printcap --Printcap /etc/printers.conf --Printcap /Library/Preferences/org.cups.printers.plist ---- --
The Printcap
directive controls whether or not a
--printcap file is automatically generated and updated with a list
--of available printers. If specified with no value, then no
--printcap file will be generated. The default is to generate a
--file named @CUPS_DEFAUL_PRINTCAP@.
When a filename is specified (e.g. @CUPS_DEFAULT_PRINTCAP@), --the printcap file is written whenever a printer is added or --removed. The printcap file can then be used by applications that --are hardcoded to look at the printcap file for the available --printers.
-- -- ----PrintcapFormat BSD --PrintcapFormat Solaris --PrintcapFormat plist ---- --
The PrintcapFormat
directive controls the output format of the
--printcap file. The default is to generate the plist format on Mac OS X, the
--Solaris format on Solaris, and the BSD format on other operating systems.
--PrintGUI /usr/bin/glpoptions ---- --
The PrintcapGUI
directive sets the program to
--associate with the IRIX printer GUI interface script which is
--used by IRIX applications to display printer-specific options.
--There is no default program.
--RemoteRoot remroot --RemoteRoot root ---- --
The RemoteRoot
directive sets the username for
--unauthenticated root requests from remote hosts. The default
--username is remroot. Setting RemoteRoot
--to root effectively disables this security
--mechanism.
--RequestRoot /var/spool/cups --RequestRoot /foo/bar/spool/cups ---- --
The RequestRoot
directive sets the directory for
--incoming IPP requests and HTML forms. If an absolute path is not
--provided then it is assumed to be relative to the ServerRoot
directory. The
--default request directory is @CUPS_REQUESTS@.
--ServerBin /usr/lib/cups --ServerBin /foo/bar/lib/cups ---- --
The ServerBin
directive sets the directory for
--server-run executables. If an absolute path is not provided then
--it is assumed to be relative to the ServerRoot
directory. The
--default executable directory is /usr/lib/cups,
--/usr/lib32/cups, or /usr/libexec/cups
--depending on the operating system.
--ServerCertificate /etc/cups/ssl/server.crt ---- --
The ServerCertificate
directive specifies the
--location of the SSL certificate file used by the server when
--negotiating encrypted connections. The certificate must not be
--encrypted (password protected) since the scheduler normally runs
--in the background and will be unable to ask for a password.
The default certificate file is --/etc/cups/ssl/server.crt.
-- -- ----ServerKey /etc/cups/ssl/server.key ---- --
The ServerKey
directive specifies the location of
--the SSL private key file used by the server when negotiating
--encrypted connections.
The default key file is --/etc/cups/ssl/server.crt.
-- -- ---ServerRoot /etc/cups --ServerRoot /foo/bar/cups ---- --
The ServerRoot
directive specifies the absolute
--path to the server configuration and state files. It is also used
--to resolve relative paths in the cupsd.conf file. The
--default server directory is /etc/cups.
--SystemGroup lpadmin --SystemGroup sys --SystemGroup system --SystemGroup root --SystemGroup root lpadmin ---- --
The SystemGroup
directive specifies the system
--administration group for System
authentication.
--Multiple groups can be listed, separated with spaces. The default
--group list is @CUPS_SYSTEM_GROUPS@
.
--TempDir /var/tmp --TempDir /foo/bar/tmp ---- --
The TempDir
directive specifies an absolute path
--for the directory to use for temporary files. The default
--directory is @CUPS_REQUESTS@/tmp.
Temporary directories must be world-writable and should have --the "sticky" permission bit enabled so that other users cannot --delete filter temporary files. The following commands will create --an appropriate temporary directory called --/foo/bar/tmp:
-- ----mkdir /foo/bar/tmp --chmod a+rwxt /foo/bar/tmp ---- -- -
--UseNetworkDefault yes --UseNetworkDefault no ---- --
The UseNetworkDefault
directive controls whether
--the client will use a network/remote printer as a default
--printer. If enabled, the default printer of a server is used as
--the default printer on a client. When multiple servers are
--advertising a default printer, the client's default printer is
--set to the first discovered printer, or to the implicit class for
--the same printer available from multiple servers.
The default is @CUPS_USE_NETWORK_DEFAULT@
.
--User lp --User guest ---- --
The User
directive specifies the UNIX user that
--filter and CGI programs run as. The default user is
--@CUPS_USER@
.
Note: -- ---- -- -You may not use user
-- --root
, as that would expose --the system to unacceptable security risks. The scheduler will --automatically choose usernobody
if you specify a --user whose ID is 0.