Selaa lähdekoodia

man: Correctly format text with bold and italics

Guillem Jover 15 vuotta sitten
vanhempi
commit
2825370120

+ 1 - 0
debian/changelog

@@ -129,6 +129,7 @@ dpkg (1.16.1) UNRELEASED; urgency=low
       dpkg-query(1).
     - Use [option...] instead of [options] and friends.
     - Use italics or bold instead of surrounding the text with <>.
+    - Correctly format text with bold and italics.
   * 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.
 

+ 13 - 12
man/deb-control.5

@@ -70,7 +70,7 @@ A list of these values can be obtained from the latest version of the
 package.
 .TP
 .BR Essential: " \fByes\fP|\fBno\fP"
-This field is usually only needed when the answer is `yes'. It denotes
+This field is usually only needed when the answer is \fByes\fP. 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
@@ -88,12 +88,12 @@ of this are shell and Perl scripts, and documentation.
 The name of the distribution this package is originating from.
 .TP
 .BI Bugs: " url"
-The url of the bug tracking system for this package. The current used format
-is \fIbts-type\fP\fB://\fP\fIbts-address\fP, like
+The \fIurl\fP of the bug tracking system for this package. The current
+used format is \fIbts-type\fP\fB://\fP\fIbts-address\fP, like
 \fBdebbugs://bugs.debian.org\fP.
 .TP
 .BI Homepage: " url"
-The upstream project home page URL.
+The upstream project home page \fIurl\fP.
 .TP
 .BI Tag: " tag-list"
 List of tags describing the qualities of the package. The description and
@@ -101,14 +101,15 @@ list of supported tags can be found in the \fBdebtags\fP package.
 .TP
 .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
-different architecture from itself. The value `foreign' means that the package is
-not co-installable with itself, but should be allowed to satisfy the dependency
-of a package of a different arch from itself. The value `allowed` allows
-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.
+installations. The value \fBsame\fP means that the package is co-installable
+with itself, but it must not be used to satisfy the dependency of any package
+of a different architecture from itself. The value \fBforeign\fP means that
+the package is not co-installable with itself, but should be allowed to
+satisfy the dependency of a package of a different arch from itself. The
+value \fBallowed\fP allows 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 \fBArchitecture: all\fP field.
 .TP
 .BI Source: " source-name"
 The name of the source package that this binary package came from, if

+ 1 - 1
man/deb-shlibs.5

@@ -27,7 +27,7 @@ entry per line. Blank lines are \fBnot\fP allowed.  Lines beginning
 with an \fB#\fP character are considered commentary, and are ignored.
 All other lines must have the format
 .IP
-.RI [ type: ]
+.RI [ type\fB:\fP ]
 .I library
 .I version
 .I dependencies

+ 4 - 4
man/deb-split.5

@@ -1,4 +1,4 @@
-.TH deb\-split 5 "2011-04-15" "Debian Project" "Debian"
+.TH deb\-split 5 "2011-07-04" "Debian Project" "Debian"
 .SH NAME
 deb\-split \- Debian multi-part binary package format
 .SH SYNOPSIS
@@ -39,11 +39,11 @@ and the program should stop. If it has not, then the program should
 be able to safely continue, unless it encounters an unexpected member
 in the archive (except at the end), as described below.
 .PP
-The second, last required member is named \fBdata.\fPN, where N denotes
-the part number. It contains the raw part data.
+The second, last required member is named \fBdata.\fP\fIN\fP, where \fIN\fP
+denotes the part number. It contains the raw part data.
 .PP
 These members must occur in this exact order. Current implementations
-should ignore any additional members after \fBdata.\fPN.
+should ignore any additional members after \fBdata.\fP\fIN\fP.
 Further members may be defined in the future, and (if possible) will be
 placed after these two.
 .SH SEE ALSO

+ 13 - 11
man/deb-src-control.5

@@ -65,20 +65,22 @@ The upstream project home page URL.
 
 .TP
 .BI Bugs: " url"
