From: mike Date: Fri, 8 Mar 2013 18:47:50 +0000 (+0000) Subject: Fix up some of the documentation stuff (STR #4223) X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=c58c682702d45a03842013d9a51ecbdb66608539;p=thirdparty%2Fcups.git Fix up some of the documentation stuff (STR #4223) git-svn-id: svn+ssh://src.apple.com/svn/cups/cups.org/trunk@10891 7a7537e8-13f0-0310-91df-b6672ffda945 --- diff --git a/doc/help/ref-cups-files-conf.html.in b/doc/help/ref-cups-files-conf.html.in index eb1e71c051..fa922cb230 100644 --- a/doc/help/ref-cups-files-conf.html.in +++ b/doc/help/ref-cups-files-conf.html.in @@ -74,24 +74,6 @@ DataDir /usr/share/cups for data files.

-

CUPS 1.2/OS X 10.5DefaultAuthType

- -

Examples

- -
-DefaultAuthType Basic
-DefaultAuthType BasicDigest
-DefaultAuthType Digest
-DefaultAuthType Negotiate
-
- -

Description

- -

The DefaultAuthType directive specifies the type -of authentication to use for IPP operations that require a -username. The default is Basic.

- -

DocumentRoot

Examples

diff --git a/doc/help/ref-cupsd-conf.html.in b/doc/help/ref-cupsd-conf.html.in index 8298092279..43ca20b64b 100644 --- a/doc/help/ref-cupsd-conf.html.in +++ b/doc/help/ref-cupsd-conf.html.in @@ -49,36 +49,6 @@ automatically handles restarting the scheduler.

-

AccessLog

- -

Examples

- -
-AccessLog /var/log/cups/access_log
-AccessLog /var/log/cups/access_log-%s
-AccessLog syslog
-
- -

Description

- -

The 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.

- -

The server name can be included in the filename by using -%s in the name.

- -

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.

- -

AccessLogLevel

Examples

@@ -360,40 +330,6 @@ used.

The default is to not allow classification overrides.

-

CUPS 1.1.15ConfigFilePerm

- -

Examples

- -
-ConfigFilePerm 0644
-ConfigFilePerm 0640
-
- -

Description

- -

The 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: - -

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.

- -
- - -

DataDir

- -

Examples

- -
-DataDir /usr/share/cups
-
- -

Description

- -

The DataDir directive sets the directory to use -for data files.

- -

CUPS 1.2/OS X 10.5DefaultAuthType

Examples

@@ -577,32 +513,6 @@ DirtyCleanInterval 0

The default value is 30 (30 seconds).

-

DocumentRoot

- -

Examples

- -
-DocumentRoot /usr/share/doc/cups
-DocumentRoot /foo/bar/doc/cups
-
- -

Description

- -

The 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@.

- -

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 DocumentRoot directory (e.g. -@CUPS_DOCROOT@/...), so it is possible to -localize the web content by providing subdirectories for each -language needed.

- -

Encryption

Examples

@@ -625,31 +535,6 @@ encryption settings for that location. The default setting is IfRequested for all locations.

-

ErrorLog

- -

Examples

- -
-ErrorLog /var/log/cups/error_log
-ErrorLog /var/log/cups/error_log-%s
-ErrorLog syslog
-
- -

Description

- -

The 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.

- -

The server name can be included in the filename by using -%s in the name.

- -

The special name "syslog" can be used to send the error -information to the system log instead of a plain file.

- -

CUPS 1.3/OS X 10.5ErrorPolicy

Examples

@@ -688,91 +573,6 @@ printer.

- -

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

- -

The FatalErrors directive determines whether certain kinds of -errors are fatal. The following kinds of errors are currently recognized:

- - - -

Multiple errors can be listed, and the form "-kind" can be used with -all to remove specific kinds of errors. The default setting is -@CUPS_FATAL_ERRORS@.

- - -

CUPS 1.1.18FileDevice

- -

Examples

- -
-FileDevice Yes
-FileDevice No
-
- -

Description

- -

The 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.

- -

The default setting is No.

- -
Note: - -

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 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.3FilterLimit

Examples

@@ -817,39 +617,6 @@ value to assign to filter processes. The nice value ranges from is 0.

-

CUPS 1.1.3FontPath

- -

Examples

- -
-FontPath /foo/bar/fonts
-FontPath /usr/share/cups/fonts:/foo/bar/fonts
-
- -

Description

- -

The 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

- -

The 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.6/OS X 10.8GSSServiceName

Examples

@@ -904,7 +671,7 @@ Include /foo/bar/filename

The Include directive includes the named file in the cupsd.conf file. If no leading path is provided, the file is assumed to be relative to the ServerRoot directory.

+HREF="ref-cups-files-conf.html#ServerRoot">ServerRoot directory.

CUPS 1.5JobPrivateAccess

@@ -1457,22 +1224,6 @@ error occurs during printing. The default is 200 messages. A value of 0 disables debugging history entirely and is not recommended.

-

CUPS 1.1.15LogFilePerm

- -

Examples

- -
-LogFilePerm 0644
-LogFilePerm 0600
-
- -

Description

- -

The LogFilePerm directive specifies the -permissions to use when writing log files. The default -is @CUPS_LOG_FILE_PERM@.

- -

LogLevel

Examples

@@ -1493,7 +1244,7 @@ LogLevel debug2

Description

The LogLevel directive specifies the level of -logging for the ErrorLog +logging for the ErrorLog file. The following values are recognized (each level logs everything under the preceding levels):

@@ -1817,31 +1568,6 @@ HREF="#Location">Location or Limit section.

-

PageLog

- -

Examples

- -
-PageLog /var/log/cups/page_log
-PageLog /var/log/cups/page_log-%s
-PageLog syslog
-
- -

Description

- -

The 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.

- -

The server name can be included in the filename by using -%s in the name.

- -

The special name "syslog" can be used to send the page -information to the system log instead of a plain file.

- -

PageLogFormat

Examples