Translations by Yukiko Bando

ACL Address

Poll

<b>Server name (ServerName)</b> <p> The hostname of your server, as advertised to the world. By default CUPS will use the hostname of the system.</p> <p> To set the default server used by clients, see the client.conf file.</p> <p> <i>ex</i>: myhost.domain.com</p>

<b>Server administrator (ServerAdmin)</b> <p> The email address to send all complaints or problems to. By default CUPS will use "root@hostname".</p> <p> <i>ex</i>: root@myhost.com</p>

<b>Access log (AccessLog)</b> <p> The access log file; if this does not start with a leading / then it is assumed to be relative to ServerRoot. By default set to "/var/log/cups/access_log".</p> <p> You can also use the special name <b>syslog</b> to send the output to the syslog file or daemon.</p> <p> <i>ex</i>: /var/log/cups/access_log</p>

<b>Data directory (DataDir)</b> <p> The root directory for the CUPS data files. By default /usr/share/cups.</p> <p> <i>ex</i>: /usr/share/cups</p>

<b>Default character set (DefaultCharset)</b> <p> The default character set to use. If not specified, defaults to utf-8. Note that this can also be overridden in HTML documents...</p> <p> <i>ex</i>: utf-8</p>

<b>Default language (DefaultLanguage)</b> <p> The default language if not specified by the browser. If not specified, the current locale is used.</p> <p> <i>ex</i>: en</p>

<b>Error log (ErrorLog)</b> <p> The error log file; if this does not start with a leading / then it is assumed to be relative to ServerRoot. By default set to "/var/log/cups/error_log".</p> <p> You can also use the special name <b>syslog</b> to send the output to the syslog file or daemon.</p> <p> <i>ex</i>: /var/log/cups/error_log</p>

<b>Font path (FontPath)</b> <p> The path to locate all font files (currently only for pstoraster). By default /usr/share/cups/fonts.</p> <p> <i>ex</i>: /usr/share/cups/fonts</p>

<b>Log level (LogLevel)</b> <p> Controls the number of messages logged to the ErrorLog file and can be one of the following:</p> <ul type=circle> <li><i>debug2</i>: Log everything.</li> <li><i>debug</i>: Log almost everything.</li> <li><i>info</i>: Log all requests and state changes.</li> <li><i>warn</i>: Log errors and warnings.</li> <li><i>error</i>: Log only errors.</li> <li><i>none</i>: Log nothing.</li> </ul><p> <i>ex</i>: info</p>

<b>Max log size (MaxLogSize)</b> <p> Controls the maximum size of each log file before they are rotated. Defaults to 1048576 (1MB). Set to 0 to disable log rotating.</p> <p> <i>ex</i>: 1048576</p>

<b>Page log (PageLog)</b> <p> The page log file; if this does not start with a leading / then it is assumed to be relative to ServerRoot. By default set to "/var/log/cups/page_log".</p> <p> You can also use the special name <b>syslog</b> to send the output to the syslog file or daemon.</p> <p> <i>ex</i>: /var/log/cups/page_log</p>

<b>Preserve job history (PreserveJobHistory)</b> <p> Whether or not to preserve the job history after a job is completed, canceled, or stopped. Default is Yes.</p> <p> <i>ex</i>: Yes</p>

<b>Preserve job files (PreserveJobFiles)</b> <p> Whether or not to preserve the job files after a job is completed, canceled, or stopped. Default is No.</p> <p> <i>ex</i>: No</p>

<b>Printcap file (Printcap)</b> <p> The name of the printcap file. Default is no filename. Leave blank to disable printcap file generation.</p> <p> <i>ex</i>: /etc/printcap</p>

<b>Request directory (RequestRoot)</b> <p> The directory where request files are stored. By default /var/spool/cups.</p> <p> <i>ex</i>: /var/spool/cups</p>

<b>Remote root user (RemoteRoot)</b> <p> The name of the user assigned to unauthenticated accesses from remote systems. By default "remroot".</p> <p> <i>ex</i>: remroot</p>

<b>Server binaries (ServerBin)</b> <p> The root directory for the scheduler executables. By default /usr/lib/cups or /usr/lib32/cups (IRIX 6.5).</p> <p> <i>ex</i>: /usr/lib/cups</p>

<b>Server files (ServerRoot)</b> <p> The root directory for the scheduler. By default /etc/cups.</p> <p> <i>ex</i>: /etc/cups</p>

<b>User (User)</b> <p> The user the server runs under. Normally this must be <b>lp</b>, however you can configure things for another user as needed.</p> <p> Note: the server must be run initially as root to support the default IPP port of 631. It changes users whenever an external program is run...</p> <p> <i>ex</i>: lp</p>

