From b4a8492a632e030877b0f39bffc2be6e89e88fc4 Mon Sep 17 00:00:00 2001 From: msweet Date: Fri, 13 Jun 2014 00:01:23 +0000 Subject: [PATCH] Final man page changes for STR #4372 and STR #4329. git-svn-id: svn+ssh://src.apple.com/svn/cups/cups.org/trunk@11927 a1ca3aef-8c08-0410-bb20-df032aa958be --- CHANGES.txt | 4 +- doc/help/man-cups-files.conf.html | 4 +- doc/help/man-ppdc.html | 2 +- doc/help/man-ppdhtml.html | 41 ++++++++++-------- doc/help/man-ppdi.html | 45 ++++++++++++------- doc/help/man-ppdmerge.html | 41 +++++++++++------- doc/help/man-ppdpo.html | 50 ++++++++++++--------- man/cups-files.conf.man.in | 2 +- man/ppdc.man | 2 +- man/ppdhtml.man | 61 ++++++++++++++------------ man/ppdi.man | 64 ++++++++++++++++----------- man/ppdmerge.man | 59 ++++++++++++++----------- man/ppdpo.man | 72 +++++++++++++++++-------------- 13 files changed, 258 insertions(+), 189 deletions(-) diff --git a/CHANGES.txt b/CHANGES.txt index 22a633007..024dddf8c 100644 --- a/CHANGES.txt +++ b/CHANGES.txt @@ -1,4 +1,4 @@ -CHANGES.txt - 2.0b1 - 2014-06-10 +CHANGES.txt - 2.0b1 - 2014-06-12 -------------------------------- CHANGES IN CUPS V2.0b1 @@ -20,7 +20,7 @@ CHANGES IN CUPS V2.0b1 - The sample drivers now include all of the installed localizations by default () - Adopted Linux man page conventions and updated all man pages - (STR #4372) + (STR #4372, STR #4329) - Changed the default AccessLogLevel and PageLogFormat to disable the access_log and page_log files by default () - Added a "--list-filters" option to the cupsfilter command (STR #4325) diff --git a/doc/help/man-cups-files.conf.html b/doc/help/man-cups-files.conf.html index 756d8adf5..2c3caa2c1 100644 --- a/doc/help/man-cups-files.conf.html +++ b/doc/help/man-cups-files.conf.html @@ -37,9 +37,11 @@ The default is "/var/log/cups/access_log".

ConfigFilePerm mode

Specifies the permissions for all configuration files that the scheduler writes. The default is "0644" on OS X and "0640" on all other operating systems. -Note: The permissions for the printers.conf file are currently masked to only allow access from the scheduler user (typically root). + +

Note: The permissions for the printers.conf file are currently 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 path

Specifies the directory where data files can be found. The default is usually "/usr/share/cups". diff --git a/doc/help/man-ppdc.html b/doc/help/man-ppdc.html index 92b9bf3f8..5982c2f9a 100644 --- a/doc/help/man-ppdc.html +++ b/doc/help/man-ppdc.html @@ -8,7 +8,7 @@

ppdc(1)

Name

-ppdc - cups ppd compiler +ppdc - cups ppd compiler (deprecated)

Synopsis

