Cleaning and format unification of manual pages.

debian/changelog

@@ -41,6 +41,7 @@ dpkg (1.14.0) UNRELEASED; urgency=low
     the .deb control file unprocessed. Thanks to Colin Watson.
   * Add support for '--admindir' in dpkg-buildpackage, dpkg-checkbuilddeps
     and dpkg-shlibdeps. Closes: #162348
+  * Cleaning and format unification of manual pages.
 
   [ Updated dpkg translations ]
   * Romanian (Eddy Petrișor).

man/ChangeLog

@@ -1,3 +1,41 @@
+2007-03-06  Guillem Jover  <guillem@debian.org>
+
+	* cleanup-info.8: Unify the summary.
+	Unify '--help' and '--version' descriptions.
+	Remove unneeded quotes in section names.
+	* update-alternatives.8: Likewise.
+	* start-stop-daemon.8: Likewise.
+	* dpkg-deb.1: Likewise.
+	* dpkg-divert.8: Likewise.
+	* dpkg-query.1: Likewise.
+	* dpkg-name.1: Likewise.
+	* dpkg-checkbuilddeps.1: Likewise.
+	* dpkg-architecture.1: Likewise.
+	* dpkg-split.1: Likewise.
+	* dpkg-statoverride.8: Likewise.
+	* dpkg-scanpackages.1: Likewise.
+	* dpkg-scansources.1: Likewise.
+
+	* dpkg-deb.1: Separate option aliased names with ',' instead of '|'.
+	* dpkg-name.1: Likewise.
+	* dpkg-split.1: Likewise.
+	* dpkg-query.1: Likewise.
+	* start-stop-daemon.8: Likewise.
+
+	* dpkg-divert.8: List each options in the OPTIONS section.
+	* dpkg-scanpackages.1: Likewise.
+	* start-stop-daemon.8: Likewise.
+
+	* dpkg-divert.8: Remove redundant '<>' characters to delimit a
+	replacable argument.
+	* dpkg-statoverride.8: Likewise.
+
+	* update-alternatives.8: Mark commands in examples as bold.
+	* dpkg-architecture.1: Reorder sections. Indent examples.
+	* dpkg-name.1: Do not specify in which programming language the
+	program is written in.
+	* dpkg-deb.1: Split '--extract' and '--vextract' options.
+
 2007-02-28  Guillem Jover  <guillem@debian.org>
 
 	* dpkg-source.1: Document new option '--admindir'.

man/cleanup-info.8

@@ -1,11 +1,12 @@
-.TH cleanup\-info 8 "2006-02-28" "Debian Project" "dpkg utilities"
+.TH cleanup\-info 8 "2007-03-06" "Debian Project" "dpkg utilities"
 .SH NAME
 cleanup\-info \- clean up the mess that bogus install\-info may have done
 .
 .SH SYNOPSIS
 .B cleanup\-info
-[\fB\-\-help\fP] [\fB\-\-unsafe\fP] [\fB\-\-version\fP] [\fB\-\-\fP]
-[\fI<dirname>\fP]
+.RI [ options ]
+.RB [ \-\- ]
+.RI [ dirname ]
 .
 .SH DESCRIPTION
 .B cleanup\-info
@@ -28,16 +29,16 @@ to using this script.
 .
 .SH OPTIONS
 .TP
-.B \-\-help
-Output the help screen and exit successfully.
-.TP
 .B \-\-unsafe
 Set some additional possibly useful options.
 .br
 .B "Warning: the `\-\-unsafe' option may garble an otherwise correct file!"
 .TP
+.B \-\-help
+Show the usage message and exit.
+.TP
 .B \-\-version
-Output version and exit successfully.
+Show the version and exit.
 .
 .SH FILES
 .TP

man/dpkg-architecture.1

@@ -1,14 +1,14 @@
-.TH dpkg\-architecture 1 "2006-06-17" "Debian Project" "dpkg utilities"
+.TH dpkg\-architecture 1 "2007-03-06" "Debian Project" "dpkg utilities"
 .SH "NAME"
 dpkg\-architecture \- set and determine the architecture for package building
 .
-.SH "SYNOPSIS"
+.SH SYNOPSIS
 .B dpkg-architecture
 .RI [ options ]
-.RI [ action ]
+.RI [ commands ]
 .PP
 .
-.SH "DESCRIPTION"
+.SH DESCRIPTION
 dpkg-architecture does provide a facility to determine and set the build and
 host architecture for package building.
 .PP
@@ -24,22 +24,7 @@ other will be set to a usable default. Indeed, it is often better to only
 specify one, because \fBdpkg\-architecture\fP will warn you if your choice
 does not match the default.
 .
-.SH OPTIONS
-.TP
-.BI \-a debian-architecture
-Set the Debian architecture.
-.TP
-.BI \-t gnu-system-type
-Set the GNU system type.
-.TP
-.B \-f
-Values set by existing environment variables with the same name as used by
-the scripts are honored (i.e. used by \fBdpkg-architecture\fP), except if
-this force flag is present. This allows the user
-to override a value even when the call to \fBdpkg\-architecture\fP is buried
-in some other script (for example \fBdpkg\-buildpackage\fP(1)).
-.
-.SH ACTIONS
+.SH COMMANDS
 .TP
 .B \-l
 Print the environment variables, one each line, in the format
@@ -74,13 +59,28 @@ the determined value.
 .B \-L
 Print a list of valid architecture names.
 .TP
-.BR \-\-help
-Print a usage message.
+.B \-\-help
+Show the usage message and exit.
 .TP
 .B \-\-version
-Print program version.
+Show the version and exit.
+.
+.SH OPTIONS
+.TP
+.BI \-a debian-architecture
+Set the Debian architecture.
+.TP
+.BI \-t gnu-system-type
+Set the GNU system type.
+.TP
+.B \-f
+Values set by existing environment variables with the same name as used by
+the scripts are honored (i.e. used by \fBdpkg-architecture\fP), except if
+this force flag is present. This allows the user
+to override a value even when the call to \fBdpkg\-architecture\fP is buried
+in some other script (for example \fBdpkg\-buildpackage\fP(1)).
 .
-.SH "TERMS"
+.SH TERMS
 .IP "build machine" 4
 The machine the package is built on.
 .IP "host machine" 4
@@ -97,29 +97,7 @@ An architecture specification string consisting of two parts separated by
 a dash: cpu and system. Examples: i386\-linux\-gnu, sparc\-linux\-gnu,
 i386\-gnu, x86_64\-netbsd.
 .
