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