-The url of the bug tracking system for this package. The current used format
-is \fIbts-type\fP\fB://\fP\fIbts-address\fP, like
+The \fIurl\fP of the bug tracking system for this package. The current
+used format is \fIbts-type\fP\fB://\fP\fIbts-address\fP, like
 \fBdebbugs://bugs.debian.org\fP. This field is usually not needed.
 
 .TP
 .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.
+The \fIurl\fP of the Version Control System repository used to maintain this
+package. Currently supported are \fBArch\fP, \fBBzr\fP (Bazaar), \fBCvs\fP,
+\fBDarcs\fP, \fBGit\fP, \fBHg\fP (Mercurial), \fBMtn\fP (Monotone) and
+\fBSvn\fP (Subversion). Usually this field points to the latest version
+of the package, such as the main branch or the trunk.
 
 .TP
 .BI Vcs\-Browser: " url"
-The url of a webinterface to browse the Version Control System repository.
+The \fIurl\fP of a webinterface to browse the Version Control System
+repository.
 
 .TP
 .BI Origin: " name"
@@ -119,8 +121,8 @@ the source package.
 
 .TP
 .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
+Same as \fBBuild\-Depends\fP, but they are only needed when building the
+architecture independent packages. The \fBBuild\-Depends\fP are also installed
 in this case.
 
 .TP
@@ -130,8 +132,8 @@ example because they interfere with the used build system.
 
 .TP
 .BI Build\-Conflicts\-Indep: " package-list"
-Same as Build\-Conflicts, but only when building the architecture independent
-packages.
+Same as \fBBuild\-Conflicts\fP, but only when building the architecture
+independent packages.
 
 The syntax of the
 .B Build\-Depends

+ 1 - 1
man/deb-symbols.5

@@ -38,7 +38,7 @@ Each entry for a library can also have some fields of meta-information.
 Those fields are stored on lines starting with an asterisk. Currently,
 the only valid field is \fIBuild-Depends-Package\fR, it indicates the name
 of the "\-dev" package associated to the library and is used by
-dpkg-shlibdeps to make sure that the dependency generated is at least as
+\fBdpkg-shlibdeps\fP to make sure that the dependency generated is at least as
 strict as the corresponding build dependency.
 .SH EXAMPLES
 .SS Simple symbols file

+ 1 - 1
man/deb-version.5

@@ -7,7 +7,7 @@
 deb\-version \- Debian package version number format
 .
 .SH SYNOPSIS
-.RI "[ " epoch ":] " upstream-version " [\-" debian-revision " ]"
+.RI "[" epoch "\fB:\fP]" upstream-version "[\fB\-\fP" debian-revision "]"
 .SH DESCRIPTION
 Version numbers as used for Debian binary and source packages
 consist of three components. These are:

+ 1 - 1
man/dpkg-architecture.1

@@ -284,7 +284,7 @@ dpkg\-architecture \-ai386 \-ilinux\-any
 .SH FILES
 All these files have to be present for \fBdpkg-architecture\fP to
 work. Their location can be overridden at runtime with the environment
-variable DPKG_DATADIR.
+variable \fBDPKG_DATADIR\fP.
 .TP
 .I /usr/share/dpkg/cputable
 Table of known CPU names and mapping to their GNU name.

+ 1 - 1
man/dpkg-checkbuilddeps.1

@@ -12,7 +12,7 @@ This program checks the installed packages in the system against the build
 dependencies and build conflicts listed in the control file. If any are
 not met, it displays them and exits with a nonzero return code.
 .P
-By default, \fIdebian/control\fR is read, but an alternate control filename
+By default, \fBdebian/control\fR is read, but an alternate control filename
 may be specified on the command line.
 .
 .SH OPTIONS

+ 1 - 1
man/dpkg-divert.8

@@ -116,7 +116,7 @@ If set and the \fB\-\-admindir\fP option has not been specified, it will
 be used as the dpkg data directory.
 .TP
 .B DPKG_MAINTSCRIPT_PACKAGE