<b>RIP cache (RIPCache)</b> <p> The amount of memory that each RIP should use to cache bitmaps. The value can be any real number followed by "k" for kilobytes, "m" for megabytes, "g" for gigabytes, or "t" for tiles (1 tile = 256x256 pixels). Defaults to "8m" (8 megabytes).</p> <p> <i>ex</i>: 8m</p>

<b>Temporary files (TempDir)</b> <p> The directory to put temporary files in. This directory must be writable by the user defined above! Defaults to "/var/spool/cups/tmp" or the value of the TMPDIR environment variable.</p> <p> <i>ex</i>: /var/spool/cups/tmp</p>

<b>Filter limit (FilterLimit)</b> <p> Sets the maximum cost of all job filters that can be run at the same time. A limit of 0 means no limit. A typical job may need a filter limit of at least 200; limits less than the minimum required by a job force a single job to be printed at any time.</p> <p> The default limit is 0 (unlimited).</p> <p> <i>ex</i>: 200</p>

<b>Listen to (Port/Listen)</b> <p> Ports/addresses that are listened to. The default port 631 is reserved for the Internet Printing Protocol (IPP) and is what is used here.</p> <p> You can have multiple Port/Listen lines to listen to more than one port or address, or to restrict access.</p> <p> Note: Unfortunately, most web browsers don't support TLS or HTTP Upgrades for encryption. If you want to support web-based encryption you will probably need to listen on port 443 (the "HTTPS" port...).</p> <p> <i>ex</i>: 631, myhost:80, 1.2.3.4:631</p>

<b>Hostname lookups (HostNameLookups)</b> <p> Whether or not to do lookups on IP addresses to get a fully-qualified hostname. This defaults to Off for performance reasons...</p> <p> <i>ex</i>: On</p>

<b>Keep alive (KeepAlive)</b> <p> Whether or not to support the Keep-Alive connection option. Default is on.</p> <p> <i>ex</i>: On</p>

<b>Keep-alive timeout (KeepAliveTimeout)</b> <p> The timeout (in seconds) before Keep-Alive connections are automatically closed. Default is 60 seconds.</p> <p> <i>ex</i>: 60</p>

<b>Max clients (MaxClients)</b> <p> Controls the maximum number of simultaneous clients that will be handled. Defaults to 100.</p> <p> <i>ex</i>: 100</p>

<b>Max request size (MaxRequestSize)</b> <p> Controls the maximum size of HTTP requests and print files. Set to 0 to disable this feature (defaults to 0).</p> <p> <i>ex</i>: 0</p>

<b>Client timeout (Timeout)</b> <p> The timeout (in seconds) before requests time out. Default is 300 seconds.</p> <p> <i>ex</i>: 300</p>

<b>Use browsing (Browsing)</b> <p> Whether or not to <b>listen</b> to printer information from other CUPS servers. </p> <p> Enabled by default. </p> <p> Note: to enable the <b>sending</b> of browsing information from this CUPS server to the LAN, specify a valid <i>BrowseAddress</i>. </p> <p> <i>ex</i>: On</p>

<b>Use short names (BrowseShortNames)</b> <p> Whether or not to use "short" names for remote printers when possible (e.g. "printer" instead of "printer@host"). Enabled by default.</p> <p> <i>ex</i>: Yes</p>

<b>Browse addresses (BrowseAddress)</b> <p> Specifies a broadcast address to be used. By default browsing information is broadcast to all active interfaces.</p> <p> Note: HP-UX 10.20 and earlier do not properly handle broadcast unless you have a Class A, B, C, or D netmask (i.e. no CIDR support).</p> <p> <i>ex</i>: x.y.z.255, x.y.255.255</p>

<b>Browse allow/deny (BrowseAllow/BrowseDeny)</b> <p> <u>BrowseAllow</u>: specifies an address mask to allow for incoming browser packets. The default is to allow packets from all addresses.</p> <p> <u>BrowseDeny</u>: specifies an address mask to deny for incoming browser packets. The default is to deny packets from no addresses.</p> <p> Both "BrowseAllow" and "BrowseDeny" accept the following notations for addresses:</p> <pre> All None *.domain.com .domain.com host.domain.com nnn.* nnn.nnn.* nnn.nnn.nnn.* nnn.nnn.nnn.nnn nnn.nnn.nnn.nnn/mm nnn.nnn.nnn.nnn/mmm.mmm.mmm.mmm </pre><p> The hostname/domainname restrictions only work if you have turned hostname lookups on!</p>

<b>Browse interval (BrowseInterval)</b> <p> The time between browsing updates in seconds. Default is 30 seconds.</p> <p> Note that browsing information is sent whenever a printer's state changes as well, so this represents the maximum time between updates.</p> <p> Set this to 0 to disable outgoing broadcasts so your local printers are not advertised but you can still see printers on other hosts.</p> <p> <i>ex</i>: 30</p>

