From: msweet Date: Thu, 12 Jun 2014 19:36:12 +0000 (+0000) Subject: Save work on man pages. X-Git-Tag: v2.2b1~607 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=53480915ef75ffee31ab8fc195a46baceeea07a9;p=thirdparty%2Fcups.git Save work on man pages. git-svn-id: svn+ssh://src.apple.com/svn/cups/cups.org/trunk@11925 a1ca3aef-8c08-0410-bb20-df032aa958be --- diff --git a/doc/help/man-ppdc.html b/doc/help/man-ppdc.html index a47b0d3cb1..92b9bf3f8a 100644 --- a/doc/help/man-ppdc.html +++ b/doc/help/man-ppdc.html @@ -44,36 +44,48 @@ ppdc - cups ppd compiler

Description

ppdc compiles PPDC source files into one or more PPD files. This program is deprecated and will be removed in a future release of CUPS. -

The -D option sets the named variable for use in the source file. +

Options

+ppdc supports the following options: +
+
-D name[=value] +
Sets the named variable for use in the source file. It is equivalent to using the #define directive in the source file. -

The -I option specifies an alternate include directory; multiple -I options can be supplied to add additional directories. -

The -c option specifies a single message catalog file in GNU -gettext source format (filename.po) to be used for localization. -

The -d option specifies the output directory for PPD -files. The default output directory is "ppd". -

The -l option specifies one or more languages to use when -localizing the PPD file(s). The default language is "en" -(English). Separate multiple languages with commas, for example -"de_DE,en_UK,es_ES,es_MX,es_US,fr_CA,fr_FR,it_IT" will create PPD -files with German, UK English, Spanish (Spain, Mexico, and US), -French (France and Canada), and Italian languages in each file. -

The -m option specifies that the output filename should be -based on the ModelName value instead of FileName or PCFilenName. -

The -t option specifies that PPD files should be tested instead -of generated. -

The -v option provides more verbose output, basically a -running status of which files are being loaded or written. -

The -z option generates compressed PPD files (filename.ppd.gz). +

-I include-directory +
Specifies an alternate include directory. +Multiple -I options can be supplied to add additional directories. +
-c message-catalog +
Specifies a single message catalog file in GNU gettext (filename.po) or Apple strings (filename.strings) format to be used for localization. +
-d output-directory +
Specifies the output directory for PPD files. +The default output directory is "ppd". +
-l language(s) +
Specifies one or more languages to use when localizing the PPD file(s). +The default language is "en" (English). +Separate multiple languages with commas, for example "de_DE,en_UK,es_ES,es_MX,es_US,fr_CA,fr_FR,it_IT" will create PPD files with German, UK English, Spanish (Spain, Mexico, and US), French (France and Canada), and Italian languages in each file. +
-m +
Specifies that the output filename should be based on the ModelName value instead of FileName or PCFilenName. +
-t +
Specifies that PPD files should be tested instead of generated. +
-v +
Specifies verbose output, basically a running status of which files are being loaded or written. +-z +Generates compressed PPD files (filename.ppd.gz). The default is to generate uncompressed PPD files. -

The --cr, --crlf, and --lf options specify the -line ending to use - carriage return, carriage return and line feed, -or line feed. The default is to use the line feed character alone. +

--cr +
--crlf +
--lf +
Specifies the line ending to use - carriage return, carriage return and line feed, or line feed alone. +The default is to use the line feed character alone. +

See Also

-ppdhtml(1), ppdi(1), ppdmerge(1), ppdpo(1), ppdcfile(5) -
-http://localhost:631/help +ppdhtml(1), +ppdi(1), +ppdmerge(1), +ppdpo(1), +ppdcfile(5), +CUPS Online Help (http://localhost:631/help)

Copyright

-Copyright 2007-2013 by Apple Inc. +Copyright © 2007-2014 by Apple Inc. diff --git a/doc/help/man-ppdcfile.html b/doc/help/man-ppdcfile.html index 65e17cb3ea..01876d9649 100644 --- a/doc/help/man-ppdcfile.html +++ b/doc/help/man-ppdcfile.html @@ -10,91 +10,86 @@

Name

ppdcfile - cups ppd compiler source file format

Description