ppdc [ diff --git a/doc/help/man-ppdhtml.html b/doc/help/man-ppdhtml.html index b4cac311d..51cdcd227 100644 --- a/doc/help/man-ppdhtml.html +++ b/doc/help/man-ppdhtml.html @@ -8,31 +8,38 @@

ppdhtml(1)

Name

-ppdhtml - cups html summary generator +ppdhtml - cups html summary generator (deprecated)

Synopsis

ppdhtml -[ -D -name[=value] -] [ -I +[ +-D name[=value] +] [ +-I include-directory ] source-file

Description

-ppdhtml reads a driver information file and produces a -HTML summary page that lists all of the drivers in a file and -the supported options. -

The -D option 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. +ppdhtml reads a driver information file and produces a HTML summary page that lists all of the drivers in a file and the supported options. +This program is deprecated and will be removed in a future release of CUPS. +

Options

+ppdhtml 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. +
-I include-directory +: Specifies an alternate include directory. +Multiple -I options can be supplied to add additional directories. +

Copyright

-Copyright 2007-2013 by Apple Inc. +Copyright © 2007-2014 by Apple Inc. diff --git a/doc/help/man-ppdi.html b/doc/help/man-ppdi.html index a0b197bca..9fb849990 100644 --- a/doc/help/man-ppdi.html +++ b/doc/help/man-ppdi.html @@ -8,32 +8,45 @@

ppdi(1)

Name

-ppdi - import ppd files +ppdi - import ppd files (deprecated)

Synopsis

ppdi -[ -I +[ +-I include-directory -] [ -o +] [ +-o source-file ] ppd-file -[ -ppd-file2...ppd-fileN +[ ... +ppd-file ]

Description

-ppdi imports one or more PPD files into a PPD compiler source file. -Multiple languages of the same PPD file are merged into a single printer -definition to facilitate accurate changes for all localizations. -

The -o option specifies the PPD source file to update. If the source -file does not exist, a new source file is created. Otherwise the existing -file is merged with the new PPD file(s) on the command-line. If no source -file is specified, the filename "ppdi.drv" is used. +ppdi imports one or more PPD files into a PPD compiler source file. +Multiple languages of the same PPD file are merged into a single printer definition to facilitate accurate changes for all localizations. +This program is deprecated and will be removed in a future release of CUPS. +

Options

+ppdi supports the following options: +

-I include-directory +: Specifies an alternate include directory. +Multiple -I options can be supplied to add additional directories. +
-o source-file +: Specifies the PPD source file to update. +If the source file does not exist, a new source file is created. +Otherwise the existing file is merged with the new PPD file(s) on the command-line. +If no source file is specified, the filename ppdi.drv is used. +

Copyright

-Copyright 2007-2013 by Apple Inc. +Copyright © 2007-2014 by Apple Inc. diff --git a/doc/help/man-ppdmerge.html b/doc/help/man-ppdmerge.html index d9d4184f2..1a9d05ae2 100644 --- a/doc/help/man-ppdmerge.html +++ b/doc/help/man-ppdmerge.html @@ -8,33 +8,42 @@

ppdmerge(1)

Name

-ppdmerge - merge ppd files +ppdmerge - merge ppd files (deprecated)

Synopsis

ppdmerge -[ -o +[ +-o output-ppd-file ] ppd-file -ppd-file2 -[ -...ppd-fileN +ppd-file +[ ... +ppd-file ]

Description

-ppdmerge merges two or more PPD files into a single, multi-language +ppdmerge merges two or more PPD files into a single, multi-language PPD file. -

The -o option specifies the PPD file to create. If not specified, -the merged PPD file is written to the standard output. If the output file -already exists, the new +This program is deprecated and will be removed in a future release of CUPS. +

Options

+ppdmerge supports the following options: +

-o output-ppd-file +: Specifies the PPD file to create. +If not specified, the merged PPD file is written to the standard output. +If the output file already exists, it is silently overwritten. +

Notes

-ppdmerge does not check whether the merged PPD files are for the -same device. Merging of different device PPDs will yield unpredictable -results. +ppdmerge does not check whether the merged PPD files are for the same device. +Merging of different device PPDs will yield unpredictable results.

Copyright

-Copyright 2007-2013 by Apple Inc. +Copyright © 2007-2014 by Apple Inc. diff --git a/doc/help/man-ppdpo.html b/doc/help/man-ppdpo.html index 5ed091f17..dfbf27840 100644 --- a/doc/help/man-ppdpo.html +++ b/doc/help/man-ppdpo.html @@ -8,36 +8,44 @@

ppdpo(1)

Name

-ppdpo - ppd message catalog generator +ppdpo - ppd message catalog generator (deprecated)

Synopsis

ppdpo -[ -D -name[=value] -] [ -I +[ +-D name[=value] +] [ +-I include-directory -] [ -o +] [ +-o output-file ] source-file

Description

-ppdpo extracts UI strings from PPDC source files and updates either -a GNU gettext or OS X strings format message catalog source file for -translation. -

The -D option 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 -o option specifies the output file. The supported extensions are -".po" or ".po.gz" for GNU gettext format message catalogs and ".strings" for -OS X strings files. +ppdpo extracts UI strings from PPDC source files and updates either a GNU gettext or OS X strings format message catalog source file for translation. +This program is deprecated and will be removed in a future release of CUPS. +

Options

+ppdpo 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. +
-I include-directory +: Specifies an alternate include directory. +Multiple -I options can be supplied to add additional directories. +
-o output-file +: Specifies the output file. +The supported extensions are .po or .po.gz for GNU gettext format message catalogs and .strings for OS X strings files. +

Copyright

-Copyright 2007-2013 by Apple Inc. +Copyright © 2007-2014 by Apple Inc. diff --git a/man/cups-files.conf.man.in b/man/cups-files.conf.man.in index 49fadd4fe..2e09befaf 100644 --- a/man/cups-files.conf.man.in +++ b/man/cups-files.conf.man.in @@ -47,7 +47,7 @@ The default is "/var/log/cups/access_log". \fBConfigFilePerm \fImode\fR Specifies the permissions for all configuration files that the scheduler writes. The default is "0644" on OS X and "0640" on all other operating systems. -.IP +.LP \fBNote:\fR The permissions for the \fIprinters.conf\fR file are currently 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. diff --git a/man/ppdc.man b/man/ppdc.man index a276bfc9c..3c843282c 100644 --- a/man/ppdc.man +++ b/man/ppdc.man @@ -14,7 +14,7 @@ .\" .TH ppdc 1 "CUPS" "12 June 2014" "Apple Inc." .SH NAME -ppdc \- cups ppd compiler +ppdc \- cups ppd compiler (deprecated) .SH SYNOPSIS .B ppdc [ diff --git a/man/ppdhtml.man b/man/ppdhtml.man index d0e0d98ba..d1e160011 100644 --- a/man/ppdhtml.man +++ b/man/ppdhtml.man @@ -1,46 +1,51 @@ .\" .\" "$Id$" .\" -.\" ppdhtml man page for CUPS. +.\" ppdhtml 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 ppdhtml 1 "CUPS" "10 October 2008" "Apple Inc." +.TH ppdhtml 1 "CUPS" "12 June 2014" "Apple Inc." .SH NAME -ppdhtml \- cups html summary generator +ppdhtml \- cups html summary generator (deprecated) .SH SYNOPSIS .B ppdhtml -[ -D -.I name[=value] -] [ -I +[ +\fB\-D \fIname\fR[\fB=\fIvalue\fR] +] [ +.B \-I .I include-directory ] .I source-file .SH DESCRIPTION -\fIppdhtml\fR reads a driver information file and produces a -HTML summary page that lists all of the drivers in a file and -the supported options. -.PP -The \fI-D\fR option sets the named variable for use in the -source file. It is equivalent to using the #define 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. +\fBppdhtml\fR reads a driver information file and produces a HTML summary page that lists all of the drivers in a file and the supported options. +\fBThis program is deprecated and will be removed in a future release of CUPS.\fR +.SH OPTIONS +\fBppdhtml\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. +.TP 5 +\fB\-I \fIinclude-directory\fR +Specifies an alternate include directory. +Multiple \fI-I\fR options can be supplied to add additional directories. .SH SEE ALSO -ppdc(1), ppdcfile(5), ppdi(1), ppdmerge(1), ppdpo(1) -.br -http://localhost:631/help +.BR ppdc (1), +.BR ppdcfile (5), +.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$". .\" diff --git a/man/ppdi.man b/man/ppdi.man index 124185770..74613e053 100644 --- a/man/ppdi.man +++ b/man/ppdi.man @@ -1,46 +1,58 @@ .\" .\" "$Id$" .\" -.\" ppdi man page for CUPS. +.\" ppdi 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 ppdi 1 "CUPS" "20 May 2008" "Apple Inc." +.TH ppdi 1 "CUPS" "12 June 2014" "Apple Inc." .SH NAME -ppdi \- import ppd files +ppdi \- import ppd files (deprecated) .SH SYNOPSIS .B ppdi -[ \-I +[ +.B \-I .I include-directory -] [ \-o +] [ +.B \-o .I source-file ] .I ppd-file -[ -.I ppd-file2 ... ppd-fileN +[ ... +.I ppd-file ] .SH DESCRIPTION -\fIppdi\fR imports one or more PPD files into a PPD compiler source file. -Multiple languages of the same PPD file are merged into a single printer -definition to facilitate accurate changes for all localizations. -.PP -The \fI-o\fR option specifies the PPD source file to update. If the source -file does not exist, a new source file is created. Otherwise the existing -file is merged with the new PPD file(s) on the command-line. If no source -file is specified, the filename "ppdi.drv" is used. +\fBppdi\fR imports one or more PPD files into a PPD compiler source file. +Multiple languages of the same PPD file are merged into a single printer definition to facilitate accurate changes for all localizations. +\fBThis program is deprecated and will be removed in a future release of CUPS.\fR +.SH OPTIONS +\fBppdi\fR supports the following options: +.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\-o \fIsource-file\fR +Specifies the PPD source file to update. +If the source file does not exist, a new source file is created. +Otherwise the existing file is merged with the new PPD file(s) on the command-line. +If no source file is specified, the filename \fIppdi.drv\fR is used. .SH SEE ALSO -ppdc(1), ppdhtml(1), ppdmerge(1), ppdpo(1), ppdcfile(5) -.br -http://localhost:631/help +.BR ppdc (1), +.BR ppdhtml (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/ppdmerge.man b/man/ppdmerge.man index 95142e8ce..475b29af9 100644 --- a/man/ppdmerge.man +++ b/man/ppdmerge.man @@ -1,47 +1,54 @@ .\" .\" "$Id$" .\" -.\" ppdmerge man page for CUPS. +.\" ppdmerge 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 ppdmerge 1 "CUPS" "20 May 2008" "Apple Inc." +.TH ppdmerge 1 "CUPS" "12 June 2014" "Apple Inc." .SH NAME -ppdmerge \- merge ppd files +ppdmerge \- merge ppd files (deprecated) .SH SYNOPSIS .B ppdmerge -[ \-o +[ +.B \-o .I output-ppd-file ] .I ppd-file -.I ppd-file2 -[ -.I ... ppd-fileN +.I ppd-file +[ ... +.I ppd-file ] .SH DESCRIPTION -\fIppdmerge\fR merges two or more PPD files into a single, multi-language +\fBppdmerge\fR merges two or more PPD files into a single, multi-language PPD file. -.PP -The \fI-o\fR option specifies the PPD file to create. If not specified, -the merged PPD file is written to the standard output. If the output file -already exists, the new +\fBThis program is deprecated and will be removed in a future release of CUPS.\fR +.SH OPTIONS +\fBppdmerge\fR supports the following options: +.TP +\fB\-o \fIoutput-ppd-file\fR +Specifies the PPD file to create. +If not specified, the merged PPD file is written to the standard output. +If the output file already exists, it is silently overwritten. .SH NOTES -\fIppdmerge\fR does not check whether the merged PPD files are for the -same device. Merging of different device PPDs will yield unpredictable -results. +\fBppdmerge\fR does not check whether the merged PPD files are for the same device. +Merging of different device PPDs will yield unpredictable results. .SH SEE ALSO -cupsprofile(1), ppdc(1), ppdhtml(1), ppdi(1), ppdpo(1), ppdcfile(5) -.br -http://localhost:631/help +.BR ppdc (1), +.BR ppdhtml (1), +.BR ppdi (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/ppdpo.man b/man/ppdpo.man index 8226e6419..4b9011bd8 100644 --- a/man/ppdpo.man +++ b/man/ppdpo.man @@ -1,52 +1,58 @@ .\" .\" "$Id$" .\" -.\" ppdpo man page for CUPS. +.\" ppdpo 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 ppdpo 1 "CUPS" "23 April 2012" "Apple Inc." +.TH ppdpo 1 "CUPS" "12 June 2014" "Apple Inc." .SH NAME -ppdpo \- ppd message catalog generator +ppdpo \- ppd message catalog generator (deprecated) .SH SYNOPSIS .B ppdpo -[ -D -.I name[=value] -] [ -I +[ +\fB\-D \fIname\fR[\fB=\fIvalue\fR] +] [ +.B \-I .I include-directory -] [ -o +] [ +.B \-o .I output-file ] .I source-file .SH DESCRIPTION -\fIppdpo\fR extracts UI strings from PPDC source files and updates either -a GNU gettext or OS X strings format message catalog source file for -translation. -.PP -The \fI-D\fR option sets the named variable for use in the -source file. It is equivalent to using the #define 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-o\fR option specifies the output file. The supported extensions are -".po" or ".po.gz" for GNU gettext format message catalogs and ".strings" for -OS X strings files. +\fBppdpo\fR extracts UI strings from PPDC source files and updates either a GNU gettext or OS X strings format message catalog source file for translation. +\fBThis program is deprecated and will be removed in a future release of CUPS.\fR +.SH OPTIONS +\fBppdpo\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. +.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\-o \fIoutput-file\fR +Specifies the output file. +The supported extensions are \fI.po\fR or \fI.po.gz\fR for GNU gettext format message catalogs and \fI.strings\fR for OS X strings files. .SH SEE ALSO -ppdc(1), ppdhtml(1), ppdi(1), ppdmerge(1), ppdcfile(5) -.br -http://localhost:631/help +.BR ppdc (1), +.BR ppdhtml (1), +.BR ppdi (1), +.BR ppdmerge (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$". .\" -- 2.39.2

ppdc(1)

Name

Synopsis

ppdhtml(1)

Name

Synopsis

Description

Options

See Also

Copyright

ppdi(1)

Name

Synopsis

Description

Options

See Also

Copyright

ppdmerge(1)

Name

Synopsis

Description

Options

Notes

See Also

Copyright

ppdpo(1)

Name

Synopsis

Description

Options

See Also

Copyright