<b>Browse order (BrowseOrder)</b> <p> Specifies the order of BrowseAllow/BrowseDeny comparisons.</p> <p> <i>ex</i>: allow,deny</p>

<b>Browse poll (BrowsePoll)</b> <p> Poll the named server(s) for printers.</p> <p> <i>ex</i>: myhost:631</p>

<b>Browse port (BrowsePort)</b> <p> The port used for UDP broadcasts. By default this is the IPP port; if you change this you need to do it on all servers. Only one BrowsePort is recognized.</p> <p> <i>ex</i>: 631</p>

<b>Browse relay (BrowseRelay)</b> <p> Relay browser packets from one address/network to another.</p> <p> <i>ex</i>: src-address dest-address</p>

<b>Browse timeout (BrowseTimeout)</b> <p> The timeout (in seconds) for network printers - if we don't get an update within this time the printer will be removed from the printer list. This number definitely should not be less the BrowseInterval value for obvious reasons. Defaults to 300 seconds.</p> <p> <i>ex</i>: 300</p>

<b>Implicit classes (ImplicitClasses)</b> <p> Whether or not to use implicit classes.</p> <p> Printer classes can be specified explicitly in the classes.conf file, implicitly based upon the printers available on the LAN, or both.</p> <p> When ImplicitClasses is On, printers on the LAN with the same name (e.g. Acme-LaserPrint-1000) will be put into a class with the same name. This allows you to setup multiple redundant queues on a LAN without a lot of administrative difficulties. If a user sends a job to Acme-LaserPrint-1000, the job will go to the first available queue.</p> <p> Enabled by default.</p>

<b>Encryption certificate (ServerCertificate)</b> <p> The file to read containing the server's certificate. Defaults to "/etc/cups/ssl/server.crt".</p> <p> <i>ex</i>: /etc/cups/ssl/server.crt</p>

<b>Encryption key (ServerKey)</b> <p> The file to read containing the server's key. Defaults to "/etc/cups/ssl/server.key".</p> <p> <i>ex</i>: /etc/cups/ssl/server.key</p>

Access permissions # Access permissions for each directory served by the scheduler. Locations are relative to DocumentRoot... # AuthType: the authorization to use: # None - Perform no authentication Basic - Perform authentication using the HTTP Basic method. Digest - Perform authentication using the HTTP Digest method. # (Note: local certificate authentication can be substituted by the client for Basic or Digest when connecting to the localhost interface) # AuthClass: the authorization class; currently only Anonymous, User, System (valid user belonging to group SystemGroup), and Group (valid user belonging to the specified group) are supported. # AuthGroupName: the group name for "Group" authorization. # Order: the order of Allow/Deny processing. # Allow: allows access from the specified hostname, domain, IP address, or network. # Deny: denies access from the specified hostname, domain, IP address, or network. # Both "Allow" and "Deny" accept the following notations for addresses: # All None *.domain.com .domain.com host.domain.com nnn.* nnn.nnn.* nnn.nnn.nnn.* nnn.nnn.nnn.nnn nnn.nnn.nnn.nnn/mm nnn.nnn.nnn.nnn/mmm.mmm.mmm.mmm # The host and domain address require that you enable hostname lookups with "HostNameLookups On" above. # Encryption: whether or not to use encryption; this depends on having the OpenSSL library linked into the CUPS library and scheduler. # Possible values: # Always - Always use encryption (SSL) Never - Never use encryption Required - Use TLS encryption upgrade IfRequested - Use encryption if the server requests it # The default value is "IfRequested".

<b>Authentication (AuthType)</b> <p> The authorization to use:<p> <ul type=circle> <li><i>None</i> - Perform no authentication.</li> <li><i>Basic</i> - Perform authentication using the HTTP Basic method.</li> <li><i>Digest</i> - Perform authentication using the HTTP Digest method.</li> </ul><p> Note: local certificate authentication can be substituted by the client for <i>Basic</i> or <i>Digest</i> when connecting to the localhost interface.</p>

<b>Class (AuthClass)</b> <p> The authorization class; currently only <i>Anonymous</i>, <i>User</i>, <i>System</i> (valid user belonging to group SystemGroup), and <i>Group</i> (valid user belonging to the specified group) are supported.</p>

<p>The user/group names allowed to access the resource. The format is a comma separated list.</p>

<b>Satisfy (Satisfy)</b> <p> This directive controls whether all specified conditions must be satisfied to allow access to the resource. If set to "all", then all authentication and access control conditions must be satisfied to allow access. </p> <p> Setting Satisfy to "any" allows a user to gain access if the authentication <i>or</i> access control requirements are satisfied. For example, you might require authentication for remote access, but allow local access without authentication. </p> <p> The default is "all". </p>

<b>Authentication group name (AuthGroupName)</b> <p> The group name for <i>Group</i> authorization.</p>