[Quilt-dev] [patch v2 11/26] Man page: italicize work titles

[Jean Delvare]

...including names of software projects (such as quilt itself).
---
 doc/quilt.1.in |  159 ++++++++++++++++++++++++++++++++++++++-------------------
 1 file changed, 107 insertions(+), 52 deletions(-)

--- quilt.orig/doc/quilt.1.in   2022-07-05 21:48:55.830820200 +0200
+++ quilt/doc/quilt.1.in        2022-07-05 21:48:58.203853864 +0200
@@ -20,22 +20,31 @@ quilt \\- tool to manage series of patch
 .YS
 .
 .SH DESCRIPTION
-Quilt is a tool to manage large sets of patches by keeping track of the
+.I Quilt
+is a tool to manage large sets of patches by keeping track of the
 changes each patch makes.
 Patches can be applied, un-applied, refreshed, etc.
 The key philosophical concept is that your primary output is patches.
 .PP
-With quilt, all work occurs within a single directory tree.
+With
+.IR quilt ,
+all work occurs within a single directory tree.
 Commands can be invoked from anywhere within the source tree.
 They are of the form
 .B quilt cmd
-similar to CVS, svn or git commands.
+similar to
+.IR CVS ,
+.IR Subversion ,
+or
+.I Git
+commands.
 They can be abbreviated as long as the specified part of the command is
 unique.
 All commands print some help text with
 .B quilt cmd \\-h.
 .PP
-Quilt manages a stack of patches.
+.I Quilt
+manages a stack of patches.
 Patches are applied incrementally on top of the base tree plus all
 preceding patches.
 They can be pushed on top of the stack
@@ -58,7 +67,7 @@ The
 environment variable can be used to override this location.
 When not found in the current directory, that subdirectory is searched
 recursively in the parent directories (this is similar to the way
-.I git
+.I Git
 searches for its configuration files).
 The
 .I patches
@@ -86,10 +95,14 @@ them is used.
 Without options, strip level 1 is assumed.
 You can also add a comment after each patch file name and options,
 introduced by a space followed by a hash character.
-When quilt adds, removes, or renames patches, it automatically updates
-the series file.
-Users of quilt can modify series files while some patches are
-applied, as long as the applied patches remain in their original order.
+When
+.I quilt
+adds, removes, or renames patches, it automatically updates the series
+file.
+Users of
+.I quilt
+can modify series files while some patches are applied, as long as the
+applied patches remain in their original order.
 .PP
 Different series files can be used to assemble patches in different
 ways, corresponding for example to different development branches.
@@ -105,12 +118,14 @@ Later when a patch is regenerated
 the backup copies in
 .RI .pc/ patch
 are compared with the current versions of the files in the source tree
-using GNU diff.
+using GNU
+.IR diff .
 .PP
 Documentation related to a patch can be put at the beginning of a patch
 file.
-Quilt is careful to preserve all text that precedes the actual patch
-when doing a refresh.
+.I Quilt
+is careful to preserve all text that precedes the actual patch when
+doing a refresh.
 (This is limited to patches in unified format; see
 .B diff
 documentation).
@@ -145,8 +160,9 @@ For internal debugging.
 Use the specified configuration file instead of \\[ti]/.quiltrc (or
 /etc/quilt.quiltrc if \\[ti]/.quiltrc does not exist).
 See the pdf documentation for details about its possible contents.
-The special value \\[lq]\\-\\[rq] causes quilt not to read any
-configuration file.
+The special value \\[lq]\\-\\[rq] causes
+.I quilt
+not to read any configuration file.
 .TP
 .B \\-\\-version
 Print the version number and exit immediately.
@@ -155,14 +171,18 @@ Print the version number and exit immedi
 The exit status is 0 if the sub-command was successfully executed, and
 1 in case of error.
 .PP
-An exit status of 2 denotes that quilt did not do anything to complete
-the command.
+An exit status of 2 denotes that
+.I quilt
+did not do anything to complete the command.
 This happens in particular when asking to push when the whole stack is
 already pushed, or asking to pop when the whole stack is already popped.
-This behavior is intended to ease the scripting around quilt.
+This behavior is intended to ease the scripting around
+.IR quilt .
 .
 .SH ENVIRONMENT
-In addition to that, quilt recognizes the following variables:
+In addition to that,
+.I quilt
+recognizes the following variables:
 .IP EDITOR 4
 The program to run to edit files.
 If it isn't redefined in the configuration file, $EDITOR as defined in
@@ -203,9 +223,11 @@ content of the patches/ directory (provi
 regenerated before the removal).
 .
 .SS "Configuration file"
-Upon startup, quilt evaluates the file .quiltrc in the user's home
-directory, /etc/quilt.quiltrc if the former file does not exist, or
-the file specified with the \\-\\-quiltrc option.
+Upon startup,
+.I quilt
+evaluates the file .quiltrc in the user's home directory, /etc/quilt.quiltrc
+if the former file does not exist, or the file specified with the
+\\-\\-quiltrc option.
 This file is a regular bash script.
 Default options can be passed to any COMMAND by defining a
 QUILT_${COMMAND}_ARGS variable.
@@ -214,37 +236,61 @@ output of \\[lq]quilt diff\\[rq] to be s
 terminal.
 .PP
 .IP QUILT_DIFF_OPTS 4
-Additional options that quilt shall pass to GNU diff when generating
-patches.
+Additional options that
+.I quilt
+shall pass to GNU
+.I diff
+when generating patches.
 A useful setting for C source code is \\[lq]\\-p\\[rq], which causes GNU
