[pkgsrc/trunk]: pkgsrc/pkgtools/cdpack/files Use more and more proper markup.

[wiz <wiz%pkgsrc.org@localhost>]

details:   https://anonhg.NetBSD.org/pkgsrc/rev/2903201d4bc4
branches:  trunk
changeset: 554771:2903201d4bc4
user:      wiz <wiz%pkgsrc.org@localhost>
date:      Fri Feb 20 07:41:15 2009 +0000

description:
Use more and more proper markup.
New sentence, new line.
Add EXIT STATUS section.
Sort options and their descriptions.
Bump date for previous.

diffstat:

 pkgtools/cdpack/files/cdpack.1 |  165 ++++++++++++++++++++++++----------------
 1 files changed, 100 insertions(+), 65 deletions(-)

diffs (280 lines):

diff -r d7d726aa7d96 -r 2903201d4bc4 pkgtools/cdpack/files/cdpack.1
--- a/pkgtools/cdpack/files/cdpack.1    Fri Feb 20 06:02:28 2009 +0000
+++ b/pkgtools/cdpack/files/cdpack.1    Fri Feb 20 07:41:15 2009 +0000
@@ -1,4 +1,4 @@
-.\" $NetBSD: cdpack.1,v 1.14 2009/02/20 05:16:51 dmcmahill Exp $
+.\" $NetBSD: cdpack.1,v 1.15 2009/02/20 07:41:15 wiz Exp $
 .\"
 .\" Copyright (c) 2001, 2002, 2003, 2005 Dan McMahill, All rights reserved.
 .\"
@@ -29,14 +29,15 @@
 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 .\" POSSIBILITY OF SUCH DAMAGE.
 .\"
-.Dd April 25, 2001
+.Dd February 20, 2009
 .Dt CDPACK 1
 .Os
 .Sh NAME
 .Nm cdpack
 .Nd produce multi-CD/DVD binary package images
 .Sh SYNOPSIS
-.Nm ""
+.Nm
+.Op -dnRVv
 .Op -ac | -ec
 .Op -af | -ef
 .Op -dvd
@@ -45,9 +46,8 @@
 .Op -m machine_architecture
 .Op -o operating_system
 .Op -r os_version
-.Op -dnRvV
+.Op -X extras_directory
 .Op -x common_directory
-.Op -X extras_directory
 .Ar packages_directory
 .Ar cd_image_directory
 .Sh DESCRIPTION
@@ -61,101 +61,125 @@
 utility extracts the dependency information from the binary
 packages in the directory
 .Ar packages_directory
-specified on the command line.  The dependency information is
-used to determine which packages are placed on which CD/DVD.  The
-directory
+specified on the command line.
+The dependency information is
+used to determine which packages are placed on which CD/DVD.
+The directory
 .Ar cd_image_directory
 is used as a staging area and the final ISO 9660 images are left in
-that directory.  A file,
-.Ar .index ,
+that directory.
+A file,
+.Pa .index ,
 which lists the contents of each CD/DVD will be left in the root
 directory of each CD/DVD image.
 .Nm
-will look for files ending both in .tgz as well as .tbz when
-scanning the directory
+will look for files ending both in
+.Pa .tgz
+as well as
+.Pa .tbz
+when scanning the directory
 .Ar packages_directory
 for binary packages.
 .Bl -tag -width "-x directory "
 .It Fl ac
-Include binary packages marked as NO_BIN_ON_CDROM on the CD/DVD set.
-The default is to omit any
-packages which were marked as NO_BIN_ON_CDROM.  This option should
+Include binary packages marked as
+.Dv NO_BIN_ON_CDROM
+on the CD/DVD set.
+The default is to omit any packages which were marked as
+.Dv NO_BIN_ON_CDROM .
+This option should
 only be used when making a CD/DVD set for personal use and not for
 distribution unless you are sure you have not violated any licenses.
 .It Fl af
-Include binary packages marked as NO_BIN_ON_FTP on the CD/DVD set.
+Include binary packages marked as
+.Dv NO_BIN_ON_FTP
+on the CD/DVD set.
 This option is enabled by default.
 .It Fl d
 Enable debugging by not deleting temporary files at the end of the
-run.  These files are left in TMPDIR.
-.It Fl ec
-Exclude packages marked as NO_BIN_ON_CDROM from the CD/DVD set.  This is
-the default.
-.It Fl ef
-Exclude packages marked as NO_BIN_ON_FTP from the CD/DVD set.  The default
-is to allow packages which are NO_BIN_ON_FTP.
+run.
+These files are left in
+.Ev TMPDIR .
 .It Fl dvd
 Create DVD sized images rather than the default CD-ROM sized images.
+.It Fl ec
+Exclude packages marked as
+.Dv NO_BIN_ON_CDROM
+from the CD/DVD set.
+This is the default.
+.It Fl ef
+Exclude packages marked as
+.Dv NO_BIN_ON_FTP
+from the CD/DVD set.
+The default is to allow packages which are
+.Dv NO_BIN_ON_FTP .
 .It Fl h
-.It Fl -help
+.It Fl Fl help
 Displays a short usage message.
 .It Fl l Ar logfile
-Log the output of mkisofs -v -v to the file
+Log the output of
+.Ic mkisofs Fl v Fl v
+to the file
 .Ar logfile .
 .It Fl m Ar machine_architecture
 Specifies
 .Ar machine_architecture
