man/cups-files.conf.man.in

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