diff options
author | msweet <msweet@a1ca3aef-8c08-0410-bb20-df032aa958be> | 2013-07-08 21:15:13 +0000 |
---|---|---|
committer | msweet <msweet@a1ca3aef-8c08-0410-bb20-df032aa958be> | 2013-07-08 21:15:13 +0000 |
commit | ffa2ca90d54cee938def492abe97894f784d8a78 (patch) | |
tree | 937223961d3c836a9d3458ba3f933ab5d8e7cba3 /man | |
parent | 9520743f2d63ee95526873098ed3968dcdf313f4 (diff) | |
download | cups-ffa2ca90d54cee938def492abe97894f784d8a78.tar.gz |
Update documentation to not embed unstable configuration values, now that man
pages are part of the repository...
git-svn-id: svn+ssh://src.apple.com/svn/cups/cups.org/trunk@11109 a1ca3aef-8c08-0410-bb20-df032aa958be
Diffstat (limited to 'man')
-rw-r--r-- | man/client.conf.man.in | 6 | ||||
-rw-r--r-- | man/cups-deviced.man.in | 6 | ||||
-rw-r--r-- | man/cups-driverd.man.in | 10 | ||||
-rw-r--r-- | man/cups-files.conf.man.in | 4 | ||||
-rw-r--r-- | man/cups-lpd.man.in | 6 | ||||
-rw-r--r-- | man/cups-snmp.man.in | 9 | ||||
-rw-r--r-- | man/cupsaddsmb.man.in | 44 | ||||
-rw-r--r-- | man/cupsd.conf.man.in | 6 | ||||
-rw-r--r-- | man/cupsd.man.in | 4 | ||||
-rw-r--r-- | man/lpoptions.man.in | 6 |
10 files changed, 34 insertions, 67 deletions
diff --git a/man/client.conf.man.in b/man/client.conf.man.in index 06a307d44..a078ac9df 100644 --- a/man/client.conf.man.in +++ b/man/client.conf.man.in @@ -12,12 +12,12 @@ .\" which should have been included with this file. If this file is .\" file is missing or damaged, see the license at "http://www.cups.org/". .\" -.TH client.conf 5 "CUPS" "25 June 2013" "Apple Inc." +.TH client.conf 5 "CUPS" "8 July 2013" "Apple Inc." .SH NAME client.conf \- client configuration file for cups .SH DESCRIPTION The \fIclient.conf\fR file configures the CUPS client and is -normally located in the \fI@CUPS_SERVERROOT@\fR or \fI~/.cups\fR +normally located in the \fI/etc/cups\fR or \fI~/.cups\fR directory. Each line in the file can be a configuration directive, a blank line, or a comment. Comment lines start with the # character. @@ -38,7 +38,7 @@ GSSServiceName name Specifies the Kerberos service name that is used for authentication, typically "host", "http", or "ipp". CUPS adds the remote hostname ("name@server.example.com") for you. The default name is -"@CUPS_DEFAULT_GSSSERVICENAME@". +"http". .TP 5 ServerName hostname-or-ip-address[:port] .TP 5 diff --git a/man/cups-deviced.man.in b/man/cups-deviced.man.in index 62b248231..4aa8f432a 100644 --- a/man/cups-deviced.man.in +++ b/man/cups-deviced.man.in @@ -12,7 +12,7 @@ .\" which should have been included with this file. If this file is .\" file is missing or damaged, see the license at "http://www.cups.org/". .\" -.TH cups-deviced 8 "CUPS" "16 June 2008" "Apple Inc." +.TH cups-deviced 8 "CUPS" "8 July 2013" "Apple Inc." .SH NAME cups-deviced \- cups device daemon .SH SYNOPSIS @@ -20,8 +20,8 @@ cups-deviced \- cups device daemon .I request-id limit user-id options .SH DESCRIPTION \fIcups-deviced\fR polls the backends in -\fI@CUPS_SERVERBIN@/backend\fR for a list of available devices. -It is run by \fIcupsd(8)\fR in response to a +\fI/usr/lib/cups/backend\fR or \fI/usr/libexec/cups/backend\fR (OS X) for a +list of available devices. It is run by \fIcupsd(8)\fR in response to a \fICUPS-Get-Devices\fR request. The output format is an IPP response message. The \fIrequest-id\fR argument is the request ID from the original IPP request, typically 1. The \fIlimit\fR diff --git a/man/cups-driverd.man.in b/man/cups-driverd.man.in index 802a58ce9..3cb3fef00 100644 --- a/man/cups-driverd.man.in +++ b/man/cups-driverd.man.in @@ -12,7 +12,7 @@ .\" which should have been included with this file. If this file is .\" file is missing or damaged, see the license at "http://www.cups.org/". .\" -.TH cups-driverd 8 "CUPS" "6 January 2011" "Apple Inc." +.TH cups-driverd 8 "CUPS" "8 July 2013" "Apple Inc." .SH NAME cups-driverd \- cups driver daemon .SH SYNOPSIS @@ -42,10 +42,10 @@ is a space-delimited list of attributes ("name=value name=value accordingly. .SH DRIVERS Drivers can be static PPD files under the -\fI@CUPS_DATADIR@/model\fR directory or programs under the -\fI@CUPS_SERVERBIN@/driver\fR directory. Static PPD files must -conform to the Adobe PPD File Format Specification version 4.3 -and may be compressed using the \fIgzip(1)\fR program. Driver +\fI/usr/share/cups/model\fR directory or programs under the +\fI/usr/lib/cups/driver\fR or \fI/usr/libexec/cups/driver\fR (OS X) directories. +Static PPD files must conform to the Adobe PPD File Format Specification version +4.3 and may be compressed using the \fIgzip(1)\fR program. Driver programs must implement the command-line interface shown in the next section. .SS DRIVER PROGRAMS diff --git a/man/cups-files.conf.man.in b/man/cups-files.conf.man.in index 7682533c2..294dc0b33 100644 --- a/man/cups-files.conf.man.in +++ b/man/cups-files.conf.man.in @@ -12,13 +12,13 @@ .\" which should have been included with this file. If this file is .\" file is missing or damaged, see the license at "http://www.cups.org/". .\" -.TH cups-files.conf 5 "CUPS" "19 November 2012" "Apple Inc." +.TH cups-files.conf 5 "CUPS" "8 July 2013" "Apple Inc." .SH NAME cups-files.conf \- file and directory configuration file for cups .SH DESCRIPTION The \fIcups-files.conf\fR file configures the files and directories used by the CUPS scheduler, \fIcupsd(8)\fR. It is normally located in the -\fI@CUPS_SERVERROOT@\fR directory. +\fI/etc/cups\fR directory. .LP Each line in the file can be a configuration directive, a blank line, or a comment. Comment lines start with the # character. diff --git a/man/cups-lpd.man.in b/man/cups-lpd.man.in index b7e45ec20..e49c2ba54 100644 --- a/man/cups-lpd.man.in +++ b/man/cups-lpd.man.in @@ -12,7 +12,7 @@ .\" which should have been included with this file. If this file is .\" file is missing or damaged, see the license at "http://www.cups.org/". .\" -.TH cups-lpd 8 "CUPS" "4 August 2008" "Apple Inc." +.TH cups-lpd 8 "CUPS" "8 July 2013" "Apple Inc." .SH NAME cups-lpd \- receive print jobs and report printer status to lpd clients .SH SYNOPSIS @@ -33,7 +33,7 @@ add the following line to the \fIinetd.conf\fR file to enable the .br .nf - printer stream tcp nowait lp @CUPS_SERVERBIN@/daemon/cups-lpd cups-lpd \\ + printer stream tcp nowait lp /usr/lib/cups/daemon/cups-lpd cups-lpd \\ -o document-format=application/octet-stream .fi .LP @@ -55,7 +55,7 @@ named \fI/etc/xinetd.d/cups\fR containing the following lines: user = lp group = sys passenv = - server = @CUPS_SERVERBIN@/daemon/cups-lpd + server = /usr/lib/cups/daemon/cups-lpd server_args = -o document-format=application/octet-stream } .fi diff --git a/man/cups-snmp.man.in b/man/cups-snmp.man.in index e6f6c7448..ae07f248d 100644 --- a/man/cups-snmp.man.in +++ b/man/cups-snmp.man.in @@ -11,11 +11,14 @@ .\" which should have been included with this file. If this file is .\" file is missing or damaged, see the license at "http://www.cups.org/". .\" -.TH cups-snmp 8 "CUPS" "23 April 2012" "Apple Inc." +.TH cups-snmp 8 "CUPS" "8 July 2013" "Apple Inc." .SH NAME snmp \- cups snmp backend .SH SYNOPSIS -.B @CUPS_SERVERBIN@/backend/snmp +.B /usr/lib/cups/backend/snmp +.I ip-address-or-hostname +.br +.B /usr/libexec/cups/backend/snmp .I ip-address-or-hostname .br .B lpinfo -v --include-schemes snmp @@ -41,7 +44,7 @@ The CUPS SNMP backend uses the information from the Host, Printer, and Port Monitor MIBs along with some vendor private MIBs and intelligent port probes to determine the correct device URI and make and model for each printer. .SH CONFIGURATION -The SNMP backend reads the @CUPS_SERVERROOT@/snmp.conf configuration file, if +The SNMP backend reads the /etc/cups/snmp.conf configuration file, if present, to set the default broadcast address, community name, and logging level. The configuration file is documented in \fIcups-snmp.conf(5)\fR. The DebugLevel value can be overridden using the CUPS_DEBUG_LEVEL environment diff --git a/man/cupsaddsmb.man.in b/man/cupsaddsmb.man.in index 447dfa467..ee0d0adb3 100644 --- a/man/cupsaddsmb.man.in +++ b/man/cupsaddsmb.man.in @@ -12,7 +12,7 @@ .\" which should have been included with this file. If this file is .\" file is missing or damaged, see the license at "http://www.cups.org/". .\" -.TH cupsaddsmb 8 "CUPS" "25 July 2007" "Apple Inc." +.TH cupsaddsmb 8 "CUPS" "8 July 2013" "Apple Inc." .SH NAME cupsaddsmb \- export printers to samba for windows clients @@ -115,17 +115,14 @@ drivers and %WINDIR%\\SYSTEM32\\SPOOL\\DRIVERS\\X64\\3 folder for 64-bit drivers. .LP -The CUPS printer driver is preferred over the Microsoft driver -since it supports the page-label, job-billing, and -job-hold-until options fully on all printers. However, currently -only Windows 2000 and higher is supported by the Microsoft +However, currently only Windows 2000 and higher is supported by the Microsoft driver, so you will also need to get the Adobe driver to support Windows 95, 98, and Me clients. The Adobe and Microsoft drivers for Windows 2000 are identical. .LP Once you have extracted the driver files, copy the 32-bit drivers -to the \fI@CUPS_DATADIR@/drivers\fR directory and the 64-bit -drivers to the \fI@CUPS_DATADIR@/drivers/x64\fR directory exactly +to the \fI/usr/share/cups/drivers\fR directory and the 64-bit +drivers to the \fI/usr/share/cups/drivers/x64\fR directory exactly as named below: .nf @@ -140,39 +137,6 @@ as named below: you use the lowercase filenames shown above, otherwise \fIcupsaddsmb\fR will fail to export the drivers. -.SH CUPS POSTSCRIPT DRIVERS FOR WINDOWS -\fIcupsaddsmb\fR can use the CUPS v6 PostScript printer driver -for Windows, which is available for download from the CUPS web -site. -.LP -The CUPS printer driver is preferred over the Adobe and -Microsoft drivers since it supports the page-label, job-billing, -and job-hold-until options fully on all printers. However, -currently only Windows 2000 and higher is supported by the CUPS -driver, so you will also need to get the Adobe driver to support -Windows 95, 98, and Me clients. -.LP -Once you have extracted the driver files, copy the 32-bit drivers -to the \fI@CUPS_DATADIR@/drivers\fR directory and the 64-bit -drivers to the \fI@CUPS_DATADIR@/drivers/x64\fR directory exactly -as named below: -.nf - - [Windows 2000 and higher] - cups6.inf (from www.cups.org) - cups6.ini (from www.cups.org) - cupsps6.dll (from www.cups.org) - cupsui6.dll (from www.cups.org) - ps5ui.dll (from your Windows system) - pscript.hlp (from your Windows system) - pscript.ntf (from your Windows system) - pscript5.dll (from your Windows system) -.fi -.LP -\fBNote:\fR Unlike Windows, case is significant - make sure that -you use the lowercase filenames shown above, otherwise -\fIcupsaddsmb\fR will fail to export the drivers. - .SH ADOBE POSTSCRIPT DRIVERS FOR WINDOWS 95, 98, AND ME \fIcupsaddsmb\fR can use the Adobe PostScript printer driver for Windows 95, 98, and ME, which are available for download from the diff --git a/man/cupsd.conf.man.in b/man/cupsd.conf.man.in index e98148d6c..60c61f7da 100644 --- a/man/cupsd.conf.man.in +++ b/man/cupsd.conf.man.in @@ -12,12 +12,12 @@ .\" which should have been included with this file. If this file is .\" file is missing or damaged, see the license at "http://www.cups.org/". .\" -.TH cupsd.conf 5 "CUPS" "19 November 2012" "Apple Inc." +.TH cupsd.conf 5 "CUPS" "8 July 2013" "Apple Inc." .SH NAME cupsd.conf \- server configuration file for cups .SH DESCRIPTION The \fIcupsd.conf\fR file configures the CUPS scheduler, \fIcupsd(8)\fR. It -is normally located in the \fI@CUPS_SERVERROOT@\fR directory. \fBNote:\fR +is normally located in the \fI/etc/cups\fR directory. \fBNote:\fR File, directory, and user configuration directives that used to be allowed in the \fIcupsd.conf\fR file are now stored in the \fIcups-files.conf(5)\fR instead in order to prevent certain types of privilege escalation attacks. @@ -192,7 +192,7 @@ are run to print a job. GSSServiceName name .br Specifies the service name when using Kerberos authentication. The default -service name is "@CUPS_DEFAULT_GSSSERVICENAME@". +service name is "http". .TP 5 HostNameLookups On .TP 5 diff --git a/man/cupsd.man.in b/man/cupsd.man.in index 66e39fcd2..9fdcc2227 100644 --- a/man/cupsd.man.in +++ b/man/cupsd.man.in @@ -12,7 +12,7 @@ .\" which should have been included with this file. If this file is .\" file is missing or damaged, see the license at "http://www.cups.org/". .\" -.TH cupsd 8 "CUPS" "9 March 2009" "Apple Inc." +.TH cupsd 8 "CUPS" "8 July 2013" "Apple Inc." .SH NAME cupsd \- cups scheduler .SH SYNOPSIS @@ -24,7 +24,7 @@ cupsd \- cups scheduler \fIcupsd\fR is the scheduler for CUPS. It implements a printing system based upon the Internet Printing Protocol, version 2.1. If no options are specified on the command-line then the default configuration file -\fI@CUPS_SERVERROOT@/cupsd.conf\fR will be used. +\fI/etc/cups/cupsd.conf\fR will be used. .SH OPTIONS .TP 5 -c config-file diff --git a/man/lpoptions.man.in b/man/lpoptions.man.in index 860d8bf0a..e04365b45 100644 --- a/man/lpoptions.man.in +++ b/man/lpoptions.man.in @@ -12,7 +12,7 @@ .\" which should have been included with this file. If this file is .\" file is missing or damaged, see the license at "http://www.cups.org/". .\" -.TH lpoptions 1 "CUPS" "29 August 2008" "Apple Inc." +.TH lpoptions 1 "CUPS" "8 July 2013" "Apple Inc." .SH NAME lpoptions \- display or set printer options and defaults .SH SYNOPSIS @@ -115,14 +115,14 @@ Options set with the \fIlpoptions\fR command are used by the .SH ROOT ACCOUNT OPTIONS When run by the root user, \fIlpoptions\fR gets and sets default options and instances for \fIall users\fR in the -@CUPS_SERVERROOT@/lpoptions file. +/etc/cups/lpoptions file. .SH COMPATIBILITY The \fIlpoptions\fR command is unique to CUPS. .SH FILES ~/.cups/lpoptions - user defaults and instances created by non-root users. .br -@CUPS_SERVERROOT@/lpoptions - system-wide defaults and instances +/etc/cups/lpoptions - system-wide defaults and instances created by the root user. .SH SEE ALSO \fIcancel(1)\fR, \fIlp(1)\fR, \fIlpadmin(8)\fR, \fIlpr(1)\fR, |