-.SH "EXAMPLES"
-\fBdpkg\-buildpackage\fP accepts the \fB\-a\fR option and passes it to
-\fBdpkg\-architecture\fP. Other examples:
-.PP
-CC=i386\-gnu\-gcc dpkg\-architecture \f(CW\*(C`\-c\*(C'\fR debian/rules build
-.PP
-eval \`dpkg\-architecture \f(CW\*(C`\-u\*(C'\fR\`
-.PP
-Check if an architecture is equal to the current architecture or a given
-one:
-.PP
-dpkg\-architecture \-elinux\-alpha
-.PP
-dpkg\-architecture \-amips \-elinux\-mips
-.PP
-Check if the current architecture or an architecture provided with -a are
-Linux systems:
-.PP
-dpkg\-architecture \-ilinux\-any
-.PP
-dpkg\-architecture \-ai386 \-ilinux\-any
-.
-.SH "VARIABLES"
+.SH VARIABLES
 The following variables are set by \fBdpkg\-architecture\fP:
 .IP "\s-1DEB_BUILD_ARCH\s0" 4
 The Debian architecture of the build machine.
@@ -265,11 +243,33 @@ compilation).
 The \fB\-e\fP and \fB\-i\fP options were only introduced in relatively recent
 versions of \fBdpkg\-architecture\fR (since dpkg 1.13.13).
 .
+.SH EXAMPLES
+\fBdpkg\-buildpackage\fP accepts the \fB\-a\fR option and passes it to
+\fBdpkg\-architecture\fP. Other examples:
+.IP
+CC=i386\-gnu\-gcc dpkg\-architecture \f(CW\*(C`\-c\*(C'\fR debian/rules build
+.IP
+eval \`dpkg\-architecture \f(CW\*(C`\-u\*(C'\fR\`
+.PP
+Check if an architecture is equal to the current architecture or a given
+one:
+.IP
+dpkg\-architecture \-elinux\-alpha
+.IP
+dpkg\-architecture \-amips \-elinux\-mips
+.PP
+Check if the current architecture or an architecture provided with -a are
+Linux systems:
+.IP
+dpkg\-architecture \-ilinux\-any
+.IP
+dpkg\-architecture \-ai386 \-ilinux\-any
+.
 .SH "SEE ALSO"
 .BR dpkg\-buildpackage (1),
 .BR dpkg\-cross (1).
 .
-.SH "AUTHOR"
+.SH AUTHOR
 .B dpkg\-architecture
 and this man page were initially written by
 Marcus Brinkmann <brinkmd@debian.org>.

man/dpkg-checkbuilddeps.1

@@ -1,9 +1,11 @@
-.TH dpkg\-checkbuilddeps 1 "2007-02-28" "Debian Project" "dpkg utilities"
+.TH dpkg\-checkbuilddeps 1 "2007-03-06" "Debian Project" "dpkg utilities"
 .SH NAME
 dpkg\-checkbuilddeps - check build dependencies and conflicts
 .
 .SH SYNOPSIS
-\fBdpkg\-checkbuilddeps\fR [\fIoptions\fR] [\fIcontrol-file\fR]
+.B dpkg\-checkbuilddeps
+.RI [ options ]
+.RI [ control-file ]
 .
 .SH DESCRIPTION
 This program checks the installed packages in the system against the build
@@ -15,7 +17,7 @@ may be specified on the command line.
 .
 .SH OPTIONS
 .TP
-\fB\-\-admindir=\fIdir\fP
+.BI \-\-admindir= dir
 Change the location of the \fBdpkg\fR database. The default location is
 \fI/var/lib/dpkg\fP.
 .TP
@@ -24,7 +26,7 @@ Ignore \fIBuild\-Depends\-Indep\fR lines. Use when no arch-indep packages will
 be built.
 .TP
 .B \-h
-Print a usage message.
+Show the usage message and exit.
 .
 .SH AUTHOR
 Copyright 2001 Joey Hess

man/dpkg-deb.1

@@ -1,46 +1,20 @@
-.TH dpkg\-deb 1 "2006-06-17" "Debian Project" "dpkg suite"
+.TH dpkg\-deb 1 "2003-03-06" "Debian Project" "dpkg suite"
 .SH NAME
 dpkg\-deb - Debian package archive (.deb) manipulation tool
+.
 .SH SYNOPSIS
 .B dpkg\-deb
-.BR \-b | \-\-build
-.IR directory " [" archive | directory ]
-.br
-.B dpkg\-deb
-.BR \-I | \-\-info
-.IR archive " [" control-file-name " ..]"
-.br
-.B dpkg\-deb
-.BR \-f | \-\-field
-.IR archive " [" control-field-name " ...]"
-.br
-.B dpkg\-deb
-.BR \-c | \-\-contents
-.I archive
-.br
-.B dpkg\-deb
-.BR \-W | \-\-show
-.RB " [" \-\-showformat\fR=\fIformat "]"
-.I archive
-.br
-.B dpkg\-deb
-.BR \-x | \-\-extract | \-X | \-\-vextract
-.I archive directory
-.br
-.B dpkg\-deb
-.BR \-e | \-\-control
-.I archive directory
-.br
-.B dpkg\-deb \-\-fsys\-tarfile
-.I archive
+.RI [ options ]
+.I command
+.
 .SH DESCRIPTION
 .B dpkg\-deb
 packs, unpacks and provides information about Debian archives.
-
+.PP
 Use
 .B dpkg
 to install and remove packages from your system.
-
+.PP
 You can also invoke
 .B dpkg\-deb
 by calling
@@ -50,9 +24,10 @@ with whatever options you want to pass to
 will spot that you wanted
 .B dpkg\-deb
 and run it for you.
-.SH ACTION OPTIONS
+.
+.SH COMMANDS
 .TP
-.BR \-\-build ", " \-b
+.BR \-b ", " \-\-build " \fIdirectory\fP [\fIarchive\fP|\fIdirectory\fP]"
 Creates a debian archive from the filesystem tree stored in
 .IR directory ". " directory
 must have a
@@ -107,7 +82,7 @@ option may not be used (since
 needs to read and parse the package control file to determine which
 filename to use).
 .TP
-.BR \-\-info ", " \-I
+.BR \-I ", " \-\-info " \fIarchive\fP [\fIcontrol-file-name\fP ...]"
 Provides information about a binary package archive.
 
 If no
@@ -123,14 +98,14 @@ will print them in the order they were specified; if any of the
 components weren't present it will print an error message to stderr
 about each one and exit with status 2.
 .TP
-.BR \-\-show ", " \-W
+.BR \-W ", " \-\-show " \fIarchive\fP"
 Provides information about a binary package archive in the format
 specified by the
 .B \-\-showformat
 argument. The default format displays the package's name and version
 on one line, seperated by a tabulator.
 .TP
-.BR \-\-field ", " \-f
+.BR \-f ", " \-\-field " \fIarchive\fP [\fIcontrol-field-name\fP ...]"
 Extracts control file information from a binary package archive.
 
 If no
@@ -148,21 +123,16 @@ will precede each with its field name (and a colon and space).
 
 No errors are reported for fields requested but not found.
 .TP
-.BR \-\-contents ", " \-c
+.BR \-c ", " \-\-contents " \fIarchive\fP"
 Lists the contents of the filesystem tree archive portion of the
 package archive. It is currently produced in the format generated by
 .BR tar 's
 verbose listing.
 .TP
-.BR \-\-extract ", " \-x ", " \-\-vextract ", " \-X
+.BR \-x ", " \-\-extract " \fIarchive directory\fP"
 Extracts the filesystem tree from a package archive into the specified
 directory.
 
-.BR \-\-vextract " (" \-X ")"
-prints a listing of the files extracted as it goes, while
-.BR \-\-extract " (" \-x ")"
-is silent unless an error occurs.
-
 Note that extracting a package to the root directory will
 .I not
 result in a correct installation! Use
@@ -172,7 +142,12 @@ to install packages.
 .I directory
 (but not its parents) will be created if necessary.
 .TP
-.BR \-\-fsys\-tarfile
+.BR \-X ", " \-\-vextract " \fIarchive directory\fP"
+Is like
+.BR \-\-extract " (" \-x ")"
+but prints a listing of the files extracted as it goes.
+.TP
+.BR \-\-fsys\-tarfile " \fIarchive\fP"
 Extracts the filesystem tree data from a binary package and sends it
 to standard output in
 .B tar
@@ -180,7 +155,7 @@ format. Together with
 .BR tar (1)
 this can be used to extract a particular file from a package archive.
 .TP
-.BR \-\-control ", " \-e
+.BR \-e ", " \-\-control " \fIarchive directory\fP"
 Extracts the control information files from a package archive into the
 specified directory.
 
@@ -191,23 +166,16 @@ in the current directory is used.
 The target directory (but not its parents) will be created if
 necessary.
 .TP
-.BR \-\-help ", " \-h
-Prints
-.BR dpkg\-deb 's
-usage message, giving a summary of its options and their uses.
+.BR \-h ", " \-\-help
+Show the usage message and exit.
 .TP
 .BR \-\-version
-Prints
-.BR dpkg\-deb 's
-version number.
+Show the version and exit.
 .TP
-.BR \-\-licence
-Prints information about
-.BR dpkg\-deb 's
-copyright licensing and lack of warranty. (The American spelling
-.B \-\-license
-is also supported).
-.SH OTHER OPTIONS
+.BR \-\-license ", " \-\-licence
+Show the copyright licensing terms and exit.
+.
+.SH OPTIONS
 .TP
 \fB\-\-showformat=\fP\fIformat\fR
 This option is used to specify the format of the output \fB\-\-show\fP
@@ -244,8 +212,9 @@ Inhibits
 usual checks on the proposed contents of an archive. You can build
 any archive you want, no matter how broken, this way.
 .TP
-.BR \-\-debug ", " \-D
+.BR \-D ", " \-\-debug
 Enables debugging output. This is not very interesting.
+.
 .SH BUGS
 .B dpkg\-deb \-I
 .IB package1 .deb
@@ -262,11 +231,13 @@ to install software! You must use
 .B dpkg
 proper to ensure that all the files are correctly placed and the
 package's scripts run and its status and contents recorded.
+.
 .SH SEE ALSO
 .BR deb (5),
 .BR deb\-control (5),
 .BR dpkg (1),
 .BR dselect (1).
+.
 .SH AUTHOR
 .B dpkg\-deb
 and this manpage were written by Ian Jackson.

man/dpkg-divert.8

@@ -1,29 +1,16 @@
-.TH dpkg\-divert 8 "2006-05-23" "Debian Project" "dpkg utilities"
+.TH dpkg\-divert 8 "2007-03-06" "Debian Project" "dpkg utilities"
 .SH NAME
 dpkg\-divert - override a package's version of a file
 .
 .SH SYNOPSIS
 .B dpkg\-divert
 .RI [ options ]
-.RB [ \-\-add ]
-.I <file>
-.br
-.B dpkg\-divert
-.RI [ options ]
-.B \-\-remove
-.I <file>
-.br
-.B dpkg\-divert
-.RI [ options ]
-.B \-\-list
-.I <glob-pattern>
-.br
-.B dpkg\-divert
-.RI [ options ]
-.B \-\-truename
-.I <file>
+.I command
 .
 .SH DESCRIPTION
+.B dpkg\-divert
+is the utility used to set up and update the list of diversions.
+.PP
 File `diversions' are a way of forcing
 .BR dpkg (1)
 not to install a file into its
@@ -34,20 +21,27 @@ file, or whenever some files (which aren't marked as 'conffiles') need to be
 preserved by dpkg, when installing a newer version of a package which
 contains those files.
 .sp
-.B dpkg\-divert
-is the utility used to set up and update the list of diversions. It
-functions in three basic modes - adding, removing, and listing diversions.
-The options are \fB\-\-add\fP, \fB\-\-remove\fP, and \fB\-\-list\fP,
-respectively. Additionally, it can print out the real name for a diverted
-file with \fB\-\-truename\fP. Other options (listed below) may also be
-specified.
+.SH COMMANDS
+.TP
+.RB [ \-\-add "] \fIfile\fP"
+Add a diversion for \fIfile\fP.
+.TP
+.BI \-\-remove " file"
+Remove a diversion for \fIfile\fP.
+.TP
+.BI \-\-list " glob-pattern"
+List diversions matching \fIglob-pattern\fP.
+.TP
+.BI \-\-truename " file"
+Print the real name for a diverted file.
+.
 .SH OPTIONS
 .TP
-.BI \-\-admindir " <directory>"
-Set the dpkg data directory to \fI<directory>\fP (default: \fI/var/lib/dpkg\fP).
+.BI \-\-admindir " directory"
+Set the dpkg data directory to \fIdirectory\fP (default: \fI/var/lib/dpkg\fP).
 .TP
-.BI \-\-divert " <divert-to>"
-\fI<divert-to>\fP is the location where the versions of \fI<file>\fP, as
+.BI \-\-divert " divert-to"
+\fIdivert-to\fP is the location where the versions of \fIfile\fP, as
 provided by other packages, will be diverted.
 .TP
 .B \-\-local
@@ -56,10 +50,10 @@ This means, that there are no exceptions, and whatever package is installed,
 the file is diverted. This can be used by an admin to install a locally
 modified version.
 .TP
-.BI \-\-package " <package>"
-\fI<package>\fP is the name of a package whose copy of \fI<file>\fP will not
-be diverted. i.e. \fI<file>\fP will be diverted for all packages except
-\fI<package>\fP.
+.BI \-\-package " package"
+\fIpackage\fP is the name of a package whose copy of \fIfile\fP will not
+be diverted. i.e. \fIfile\fP will be diverted for all packages except
+\fIpackage\fP.
 .TP
 .B \-\-quiet
 Quiet mode, i.e. no verbose output.
@@ -72,10 +66,10 @@ in case the destination file already exists.
 Test mode, i.e. don't actually perform any changes, just demonstrate.
 .TP
 .B \-\-help
-Output short usage instructions, and exit successfully.
+Show the usage message and exit.
 .TP
 .B \-\-version
-Output program name and version and exit successfully.
+Show the version and exit.
 .
 .SH NOTES
 When adding, default is \fB\-\-local\fP and \fB\-\-divert\fP
@@ -123,6 +117,7 @@ Note: \fBdpkg\-divert\fP preserves the old copy of this file, with extension
 .
 .SH SEE ALSO
 .BR dpkg (1).
+.
 .SH AUTHOR
 Copyright (C) 1995 Ian Jackson.
 .sp

man/dpkg-name.1

@@ -3,46 +3,41 @@
 .\"
 .\" This is free software; see the GNU General Public Licence version 2
 .\" or later for copying conditions.  There is NO warranty.
-.TH dpkg\-name 1 "2006-02-28" "Debian Project" "dpkg utilities"
+.TH dpkg\-name 1 "2007-03-06" "Debian Project" "dpkg utilities"
 .SH NAME
 dpkg\-name \- rename Debian packages to full package names
+.
 .SH SYNOPSIS
 .B dpkg\-name
-.RB [ \-a | \-\-no\-architecture ]
-.RB [ \-o | \-\-overwrite ]
-.RB [ \-s | \-\-subdir
-.RI [ dir ]]
-.RB [ \-c | \-\-create\-dir ]
-.RB [ \-h | \-\-help ]
-.RB [ \-v | \-\-version ]
-.RB [ \-l | \-\-license ]
-.RB [ \-k | \-\-symlink ]
+.RI [ options  ]
 .RB [ \-\- ]
-.RI [ files ]
+.I files
+.
 .SH DESCRIPTION
 .PP
 This manual page documents the
 .B dpkg\-name
-sh script which provides an easy way to rename
+program which provides an easy way to rename
 .B Debian
 packages into their full package names. A full package name consists
-of <package>_<version>_<architecture>.deb as specified in the control
-file of the package. The <version> part of the filename consists of
+of \fI<package>_<version>_<architecture>.deb\fP as specified in the control
+file of the package. The \fI<version>\fP part of the filename consists of
 the upstream version information optionally followed by a hyphen and
 the revision information.
+.
 .SH OPTIONS
 .TP
-.B "\-a, \-\-no\-architecture"
+.BR \-a ", " \-\-no\-architecture
 The destination filename will not have the architecture information.
 .TP
-.B "\-k, \-\-symlink"
+.BR \-k ", " \-\-symlink
 Create a symlink, instead of moving.
 .TP
-.B "\-o, \-\-overwrite"
+.BR \-o ", " \-\-overwrite
 Existing files will be overwritten if they have the same name as the
 destination filename.
 .TP
-.BR "\-s, \-\-subdir" " [\fIdir\fP]"
+.BR \-s ", " \-\-subdir " [\fIdir\fP]"
 Files will be moved into a subdirectory. If the directory given as argument exists
 the files will be moved into that directory otherwise the name of
 the target directory is extracted from the section field in the
@@ -54,20 +49,20 @@ as well as for sections `non-free' and `contrib' the target directory is
 a lot of packages will find their way to the `no\-section' area. Use
 this option with care, it's messy.
 .TP
-.B "\-c, \-\-create\-dir"
+.BR \-c ", " \-\-create\-dir
 This option can used together with the \-s option. If a target
 directory isn't found it will be created automatically.
 .B Use this option with care.
 .TP
-.B "\-h, \-\-help"
-Print a usage message and exit successfully.
+.BR \-h ", " \-\-help
+Show the usage message and exit.
 .TP
-.B "\-v, \-\-version"
-Print version information and exit successfully.
+.BR \-v ", " \-\-version
+Show the version and exit.
 .TP
-.B "\-l, \-\-license"
-Print copyright information and (a reference to GNU) license
-information and exit successfully.
+.BR \-l ", " \-\-license
+Show the copyright licensing terms and exit.
+.
 .SH EXAMPLES
 .TP
 .B dpkg\-name bar\-foo.deb
@@ -88,6 +83,7 @@ don't come with section information.
 .TP
 .B dpkg \-\-build debian\-tmp && dpkg\-name \-o \-s .. debian\-tmp.deb
 This can be used when building new packages.
+.
 .SH BUGS
 Some packages don't follow the name structure
 <package>_<version>_<architecture>.deb. Packages renamed by dpkg\-name
@@ -97,6 +93,7 @@ packages are installed by
 .BR dpkg (1),
 but other installation tools
 might depend on this naming structure.
+.
 .SH SEE ALSO
 .BR deb (5),
 .BR deb\-control (5),
@@ -104,6 +101,7 @@ might depend on this naming structure.
 .BR dpkg\-deb (1),
 .BR find (1),
 .BR xargs (1).
+.
 .SH COPYRIGHT
 Copyright 1995,1996 Erick Branderhorst.
 .B dpkg\-name

man/dpkg-query.1

@@ -1,37 +1,10 @@
-.TH dpkg\-query 1 "2006-04-09" "Debian Project" "dpkg suite"
+.TH dpkg\-query 1 "2007-03-06" "Debian Project" "dpkg suite"
 .SH NAME
 dpkg\-query \- a tool to query the dpkg database
 .
 .SH SYNOPSIS
 .B dpkg\-query
-.BR \-l | \-\-list
-.IR package-name-pattern " ..."
-.br
-.B dpkg\-query
-.BR \-W | \-\-show
-.IR package-name-pattern " ..."
-.br
-.B dpkg\-query
-.BR \-s | \-\-status
-.IR package-name " ..."
-.br
-.B dpkg\-query
-.BR \-L | \-\-listfiles
-.IR package-name " ..."
-.br
-.B dpkg\-query
-.BR  \-S | \-\-search
-.IR filename-search-pattern " ..."
-.br
-.B dpkg\-query
-.BR \-p | \-\-print\-avail
-.IR package-name " ..."
-.br
-.B dpkg\-query
-.BR \-\-licence | \-\-license
-.br
-.B dpkg\-query
-.BR \-\-version
+.RI [ option "...] " command
 .
 .SH DESCRIPTION
 \fBdpkg\-query\fP is a tool to show information about packages listed in
@@ -39,7 +12,7 @@ the \fBdpkg\fP database.
 .
 .SH COMMANDS
 .TP
-\fB\-l\fP | \fB\-\-list\fP \fIpackage-name-pattern\fP ...
+.BR \-l ", " \-\-list " \fIpackage-name-pattern\fP ..."
 List packages matching given pattern. If no \fIpackage-name-pattern\fP
 is given, list all packages in \fI/var/lib/dpkg/status\fP, excluding
 the ones marked with state purge. Normal shell wildchars are allowed
@@ -58,45 +31,48 @@ automatically to fit the terminal width. It is intended for human
 readers, and is not easily machine-readable. See \fB\-W\fP (\fB\-\-show\fP)
 and \fB\-\-showformat\fP for a way to configure the output format.
 .TP
-\fB\-W\fP | \fB\-\-show\fP \fIpackage-name-pattern\fP ...
+.BR \-W ", " \-\-show " \fIpackage-name-pattern\fP ..."
 Just like the \fB\-\-list\fP option this will list all packages matching
 the given pattern. However the output can be customized using the
 \fB\-\-showformat\fP option.
 The default output format gives one line per matching package, each line
 having the name and installed version of the package, separated by a tab.
 .TP
-\fB\-s\fP | \fB\-\-status\fP \fIpackage-name\fP ...
+.BR \-s ", " \-\-status " \fIpackage-name\fP ..."
 Report status of specified package. This just displays the entry in
 the installed package status database.
 .TP
-\fB\-L\fP | \fB\-\-listfiles\fP \fIpackage-name\fP ...
+.BR \-L ", " \-\-listfiles " \fIpackage-name\fP ..."
 List files installed to your system from \fBpackage-name\fP.
 However, note that files created by package-specific
 installation-scripts are not listed.
 .TP
-\fB\-S\fP | \fB\-\-search\fP \fIfilename-search-pattern\fP ...
+.BR \-S ", " \-\-search " \fIfilename-search-pattern\fP ..."
 Search for a filename from installed packages. All standard shell
 wildchars can be used in the pattern. This command will not list
 extra files created by maintainer scripts, nor will it list
 alternatives.
 .TP
-\fB\-p\fP |\fB\-\-print\-avail\fP \fIpackage-name\fP
+.BR \-p ", " \-\-print\-avail " \fIpackage-name\fP"
 Display details about \fIpackage-name\fP, as found in
 \fI/var/lib/dpkg/available\fP.
 .TP
-\fB\-\-licence\fP | \fB\-\-license\fP
-Display licence and copyright information.
+.BR \-h ", " \-\-help
+Show the usage message and exit.
+.TP
+.B \-\-version
+Show the version and exit.
 .TP
-\fB\-\-version\fP
-Display version information.
+.BR \-\-license ", " \-\-licence
+Show the copyright licensing terms and exit.
 .
 .SH OPTIONS
 .TP
-\fB\-\-admindir=\fIdir\fP
+.BI \-\-admindir= dir
 Change the location of the \fBdpkg\fR database. The default location is
 \fI/var/lib/dpkg\fP.
 .TP
-\fB-f\fP | \fB\-\-showformat=\fP\fIformat\fR
+.BR \-f ", " \-\-showformat=\fIformat\fR
 This option is used to specify the format of the output \fB\-\-show\fP
 will produce. The format is a string that will be output for each package
 listed.

man/dpkg-scanpackages.1

@@ -13,18 +13,16 @@
 .\" You should have received a copy of the GNU General Public
 .\" License along with dpkg; if not, write to the Free Software
 .\" Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
-.TH dpkg\-scanpackages 1 "2006-05-10" "Debian Project" "dpkg utilities"
+.TH dpkg\-scanpackages 1 "2007-03-06" "Debian Project" "dpkg utilities"
 .SH NAME
 dpkg\-scanpackages - create Packages files
 .
 .SH SYNOPSIS
 .B dpkg\-scanpackages
-.RB [ \-u "] [" \-a
-.I <arch>
-.RB "] [" \-m ]
-.I binarydir
-.I overridefile
-.RI [ pathprefix ]
+.RI [ options ]
+.I binary-dir
+.I override-file
+.RI [ path-prefix ]
 .B >
 .I Packages
 .
@@ -65,18 +63,27 @@ package fits into the distribution; see below.
 .I pathprefix
 is an optional string to be prepended to the Filename fields.
 .PP
-If
-.B \-u
-is specified, then scan for *.udeb, instead of *.deb.
-.PP
-When \fB\-a\fP\fI<arch>\fP is specified, then instead of scanning for all
-debs, a pattern consisting of *_all.deb and *_arch.deb is used.
-.PP
 If more than one version of a package is found only the newest one
 is included in the output. If they have the same version and only
-differ in architecture only the first one found is used. You can override
-this behaviour with the \fB\-m\fP switch. If given, all found packages
-are included in the output.
+differ in architecture only the first one found is used.
+.
+.SH OPTIONS
+.TP
+.BR \-u ", " \-\-udeb
+Scan for \fI*.udeb\fP, instead of \fI*.deb\fP.
+.TP
+.BR \-a ", " \-\-arch " \fIarch\fP"
+Use a pattern consisting of \fI*_all.deb\fP and \fI*_arch.deb\fP instead of
+scanning for all debs,
+.TP
+.BR \-m ", " \-\-multiversion
+Include all found packages in the output.
+.TP
+.BR \-h ", " \-\-help
+Show the usage message and exit.
+.TP
+.BR \-\-version
+Show the version and exit.
 .
 .SH THE OVERRIDE FILE
 While most information about a package can be found in the control file,

man/dpkg-scansources.1

@@ -1,8 +1,8 @@
-.TH dpkg\-scansources 1 "2006-05-10" "Debian Project" "dpkg utilities"
-.SH "NAME"
+.TH dpkg\-scansources 1 "2007-03-06" "Debian Project" "dpkg utilities"
+.SH NAME
 dpkg\-scansources \- search for '.dsc' files and build the 'Sources' index
 .
-.SH "SYNOPSIS"
+.SH SYNOPSIS
 .B dpkg\-scansources
 .RI [ options ]
 .I binary-dir
@@ -11,7 +11,7 @@ dpkg\-scansources \- search for '.dsc' files and build the 'Sources' index
 .B >
 .I Sources
 .
-.SH "DESCRIPTION"
+.SH DESCRIPTION
 \fBdpkg-scansources\fR scans the given \fIbinary-dir\fR for \fI.dsc\fR files.
 These are used to create a Debian source index, which is output to
 stdout.
@@ -41,11 +41,8 @@ you will probably need to compress the file with
 except on local access (i.e.
 .B file://
 sources).
-.SH "OPTIONS"
-.IP "\fB\-\-debug\fR" 4
-Turn debugging on.
-.IP "\fB\-\-help\fR" 4
-Show the usage message and die.
+.
+.SH OPTIONS
 .IP "\fB\-n\fR, \fB\-\-no\-sort\fR" 4
 Don't sort the index records. Normally they are sorted by source package
 name.
@@ -58,11 +55,15 @@ file. It contains only two whitespace separated fields, the first is the
 source package name and the second is the section. Blank lines and comment
 lines are ignored in the normal manner. If a package appears in both files
 the source override takes precedence for setting the section.
+.IP "\fB\-\-debug\fR" 4
+Turn debugging on.
+.IP "\fB\-\-help\fR" 4
+Show the usage message and exit.
 .IP "\fB\-\-version\fR" 4
-Print the version number and exit.
+Show the version and exit.
 .
 .SH "SEE ALSO"
 .BR dpkg\-scanpackages (1).
 .
-.SH "AUTHOR"
+.SH AUTHOR
 Roderick Schertler <roderick@argon.org>

man/dpkg-split.1

@@ -1,30 +1,13 @@
 .\" Authors: Ian Jackson
-.TH dpkg\-split 1 "2006-02-28" "Debian Project" "dpkg utilities"
+.TH dpkg\-split 1 "2007-03-06" "Debian Project" "dpkg utilities"
 .SH NAME
 dpkg\-split \- Debian package archive split/join tool
+.
 .SH SYNOPSIS
 .B dpkg\-split
-.BR \-s | \-\-split
-.IR complete-archive " [" prefix ]
-.br
-.B dpkg\-split
-.BR \-j | \-\-join
-.IR part " ..."
-.br
-.B dpkg\-split
-.BR \-I | \-\-info
-.IR part " ..."
-.br
-.B dpkg\-split
-.BR \-a | \-\-auto
-.BI \-o " complete-output part"
-.br
-.B dpkg\-split
-.BR \-l | \-\-listq
-.br
-.B dpkg\-split
-.BR \-d | \-\-discard
-.RI [ package " ...]"
+.RI [ options ]
+.I command
+.
 .SH DESCRIPTION
 .B dpkg\-split
 splits Debian binary package files into smaller parts and reassembles
@@ -45,9 +28,10 @@ options allow the management of the queue.
 
 All splitting, joining and queueing operations produce informative
 messages on standard output; these may safely be ignored.
-.SH ACTION OPTIONS
+.
+.SH COMMANDS
 .TP
-.BR \-\-split ", " \-s
+.BR \-s ", " \-\-split " \fIcomplete-archive\fP [\fIprefix\fP]"
 Splits a single Debian binary package into several parts.
 
 The parts are named
@@ -66,7 +50,7 @@ filename is taken, including directory, with any trailing
 .B .deb
 removed.
 .TP
-.BR \-\-join ", " \-j
+.BR \-j ", " \-\-join " \fIpart\fP..."
 Joins the parts of a package file together, reassembling the original
 file as it was before it was split.
 
@@ -85,12 +69,12 @@ By default the output file is called
 .IB package \- version .deb\fR.
 
 .TP
-.BR \-\-info ", " \-I
+.BR \-I ", " \-\-info " \fIpart\fP..."
 Prints information, in a human-readable format, about the part file(s)
 specified. Arguments which are not binary package parts produce a
 message saying so instead (but still on standard output).
 .TP
-.BR \-\-auto ", " \-a
+.BR \-a ", " "\-\-auto \-o" " \fIcomplete-output part\fP"
 Automatically queue parts and reassemble a package if possible.
 
 The
@@ -125,14 +109,14 @@ option must be supplied when using
 (If this were not mandatory the calling program would not know what
 output file to expect.)
 .TP
-.BR \-\-listq ", " \-l
+.BR \-l ", " \-\-listq
 Lists the contents of the queue of packages to be reassembled.
 
 For each package file of which parts are in the queue the output gives
 the name of the package, the parts in the queue, and the total number
 of bytes stored in the queue.
 .TP
-.BR \-\-discard ", " \-d
+.BR \-d ", " \-\-discard " [\fIpackage\fP...]"
 This discards parts from the queue of those waiting for the remaining
 parts of their packages.
 
@@ -141,34 +125,27 @@ If no
 is specified then the queue is cleared completely; if any are
 specified then only parts of the relevant package(s) are deleted.
 .TP
-.BR \-\-help ", " \-h
-Prints
-.BR dpkg\-split 's
-usage message, giving a summary of its options and their uses.
+.BR \-h ", " \-\-help
+Show the usage message and exit.
 .TP
 .BR \-\-version
-Prints
-.BR dpkg\-split 's
-version number.
+Show the version and exit.
 .TP
-.BR \-\-licence
-Prints information about
-.BR dpkg\-split 's
-copyright licensing and lack of warranty. (The American spelling
-.B \-\-license
-is also supported.)
-.SH OTHER OPTIONS
+.BR \-\-license ", " \-\-licence
+Show the copyright licensing terms and exit.
+.
+.SH OPTIONS
 .TP
 .BI \-\-depotdir " directory"
 Specifies an alternative directory for the queue of parts awaiting
 automatic reassembly. The default is
 .BR /var/lib/dpkg .
 .TP
-.BI \-\-partsize\fR|\fB\-S " kbytes"
+.BR \-S ", " \-\-partsize " \fIkbytes\fP"
 Specifies the maximum part size when splitting, in kilobytes (1024
-bytes). The default is 450Kb.
+bytes). The default is 450 KiB.
 .TP
-.BI \-\-output\fR|\fB\-O " complete-output"
+.BR \-o ", " \-\-output " \fIcomplete-output\fP"
 Specifies the output file name for a reassembly.
 
 This overrides the default for a manual reassembly
@@ -176,7 +153,7 @@ This overrides the default for a manual reassembly
 and is mandatory for an automatic queue-or-reassemble
 .RB ( \-\-auto ).
 .TP
-.BR \-\-npquiet ", " \-Q
+.BR \-Q ", " \-\-npquiet
 When doing automatic queue-or-reassembly
 .B dpkg\-split
 usually prints a message if it is given a
@@ -202,6 +179,7 @@ The result is then truncated as much as is necessary, and filenames of
 the form
 .IB "prefixN" of M .deb
 are generated.
+.
 .SH EXIT STATUS
 An exit status of 0 indicates that the requested split, merge, or
 other command succeeded.
@@ -218,6 +196,7 @@ file was not a binary package part.
 An exit status of 2 indicates some kind of trouble, such as a system
 call failure, a file that looked like a package part file but was
 corrupted, a usage error or some other problem.
+.
 .SH BUGS
 .B dpkg\-split
 uses some rather out-of-date conventions for the the filenames of
@@ -232,6 +211,7 @@ package part is one.
 The architecture is not represented in the part files' header, only in
 the control information of the contained binary package file, and it
 is not present in the filenames generated.
+.
 .SH FILES
 .TP
 .I /var/lib/dpkg/parts
@@ -242,7 +222,8 @@ The filenames used in this directory are in a format internal to
 .B dpkg\-split
 and are unlikely to be useful to other programs, and in any case the
 filename format should not be relied upon.
-.SH SEE ALSO
+.
+.SH "SEE ALSO"
 .BR deb (5),
 .BR deb\-control (5),
 .BR dpkg\-deb (1),

man/dpkg-statoverride.8

@@ -1,20 +1,11 @@
-.TH dpkg\-statoverride 8 "2006-05-23" "Debian project" "dpkg utilities"
+.TH dpkg\-statoverride 8 "2007-03-06" "Debian project" "dpkg utilities"
 .SH NAME
 dpkg\-statoverride - override ownership and mode of files
 .
 .SH SYNOPSIS
 .B dpkg\-statoverride
 .RI [ options ]
-.BI \-\-add " <user> <group> <mode> <file>"
-.br
-.B dpkg\-statoverride
-.RI [ options ]
-.BI \-\-remove " <file>"
-.br
-.B dpkg\-statoverride
-.RI [ options ]
-.B \-\-list
-.RI [ <glob-pattern> ]
+.I command
 .
 .SH DESCRIPTION
 `\fBstat overrides\fR' are a way to tell
@@ -30,27 +21,39 @@ flag, or only executable by a certain group.
 overrides. It has three basic functions: adding, removing and listing
 overrides.
 .
-.SH OPTIONS
+.SH COMMANDS
 .TP
-.BI \-\-add " <user> <group> <mode> <file>"
-Add an override for \fB<file>\fR. \fB<file>\fR does not need to exist
+.BI \-\-add " user group mode file"
+Add an override for \fBfile\fR. \fBfile\fR does not need to exist
 when this command is used; the override will be stored and used later.
 Users and groups can be specified by their name (for example \fBroot\fR
 or \fBnobody\fR), or by their number by prepending the number with a
 `\fB#\fR' (for example \fB#0\fR or \fB#65534\fR).
 
-If \-\-update is specified and \fB<file>\fR exists, it is immediately
+If \-\-update is specified and \fBfile\fR exists, it is immediately
 set to the new owner and mode.
 .TP
-.BI \-\-remove " <file>"
-Remove an override for \fB<file>\fR, the status of \fB<file>\fR is left
+.BI \-\-remove " file"
+Remove an override for \fBfile\fR, the status of \fBfile\fR is left
 unchanged by this command.
 .TP
-.BR \-\-list " [\fI<glob-pattern>\fP]"
+.BR \-\-list " [\fIglob-pattern\fP]"
 List all overrides. If a glob pattern is specified restrict the output
 to overrides which match the glob. If there are no overrides or none
 match the glob \fBdpkg\-statoverride\fR will exit with an exitcode of 1.
 .TP
+.B \-\-help
+Show the usage message and exit.
+.TP
+.B \-\-version
+Show the version and exit.
+.
+.SH OPTIONS
+.TP
+.BI \-\-admindir " directory"
+Change the directory of the dpkg database where the statoverride file is
+also stored. Defaults to \fI/var/lib/dpkg\fP.
+.TP
 .B \-\-force
 Force an action, even if a sanity check would otherwise prohibit it.
 This is necessary to override an existing override.
@@ -61,16 +64,6 @@ exists.
 .TP
 .B \-\-quiet
 Be less verbose about what we do.
-.TP
-.B \-\-help
-Show usage information.
-.TP
-.B \-\-version
-Show program version and copyright.
-.TP
-.B \-\-admindir
-Change the directory of the dpkg database where the statoverride file is
-also stored. Defaults to \fI/var/lib/dpkg\fP.
 .
 .SH FILES
 .TP

man/start-stop-daemon.8

@@ -1,23 +1,11 @@
-.TH start\-stop\-daemon 8 "2006-02-28" "Debian Project" "dpkg utilities"
+.TH start\-stop\-daemon 8 "2007-03-06" "Debian Project" "dpkg utilities"
 .SH NAME
 start\-stop\-daemon \- start and stop system daemon programs
 .
 .SH SYNOPSIS
 .B start\-stop\-daemon
-.BR \-S | \-\-start
-.IR options
-.RB [ \-\- ]
-.IR arguments
-.HP
-.B start\-stop\-daemon
-.BR \-K | \-\-stop
-.IR options
-.HP
-.B start\-stop\-daemon
-.BR \-H | \-\-help
-.HP
-.B start\-stop\-daemon
-.BR \-V | \-\-version
+.RI [ options ]
+.I command
 .
 .SH DESCRIPTION
 .B start\-stop\-daemon
@@ -26,11 +14,30 @@ Using the
 .BR \-\-exec ", " \-\-pidfile ", " \-\-user ", and " \-\-name " options,"
 .B start\-stop\-daemon
 can be configured to find existing instances of a running process.
-
-With
-.BR \-\-start ,
+.PP
+Note: unless
+.B \-\-pidfile
+is specified,
+.B start\-stop\-daemon
+behaves similar to
+.BR killall (1).
 .B start\-stop\-daemon
-checks for the existence of a specified process.
+will scan the process table looking for any processes which
+match the process name, uid, and/or gid (if specified). Any
+matching process will prevent
+.BR \-\-start
+from starting the daemon. All matching processes will be
+sent the KILL signal if
+.BR \-\-stop
+is specified. For daemons which have long-lived children
+which need to live through a
+.BR \-\-stop
+you must specify a pidfile.
+.
+.SH COMMANDS
+.TP
+.BR \-S ", " \-\-start " [" \-\- "] \fIarguments\fP"
+Check for the existence of a specified process.
 If such a process exists,
 .B start\-stop\-daemon
 does nothing, and exits with error status 1 (0 if
@@ -45,11 +52,9 @@ Any arguments given after
 .BR \-\-
 on the command line are passed unmodified to the program being
 started.
-
-With
-.BR \-\-stop ,
-.B start\-stop\-daemon
-also checks for the existence of a specified process.
+.TP
+.BR \-K ", " \-\-stop
+Checks for the existence of a specified process.
 If such a process exists,
 .B start\-stop\-daemon
 sends it the signal specified by
@@ -65,58 +70,44 @@ is specified). If
 is specified then
 .B start\-stop\-daemon
 will check that the process(es) have terminated.
-
-Note: unless
-.B \-\-pidfile
-is specified,
-.B start\-stop\-daemon
-behaves similar to
-.BR killall (1).
-.B start\-stop\-daemon
-will scan the process table looking for any processes which
-match the process name, uid, and/or gid (if specified). Any
-matching process will prevent
-.BR \-\-start
-from starting the daemon. All matching processes will be
-sent the KILL signal if
-.BR \-\-stop
-is specified. For daemons which have long-lived children
-which need to live through a
-.BR \-\-stop
-you must specify a pidfile.
-
+.TP
+.BR \-H ", " \-\-help
+Show usage information and exit.
+.TP
+.BR \-V ", " \-\-version
+Show the program version and exit.
+.
 .SH OPTIONS
-
 .TP
-\fB\-x\fP|\fB\-\-exec\fP \fIexecutable\fP
+.BR \-x ", " \-\-exec " \fIexecutable\fP"
 Check for processes that are instances of this executable (according to
 \fB/proc/\fIpid\fP/exe\fR).
 .TP
-\fB\-p\fP|\fB\-\-pidfile\fP \fIpid-file\fP
+.BR \-p ", " \-\-pidfile " \fIpid-file\fP"
 Check whether a process has created the file
 .IR pid-file .
 .TP
-\fB\-u\fP|\fB\-\-user\fP \fIusername\fP|\fIuid\fP
+.BR \-u ", " \-\-user " \fIusername\fP|\fIuid\fP
 Check for processes owned by the user specified by
 .I username
 or
 .IR uid .
 .TP
-\fB\-g\fP|\fB\-\-group\fP \fIgroup\fP|\fIgid\fP
+.BR \-g ", " \-\-group " \fIgroup\fP|\fIgid\fP"
 Change to \fIgroup\fP or \fIgid\fP when starting the process.
 .TP
-\fB\-n\fP|\fB\-\-name\fP \fIprocess-name\fP
+.BR \-n ", " \-\-name " \fIprocess-name\fP"
 Check for processes with the name
 .I process-name
 (according to
 .BR /proc/\fIpid\fB/stat\fP ).
 .TP
-\fB\-s\fP|\fB\-\-signal\fP \fIsignal\fP
+.BR \-s ", " \-\-signal " \fIsignal\fP"
 With
 .BR \-\-stop ,
 specifies the signal to send to processes being stopped (default 15).
 .TP
-\fB\-R\fP|\fB\-\-retry\fP \fItimeout\fP|\fIschedule\fP
+.BR \-R ", " \-\-retry " \fItimeout\fP|\fIschedule\fP"
 With
 .BR \-\-stop ,
 specifies that
@@ -163,7 +154,7 @@ with
 .B \-\-signal
 is ignored.
 .TP
-\fB\-a\fP|\fB\-\-startas\fP \fIpathname\fP
+.BR \-a ", " \-\-startas " \fIpathname\fP"
 With
 .BR \-\-start ,
 start the process specified by
@@ -171,17 +162,17 @@ start the process specified by
 If not specified, defaults to the argument given to
 .BR \-\-exec .
 .TP
-.BR \-t | \-\-test
+.BR \-t ", " \-\-test
 Print actions that would be taken and set appropriate return value,
 but take no action.
 .TP
-.BR \-o | \-\-oknodo
+.BR \-o ", " \-\-oknodo
 Return exit status 0 instead of 1 if no actions are (would be) taken.
 .TP
-.BR \-q | \-\-quiet
+.BR \-q ", " \-\-quiet
 Do not print informational messages; only display error messages.
 .TP
-\fB\-c\fP|\fB\-\-chuid\fP \fIusername\fR|\fIuid\fP
+.BR "\-c ", " \-\-chuid " \fIusername\fR|\fIuid\fP
 Change to this username/uid before starting the process. You can also
 specify a group by appending a
 .BR : ,
@@ -198,13 +189,13 @@ groups that the user isn't normally a member of (like adding per process
 group membership for generic users like
 .BR nobody ).
 .TP
-\fB\-r\fP|\fB\-\-chroot\fP \fIroot\fP
+.BR \-r ", " \-\-chroot " \fIroot\fP"
 Chdir and chroot to
 .I root
 before starting the process. Please note that the pidfile is also written
 after the chroot.
 .TP
-\fB\-d\fP|\fB\-\-chdir\fP \fIpath\fP
+.BR \-d ", " \-\-chdir " \fIpath\fP"
 Chdir to
 .I path
 before starting the process. This is done after the chroot if the
@@ -212,7 +203,7 @@ before starting the process. This is done after the chroot if the
 start\-stop\-daemon will chdir to the root directory before starting
 the process.
 .TP
-.BR \-b | \-\-background
+.BR \-b ", " \-\-background
 Typically used with programs that don't detach on their own. This option
 will force
 .B start\-stop\-daemon
@@ -224,13 +215,13 @@ reason. This is a last resort, and is only meant for programs that either
 make no sense forking on their own, or where it's not feasible to add the
 code for them to do this themself.
 .TP
-\fB\-N\fP|\fB\-\-nicelevel\fP \fIint\fP
+.BR \-N ", " \-\-nicelevel " \fIint\fP"
 This alters the priority of the process before starting it.
 .TP
-\fB\-k\fP|\fB\-\-umask\fP \fImask\fP
+.BR \-k ", " \-\-umask " \fImask\fP"
 This sets the umask of the process before starting it.
 .TP
-.BR \-m | \-\-make\-pidfile
+.BR \-m ", " \-\-make\-pidfile
 Used when starting a program that does not create its own pid file. This
 option will make
 .B start\-stop\-daemon
@@ -245,15 +236,9 @@ only useful when combined with the
 .B \-\-background
 option.
 .TP
-.BR \-v | \-\-verbose
+.BR \-v ", " \-\-verbose
 Print verbose informational messages.
-.TP
-.BR \-H | \-\-help
-Print help information; then exit.
-.TP
-.BR \-V | \-\-version
-Print version information; then exit.
-
+.
 .SH AUTHORS
 Marek Michalkiewicz <marekm@i17linuxb.ists.pwr.wroc.pl> based on
 a previous version by Ian Jackson <ian@chiark.greenend.org.uk>.

man/update-alternatives.8

@@ -5,57 +5,14 @@
 .\" by the Free Software Foundation; either version 2 of the License, or
 .\" (at your option) any later version.  There is NO WARRANTY.  You can
 .\" find the GNU GPL in /usr/share/common-licenses/GPL on any Debian system.
-.TH update\-alternatives 8 "2006-11-24" "Debian Project" "dpkg utilities"
+.TH update\-alternatives 8 "2007-03-06" "Debian Project" "dpkg utilities"
 .SH NAME
 update\-alternatives - maintain symbolic links determining default commands
 .
 .SH SYNOPSIS
 .B update\-alternatives
 .RI [ options ]
-.B \-\-install
-.I genname symlink altern priority
-.RB [ \-\-slave
-.I genname symlink
-.IR altern ]...
-.PP
-.B update\-alternatives
-.RI [ options ]
-.B \-\-remove
-.I name path
-.PP
-.B update\-alternatives
-.RI [ options ]
-.B \-\-remove\-all
-.I name
-.PP
-.B update\-alternatives
-.RI [ options ]
-.B \-\-all
-.PP
-.B update\-alternatives
-.RI [ options ]
-.B \-\-auto
-.I name
-.PP
-.B update\-alternatives
-.RI [ options ]
-.B \-\-display
-.I name
-.PP
-.B update\-alternatives
-.RI [ options ]
-.B \-\-list
-.I name
-.PP
-.B update\-alternatives
-.RI [ options ]
-.B \-\-config
-.I name
-.PP
-.B update\-alternatives
-.RI [ options ]
-.B \-\-set
-.I name path
+.I command
 .
 .SH DESCRIPTION
 .B update\-alternatives
@@ -262,7 +219,7 @@ and the current setting for it, use the
 action:
 .RS
 .PP
-update\-alternatives \-\-display vi
+.BR "update\-alternatives \-\-display" vi
 .RE
 .PP
 To choose a particular
@@ -271,7 +228,7 @@ implementation, use this command as root and then select a number
 from the list:
 .RS
 .PP
-update\-alternatives \-\-config vi
+.BR "update\-alternatives \-\-config" vi
 .RE
 .PP
 To go back to having the
@@ -279,47 +236,10 @@ To go back to having the
 implementation chosen automatically, do this as root:
 .RS
 .PP
-update\-alternatives \-\-auto vi
+.BR "update\-alternatives \-\-auto" vi
 .RE
 .
-.SH OPTIONS
-Exactly one action must be specified if
-.B update\-alternatives
-is to perform any meaningful task.
-Any number of the common options may be specified together with any action.
-.SS "COMMON OPTIONS"
-.TP
-.B \-\-verbose
-Generate more comments about what
-.B update\-alternatives
-is doing.
-.TP
-.B \-\-quiet
-Don't generate any comments unless errors occur.
-This option is not yet implemented.
-.TP
-.B \-\-test
-Don't actually do anything, just say what would be done.
-This option is not yet implemented.
-.TP
-.B \-\-help
-Give some usage information.
-.TP
-.B \-\-version
-Tell which version of
-.B update\-alternatives
-this is.
-.TP
-\fB\-\-altdir\fR \fIdirectory\fR
-Specifies the alternatives directory, when this is to be
-different from the default.
-.TP
-\fB\-\-admindir\fR \fIdirectory\fR
-Specifies the administrative directory, when this is to be
-different from the default.
-.SS ACTIONS
-.\" The names of the arguments should be identical with the ones
-.\" in SYNOPSIS section.
+.SH COMMANDS
 .TP
 \fB\-\-install\fR \fIgenname symlink altern priority\fR [\fB\-\-slave\fR \fIgenname symlink altern\fR] ...
 Add a group of alternatives to the system.
@@ -411,6 +331,35 @@ interactively select which one to use. The link group is updated
 and taken out of
 .I auto
 mode.
+.TP
+.B \-\-help
+Show the usage message and exit.
+.TP
+.B \-\-version
+Show the version and exit.
+.
+.SH OPTIONS
+.TP
+.BI \-\-altdir " directory"
+Specifies the alternatives directory, when this is to be
+different from the default.
+.TP
+.BI \-\-admindir " directory"
+Specifies the administrative directory, when this is to be
+different from the default.
+.TP
+.B \-\-verbose
+Generate more comments about what
+.B update\-alternatives
+is doing.
+.TP
+.B \-\-quiet
+Don't generate any comments unless errors occur.
+This option is not yet implemented.
+.TP
+.B \-\-test
+Don't actually do anything, just say what would be done.
+This option is not yet implemented.
 .
 .SH FILES
 .TP