diff options
author | jlovell <jlovell@a1ca3aef-8c08-0410-bb20-df032aa958be> | 2007-05-04 21:17:48 +0000 |
---|---|---|
committer | jlovell <jlovell@a1ca3aef-8c08-0410-bb20-df032aa958be> | 2007-05-04 21:17:48 +0000 |
commit | b94498cfba64422f0f21181b0c51cc0bed7c7d92 (patch) | |
tree | e3bdd0e05380bc8996f35ddb5439ab9044298712 /doc | |
parent | 323c5de1e804061e344172cc9a9551bb0ee71005 (diff) |
Load cups into easysw/current.
git-svn-id: svn+ssh://src.apple.com/svn/cups/easysw/current@321 a1ca3aef-8c08-0410-bb20-df032aa958be
Diffstat (limited to 'doc')
-rw-r--r-- | doc/help/options.html | 29 | ||||
-rw-r--r-- | doc/help/ref-cupsd-conf.html.in (renamed from doc/help/ref-cupsd-conf.html) | 86 | ||||
-rw-r--r-- | doc/help/ref-snmp-conf.html | 26 | ||||
-rw-r--r-- | doc/help/spec-ipp.html | 91 | ||||
-rw-r--r-- | doc/help/spec-ppd.html | 33 |
5 files changed, 200 insertions, 65 deletions
diff --git a/doc/help/options.html b/doc/help/options.html index 20a17d3a8..d42b384dd 100644 --- a/doc/help/options.html +++ b/doc/help/options.html @@ -1,7 +1,7 @@ <HTML> <!-- SECTION: Getting Started --> <HEAD> - <TITLE>Printing and Options</TITLE> + <TITLE>Command-Line Printing and Options</TITLE> </HEAD> <BODY> @@ -171,6 +171,33 @@ lpstat </PRE> +<H2 CLASS="title"><A NAME="LPMOVE">Moving a Print Job</A></H2> + +<P>The <A HREF="man-lpmove.html">lpmove(8)</A> command moves a print +job to a new printer or class:</P> + +<PRE CLASS="command"> +lpmove <I>job-id</I> <i>destination</i> +</PRE> + +<P>The <I>job-id</I> is the number that was reported to you by +the <B>lp</B> or <B>lpstat</B> commands. <i>Destination</i> is the +name of a printer or class that you want to actually print the job. + +<BLOCKQUOTE><B>Note:</B> + +<P>The <B>lpmove</B> command is located in the system command +directory (typically <VAR>/usr/sbin</VAR> or <VAR>/usr/local/sbin</VAR>), +and so may not be in your command path. Specify the full path to the +command if you get a "command not found" error, for example: + +<PRE CLASS="command"> +/usr/sbin/lpmove foo-123 bar +</PRE> + +</BLOCKQUOTE> + + <H2 CLASS="title"><A NAME="OPTIONS">Standard Printing Options</A></H2> <P>The following options apply when printing all types of diff --git a/doc/help/ref-cupsd-conf.html b/doc/help/ref-cupsd-conf.html.in index 997b479a3..e15c6c1d4 100644 --- a/doc/help/ref-cupsd-conf.html +++ b/doc/help/ref-cupsd-conf.html.in @@ -67,7 +67,7 @@ server activity.</P> information to the system log instead of a plain file.</P> <P>The default access log file is -<VAR>/var/log/cups/access_log</VAR>.</P> +<VAR>@CUPS_LOGDIR@/access_log</VAR>.</P> <H2 CLASS="title"><A NAME="Allow">Allow</A></H2> @@ -521,8 +521,7 @@ BrowseLocalProtocols cups dns-sd <P>The <CODE>BrowseLocalProtocols</CODE> directive specifies the protocols to use when advertising local shared printers on the network. Multiple protocols can be specified by separating them -with spaces. The default is <CODE>cups</CODE>, which is a -broadcast-based protocol.</P> +with spaces. The default is <CODE>@CUPS_BROWSE_REMOTE_PROTOCOLS@</CODE>.</P> <H2 CLASS="title"><A NAME="BrowseOrder">BrowseOrder</A></H2> @@ -616,7 +615,10 @@ BrowseProtocols cups dns-sd protocols to use when showing and advertising shared printers on the local network. Multiple protocols can be specified by separating them with spaces. The default protocol is -<CODE>cups</CODE>, which is a broadcast-based protocol.</P> +<CODE>@CUPS_BROWSE_LOCAL_PROTOCOLS@</CODE> for +<A HREF="#BrowseLocalProtocols"><CODE>BrowseLocalProtocols</CODE></A> and +<CODE>@CUPS_BROWSE_REMOTE_PROTOCOLS@</CODE> for +<A HREF="#BrowseRemoteProtocols"><CODE>BrowseRemoteProtocols</CODE></A>.</P> <BLOCKQUOTE><B>Note:</B> @@ -698,8 +700,7 @@ BrowseRemoteProtocols cups dns-sd <P>The <CODE>BrowseRemoteProtocols</CODE> directive specifies the protocols to use when finding remote shared printers on the network. Multiple protocols can be specified by separating them -with spaces. The default is <CODE>cups</CODE>, which is a -broadcast-based protocol.</P> +with spaces. The default is <CODE>@CUPS_BROWSE_REMOTE_PROTOCOLS@</CODE>.</P> <H2 CLASS="title"><A NAME="BrowseShortNames">BrowseShortNames</A></H2> @@ -720,7 +721,7 @@ Short names are just the remote printer name, without the server same name, the printers will have long names ("printer@server1", "printer@server2".)</P> -<P>The default value for this option is <CODE>Yes</CODE>.</P> +<P>The default value for this option is <CODE>@CUPS_BROWSE_SHORT_NAMES@</CODE>.</P> <H2 CLASS="title"><A NAME="BrowseTimeout">BrowseTimeout</A></H2> @@ -759,7 +760,7 @@ Browsing Off <P>The <CODE>Browsing</CODE> directive controls whether or not network printer browsing is enabled. The default setting is -<CODE>On</CODE>.</P> +<CODE>@CUPS_BROWSING@</CODE>.</P> <P>This directive does not enable sharing of local printers by itself; you must also use the <A @@ -835,7 +836,7 @@ ConfigFilePerm 0640 <P>The <CODE>ConfigFilePerm</CODE> directive specifies the permissions to use when writing configuration files. The default -is 0640.</P> +is @CUPS_CONFIG_FILE_PERM@.</P> <H2 CLASS="title"><A NAME="DataDir">DataDir</A></H2> @@ -956,7 +957,7 @@ DefaultShared no <P>The <CODE>DefaultShared</CODE> directive specifies whether printers are shared (published) by default. The default is -<CODE>yes</CODE>.</P> +<CODE>@CUPS_DEFAULT_SHARED@</CODE>.</P> <H2 CLASS="title"><A NAME="Deny">Deny</A></H2> @@ -1020,13 +1021,13 @@ DocumentRoot /foo/bar/doc/cups 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 <A HREF="#ServerRoot"><CODE>ServerRoot</CODE></A> directory. The -default directory is <VAR>/usr/share/doc/cups</VAR>.</P> +default directory is <VAR>@CUPS_DOCROOT@</VAR>.</P> <P>Documents are first looked up in a sub-directory for the primary language requested by the client (e.g. -<VAR>/usr/share/doc/cups/fr/...</VAR>) and then directly under +<VAR>@CUPS_DOCROOT@/fr/...</VAR>) and then directly under the <CODE>DocumentRoot</CODE> directory (e.g. -<VAR>/usr/share/doc/cups/...</VAR>), so it is possible to +<VAR>@CUPS_DOCROOT@/...</VAR>), so it is possible to localize the web content by providing subdirectories for each language needed.</P> @@ -1069,7 +1070,7 @@ ErrorLog syslog log file. If the filename is not absolute then it is assumed to be relative to the <A HREF="#ServerRoot"><CODE>ServerRoot</CODE></A> directory. The -default error log file is <VAR>/var/log/cups/error_log</VAR>.</P> +default error log file is <VAR>@CUPS_LOGDIR@/error_log</VAR>.</P> <P>The server name can be included in the filename by using <CODE>%s</CODE> in the name.</P> @@ -1283,25 +1284,6 @@ performance problems with hostname lookups. Set this option to required.</P> -<H2 CLASS="title"><A NAME="ImplicitClasses">ImplicitClasses</A></H2> - -<H3>Examples</H3> - -<PRE CLASS="command"> -ImplicitClasses On -ImplicitClasses Off -</PRE> - -<H3>Description</H3> - -<P>The <CODE>ImplicitClasses</CODE> directive controls whether -implicit classes are created based upon the available network -printers and classes. The default setting is <CODE>On</CODE> but -is automatically turned <CODE>Off</CODE> if <A -HREF="#Browsing"><CODE>Browsing</CODE></A> is turned -<CODE>Off</CODE>.</P> - - <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.1.10</SPAN><A NAME="ImplicitAnyClasses">ImplicitAnyClasses</A></H2> <H3>Examples</H3> @@ -1322,6 +1304,25 @@ setting is <CODE>Off</CODE>.</P> must be enabled for this directive to have any effect.</P> +<H2 CLASS="title"><A NAME="ImplicitClasses">ImplicitClasses</A></H2> + +<H3>Examples</H3> + +<PRE CLASS="command"> +ImplicitClasses On +ImplicitClasses Off +</PRE> + +<H3>Description</H3> + +<P>The <CODE>ImplicitClasses</CODE> directive controls whether +implicit classes are created based upon the available network +printers and classes. The default setting is +<CODE>@CUPS_IMPLICIT_CLASSES@</CODE> but is automatically turned +<CODE>Off</CODE> if <A HREF="#Browsing"><CODE>Browsing</CODE></A> is turned +<CODE>Off</CODE>.</P> + + <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.1.9</SPAN><A NAME="Include">Include</A></H2> <H3>Examples</H3> @@ -1819,7 +1820,7 @@ LogFilePerm 0600 <P>The <CODE>LogFilePerm</CODE> directive specifies the permissions to use when writing configuration files. The default -is 0644.</P> +is @CUPS_LOG_FILE_PERM@.</P> <H2 CLASS="title"><A NAME="LogLevel">LogLevel</A></H2> @@ -1934,7 +1935,7 @@ MaxCopies 65535 <P>The <CODE>MaxCopies</CODE> directive controls the maximum number of copies that a user can print of a job. The default is -100 copies.</P> +@CUPS_MAX_COPIES@ copies.</P> <BLOCKQUOTE><B>Note:</B> @@ -2107,7 +2108,7 @@ PageLog syslog log file. If the filename is not absolute then it is assumed to be relative to the <A HREF="#ServerRoot"><CODE>ServerRoot</CODE></A> directory. The -default page log file is <VAR>/var/log/cups/page_log</VAR>.</P> +default page log file is <VAR>@CUPS_LOGDIR@/page_log</VAR>.</P> <P>The server name can be included in the filename by using <CODE>%s</CODE> in the name.</P> @@ -2349,7 +2350,7 @@ RequestRoot /foo/bar/spool/cups incoming IPP requests and HTML forms. If an absolute path is not provided then it is assumed to be relative to the <A HREF="#ServerRoot"><CODE>ServerRoot</CODE></A> directory. The -default request directory is <VAR>/var/spool/cups</VAR>.</P> +default request directory is <VAR>@CUPS_REQUESTS@</VAR>.</P> <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.1.7</SPAN><A NAME="Require">Require</A></H2> @@ -2700,10 +2701,7 @@ SystemGroup root lpadmin <P>The <CODE>SystemGroup</CODE> directive specifies the system administration group for <CODE>System</CODE> authentication. Multiple groups can be listed, separated with spaces. The default -is system-dependent and generally consists of all of the -following groups, if present: <CODE>lpadmin</CODE>, -<CODE>root</CODE>, <CODE>sys</CODE>, and/or -<CODE>system</CODE>.</P> +group list is <CODE>@CUPS_SYSTEM_GROUPS@</CODE>.</P> <H2 CLASS="title"><A NAME="TempDir">TempDir</A></H2> @@ -2719,7 +2717,7 @@ TempDir /foo/bar/tmp <P>The <CODE>TempDir</CODE> directive specifies an absolute path for the directory to use for temporary files. The default -directory is <VAR>/var/spool/cups/tmp</VAR>.</P> +directory is <VAR>@CUPS_REQUESTS@/tmp</VAR>.</P> <P>Temporary directories must be world-writable and should have the "sticky" permission bit enabled so that other users cannot @@ -2768,7 +2766,7 @@ advertising a default printer, the client's default printer is set to the first discovered printer, or to the implicit class for the same printer available from multiple servers.</P> -<P>The default is <CODE>yes</CODE>.</P> +<P>The default is <CODE>@CUPS_USE_NETWORK_DEFAULT@</CODE>.</P> <H2 CLASS="title"><A NAME="User">User</A></H2> @@ -2784,7 +2782,7 @@ User guest <P>The <CODE>User</CODE> directive specifies the UNIX user that filter and CGI programs run as. The default user is -<CODE>lp</CODE>.</P> +<CODE>@CUPS_USER@</CODE>.</P> <BLOCKQUOTE><B>Note:</B> diff --git a/doc/help/ref-snmp-conf.html b/doc/help/ref-snmp-conf.html index e3047f24b..71e18d6d6 100644 --- a/doc/help/ref-snmp-conf.html +++ b/doc/help/ref-snmp-conf.html @@ -80,6 +80,32 @@ messages. Level 3 adds a hex dump of the network data.</P> <P>The default setting is <VAR>0</VAR>.</P> +<H2 CLASS="title"><A NAME="DeviceURI">DeviceURI</A></H2> + +<H3>Examples</H3> + +<PRE CLASS="command"> +DeviceURI "HP.*JetDirect.*" socket://%s:9100 socket://%s:9101 socket://%s:9102 +DeviceURI "HP.*" socket://%s +DeviceURI "Acme.*Laser.*" lpd://%s/print +DeviceURI "Xerox.*" +</PRE> + +<H3>Description</H3> + +<P>The <CODE>DeviceURI</CODE> directive specifies a regular expression +(enclosed in double quotes) that is matched against the SNMP device +description OID returned by a printer. If the description matches the +regular expression, each device URI that follows the regular expression +is listed by the backend, with any occurrences of <CODE>%s</CODE> +replaced by the device's hostname or IP address. If no URIs are listed, +the device is ignored.</P> + +<P>The <CODE>DeviceURI</CODE> directives are processed serially in +the order specified in the <VAR>snmp.conf</VAR> file until a match +is found.</P> + + <H2 CLASS="title"><A NAME="HostNameLookups">HostNameLookups</A></H2> <H3>Examples</H3> diff --git a/doc/help/spec-ipp.html b/doc/help/spec-ipp.html index 9816e6743..be45bdd94 100644 --- a/doc/help/spec-ipp.html +++ b/doc/help/spec-ipp.html @@ -38,7 +38,7 @@ Output-bin Attribute Extension", and "IPP/1.1: finishings 'fold',' trim', and 'bale' attribute values extension" specifications.</p> -<p>CUPS also provides 13 new operations and many new attributes +<p>CUPS also provides 15 new operations and many new attributes to support multiple IPP printers and printer classes on a single host.</p> @@ -321,6 +321,12 @@ summary='Supported Operations'> <td>0x400E</td> <td>Authenticate a job for printing.</td> </tr> +<tr> + <td><a href='#CUPS_GET_PPD'>CUPS-Get-PPD</a></td> + <td>1.3</td> + <td>0x400F</td> + <td>Get a PPD file.</td> +</tr> </tbody> </table></div> @@ -1685,6 +1691,77 @@ CUPS-Authenticate-Job Response: </dl +<h3 class='title'><span class='info'>CUPS 1.3</span><a name='CUPS_GET_PPD'>CUPS-Get-PPD Operation</a></h3> + +<p>The CUPS-Get-PPD operation (0x400F) gets a PPD file from the +server. The PPD file can be specified using a <tt>ppd-name</tt> +returned by <a href='#CUPS_GET_PPDS'><tt>CUPS-Get-PPDs</tt></a> +or using the <tt>printer-uri</tt> for a queue.</p> + +<p>If the PPD file is found, <tt>successful-ok</tt> is returned with +the PPD file following the response data.</p> + +<p>If the PPD file cannot be served by the local server because +the <tt>printer-uri</tt> attribute points to an external printer, +a <tt>cups-see-other</tt> status is returned with the correct +URI to use.</p> + +<p>If the PPD file does not exist, <tt>client-error-not-found</tt> is +returned.</p> + +<h4>CUPS-Get-PPD Request</h4> + +<p>The following group of attributes is supplied as part of the +CUPS-Get-PPD request: + +<p>Group 1: Operation Attributes + +<dl> + + <dt>Natural Language and Character Set: + + <dd>The "attributes-charset" and "attributes-natural-language" + attributes as described in section 3.1.4.1 of the IPP Model and + Semantics document. + + <dt>"printer-uri" (uri) + <br><i>OR</i> + <br>"ppd-name" (name(255)): + + <dd>The client MUST supply a printer URI or PPD name. + +</dl> + +<h4>CUPS-Get-PPD Response</h4> + +<p>The following group of attributes is sent as part of the +CUPS-Get-PPD Response: + +<p>Group 1: Operation Attributes + +<dl> + + <dt>Status Message: + + <dd>The standard response status message. + + <dt>Natural Language and Character Set: + + <dd>The "attributes-charset" and "attributes-natural-language" + attributes as described in section 3.1.4.2 of the IPP Model and + Semantics document. + + <dt>"printer-uri" (uri): + + <dd>The printer that provides the actual PPD file when + the status code is cups-see-other (0x280) + +</dl> + +<p>If the status code is <tt>successful-ok</tt>, the PPD file follows +the end of the IPP response.</p> + + <h2 class='title'><a name='ATTRIBUTES'>Attributes</a></h2> <p>CUPS provides many extension attributes to support multiple @@ -1843,7 +1920,7 @@ for billing purposes. <p>The job-hold-until attribute specifies a hold time. In addition to the standard IPP/1.1 keyword names, CUPS supports name values of the form "HH:MM" and "HH:MM:SS" that specify a hold time. The hold time is in -Greenwich Mean Time (GMT) and <i>not</i> in the local time zone. If the +Universal Coordinated Time (UTC) and <i>not</i> in the local time zone. If the specified time is less than the current time, the job is held until the next day. @@ -2064,15 +2141,19 @@ ShortNickName attributes are used instead. relative to the model directory. The forward slash (/) is used to delineate directories. -<h4><a name="ppd-natural-language">ppd-natural-language (naturalLanguage)</a></h4> +<h4><a name="ppd-natural-language">ppd-natural-language (1setOf naturalLanguage)</a></h4> <p>The ppd-natural-language attribute specifies the language encoding of the PPD file (the LanguageVersion attribute in the PPD file). If the language is unknown or undefined then "en" (English) is assumed. -<h4><a name="ppd-product">ppd-product (text(127))</a></h4> +<h4><a name="ppd-product">ppd-product (1setOf text(127))</a></h4> + +<p>The ppd-product attribute specifies the Product attribute values in the PPD file. + +<h4><a name="ppd-psversion">ppd-psversion (1setOf text(127))</a><span class="info">CUPS 1.3</span></h4> -<p>The ppd-product attribute specifies the Product attribute value in the PPD file. +<p>The ppd-product attribute specifies the PSVersion attribute values in the PPD file. <h3 class='title'><a name='PRINTER_ATTRIBUTES'>Printer Attributes</a></h3> diff --git a/doc/help/spec-ppd.html b/doc/help/spec-ppd.html index 16c054544..cf02272bc 100644 --- a/doc/help/spec-ppd.html +++ b/doc/help/spec-ppd.html @@ -8,7 +8,7 @@ </head> <body> <!-- - "$Id: spec-ppd.html 6252 2007-02-10 15:34:18Z mike $" + "$Id: spec-ppd.html 6457 2007-04-17 18:40:55Z mike $" CUPS PPD extensions specification for the Common UNIX Printing System (CUPS). @@ -204,13 +204,13 @@ http://www.vendor.com/help" <p>This attribute describes which language localizations are included in the PPD. The "locale list" string is a space-delimited -list of locale names ("en", "en_US", "fr_FR", etc.)</p> +list of locale names ("en", "en_US", "fr_CA", etc.)</p> <p>Example:</p> <pre class='command'> <em>*% Specify Canadian, UK, and US English, and Candian and French French</em> -*cupsLanguages: "en_CA en_UK en_US fr_CA fr_FR" +*cupsLanguages: "en_CA en_UK en_US fr_CA fr_CA" </pre> <h3>cupsManualCopies</h3> @@ -575,7 +575,10 @@ languages by following the following additional rules:</p> <li>Localizations are specified using a locale prefix of the form "ll" or "ll_CC." where "ll" is the 2-letter ISO language code and "CC" is the 2-letter ISO country - code</li> + code<ul> + <li>A generic language translation ("ll") SHOULD be provided with country-specific differences ("ll_CC") provided only as needed</li> + <li>For historical reasons, the "zh" and "zh_CN" locales map to Simplified Chinese while the "zh_TW" locale maps to Traditional Chinese</li> + </ul></li> <li>Locale-specific translation strings MUST be encoded using UTF-8.</li> @@ -612,17 +615,17 @@ in the PPD file for a given locale.</blockquote> <pre class='command'> *LanguageVersion: English *LanguageEncoding: ISOLatin1 -*cupsLanguages: "de_DE fr_FR" +*cupsLanguages: "de fr_CA" *ModelName: "Foobar Laser 9999" <em>*% Localize ModelName for French and German</em> -*fr_FR.Translation ModelName/La Foobar Laser 9999: "" -*de_DE.Translation ModelName/Foobar LaserDrucken 9999: "" +*fr_CA.Translation ModelName/La Foobar Laser 9999: "" +*de.Translation ModelName/Foobar LaserDrucken 9999: "" *cupsIPPReason com.vendor-error/A serious error occurred: "/help/com.vendor/error.html" <em>*% Localize printer-state-reason for French and German</em> -*fr_FR.cupsIPPReason com.vendor-error/Une erreur sèrieuse s'est produite: "/help/com.vendor/error.html" -*de_DE.cupsIPPReason com.vendor-error/Eine ernste Störung trat: "/help/com.vendor/error.html" +*fr_CA.cupsIPPReason com.vendor-error/Une erreur sèrieuse s'est produite: "/help/com.vendor/error.html" +*de.cupsIPPReason com.vendor-error/Eine ernste Störung trat: "/help/com.vendor/error.html" ... @@ -630,16 +633,16 @@ in the PPD file for a given locale.</blockquote> *OrderDependency: 10 AnySetup *InputSlot *DefaultInputSlot: Auto <em>*% Localize InputSlot for French and German</em> -*fr_FR.Translation InputSlot/Papier source: "" -*de_DE.Translation InputSlot/Papiereinzug: "" +*fr_CA.Translation InputSlot/Papier source: "" +*de.Translation InputSlot/Papiereinzug: "" *InputSlot Auto/Default: "<</ManualFeed false>>setpagedevice" <em>*% Localize InputSlot=Auto for French and German</em> -*fr_FR.InputSlot Auto/Par Defaut: "" -*de_DE.InputSlot Auto/Standard: "" +*fr_CA.InputSlot Auto/Par Defaut: "" +*de.InputSlot Auto/Standard: "" *InputSlot Manual/Manual Feed: "<</ManualFeed true>>setpagedevice" <em>*% Localize InputSlot=Manual for French and German</em> -*fr_FR.InputSlot Manual/Manuel mecanisme de alimentation: "" -*de_DE.InputSlot Manual/Manueller Einzug: "" +*fr_CA.InputSlot Manual/Manuel mecanisme de alimentation: "" +*de.InputSlot Manual/Manueller Einzug: "" *CloseUI: *InputSlot </pre> |