-as the target architecture for the binary packages in the generated README file.
+as the target architecture for the binary packages in the generated
+README file.
 .It Fl n
 Do not duplicate packages in order to prevent inter-CD/DVD dependencies.
 The default without the
 .Fl n
 option will place a package and all of its dependencies on the same
-CD/DVD.  If a particular package is also required by pacakges on other
+CD/DVD.
+If a particular package is also required by pacakges on other
 CD/DVD's, it will be placed there as well.
 When the
 .Fl n
-option is used packages are not duplicated.  This results in slightly
-smaller ISO 9660 images.
+option is used packages are not duplicated.
+This results in slightly smaller ISO 9660 images.
 .Nm
 places packages which are lower in the dependency tree on lower
 numbered CD/DVD's and packages which are higher on the higher numbered
-CD/DVD's.  In this fashion, a package on CD/DVD number n
+CD/DVD's.
+In this fashion, a package on CD/DVD number n
 will have all of its dependencies on CD/DVD numbers 1 through n
 .It Fl o Ar operating_system
 Specifies
 .Ar operating_system
-as the target operating system for the binary packages in the generated README file.
+as the target operating system for the binary packages in the
+generated README file.
+.It Fl R
+Generate a file,
+.Pa README.txt ,
+which will be placed in the root directory of each CD/DVD image.
+This README file contains a small amount of information about the contents
+of the CD/DVD set.
 .It Fl r Ar os_version
 Specifies
 .Ar os_version
-as the target operating system version for the binary packages in the generated README file.
-.It Fl R
-Generate a file,
-.Ar README.txt ,
-which will be placed in the root directory of each CD/DVD image.  This
-README file contains a small amount of information about the contents
-of the CD/DVD set.
-.It Fl v
-Be verbose.  Currently does not change things much.
+as the target operating system version for the binary packages in
+the generated README file.
 .It Fl V
 Print the program version number and exit.
+.It Fl v
+Be verbose.
+Currently does not change things much.
+.It Fl X Ar directory
+Includes the contents of
+.Ar directory
+on the last CD/DVD in the set.
+This is useful for adding
+a pkgsrc.tar.gz tarball, i.e. a file which does not
+need to be on each CD/DVD.
 .It Fl x Ar directory
 Includes the contents of
 .Ar directory
-on each CD/DVD.  This is useful for README files, etc., which you want
+on each CD/DVD.
+This is useful for README files, etc., which you want
 to be present on each CD/DVD in the set.
-.It Fl X Ar directory
-Includes the contents of
-.Ar directory
-on the last CD/DVD in the set.  This is useful for adding
-a pkgsrc.tar.gz tarball, i.e. a file which does not
-need to be on each CD/DVD.
-.El
-.Pp
-The
-.Nm
-utility exits 0 on success, and >0 if an error occurs.
+.Sh EXIT STATUS
+.Ex -std cdpack
 .Sh ENVIRONMENT
 .Nm
 uses the fillowing environment variables if set.
@@ -163,35 +187,40 @@
 .It Ev AWK
 awk implementation to use.
 Defaults to
-.Dq Li @AWK@ .
+.Dq Pa @AWK@ .
 .It Ev BZCAT
-bzcat2 implementation to use.
+bzcat implementation to use.
 Defaults to
-.Dq Li @BZCAT@ .
+.Dq Pa @BZCAT@ .
 .It Ev GZCAT
-bzcat2 implementation to use.
+gzcat implementation to use.
 Defaults to
-.Dq Li @GZCAT@ .
+.Dq Pa @GZCAT@ .
 .It Ev TMPDIR
 Directory for holding temporary files during the image creation.
 Defaults to
-.Dq Li /tmp .
+.Dq Pa /tmp .
 .El
 .Sh EXAMPLES
 This example takes all of the binary packages found in
-/usr/pkgsrc/packages/All and creates cd images in
-/u2/cdimages/cd{1,2,...}.iso.  The directories
-/u2/cdimages/cd{1,2,...} are used to create the ISO 9660 layouts.
+.Pa /usr/pkgsrc/packages/All
+and creates cd images in
+.Pa /u2/cdimages/cd{1,2,...}.iso .
+The directories
+.Pa /u2/cdimages/cd{1,2,...}
+are used to create the ISO 9660 layouts.
 .D1 cdpack /usr/pkgsrc/packages/All /u2/cdimages
 .Pp
 To include a common set of files on all CD/DVD's, place them in a
-directory, /tmp/foo, in this example, and pass in the directory name
+directory,
+.Pa /tmp/foo
+in this example, and pass in the directory name
 with the
 .Fl x
 option.
 .Dl cdpack -x /tmp/foo /usr/pkgsrc/packages/All /u2/cdimages
 .Sh SEE ALSO
-.Xr cddist 1
+.Xr cddist 1 ,
 .Xr mkisofs 1
 .Sh HISTORY
 The
@@ -200,8 +229,14 @@
 .Nx
 packages collection in April, 2001.
 .Sh AUTHORS
+.An -nosplit
 The
 .Nm
-utility was written by Dan McMahill (dmcmahill%NetBSD.org@localhost).  The
+utility was written by
+.An Dan McMahill
+.Aq dmcmahill%NetBSD.org@localhost .
+The
 idea of duplicating packages to eliminate inter-CD/DVD dependencies
-came from Todd Vierling (tv%NetBSD.org@localhost).
+came from
+.An Todd Vierling
+.Aq tv%NetBSD.org@localhost .