-diff to show in the resulting patch which function a change is in.
+.I diff
+to show in the resulting patch which function a change is in.
 .IP QUILT_PATCH_OPTS 4
-Additional options that quilt shall pass to GNU patch when applying
-patches.
-For example, recent versions of GNU patch support the
-\\[lq]\\-\\-reject\\-format=unified\\[rq] option for generating reject
-files in \\[lq]unified diff\\[rq] style (older patch versions used
-\\[lq]\\-\\-unified\\-reject\\-files\\[rq] for that).
+Additional options that
+.I quilt
+shall pass to GNU
+.I patch
+when applying patches.
+For example, recent versions of GNU
+.I patch
+support the \\[lq]\\-\\-reject\\-format=unified\\[rq] option for
+generating reject files in \\[lq]unified diff\\[rq] style (older
+.I patch
+versions used \\[lq]\\-\\-unified\\-reject\\-files\\[rq] for that).
 .IP
 You may also want to add the \\[lq]\\-E\\[rq] option if you have issues
-with quilt not deleting empty files when you think it should.
-The documentation of GNU patch says that \\[lq]normally this option is
-unnecessary\\[rq], but when patch is in POSIX mode or if the patch
-format doesn't allow to distinguish empty files from deleted files,
-patch deletes empty files only if the \\[lq]\\-E\\[rq] option is given.
-Beware that when passing \\[lq]\\-E\\[rq] to patch, quilt will no longer
-be able to deal with empty files, which is why using \\[lq]\\-E\\[rq] is
-no longer the default.
+with
+.I quilt
+not deleting empty files when you think it should.
+The documentation of GNU
+.I patch
+says that \\[lq]normally this option is unnecessary\\[rq], but when
+.I patch
+is in POSIX mode or if the patch format doesn't allow to distinguish
+empty files from deleted files,
+.I patch
+deletes empty files only if the \\[lq]\\-E\\[rq] option is given.
+Beware that when passing \\[lq]\\-E\\[rq] to
+.IR patch ,
+.I quilt
+will no longer be able to deal with empty files, which is why using
+\\[lq]\\-E\\[rq] is no longer the default.
 .IP QUILT_DIFFSTAT_OPTS 4
-Additional options that quilt shall pass to diffstat when generating
-patch statistics.
+Additional options that
+.I quilt
+shall pass to
+.I diffstat
+when generating patch statistics.
 For example, \\[lq]\\-f0\\[rq] can be used for an alternative output
 format.
-Recent versions of diffstat also support alternative rounding methods
-(\\[lq]\\-r1\\[rq], \\[lq]\\-r2\\[rq]).
+Recent versions of
+.I diffstat
+also support alternative rounding methods (\\[lq]\\-r1\\[rq],
+\\[lq]\\-r2\\[rq]).
 .IP QUILT_PC 4
 The location of backup files and any other data relating to the current
-state of the working directory from quilt's perspective.
+state of the working directory from
+.IR quilt 's
+perspective.
 Defaults to \\[lq].pc\\[rq].
 .IP QUILT_PATCHES 4
 The location of patch files, defaulting to \\[lq]patches\\[rq].
@@ -253,27 +299,35 @@ The name of the series file, defaulting
 Unless an absolute path is used, the search algorithm described above
 applies.
 .IP QUILT_PATCHES_PREFIX 4
-If set to anything, quilt will prefix patch names it prints with their
+If set to anything,
+.I quilt
+will prefix patch names it prints with their
 directory (QUILT_PATCHES).
 .IP QUILT_NO_DIFF_INDEX 4
-By default, quilt prepends an \\[lq]Index:\\[rq] line to the patches it
-generates.
+By default,
+.I quilt
+prepends an \\[lq]Index:\\[rq] line to the patches it generates.
 If this variable is set to anything, no line is prepended.
 This is a shortcut to adding \\-\\-no\\-index to both QUILT_DIFF_ARGS
 and QUILT_REFRESH_ARGS.
 .IP QUILT_NO_DIFF_TIMESTAMPS 4
-By default, quilt includes timestamps in headers when generating
-patches.
+By default,
+.I quilt
+includes timestamps in headers when generating patches.
 If this variable is set to anything, no timestamp will be included.
 This is a shortcut to adding \\-\\-no\\-timestamps to both
 QUILT_DIFF_ARGS and QUILT_REFRESH_ARGS.
 .IP QUILT_PAGER 4
-The pager quilt shall use for commands which produce paginated output.
+The pager
+.I quilt
+shall use for commands which produce paginated output.
 If unset, the values of GIT_PAGER or PAGER is used.
 If none of these variables is set, \\[lq]less \\-R\\[rq] is used.
 An empty value indicates that no pager should be used.
 .IP QUILT_COLORS 4
-By default, quilt uses its predefined color set in order to be more
+By default,
+.I quilt
+uses its predefined color set in order to be more
 comprehensible when distiguishing various types of patches, e.g.,
 applied/unapplied, failed, etc.
 .IP
@@ -362,8 +416,9 @@ QUILT_COLORS='diff_hdr=35;44'
 .EE
 .
 .SH AUTHORS
-Quilt started as a series of scripts written by Andrew Morton
-(patch\\-scripts).
+.I Quilt
+started as a series of scripts written by Andrew Morton
+.RI ( patch\\-scripts ).
 Based on Andrew's ideas, Andreas Gruenbacher completely rewrote the
 scripts, with the help of several other contributors (see AUTHORS file
 in the distribution).