-If set and the \fI\-\-local\fP and \fI\-\-package\fP options have not been
+If set and the \fB\-\-local\fP and \fB\-\-package\fP options have not been
 specified, \fBdpkg\-divert\fP will use it as the package name.
 .
 .SH FILES

+ 3 - 3
man/dpkg-maintscript-helper.1

@@ -4,7 +4,7 @@ dpkg\-maintscript\-helper \- works around known dpkg limitations in maintainer s
 .
 .SH SYNOPSIS
 .B dpkg\-maintscript\-helper
-.IR command " [" parameter "...] \-\- " maint-script-parameter ...
+.IR command " [" parameter "...] \fB\-\-\fP " maint-script-parameter ...
 .
 .SH COMMANDS AND PARAMETERS
 .P
@@ -22,7 +22,7 @@ Many of those tasks require coordinated actions from several maintainer
 scripts (\fBpreinst\fP, \fBpostinst\fP, \fBprerm\fP, \fBpostrm\fP). To
 avoid mistakes the same call simply needs to be put in all scripts and the
 program will automatically adapt its behaviour based on the environment
-variable DPKG_MAINTSCRIPT_NAME and on the maintainer scripts arguments
+variable \fBDPKG_MAINTSCRIPT_NAME\fP and on the maintainer scripts arguments
 that you have to forward after a double dash.
 .
 .SH CONFFILE RELATED TASKS
@@ -114,7 +114,7 @@ required version of dpkg has been unpacked before. The required version
 depends on the command used, for \fBrm_conffile\fP and \fBmv_conffile\fP
 it is 1.15.7.2:
 .P
-    Pre-Depends: dpkg (>= 1.15.7.2)
+    \fBPre-Depends:\fP dpkg (>= 1.15.7.2)
 .P
 But in many cases the operation done by the program is not critical for
 the package, and instead of using a pre-dependency we can call the

+ 1 - 2
man/dpkg-name.1

@@ -89,8 +89,7 @@ Some packages don't follow the name structure
 Packages renamed by dpkg\-name
 will follow this structure. Generally this will have no impact on how
 packages are installed by
-.BR dselect (1)/
-.BR dpkg (1),
+.BR dselect (1)/ dpkg (1),
 but other installation tools
 might depend on this naming structure.
 .

+ 1 - 1
man/dpkg-shlibdeps.1

@@ -17,7 +17,7 @@ as variable names
 where
 .I dependencyfield
 is a dependency field name. Any other variables starting with
-.I shlibs:
+.B shlibs:
 are removed from the file.
 .P
 .B dpkg\-shlibdeps

+ 2 - 2
man/dpkg-split.1

@@ -98,8 +98,8 @@ If
 .I part
 is not a split binary package part then
 .B dpkg\-split
-will exit with status 1; if some other trouble occurs then it will
-exit with status 2.
+will exit with status \fB1\fP; if some other trouble occurs then it will
+exit with status \fB2\fP.
 
 The
 .BR \-\-output " or " \-o

+ 4 - 4
man/dpkg-trigger.1

@@ -25,9 +25,9 @@ Unrecognised trigger name syntaxes are an error for \fBdpkg\-trigger\fP.
 .TP
 .BR \-\-check\-supported
 Check if the running \fBdpkg\fP supports triggers (usually called from a
-postinst). Will exit 0 if a triggers-capable \fBdpkg\fP has run, or 1 with
-an error message to stderr if not. Normally, however, it is better just to
-activate the desired trigger with \fBdpkg\-trigger\fP.
+postinst). Will exit \fB0\fP if a triggers-capable \fBdpkg\fP has run,
+or \fB1\fP with an error message to stderr if not. Normally, however,
+it is better just to activate the desired trigger with \fBdpkg\-trigger\fP.
 .TP
 .BR \-h ", " \-\-help
 Show the usage message and exit.
