man/cups-files.conf.man.in

   1 .\"
   2 .\" "$Id$"
   3 .\"
   4 .\" cups-files.conf man page for CUPS.
   5 .\"
   6 .\" Copyright 2007-2015 by Apple Inc.
   7 .\" Copyright 1997-2006 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 cups-files.conf 5 "CUPS" "2 February 2015" "Apple Inc."
  16 .SH NAME
  17 cups\-files.conf \- file and directory configuration file for cups
  18 .SH DESCRIPTION
  19 The \fBcups\-files.conf\fR file configures the files and directories used by the CUPS scheduler,
  20 .BR cupsd (8).
  21 It is normally located in the \fI/etc/cups\fR directory.
  22 .LP
  23 Each line in the file can be a configuration directive, a blank line, or a comment.
  24 Configuration directives typically consist of a name and zero or more values separated by whitespace.
  25 The configuration directive name and values are case-insensitive.
  26 Comment lines start with the # character.
  27 .SS DIRECTIVES
  28 The following directives are understood by
  29 .BR cupsd (8):
  30 .\"#AccessLog
  31 .TP 5
  32 \fBAccessLog\fR
  33 .TP 5
  34 \fBAccessLog \fIfilename\fR
  35 .TP 5
  36 \fBAccessLog syslog\fR
  37 Defines the access log filename.
  38 Specifying a blank filename disables access log generation.
  39 The value "syslog" causes log entries to be sent to the system log daemon.
  40 The server name may be included in filenames using the string "%s", for example:
  41 .nf
  42
  43     AccessLog /var/log/cups/%s-access_log
  44
  45 .fi
  46 The default is "/var/log/cups/access_log".
  47 .\"#ConfigFilePerm
  48 .TP 5
  49 \fBConfigFilePerm \fImode\fR
  50 Specifies the permissions for all configuration files that the scheduler writes.
  51 The default is "0644" on OS X and "0640" on all other operating systems.
  52 .LP
  53 \fBNote:\fR The permissions for the \fIprinters.conf\fR file are currently masked to only allow access from the scheduler user (typically root).
  54 This is done because printer device URIs sometimes contain sensitive authentication information that should not be generally known on the system.
  55 There is no way to disable this security feature.
  56 .\"#DataDir
  57 .TP 5
  58 \fBDataDir \fIpath\fR
  59 Specifies the directory where data files can be found.
  60 The default is usually "/usr/share/cups".
  61 .\"#DocumentRoot
  62 .TP 5
  63 \fBDocumentRoot \fIdirectory\fR
  64 Specifies the root directory for the CUPS web interface content.
  65 The default is usually "/usr/share/doc/cups".
  66 .\"#ErrorLog
  67 .TP 5
  68 \fBErrorLog\fR
  69 .TP 5
  70 \fBErrorLog \fIfilename\fR
  71 .TP 5
  72 \fBErrorLog syslog\fR
  73 Defines the error log filename.
  74 Specifying a blank filename disables error log generation.
  75 The value "syslog" causes log entries to be sent to the system log daemon.
  76 The server name may be included in filenames using the string "%s", for example:
  77 .nf
  78
  79     ErrorLog /var/log/cups/%s-error_log
  80
  81 .fi
  82 The default is "/var/log/cups/error_log".
  83 .\"#FatalErrors
  84 .TP 5
  85 \fBFatalErrors none\fR
  86 .TP 5
  87 \fBFatalErrors all \fI\-kind \fR[ ... \fI\-kind \fR]
  88 .TP 5
  89 \fBFatalErrors \fIkind \fR[ ... \fIkind \fR]
  90 Specifies which errors are fatal, causing the scheduler to exit.
  91 The default is "config".
  92 The \fIkind\fR strings are:
  93 .RS 5
  94 .TP 5
  95 .B none
  96 No errors are fatal.
  97 .TP 5
  98 .B all
  99 All of the errors below are fatal.
 100 .TP 5
 101 .B browse
 102 Browsing initialization errors are fatal, for example failed connections to the DNS-SD daemon.
 103 .TP 5
 104 .B config
 105 Configuration file syntax errors are fatal.
 106 .TP 5
 107 .B listen
 108 Listen or Port errors are fatal, except for IPv6 failures on the loopback or "any" addresses.
 109 .TP 5
 110 .B log
 111 Log file creation or write errors are fatal.
 112 .TP 5
 113 .B permissions
 114 Bad startup file permissions are fatal, for example shared TLS certificate and key files with world-read permissions.
 115 .RE
 116 .\"#FileDevice
 117 .TP 5
 118 \fBFileDevice Yes\fR
 119 .TP 5
 120 \fBFileDevice No\fR
 121 Specifies whether the file pseudo-device can be used for new printer queues.
 122 The URI "file:///dev/null" is always allowed.
 123 .\"#Group
 124 .TP 5
 125 \fBGroup \fIgroup-name-or-number\fR
 126 Specifies the group name or ID that will be used when executing external programs.
 127 The default group is operating system specific but is usually "lp" or "nobody".
 128 .\"#LogFilePerm
 129 .TP 5
 130 \fBLogFilePerm \fImode\fR
 131 Specifies the permissions of all log files that the scheduler writes.
 132 The default is "0644".
 133 .\"#PageLog
 134 .TP 5
 135 \fBPageLog \fR[ \fIfilename\fR ]
 136 .TP 5
 137 \fBPageLog syslog\fR
 138 Defines the page log filename.
 139 The value "syslog" causes log entries to be sent to the system log daemon.
 140 Specifying a blank filename disables page log generation.
 141 The server name may be included in filenames using the string "%s", for example:
 142 .nf
 143
 144     PageLog /var/log/cups/%s-page_log
 145
 146 .fi
 147 The default is "/var/log/cups/page_log".
 148 .\"#RemoteRoot
 149 .TP 5
 150 \fBRemoteRoot \fIusername\fR
 151 Specifies the username that is associated with unauthenticated accesses by clients claiming to be the root user.
 152 The default is "remroot".
 153 .\"#RequestRoot
 154 .TP 5
 155 \fBRequestRoot \fIdirectory\fR
 156 Specifies the directory that contains print jobs and other HTTP request data.
 157 The default is "/var/spool/cups".
 158 .\"#Sandboxing
 159 .TP 5
 160 \fBSandboxing relaxed\fR
 161 .TP 5
 162 \fBSandboxing strict\fR
 163 Specifies the level of security sandboxing that is applied to print filters, backends, and other child processes of the scheduler.
 164 The default is "strict".
 165 This directive is currently only used/supported on OS X.
 166 .\"#ServerBin
 167 .TP 5
 168 \fBServerBin \fIdirectory\fR
 169 Specifies the directory containing the backends, CGI programs, filters, helper programs, notifiers, and port monitors.
 170 The default is "/usr/lib/cups" or "/usr/libexec/cups" depending on the platform.
 171 .\"#ServerKeychain
 172 .TP 5
 173 \fBServerKeychain \fIpath\fR
 174 Specifies the location of TLS certificates and private keys.
 175 The default is "/Library/Keychains/System.keychain" on OS X and "/etc/cups/ssl" on all other operating systems.
 176 OS X uses its keychain database to store certificates and keys while other platforms use separate files in the specified directory, *.crt for PEM-encoded certificates and *.key for PEM-encoded private keys.
 177 .\"#ServerRoot
 178 .TP 5
 179 \fBServerRoot \fIdirectory\fR
 180 Specifies the directory containing the server configuration files.
 181 The default is "/etc/cups".
 182 .\"#SyncOnClose
 183 .TP 5
 184 \fBSyncOnClose Yes\fR
 185 .TP 5
 186 \fBSyncOnClose No\fR
 187 Specifies whether the scheduler calls
 188 .BR fsync (2)
 189 after writing configuration or state files.
 190 The default is "No".
 191 .\"#SystemGroup
 192 .TP 5
 193 \fBSystemGroup \fIgroup-name \fR[ ... \fIgroup-name\fR ]
 194 Specifies the group(s) to use for \fI@SYSTEM\fR group authentication.
 195 The default contains "admin", "lpadmin", "root", "sys", and/or "system".
 196 .\"#TempDir
 197 .TP 5
 198 \fBTempDir \fIdirectory\fR
 199 Specifies the directory where temporary files are stored.
 200 The default is "/var/spool/cups/tmp".
 201 .\"#User
 202 .TP 5
 203 \fBUser \fIusername\fR
 204 Specifies the user name or ID that is used when running external programs.
 205 The default is "lp".
 206 .SH SEE ALSO
 207 .BR classes.conf (5),
 208 .BR cups (1),
 209 .BR cupsd (8),
 210 .BR cupsd.conf (5),
 211 .BR mime.convs (5),
 212 .BR mime.types (5),
 213 .BR printers.conf (5),
 214 .BR subscriptions.conf (5),
 215 CUPS Online Help (http://localhost:631/help)
 216 .SH COPYRIGHT
 217 Copyright \[co] 2007-2015 by Apple Inc.
 218 .\"
 219 .\" End of "$Id$".
 220 .\"