The following commit has been merged in the master branch: commit 9c757bf4c00f777f089e0ab6f83f10edd5892679 Author: Guillem Jover <guil...@debian.org> Date: Wed Jul 6 17:19:38 2011 +0200
man: Use italics or bold instead of surrounding the text with <> Using <> to delimit parts of text is necessary when using plain text output, but not when we have some formatting available around, which is the case with the man pages, but not with the program output. diff --git a/TODO b/TODO index 75606a2..0d1bc39 100644 --- a/TODO +++ b/TODO @@ -63,7 +63,6 @@ TODO * Man pages: - Add example to dpkg-scanfoo manpages? - Merge synopsis lines in dpkg-triggers. - - Check all '<>' use bold instead. - Check all command vs action. - Check usage of '|' instead of ', '. - Check position of short option before long option. diff --git a/debian/changelog b/debian/changelog index cdff489..b8d8aec 100644 --- a/debian/changelog +++ b/debian/changelog @@ -128,6 +128,7 @@ dpkg (1.16.1) UNRELEASED; urgency=low - Clarify that several front-end fields are not dselect specific in dpkg-query(1). - Use [option...] instead of [options] and friends. + - Use italics or bold instead of surrounding the text with <>. * Refer to Sources and Packages files as part of a repository instead of as being of exclusive use or owned by APT, which has never been the case. diff --git a/man/deb-control.5 b/man/deb-control.5 index 8a4f8c9..4184262 100644 --- a/man/deb-control.5 +++ b/man/deb-control.5 @@ -1,6 +1,6 @@ .\" Author: Raul Miller .\" Includes text from the debian Guidelines by Ian Jackson, Ian Murdock -.TH deb\-control 5 "2010-07-29" "Debian Project" "Debian" +.TH deb\-control 5 "2011-07-04" "Debian Project" "Debian" .SH NAME deb\-control \- Debian packages' master control file format . @@ -24,24 +24,24 @@ field, see below). . .SH REQUIRED FIELDS .TP -.BR Package: " <package name>" +.BI Package: " package-name" The value of this field determines the package name, and is used to generate file names by most installation tools. .TP -.BR Version: " <version string>" +.BI Version: " version-string" Typically, this is the original package's version number in whatever form the program's author uses. It may also include a Debian revision number (for non-native packages). The exact format and sorting algorithm are described in .BR deb\-version (5). .TP -.BR Maintainer: " <fullname email>" +.BI Maintainer: " fullname-email" Should be in the format `Joe Bloggs <jblo...@foo.com>', and is typically the person who created the package, as opposed to the author of the software that was packaged. .TP -.BR Description: " <short description>" -.BR " " "<long description>" +.BI Description: " short-description" +.BI " " "long-description" .br The format for the package description is a short brief summary on the first line (after the "Description" field). The following lines should be @@ -51,12 +51,12 @@ contain a single '.' following the preceding space. . .SH OPTIONAL FIELDS .TP -.BR Section: " <section>" +.BI Section: " section" This is a general field that gives the package a category based on the software that it installs. Some common sections are `utils', `net', `mail', `text', `x11' etc. .TP -.BR Priority: " <priority>" +.BI Priority: " priority" Sets the importance of this package in relation to the system as a whole. Common priorities are `required', `standard', `optional', `extra' etc. .LP @@ -69,14 +69,14 @@ A list of these values can be obtained from the latest version of the .B debian\-policy package. .TP -.BR Essential: " <yes|no>" +.BR Essential: " \fByes\fP|\fBno\fP" This field is usually only needed when the answer is `yes'. It denotes a package that is required for proper operation of the system. Dpkg or any other installation tool will not allow an .B Essential package to be removed (at least not without using one of the force options). .TP -.BR Architecture: " <arch|all>" +.BR Architecture: " \fIarch\fP|\fBall\fP" The architecture specifies which type of hardware this package was compiled for. Common architectures are `i386', `m68k', `sparc', `alpha', `powerpc' etc. Note that the @@ -84,21 +84,22 @@ etc. Note that the option is meant for packages that are architecture independent. Some examples of this are shell and Perl scripts, and documentation. .TP -.BR Origin: " <name>" +.BI Origin: " name" The name of the distribution this package is originating from. .TP -.BR Bugs: " <url>" +.BI Bugs: " url" The url of the bug tracking system for this package. The current used format -is \fB<bts-type>://<bts-address>\fP, like \fBdebbugs://bugs.debian.org\fP. +is \fIbts-type\fP\fB://\fP\fIbts-address\fP, like +\fBdebbugs://bugs.debian.org\fP. .TP -.BR Homepage: " <url>" +.BI Homepage: " url" The upstream project home page URL. .TP -.BR Tag: " <tag list>" +.BI Tag: " tag-list" List of tags describing the qualities of the package. The description and list of supported tags can be found in the \fBdebtags\fP package. .TP -.BR Multi\-Arch: " <same|foreign|allowed>" +.BR Multi\-Arch: " \fBsame\fP|\fBforeign\fP|\fBallowed\fP" This field is used to indicate how this package should behave on a multi-arch installations. The value `same' means that the package is co-installable with itself, but it must not be used to satisfy the dependency of any package of a @@ -109,26 +110,26 @@ reverse-dependencies to indicate in their Depends field that they need a package from a foreign architecture, but has no effect otherwise. This field should not be present in packages with the Architecture: all field. .TP -.BR Source: " <source name>" +.BI Source: " source-name" The name of the source package that this binary package came from, if different than the name of the package itself. .TP .PD 0 -.BR Subarchitecture: " <value>" +.BI Subarchitecture: " value" .TP .PD 0 -.BR Kernel\-Version: " <value>" +.BI Kernel\-Version: " value" .TP .PD -.BR Installer\-Menu\-Item: " <value>" +.BI Installer\-Menu\-Item: " value" These fields are used by the debian\-installer and are usually not needed. See /usr/share/doc/debian\-installer/devel/modules.txt from the .B debian\-installer package for more details about them. .TP -.BR Depends: " <package list>" +.BI Depends: " package-list" List of packages that are required for this package to provide a non-trivial amount of functionality. The package maintenance software will not allow a package to be installed if the packages listed in its @@ -139,21 +140,21 @@ fields are run before those of the packages which depend on them. On the opposite, in a removal, the prerm script of a package is run before those of the packages listed in its Depends: field. .TP -.BR Pre\-Depends: " <package list>" +.BI Pre\-Depends: " package-list" List of packages that must be installed .B and configured before this one can be installed. This is usually used in the case where this package requires another package for running its preinst script. .TP -.BR Recommends: " <package list>" +.BI Recommends: " package-list" Lists packages that would be found together with this one in all but unusual installations. The package maintenance software will warn the user if they install a package without those listed in its .B Recommends field. .TP -.BR Suggests: " <package list>" +.BI Suggests: " package-list" Lists packages that are related to this one and can perhaps enhance its usefulness, but without which installing this package is perfectly reasonable. @@ -176,7 +177,7 @@ by a hyphen). Accepted version relationships are ">>" for greater than, "<<" for less than, ">=" for greater than or equal to, "<=" for less than or equal to, and "=" for equal to. .TP -.BR Breaks: " <package list>" +.BI Breaks: " package-list" Lists packages that this one breaks, for example by exposing bugs when the named packages rely on this one. The package maintenance software will not allow broken packages to be configured; generally @@ -184,7 +185,7 @@ the resolution is to upgrade the packages named in a .B Breaks field. .TP -.BR Conflicts: " <package list>" +.BI Conflicts: " package-list" Lists packages that conflict with this one, for example by containing files with the same names. The package maintenance software will not allow conflicting packages to be installed at the same time. Two @@ -192,7 +193,7 @@ conflicting packages should each include a .B Conflicts line mentioning the other. .TP -.BR Replaces: " <package list>" +.BI Replaces: " package-list" List of packages files from which this one replaces. This is used for allowing this package to overwrite the files of another package and is usually used with the @@ -200,7 +201,7 @@ is usually used with the field to force removal of the other package, if this one also has the same files as the conflicted package. .TP -.BR Provides: " <package list>" +.BI Provides: " package-list" This is a list of virtual packages that this one provides. Usually this is used in the case of several packages all providing the same service. For example, sendmail and exim can serve as a mail server, so they @@ -230,7 +231,7 @@ and fields. . .TP -.BR Built\-Using: " <package list>" +.BI Built\-Using: " package-list" This field lists extra source packages that were used during the build of this binary package. This is an indication to the archive maintenance software that these extra source packages must be kept whilst this binary package is diff --git a/man/deb-src-control.5 b/man/deb-src-control.5 index 0ef7f17..e1f7942 100644 --- a/man/deb-src-control.5 +++ b/man/deb-src-control.5 @@ -28,7 +28,7 @@ treated as comments. . .SH SOURCE FIELDS .TP -.BR Source: " <source package name> (required)" +.BR Source: " \fIsource-package-name\fP (required)" The value of this field is the name of the source package, and should match the name of the source package in the debian/changelog file. A package name must consist only of lower case letters (a-z), digits (0-9), plus (+) and @@ -36,63 +36,63 @@ minus (-) signs, and periods (.). Package names must be at least two characters long and must start with an alphanumeric character. .TP -.BR Maintainer: " <fullname email> (required)" +.BR Maintainer: " \fIfullname-email\fP (required)" Should be in the format "Joe Bloggs <jblo...@foo.com>", and references the person who currently maintains the package, as opposed to the author of the software or the original packager. .TP -.BR Uploaders: " <fullname email>" +.BI Uploaders: " fullname-email" Lists all the names and email addresses of co-maintainers of the package, in the same format as the Maintainer field. Multiple co-maintainers should be separated by a comma. .TP -.BR Standards\-Version: " <version string>" +.BI Standards\-Version: " version-string" This documents the most recent version of the standards (which consists of the Debian Policy Manual and referenced texts from the .B debian\-policy package) this package complies to. .TP -.BR DM\-Upload\-Allowed: " <yes|no>" +.BR DM\-Upload\-Allowed: " \fByes\fP|\fBno\fP" This field indicates whether the package can be uploaded by Debian Maintainers appearing in the Maintainer or Uploaders field. The default value is "no". .TP -.BR Homepage: " <url>" +.BI Homepage: " url" The upstream project home page URL. .TP -.BR Bugs: " <url>" +.BI Bugs: " url" The url of the bug tracking system for this package. The current used format -is \fB<bts-type>://<bts-address>\fP, like \fBdebbugs://bugs.debian.org\fP. This -field is usually not needed. +is \fIbts-type\fP\fB://\fP\fIbts-address\fP, like +\fBdebbugs://bugs.debian.org\fP. This field is usually not needed. .TP -.BR Vcs\-*: " <url>" +.BI Vcs\-*: " url" The url of the Version Control System repository used to maintain this package. Currently supported are Arch, Bzr (Bazaar), Cvs, Darcs, Git, Hg (Mercurial), Mtn (Monotone) and Svn (Subversion). Usually this field points to the latest version of the package, such as the main branch or the trunk. .TP -.BR Vcs\-Browser: " <url>" +.BI Vcs\-Browser: " url" The url of a webinterface to browse the Version Control System repository. .TP -.BR Origin: " <name>" +.BI Origin: " name" The name of the distribution this package is originating from. This field is usually not needed. .TP -.BR Section: " <section>" +.BI Section: " section" This is a general field that gives the package a category based on the software that it installs. Some common sections are "utils", "net", "mail", "text", "x11", etc. .TP -.BR Priority: " <priority>" +.BI Priority: " priority" Sets the importance of this package in relation to the system as a whole. Common priorities are "required", "standard", "optional", "extra", etc. @@ -106,30 +106,30 @@ A list of these values can be obtained from the latest version of the package. .TP -.BR Build\-Features: " <features list>" +.BI Build\-Features: " features-list" A comma-separated list of names of build-time features that are supported by the source package. Currently, the only supported feature is \fBbuild-arch\fP. It allows dpkg-buildpackage to call the \fIbuild-arch\fP or \fIbuild-indep\fP targets in place of \fIbuild\fP. .TP -.BR Build\-Depends: " <package list>" +.BI Build\-Depends: " package-list" A list of packages that need to be installed and configured to be able to build the source package. .TP -.BR Build\-Depends\-Indep: " <package list>" +.BI Build\-Depends\-Indep: " package-list" Same as Build\-Depends, but they are only needed when building the architecture independent packages. The Build\-Depends are also installed in this case. .TP -.BR Build\-Conflicts: " <package list>" +.BI Build\-Conflicts: " package-list" A list of packages that should not be installed when the package is build, for example because they interfere with the used build system. .TP -.BR Build\-Conflicts\-Indep: " <package list>" +.BI Build\-Conflicts\-Indep: " package-list" Same as Build\-Conflicts, but only when building the architecture independent packages. @@ -180,12 +180,12 @@ fields can also be in a binary paragraph to override the global value from the source package. .TP -.BR Package: " <binary package name> (required)" +.BR Package: " \fIbinary-package-name\fP (required)" This field is used to name the binary package name. The same restrictions as to a source package name apply. .TP -.BR Architecture: " <arch|all|any> (required)" +.BR Architecture: " \fIarch\fP|\fBall\fP|\fBany\fP (required)" The architecture specifies on which type of hardware this package runs. For packages that run on all architectures, use the .B any @@ -199,20 +199,20 @@ architecture wildcards in that list (see for more information about them). .TP -.BR Package\-Type: " <deb|udeb>" +.BR Package\-Type: " \fBdeb\fP|\fBudeb\fP" This field defines the type of the package. "udeb" is for size-constrained packages used by the debian installer. "deb" is the default value, it's assumed if the field is absent. More types might be added in the future. .TP .PD 0 -.BR Subarchitecture: " <value>" +.BI Subarchitecture: " value" .TP .PD 0 -.BR Kernel\-Version: " <value>" +.BI Kernel\-Version: " value" .TP .PD 0 -.BR Installer\-Menu\-Item: " <value>" +.BI Installer\-Menu\-Item: " value" These fields are used by the debian\-installer and are usually not needed. See /usr/share/doc/debian\-installer/devel/modules.txt from the .B debian\-installer @@ -220,16 +220,16 @@ package for more details about them. .TP .PD 0 -.BR Essential: " <yes|no>" +.BR Essential: " \fByes\fP|\fBno\fP" .TP .PD 0 -.BR Multi\-Arch: " <same|foreign|allowed> " +.BR Multi\-Arch: " \fBsame\fP|\fBforeign\fP|\fBallowed\fP" .TP .PD 0 -.BR Tag: " <tag list>" +.BI Tag: " tag-list" .TP .PD 0 -.BR Description: " <short description> (required)" +.BR Description: " \fIshort-description\fP (required)" These fields are described in the .BR deb\-control (5) manual page, as they are copied literally to the control file of the binary @@ -237,34 +237,34 @@ package. .TP .PD 0 -.BR Depends: " <package list>" +.BI Depends: " package-list" .TP .PD 0 -.BR Pre\-Depends: " <package list>" +.BI Pre\-Depends: " package-list" .TP .PD 0 -.BR Recommends: " <package list>" +.BI Recommends: " package-list" .TP .PD 0 -.BR Suggests: " <package list>" +.BI Suggests: " package-list" .TP .PD 0 -.BR Breaks: " <package list>" +.BI Breaks: " package-list" .TP .PD 0 -.BR Enhances: " <package list>" +.BI Enhances: " package-list" .TP .PD 0 -.BR Replaces: " <package list>" +.BI Replaces: " package-list" .TP .PD 0 -.BR Conflicts: " <package list>" +.BI Conflicts: " package-list" .TP .PD 0 -.BR Provides: " <package list>" +.BI Provides: " package-list" .TP .PD 0 -.BR Built-Using: " <package list>" +.BI Built-Using: " package-list" .br These fields declare relationships between packages. They are discussed in the diff --git a/man/deb-symbols.5 b/man/deb-symbols.5 index bb5a53b..fa40280 100644 --- a/man/deb-symbols.5 +++ b/man/deb-symbols.5 @@ -10,27 +10,27 @@ symbols The format for an extended shared library dependency information entry in these files is: .PP -<library soname> <main dependency template> +.I library-soname main-dependency-template .br -[ | <alternative dependency template> ] +[ | \fIalternative-dependency-template\fP ] .br [ ... ] .br -[ * <field-name>: <field value> ] +[ * \fIfield-name\fP: \fIfield-value\fP ] .br [ ... ] - <symbol> <minimal version>[ <id of dependency template> ] + \fIsymbol\fP \fIminimal-version\fP[ \fIid-of-dependency-template\fP ] .P -The \fIlibrary soname\fR is exactly the value of the SONAME field -as exported by \fBobjdump\fR(1). A \fIdependency template\fR is a +The \fIlibrary-soname\fR is exactly the value of the SONAME field +as exported by \fBobjdump\fR(1). A \fIdependency-template\fR is a dependency where \fI#MINVER#\fR is dynamically replaced either by -a version check like "(>= \fIminimal version\fR)" or by nothing (if +a version check like "(>= \fIminimal-version\fR)" or by nothing (if an unversioned dependency is deemed sufficient). .P Each exported \fIsymbol\fR (listed as \fIname\fR@\fIversion\fR, with \fIversion\fR being "Base" if the library is not versioned) is associated -to a \fIminimal version\fR of its dependency template (the main dependency -template is used if \fIid of dependency template\fR is not present). The +to a \fIminimal-version\fR of its dependency template (the main dependency +template is used if \fIid-of-dependency-template\fR is not present). The first alternative dependency template is numbered 1, the second one 2, etc. .P diff --git a/man/dpkg-divert.8 b/man/dpkg-divert.8 index 23e5207..763c0cc 100644 --- a/man/dpkg-divert.8 +++ b/man/dpkg-divert.8 @@ -77,8 +77,8 @@ Show the version and exit. . .SH NOTES When adding, default is \fB\-\-local\fP and \fB\-\-divert\fP -\fI<original>.distrib\fP. When removing, \fB\-\-package\fP or \fB\-\-local\fP -and \fB\-\-divert\fP must match if specified. +\fIoriginal\fP\fB.distrib\fP. When removing, \fB\-\-package\fP or +\fB\-\-local\fP and \fB\-\-divert\fP must match if specified. Directories can't be diverted with \fBdpkg\-divert\fP. diff --git a/man/dpkg-maintscript-helper.1 b/man/dpkg-maintscript-helper.1 index ed268b9..6e4b2f9 100644 --- a/man/dpkg-maintscript-helper.1 +++ b/man/dpkg-maintscript-helper.1 @@ -121,8 +121,8 @@ the package, and instead of using a pre-dependency we can call the program only if we know that the required command is supported by the currently installed dpkg: .P - if dpkg-maintscript-helper supports <command>; then - dpkg-maintscript-helper <command> ... + if dpkg-maintscript-helper supports \fIcommand\fP; then + dpkg-maintscript-helper \fIcommand\fP ... fi . .SH AUTHORS diff --git a/man/dpkg-name.1 b/man/dpkg-name.1 index 41ebb67..0d95c6f 100644 --- a/man/dpkg-name.1 +++ b/man/dpkg-name.1 @@ -19,11 +19,12 @@ This manual page documents the .B dpkg\-name program which provides an easy way to rename .B Debian -packages into their full package names. A full package name consists -of \fI<package>_<version>_<architecture>.<package-type>\fP as specified in -the control file of the package. The \fI<version>\fP part of the filename +packages into their full package names. A full package name consists of +.IB package _ version _ architecture . package-type +as specified in the control file of the package. The \fIversion\fP part +of the filename consists of the upstream version information optionally followed by a -hyphen and the revision information. The \fI<package-type>\fP part comes +hyphen and the revision information. The \fIpackage-type\fP part comes from that field if present or fallbacks to \fBdeb\fP. . .SH OPTIONS @@ -43,11 +44,11 @@ Files will be moved into a subdirectory. If the directory given as argument exis the files will be moved into that directory otherwise the name of the target directory is extracted from the section field in the control part of the package. The target directory will be -`unstable/binary\-<architecture>/<section>'. If the section is +`unstable/binary\-\fIarchitecture\fP/\fIsection\fP'. If the section is not found in the control, then `no-section' is assumed, and in this case, as well as for sections `non-free' and `contrib' the target directory is -`<section>/binary\-<architecture>'. The section field isn't required so -a lot of packages will find their way to the `no\-section' area. Use +`\fIsection\fP/binary\-\fIarchitecture\fP'. The section field isn't required +so a lot of packages will find their way to the `no\-section' area. Use this option with care, it's messy. .TP .BR \-c ", " \-\-create\-dir @@ -84,7 +85,8 @@ 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 +.IB package _ version _ architecture .deb\fR.\fP +Packages renamed by dpkg\-name will follow this structure. Generally this will have no impact on how packages are installed by .BR dselect (1)/ diff --git a/man/dpkg-parsechangelog.1 b/man/dpkg-parsechangelog.1 index e6dc56c..424c61f 100644 --- a/man/dpkg-parsechangelog.1 +++ b/man/dpkg-parsechangelog.1 @@ -52,23 +52,23 @@ than one entry is requested, then most fields are taken from the latest entry, except otherwise stated: .RS .TP -.BR Source: " <pkg name>" +.BI Source: " pkg-name" .TP -.BR Version: " <version>" +.BI Version: " version" .TP -.BR Distribution: " <target distribution>" +.BI Distribution: " target-distribution" .TP -.BR Urgency: " <urgency>" +.BI Urgency: " urgency" The highest urgency of all included entries is used. .TP -.BR Maintainer: " <author>" +.BI Maintainer: " author" .TP -.BR Date: " <date>" +.BI Date: " date" .TP -.BR Closes: " <bug number>" +.BI Closes: " bug-number" The Closes fields of all included entries are merged. .TP -.BR Changes: " <changelog entries>" +.BI Changes: " changelog-entries" The text of all changelog entries is concatenated. To make this field a valid Debian control format multiline field empty lines are replaced with a single full stop and all lines diff --git a/man/dpkg.1 b/man/dpkg.1 index 3a9336f..cdbfe5e 100644 --- a/man/dpkg.1 +++ b/man/dpkg.1 @@ -218,9 +218,9 @@ will not be shown. .TP .B \-\-set\-selections Set package selections using file read from stdin. This file should be -in the format '<package> <state>', where state is one of install, hold, -deinstall or purge. Blank lines and comment lines beginning with '#' -are also permitted. +in the format '\fIpackage\fP \fIstate\fP', where state is one of +\fBinstall\fP, \fBhold\fP, \fBdeinstall\fP or \fBpurge\fP. Blank lines +and comment lines beginning with '#' are also permitted. .TP .B \-\-clear\-selections Set the requested state of every non-essential package to deinstall. @@ -246,8 +246,8 @@ than any version: \fBlt\-nl le\-nl ge\-nl gt\-nl\fP. These are provided only for compatibility with control file syntax: \fB< << <= = >= >> >\fP. .TP -.B \-\-command\-fd \fI<n>\fP -Accept a series of commands on input file descriptor \fI<n>\fP. Note: +.B \-\-command\-fd \fIn\fP +Accept a series of commands on input file descriptor \fIn\fP. Note: additional options set on the command line, and through this file descriptor, are not reset for subsequent commands executed during the same run. .TP @@ -601,13 +601,13 @@ multiple times. The output format used is the same as in \fB\-\-status\-fd. Log status change updates and actions to \fIfilename\fP, instead of the default \fI/var/log/dpkg.log\fP. If this option is given multiple times, the last filename is used. Log messages are of the form -`YYYY-MM-DD HH:MM:SS status -<state> <pkg> <installed-version>' for status change updates; -`YYYY-MM-DD HH:MM:SS <action> <pkg> <installed-version> -<available-version>' for actions where \fI<action>\fP is one of install, -upgrade, remove, purge; and `YYYY-MM-DD HH:MM:SS conffile <filename> -<decision>' for conffile changes where \fI<decision>\fP is either install -or keep. +`YYYY-MM-DD HH:MM:SS status \fIstate\fP \fIpkg\fP \fIinstalled-version\fP' +for status change updates; +`YYYY-MM-DD HH:MM:SS \fIaction\fP \fIpkg\fP \fIinstalled-version\fP +\fIavailable-version\fP' for actions where \fIaction\fP is one of +\fBinstall\fP, \fBupgrade\fP, \fBremove\fP, \fBpurge\fP; and +`YYYY-MM-DD HH:MM:SS conffile \fIfilename\fP \fIdecision\fP' for conffile +changes where \fIdecision\fP is either \fBinstall\fP or \fBkeep\fP. .TP \fB\-\-no\-debsig\fP Do not try to verify package signatures. diff --git a/man/dselect.1 b/man/dselect.1 index 0b88e26..be53acb 100644 --- a/man/dselect.1 +++ b/man/dselect.1 @@ -42,13 +42,13 @@ command line option but without leading dashes) or a comment (if it starts with a \fB#\fR). .br .TP -.BI \-\-admindir " <directory>" +.BI \-\-admindir " directory" Changes the directory where the dpkg `\fIstatus\fP', `\fIavailable\fP' and similar files are located. This defaults to \fI/var/lib/dpkg\fP and normally there shouldn't be any need to change it. .TP -.BI \-\-debug " <file> \fR|\fP " \-D <file> -Turn on debugging. Debugging information is sent to \fI<file>\fP. +.BI \-\-debug " file \fR|\fP " \-D file +Turn on debugging. Debugging information is sent to \fIfile\fP. .TP .B \-\-expert Turns on expert mode, i.e. doesn't display possibly annoying help diff --git a/man/update-alternatives.8 b/man/update-alternatives.8 index abf87cc..5836b91 100644 --- a/man/update-alternatives.8 +++ b/man/update-alternatives.8 @@ -386,30 +386,30 @@ RFC822-like flat format. It's made of \fIn\fP + 1 blocks where \fIn\fP is the number of alternatives available in the queried link group. The first block contains the following fields: .TP -.BR Link: " <link>" +.BI Link: " link" The generic name of the alternative. .TP -.BR Status: " <status>" +.BI Status: " status" The status of the alternative (\fBauto\fR or \fBmanual\fR). .TP -.BR Best: " <best choice>" +.BI Best: " best-choice" The path of the best alternative for this link group. Not present if there is no alternatives available. .TP -.BR Value: " <currently selected alternative> " +.BI Value: " currently-selected-alternative" The path of the currently selected alternative. It can also take the magic value \fBnone\fR. It is used if the link doesn't exist. .TP .TP The other blocks describe the available alternatives in the queried link group: .TP -.BR Alternative: " <path of this alternative>" +.BI Alternative: " path-of-this-alternative" Path to this block's alternative. .TP -.BR Priority: " <priority value>" +.BI Priority: " priority-value" Value of the priority of this alternative. .TP -.BR Slaves: " <list of slaves>" +.BI Slaves: " list-of-slaves" When this header is present, the \fBnext\fR lines hold all slave alternatives associated to the master link of the alternative. There is one slave per line. Each line contains one space, the generic name of the slave -- dpkg's main repository -- To UNSUBSCRIBE, email to debian-dpkg-cvs-requ...@lists.debian.org with a subject of "unsubscribe". Trouble? Contact listmas...@lists.debian.org