@@ -43,7 +43,7 @@ Change the location of the \fBdpkg\fR database. The default location is
 .TP
 .BR \-\-by\-package=\fIpackage\fR
 Override trigger awaiter (normally set by \fBdpkg\fP through the
-DPKG_MAINTSCRIPT_PACKAGE environment variable of the maintainer scripts,
+\fBDPKG_MAINTSCRIPT_PACKAGE\fP environment variable of the maintainer scripts,
 naming the package to which the script belongs, and this will be used
 by default).
 .TP

+ 4 - 4
man/dpkg-vendor.1

@@ -1,4 +1,4 @@
-.TH dpkg\-vendor 1 "2009-05-10" "Debian Project" "dpkg suite"
+.TH dpkg\-vendor 1 "2011-07-04" "Debian Project" "dpkg suite"
 .SH NAME
 dpkg\-vendor \- queries information about distribution vendors
 .
@@ -14,11 +14,11 @@ information about the current vendor.
 .SH COMMANDS
 .TP
 .BI \-\-is " vendor"
-Exits with 0 if the current vendor is \fIvendor\fP. Otherwise exits
+Exits with \fB0\fP if the current vendor is \fIvendor\fP. Otherwise exits
 with non-zero.
 .TP
 .BI \-\-derives\-from " vendor"
-Exits with 0 if the current vendor distribution is a derivative of
+Exits with \fB0\fP if the current vendor distribution is a derivative of
 \fIvendor\fP, otherwise exits with non-zero. It uses the "Parent" field
 to browse all ancestors of the current vendor.
 .TP
@@ -36,7 +36,7 @@ Show the version and exit.
 .TP
 .BI \-\-vendor " vendor"
 Assumes the current vendor is \fIvendor\fP instead of discovering it
-with the DEB_VENDOR environment variable or
+with the \fBDEB_VENDOR\fP environment variable or
 \fB/etc/dpkg/origins/default\fP.
 .
 .SH ENVIRONMENT

+ 8 - 8
man/update-alternatives.8

@@ -115,7 +115,7 @@ the alternatives pointed to by members of the group
 will be those which have the highest priority.
 .PP
 When using the
-.I \-\-config
+.B \-\-config
 option,
 .B update\-alternatives
 will list all of the choices for the link group
@@ -126,13 +126,13 @@ You will then be prompted for your choice regarding this link group.
 Depending on the choice made, the link group might no longer be in
 .I auto
 mode. You will need to use the
-.I \-\-auto
+.B \-\-auto
 option in order to return to the automatic mode (or you can rerun
-.I \-\-config
+.B \-\-config
 and select the entry marked as automatic).
 .PP
 If you want to configure non-interactively you can use the
-.I \-\-set
+.B \-\-set
 option instead (see below).
 .PP
 Different packages providing the same file need to do so
@@ -237,7 +237,7 @@ Set the program
 as alternative for
 .I name.
 This is equivalent to
-.IB \-\-config
+.B \-\-config
 but is non-interactive and thus scriptable.
 .TP
 \fB\-\-remove\fR \fIname path\fR
@@ -381,7 +381,7 @@ Problems were encountered whilst parsing the command line
 or performing the action.
 .
 .SH "QUERY FORMAT"
-The \fBupdate\-alternatives\fP \fI\-\-query\fP format is using an
+The \fBupdate\-alternatives \-\-query\fP format is using an
 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:
@@ -446,7 +446,7 @@ Slaves:
 .fi
 .
 .SH DIAGNOSTICS
-With \fI\-\-verbose\fR
+With \fB\-\-verbose\fR
 .B update\-alternatives
 chatters incessantly about its activities on its standard output channel.
 If problems occur,
@@ -463,7 +463,7 @@ is controlled by the link group \fBvi\fP, which includes links for the
 program itself and the associated manpage.
 .PP
 To display the available packages which provide \fBvi\fP and the current
-setting for it, use the \fI\-\-display\fP action:
+setting for it, use the \fB\-\-display\fP action:
 .RS
 .PP
 .B update\-alternatives \-\-display vi