-The CUPS PPD compiler reads meta files that contain descriptions -of one or more PPD files to be generated by ppdc. This man -page provides a quick reference to the supported keywords and -should be used in conjunction with the online help for CUPS. -

The source file format is plain ASCII text that can be edited -using your favorite text editor. Comments are supported using -the C (/* ... */) and C++ (// ...) comment mechanisms. -

Printer driver information can be grouped and shared using -curly braces ({ ... }); PPD files are written when a close -brace or end-of-file is seen and a PCFileName directive has been -defined. -

Directives may be placed anywhere on a line and are followed by -one or more values. The following is a list of the available -directives and the values they accept: +The CUPS PPD compiler reads meta files that contain descriptions of one or more PPD files to be generated by +ppdc(1). +This man page provides a quick reference to the supported keywords and should be used in conjunction with the online help for CUPS. +

The source file format is plain ASCII text that can be edited using your favorite text editor. Comments are supported using the C (/* ... */) and C++ (// ...) comment mechanisms. +

Printer driver information can be grouped and shared using curly braces ({ ... }); PPD files are written when a close brace or end-of-file is seen and a PCFileName directive has been defined. +

Directives may be placed anywhere on a line and are followed by one or more values. The following is a list of the available directives and the values they accept:

-
#define name value -
#elif {name | value} +
#define name value +
#elif {name | value}
#else
#endif -
#font name encoding "version" charset status -
#if {name | value} -
#include <filename> -
#include "filename" -
#media name width length -
#media "name/text" width length -
#po locale "filename.po" -
Attribute name "" value -
Attribute name keyword value -
Attribute name "keyword/text" value -
Choice name "code" -
Choice "name/text" "code" -
ColorDevice boolean-value -
ColorModel name colorspace colororder compression -
ColorModel "name/text" colorspace colororder compression -
ColorProfile resolution/mediatype gamma density matrix -
Copyright "text" -
CustomMedia name width length left bottom right top "size-code" "region-code" -
CustomMedia "name/text" width length left bottom right top "size-code" "region-code" -
Cutter boolean-value -
Darkness temperature name -
Darkness temperature "name/text" -
DriverType type -
Duplex type -
Filter mime-type cost program -
Finishing name -
Finishing "name/text" -
Font * -
Font name encoding "version" charset status -
Group name -
Group "name/text" -
HWMargins left bottom right top -
InputSlot position name -
InputSlot position "name/text" -
Installable name -
Installable "name/text" -
LocAttribute name "keyword/text" value -
ManualCopies boolean-value -
Manufacturer "name" -
MaxSize width length -
MediaSize name -
MediaType type name -
MediaType type "name/text" -
MinSize width length -
ModelName "name" -
ModelNumber number -
Option name type section order -
Option "name/text" type section order -
PCFileName "filename.ppd" -
Resolution colorspace bits-per-color row-count row-feed row-step name -
Resolution colorspace bits-per-color row-count row-feed row-step "name/text" -
SimpleColorProfile resolution/mediatype density yellow-density red-density gamma red-adjust green-adjust blue-adjust -
Throughput pages-per-minute -
UIConstraints "*Option1 *Option2" -
UIConstraints "*Option1 Choice1 *Option2" -
UIConstraints "*Option1 *Option2 Choice2" -
UIConstraints "*Option1 Choice1 *Option2 Choice2" -
VariablePaperSize boolean-value -
Version number +
#font name encoding "version" charset status +
#if {name | value} +
#include <filename> +
#include "filename" +
#media name width length +
#media "name/text" width length +
#po locale "filename" +
Attribute name "" value +
Attribute name keyword value +
Attribute name "keyword/text" value +
Choice name "code" +
Choice "name/text" "code" +
ColorDevice boolean-value +
ColorModel name colorspace colororder compression +
ColorModel "name/text" colorspace colororder compression +
ColorProfile resolution/mediatype gamma density matrix +
Copyright "text" +
CustomMedia name width length left bottom right top "size-code" "region-code" +
CustomMedia "name/text" width length left bottom right top "size-code" "region-code" +
Cutter boolean-value +
Darkness temperature name +
Darkness temperature "name/text" +
DriverType type +
Duplex type +
Filter Imime-type cost program +
Finishing name +
Finishing "name/text" +
Font * +
Font name encoding "version" charset status +
Group name +
Group "name/text" +
HWMargins left bottom right top +
InputSlot position name +
InputSlot position "name/text" +
Installable name +
Installable "name/text" +
LocAttribute name "keyword/text" value +
ManualCopies boolean-value +
Manufacturer "name" +
MaxSize width length +
MediaSize name +
MediaType type name +
MediaType type "name/text" +
MinSize width length +
ModelName "name" +
ModelNumber number +
Option name type section order +
Option "name/text" type section order +
PCFileName "filename.ppd" +
Resolution colorspace bits-per-color row-count row-feed row-step name +
Resolution colorspace bits-per-color row-count row-feed row-step "name/text" +
SimpleColorProfile resolution/mediatype density yellow-density red-density gamma red-adjust green-adjust blue-adjust +
Throughput pages-per-minute +
UIConstraints "*Option1 *Option2" +
UIConstraints "*Option1 Choice1 *Option2" +
UIConstraints "*Option1 *Option2 Choice2" +
UIConstraints "*Option1 Choice1 *Option2 Choice2" +
VariablePaperSize boolean-value +
Version number

See Also

-ppdc(1), ppdhtml(1), ppdi(1), ppdmerge(1), ppdpo(1) -
-http://localhost:631/help +ppdc(1), +ppdhtml(1), +ppdi(1), +ppdmerge(1), +ppdpo(1), +CUPS Online Help (http://localhost:631/help)

Copyright

-Copyright 2007-2013 by Apple Inc. +Copyright © 2007-2014 by Apple Inc. diff --git a/man/ppdc.man b/man/ppdc.man index 1c94a727f3..a276bfc9c4 100644 --- a/man/ppdc.man +++ b/man/ppdc.man @@ -50,46 +50,57 @@ ppdc \- cups ppd compiler .SH DESCRIPTION \fBppdc\fR compiles PPDC source files into one or more PPD files. \fBThis program is deprecated and will be removed in a future release of CUPS.\fR -.PP -The \fI-D\fR option sets the named variable for use in the source file. +.SH OPTIONS +\fBppdc\fR supports the following options: +.TP 5 +\fB\-D \fIname\fR[\fB=\fIvalue\fR] +Sets the named variable for use in the source file. It is equivalent to using the \fI#define\fR directive in the source file. -.PP -The \fI-I\fR option specifies an alternate include directory; multiple \fI-I\fR options can be supplied to add additional directories. -.PP -The \fI-c\fR option specifies a single message catalog file in GNU -gettext source format (filename.po) to be used for localization. -.PP -The \fI-d\fR option specifies the output directory for PPD -files. The default output directory is "ppd". -.PP -The \fI-l\fR option specifies one or more languages to use when -localizing the PPD file(s). The default language is "en" -(English). Separate multiple languages with commas, for example -"de_DE,en_UK,es_ES,es_MX,es_US,fr_CA,fr_FR,it_IT" will create PPD -files with German, UK English, Spanish (Spain, Mexico, and US), -French (France and Canada), and Italian languages in each file. -.PP -The \fI-m\fR option specifies that the output filename should be -based on the ModelName value instead of FileName or PCFilenName. -.PP -The \fI-t\fR option specifies that PPD files should be tested instead -of generated. -.PP -The \fI-v\fR option provides more verbose output, basically a -running status of which files are being loaded or written. -.PP -The \fI-z\fR option generates compressed PPD files (filename.ppd.gz). +.TP 5 +\fB\-I \fIinclude-directory\fR +Specifies an alternate include directory. +Multiple \fI-I\fR options can be supplied to add additional directories. +.TP 5 +\fB\-c \fImessage-catalog\fR +Specifies a single message catalog file in GNU gettext (filename.po) or Apple strings (filename.strings) format to be used for localization. +.TP 5 +\fB\-d \fIoutput-directory\fR +Specifies the output directory for PPD files. +The default output directory is "ppd". +.TP 5 +\fB\-l \fIlanguage(s)\fR +Specifies one or more languages to use when localizing the PPD file(s). +The default language is "en" (English). +Separate multiple languages with commas, for example "de_DE,en_UK,es_ES,es_MX,es_US,fr_CA,fr_FR,it_IT" will create PPD files with German, UK English, Spanish (Spain, Mexico, and US), French (France and Canada), and Italian languages in each file. +.TP 5 +.B \-m +Specifies that the output filename should be based on the ModelName value instead of FileName or PCFilenName. +.TP 5 +.B \-t +Specifies that PPD files should be tested instead of generated. +.TP 5 +.B \-v +Specifies verbose output, basically a running status of which files are being loaded or written. +.B \-z +Generates compressed PPD files (filename.ppd.gz). The default is to generate uncompressed PPD files. -.PP -The \fI--cr\fR, \fI--crlf\fR, and \fI--lf\fR options specify the -line ending to use - carriage return, carriage return and line feed, -or line feed. The default is to use the line feed character alone. +.TP 5 +\fB\-\-cr\fR +.TP 5 +\fB\-\-crlf\fR +.TP 5 +\fB\-\-lf\fR +Specifies the line ending to use - carriage return, carriage return and line feed, or line feed alone. +The default is to use the line feed character alone. .SH SEE ALSO -ppdhtml(1), ppdi(1), ppdmerge(1), ppdpo(1), ppdcfile(5) -.br -http://localhost:631/help +.BR ppdhtml (1), +.BR ppdi (1), +.BR ppdmerge (1), +.BR ppdpo (1), +.BR ppdcfile (5), +CUPS Online Help (http://localhost:631/help) .SH COPYRIGHT -Copyright 2007-2013 by Apple Inc. +Copyright \[co] 2007-2014 by Apple Inc. .\" .\" End of "$Id$". .\" diff --git a/man/ppdcfile.man b/man/ppdcfile.man index d31db08869..176966e498 100644 --- a/man/ppdcfile.man +++ b/man/ppdcfile.man @@ -1,170 +1,165 @@ .\" .\" "$Id$" .\" -.\" ppdcfile man page for CUPS. +.\" ppdcfile man page for CUPS. .\" -.\" Copyright 2007-2013 by Apple Inc. -.\" Copyright 1997-2007 by Easy Software Products. +.\" Copyright 2007-2014 by Apple Inc. +.\" Copyright 1997-2007 by Easy Software Products. .\" -.\" These coded instructions, statements, and computer programs are the -.\" property of Apple Inc. and are protected by Federal copyright -.\" law. Distribution and use rights are outlined in the file "LICENSE.txt" -.\" 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/". +.\" These coded instructions, statements, and computer programs are the +.\" property of Apple Inc. and are protected by Federal copyright +.\" law. Distribution and use rights are outlined in the file "LICENSE.txt" +.\" 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 ppdcfile 5 "CUPS" "3 December 2012" "Apple Inc." +.TH ppdcfile 5 "CUPS" "12 June 2014" "Apple Inc." .SH NAME ppdcfile \- cups ppd compiler source file format .SH DESCRIPTION -The CUPS PPD compiler reads meta files that contain descriptions -of one or more PPD files to be generated by \fIppdc\fR. This man -page provides a quick reference to the supported keywords and -should be used in conjunction with the online help for CUPS. +The CUPS PPD compiler reads meta files that contain descriptions of one or more PPD files to be generated by +.BR ppdc (1). +This man page provides a quick reference to the supported keywords and should be used in conjunction with the online help for CUPS. .PP -The source file format is plain ASCII text that can be edited -using your favorite text editor. Comments are supported using -the C (/* ... */) and C++ (// ...) comment mechanisms. +The source file format is plain ASCII text that can be edited using your favorite text editor. Comments are supported using the C (/* ... */) and C++ (// ...) comment mechanisms. .PP -Printer driver information can be grouped and shared using -curly braces ({ ... }); PPD files are written when a close -brace or end-of-file is seen and a PCFileName directive has been -defined. +Printer driver information can be grouped and shared using curly braces ({ ... }); PPD files are written when a close brace or end-of-file is seen and a PCFileName directive has been defined. .PP -Directives may be placed anywhere on a line and are followed by -one or more values. The following is a list of the available -directives and the values they accept: +Directives may be placed anywhere on a line and are followed by one or more values. The following is a list of the available directives and the values they accept: .TP 5 -\fB#define\fR name value +\fB#define \fIname value\fR .TP 5 -\fB#elif\fR {name | value} +\fB#elif \fR{\fIname \fR| \fIvalue\fR} .TP 5 \fB#else\fR .TP 5 \fB#endif\fR .TP 5 -\fB#font\fR name encoding "version" charset status +\fB#font \fIname encoding "version" charset status\fR .TP 5 -\fB#if\fR {name | value} +\fB#if \fR{\fIname \fR| \fIvalue\fR} .TP 5 -\fB#include\fR +\fB#include <\fIfilename\fB>\fR .TP 5 -\fB#include\fR "filename" +\fB#include "\fIfilename\fB"\fR .TP 5 -\fB#media\fR name width length +\fB#media \fIname width length\fR .TP 5 -\fB#media\fR "name/text" width length +\fB#media "\fIname\fB/\fItext\fB" \fIwidth length\fR .TP 5 -\fB#po\fR locale "filename.po" +\fB#po \fIlocale \fB"\fIfilename\fB"\fR .TP 5 -\fBAttribute\fR name "" value +\fBAttribute \fIname \fB"" \fIvalue\fR .TP 5 -\fBAttribute\fR name keyword value +\fBAttribute \fIname keyword value\fR .TP 5 -\fBAttribute\fR name "keyword/text" value +\fBAttribute \fIname \fB"\fIkeyword\fB/\fItext\fB" \fIvalue\fR .TP 5 -\fBChoice\fR name "code" +\fBChoice \fIname \fB"\fIcode\fB"\fR .TP 5 -\fBChoice\fR "name/text" "code" +\fBChoice \fB"\fIname\fB/\fItext\fB" "\fIcode\fB"\fR .TP 5 -\fBColorDevice\fR boolean-value +\fBColorDevice \fIboolean-value\fR .TP 5 -\fBColorModel\fR name colorspace colororder compression +\fBColorModel \fIname colorspace colororder compression\fR .TP 5 -\fBColorModel\fR "name/text" colorspace colororder compression +\fBColorModel "\fIname\fB/\fItext\fB" \fIcolorspace colororder compression\fR .TP 5 -\fBColorProfile\fR resolution/mediatype gamma density matrix +\fBColorProfile \fIresolution\fB/\fImediatype gamma density matrix\fR .TP 5 -\fBCopyright\fR "text" +\fBCopyright "\fItext\fR" .TP 5 -\fBCustomMedia\fR name width length left bottom right top "size-code" "region-code" +\fBCustomMedia \fIname width length left bottom right top \fB"\fIsize-code\fB" "\fIregion-code\fB"\fR .TP 5 -\fBCustomMedia\fR "name/text" width length left bottom right top "size-code" "region-code" +\fBCustomMedia "\fIname\fB/\fItext\fB" \fIwidth length left bottom right top \fB"\fIsize-code\fB" "\fIregion-code\fB"\fR .TP 5 -\fBCutter\fR boolean-value +\fBCutter \fIboolean-value\fR .TP 5 -\fBDarkness\fR temperature name +\fBDarkness \fItemperature name\fR .TP 5 -\fBDarkness\fR temperature "name/text" +\fBDarkness \fItemperature \fB"\fIname\fB/\fItext\fB"\fR .TP 5 -\fBDriverType\fR type +\fBDriverType \fItype\fR .TP 5 -\fBDuplex\fR type +\fBDuplex \fItype\fR .TP 5 -\fBFilter\fR mime-type cost program +\fBFilter \Imime-type cost program\fR .TP 5 -\fBFinishing\fR name +\fBFinishing \fIname\fR .TP 5 -\fBFinishing\fR "name/text" +\fBFinishing "\fIname\fB/\fItext\fB"\fR .TP 5 -\fBFont\fR * +\fBFont *\fR .TP 5 -\fBFont\fR name encoding "version" charset status +\fBFont \fIname encoding \fB"\fIversion\fB" \fIcharset status\fR .TP 5 -\fBGroup\fR name +\fBGroup \fIname\fR .TP 5 -\fBGroup\fR "name/text" +\fBGroup "\fIname\fB/\fItext\fB"\fR .TP 5 -\fBHWMargins\fR left bottom right top +\fBHWMargins \fIleft bottom right top\fR .TP 5 -\fBInputSlot\fR position name +\fBInputSlot \fIposition name\fR .TP 5 -\fBInputSlot\fR position "name/text" +\fBInputSlot \fIposition \fB"\fIname\fB/\fItext\fB"\fR .TP 5 -\fBInstallable\fR name +\fBInstallable \fIname\fR .TP 5 -\fBInstallable\fR "name/text" +\fBInstallable "\fIname\fB/\fItext\fB"\fR .TP 5 -\fBLocAttribute\fR name "keyword/text" value +\fBLocAttribute \fIname \fB"\fIkeyword\fB/\fItext\fB" \fIvalue\fR .TP 5 -\fBManualCopies\fR boolean-value +\fBManualCopies \fIboolean-value\fR .TP 5 -\fBManufacturer\fR "name" +\fBManufacturer "\fIname\fB"\fR .TP 5 -\fBMaxSize\fR width length +\fBMaxSize \fIwidth length\fR .TP 5 -\fBMediaSize\fR name +\fBMediaSize \fIname\fR .TP 5 -\fBMediaType\fR type name +\fBMediaType \fItype name\fR .TP 5 -\fBMediaType\fR type "name/text" +\fBMediaType \fItype \fB"\fIname\fB/\fItext\fB"\fR .TP 5 -\fBMinSize\fR width length +\fBMinSize \fIwidth length\fR .TP 5 -\fBModelName\fR "name" +\fBModelName "\fIname\fB"\fR .TP 5 -\fBModelNumber\fR number +\fBModelNumber \fInumber\fR .TP 5 -\fBOption\fR name type section order +\fBOption \fIname type section order\fR .TP 5 -\fBOption\fR "name/text" type section order +\fBOption "\fIname\fB/\fItext\fB" \fItype section order\fR .TP 5 -\fBPCFileName\fR "filename.ppd" +\fBPCFileName "\fIfilename.ppd\fB"\fR .TP 5 -\fBResolution\fR colorspace bits-per-color row-count row-feed row-step name +\fBResolution \fIcolorspace bits-per-color row-count row-feed row-step name\fR .TP 5 -\fBResolution\fR colorspace bits-per-color row-count row-feed row-step "name/text" +\fBResolution \fIcolorspace bits-per-color row-count row-feed row-step \fB"\fIname\fB/\fItext\fB"\fR .TP 5 -\fBSimpleColorProfile\fR resolution/mediatype density yellow-density red-density gamma red-adjust green-adjust blue-adjust +\fBSimpleColorProfile \fIresolution\fB/\fImediatype density yellow-density red-density gamma red-adjust green-adjust blue-adjust\fR .TP 5 -\fBThroughput\fR pages-per-minute +\fBThroughput \fIpages-per-minute\fR .TP 5 -\fBUIConstraints\fR "*Option1 *Option2" +\fBUIConstraints "\fI*Option1 *Option2\fB"\fR .TP 5 -\fBUIConstraints\fR "*Option1 Choice1 *Option2" +\fBUIConstraints "\fI*Option1 Choice1 *Option2\fB"\fR .TP 5 -\fBUIConstraints\fR "*Option1 *Option2 Choice2" +\fBUIConstraints "\fI*Option1 *Option2 Choice2\fB"\fR .TP 5 -\fBUIConstraints\fR "*Option1 Choice1 *Option2 Choice2" +\fBUIConstraints "\fI*Option1 Choice1 *Option2 Choice2\fB"\fR .TP 5 -\fBVariablePaperSize\fR boolean-value +\fBVariablePaperSize \fIboolean-value\fR .TP 5 -\fBVersion\fR number +\fBVersion \fInumber\fR .SH SEE ALSO -ppdc(1), ppdhtml(1), ppdi(1), ppdmerge(1), ppdpo(1) -.br -http://localhost:631/help +.BR ppdc (1), +.BR ppdhtml (1), +.BR ppdi (1), +.BR ppdmerge (1), +.BR ppdpo (1), +CUPS Online Help (http://localhost:631/help) .SH COPYRIGHT -Copyright 2007-2013 by Apple Inc. +Copyright \[co] 2007-2014 by Apple Inc. .\" .\" End of "$Id$". .\"