[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[groff] 02/02: doc/ Fix style nits.

From: G. Branden Robinson
Subject: [groff] 02/02: doc/ Fix style nits.
Date: Sun, 19 Jan 2020 08:28:24 -0500 (EST)

gbranden pushed a commit to branch master
in repository groff.

commit 4d4a24c1d663eec107bdd130b267f30d23ee73df
Author: G. Branden Robinson <address@hidden>
AuthorDate: Sun Jan 19 23:49:28 2020 +1100

    doc/ Fix style nits.
    * The correct way to refer to a groff release in running text is, e.g.,
      "groff 1.22.4".  Dashes and underscores are introduced as elements of
      filenames for better ergonomics with the many languages that use
      whitespace for separation of lexical elements.  TL;DR: s/-/\\~/
    * Use \[>=] character escape instead of ">=".
    * Escape hyphens in Debian package names, filenames, URLs, code
      examples, and long option names even when they're not word-initial.
    * Mark up syntax descriptions properly instead of putting everything in
      undifferentiated bold.  Literals are in bold, parameters are in
      italics, and syntactical meta-elements (I don't have a good name for
      these...) are in roman.  I.e., don't bold your ellipses unless you
      mean for people to type "..." literally.
    * Convert some instances of \f font escapes to ms macros.  (I may come
      back later with a machete for the others.)  This is not a raw roff
    * Recast phrases referring to groff unit quantities.  This somewhat
      reverts a couple of Bjarni's changes.  It is more conventional in
      English prose to pair a number with its unit abbreviation first, then
      expand the abbreviation using a parenthetical word or phrase
      afterwards--e.g., "150 ft·lb/sec (foot-pounds per second)".
    * Set references to man pages as man pages do: italics followed a
      parenthesized section number in roman, with no intervening whitespace.
      (The question of italics vs. bold is contested, but the absence of
      whitespace is not.)
    * Set tildes in character escape names as full-size tildes with \[ti],
      instead of playing around with the font size.  This carries one of
      Bjarni's fixes farther than he did.  The context of the characters in
      a *roff character escape is that of keycaps that appear on a keyboard.
      The output context is not relevant.  On keyboards we do not have
      separate keys for a spacing tilde on the centerline and a small,
      elevated tilde used as a combining character.
    * Use \~ between a numerical quantity and an immediately subsequent
      unit, e.g., "10\~points".
 doc/ | 157 ++++++++++++++++++++++++++++++++++++++-------------------
 1 file changed, 105 insertions(+), 52 deletions(-)

diff --git a/doc/ b/doc/
index ca1b9bb..e375531 100644
--- a/doc/
+++ b/doc/
@@ -106,7 +106,7 @@ is now maintained by the team at
 \s[-2]\f[I]This document was produced using
-.URL http://\\:software/\:groff groff-\n[.x].\n[.y].\n[.Y] .
+.URL http://\\:software/\:groff groff\~\n[.x].\n[.y].\n[.Y] .
 The image at the top has been contributed by Imogen Mulley,
 based on a similar picture found on the
@@ -179,7 +179,7 @@ following tools to build `groff' directly from its source:
 .in 2m
-perl >= v5.6.1 (see macro GROFF_PERL in file `m4/groff.m4')
+perl \[>=] v5.6.1 (see macro GROFF_PERL in file `m4/groff.m4')
 the psutils package
 the netpbm package
@@ -211,7 +211,7 @@ The `groff' configure script searches for the X11 headers 
and libraries
 `Xaw' and `Xmu'.
 So the corresponding developer packages of your system must be installed,
 otherwise `groff' does not install `gxditview' and the `\-TX*' devices.
-In Debian, the developer packages are `libxaw7-dev' and `libxmu-dev'.
+In Debian, the developer packages are `libxaw7\-dev' and `libxmu\-dev'.
@@ -220,9 +220,9 @@ Bug reports
 Please report bugs using the project's
 .URL https://\\:projects/\:groff "bug tracker" .
-You may use the form in the file `BUG-REPORT'; the idea of this is to
+You may use the form in the file `BUG\-REPORT'; the idea of this is to
 make sure that FSF has all the information it needs to fix the bug.
-At the very least, read the `BUG-REPORT' form and make sure that you supply
+At the very least, read the `BUG\-REPORT' form and make sure that you supply
 all the information that it asks for.
 Even if you are not sure that something is a bug, report it:
 this enables us to determine whether it really is a bug.
@@ -247,7 +247,7 @@ for general discussion of groff; and
 a read-only list showing commits to the git repository.
-To subscribe, send a mail to \[la]list\[ra]-request@\[la]domain\[ra]
+To subscribe, send a mail to \[la]list\[ra]\-request@\[la]domain\[ra]
 .MTO groff\-request@\
 for the `groff' list) with the word `subscribe' in either the
@@ -256,9 +256,9 @@ Alternatively, you may subscribe by visiting the web pages 
 .in 2m
@@ -275,8 +275,8 @@ gxditview
 X11 resources for gxditview, which were previously installed in
-/usr/X11/lib/X11/app-defaults no matter which `prefix' was set, are
-now installed in appresdir=$prefix/lib/X11/app-defaults.
+/usr/X11/lib/X11/app\-defaults no matter which `prefix' was set, are
+now installed in appresdir=$prefix/lib/X11/app\-defaults.
 If `appresdir' is not a standard X11 resource directory, the environment
 variable XFILESEARCHPATH should be set to this path.
 The standard default directories depends on the system `libXt'.
@@ -284,9 +284,9 @@ Common directories include:
 .in 2m
@@ -338,7 +338,7 @@ option by default, unless a request similar to:
 .in 2m
-\&.if !\en[PHASE] .tm pdfroff-option:set toc_relocation=enabled
+\&.if !\en[PHASE] .tm pdfroff\-option:set toc_relocation=enabled
@@ -448,7 +448,7 @@ Line numbering support has been improved.
 The \-mom macro package has reached version 2.0, focusing on PDF output
 with gropdf (using the new `pdfmom' wrapper script).
-See the file `version-2.html' of the \-mom documentation for a list of the
+See the file `version\-2.html' of the \-mom documentation for a list of the
 many changes.
@@ -814,7 +814,7 @@ Support for keyboard navigation has been improved.
 Similar to other X11 applications, there are now two resource files,
-`GXditview' and `GXditview-color'.
+`GXditview' and `GXditview\-color'.
@@ -1003,18 +1003,32 @@ eqn
 The following keywords aren't new but haven't been documented previously:
 .in 2m
-\fBundef NAME\fP (to undefine a macro)
+.B undef
+.I name
+(to undefine a macro)
-\fBcopy "FILE"\fP (a synonym for `include')
+.I file \[dq] \[dq]
+a synonym for `include')
-\fBspace n\fP (to modify the vertical spacing before and after an equation)
+.B space
+.I n
+(to modify the vertical spacing before and after an equation)
 The following macros aren't new but haven't been documented previously:
 .in 2m
-\fBAlpha, .\|.\|., Omega\fP (the same as `ALPHA', .\|.\|., `OMEGA')
+.B Alpha ,
+.B Omega
+(the same as
 \fBldots\fP (three dots on the base line)
@@ -1026,24 +1040,56 @@ The following keywords have been extended.
 Again, this isn't new but hasn't been documented previously:
 .in 2m
-.ft B
-col n { .\|.\|. }
+.B col
+.I n
+.B {
+.B }
-lcol n { .\|.\|. }
+.B lcol
+.I n
+.B {
+.B }
-rcol n { .\|.\|. }
+.B rcol
+.I n
+.B {
+.B }
-ccol n { .\|.\|. }
+.B ccol
+.I n
+.B {
+.B }
-pile n { .\|.\|. }
+.B pile
+.I n
+.B {
+.B }
-lpile n { .\|.\|. }
+.B lpile
+.I n
+.B {
+.B }
-rpile n { .\|.\|. }
+.B rpile
+.I n
+.B {
+.B }
-cpile n { .\|.\|. }
-.ft P
-(set vertical spacing between rows to\~N)
+.B cpile
+.I n
+.B {
+.B }
+The above all set the vertical spacing between rows to\~\c
+.I n ).
@@ -1162,9 +1208,9 @@ same point size as body text.
 Sets the point size increment for each level of heading (set with
 `NH'), below the threshold level set by `GROWPS'; e.g., if
 \en[PS]\~=\~10, \en[GROWPS]\~=\~3 and \en[PSINCR]\~=\~2.0p, then `.NH\~1'
-produces 14 points (p) headings, `.NH\~2' produces 12 points,
+produces 14-point headings, `.NH\~2' produces 12-point,
 and all other levels
-remain at 10 points (because \en[PS]\~=\~10).
+remain at 10\~points (because \en[PS]\~=\~10).
 The `SH' macro now accepts a numeric argument, to make heading size
@@ -1353,7 +1399,8 @@ grolj4
-A new man page `\fBlj4_font\fP (5)'
+A new man page
+.I lj4_font (5)
 documents how fonts are accessed with
@@ -1396,9 +1443,9 @@ the old single script style.
-New options: \-\-text (\-\-mode\~text), \-\-tty-viewer, \-\-X (\-\-mode\~X),
-\-\-X-viewer, \-\-html (\-\-mode\~html), \-\-html-view, \-\-apropos-data,
-\-\-apropos-devel, \-\-apropos-progs.
+New options: \-\-text (\-\-mode\~text), \-\-tty\-viewer, \-\-X (\-\-mode\~X),
+\-\-X\-viewer, \-\-html (\-\-mode\~html), \-\-html\-view, \-\-apropos\-data,
+\-\-apropos\-devel, \-\-apropos\-progs.
 New documentation file README_SH.
@@ -1628,9 +1675,9 @@ The glyphs \e[*e] and \e[+e] have been exchanged to be in 
sync with
 all other devices.
-The glyph \e[\s'+2'~\s'-2'=] is now called \e[|=].
+The glyph \e[\[ti]=] is now called \e[|=].
 Similar to other devices,
-\e[\s'+2'~\s'-2'=] is now another name for glyph \e[\s'+2'~~\s'-2'].
+\e[\[ti]=] is now another name for glyph \e[\[ti]\[ti]].
@@ -1850,13 +1897,15 @@ papersize /etc/papersize a4
 A local font directory has been prepended to the default font path; it
-defaults to /usr/local/share/groff/site-font.
+defaults to /usr/local/share/groff/site\-font.
 Similar to the normal font searching process, files must be placed into
-a dev\f[I]XXX\f[] subdirectory, e.g.\&\" not a end of sentence
+a \%dev\c
+subdirectory, e.g.,
 .in 2m
 .ft C
 .ft P
@@ -2113,10 +2162,10 @@ Please see and groff.texinfo for more 
 The escapes `\e%', `\e&', `\e)', and `\e:' no longer cause an error in \eX;
 they are ignored now.
-Additionally `\e\ ' and `\e\s+2~\s-2' are converted to single space characters.
+Additionally `\e\ ' (space) and `\e\[ti]' are converted to single space 
-The default tab distance in nroff mode is now 0.8 inches (i) to be compatible
+The default tab distance in nroff mode is now 0.8i\~(inches) to be compatible
 with Unix troff.
@@ -2148,8 +2197,8 @@ Both the man and mdoc macro packages now use the LL and 
LT registers for
 setting the line and title length, respectively (similar to those
 registers in the ms macro package).
 If not set on the command line or in a macro file loaded before the macro
-package itself, they default to 78 en (n) in nroff mode and
-6.5 inches in troff mode.
+package itself, they default to 78n\~(ens) in nroff mode and
+6.5i\~(inches) in troff mode.
 The `\-xwidth' specifier in the mdoc macro package has been removed.
@@ -2204,9 +2253,9 @@ The following macros have been renamed:
 .in 2m
-LINE   -> HR
+LINE   \-> HR
@@ -2369,7 +2418,7 @@ Grodvi
 By default,
-font sizes are now available in the range 5\[en]10000\~points (p),
+font sizes are now available in the range 5\[en]10000p\~(points),
 similar to PS fonts.
 If you want the old behaviour (i.e., font sizes at discrete values only),
 insert the following at the start of your document:
@@ -2431,7 +2480,9 @@ For the `man' program, it may be necessary to add the 
`\-R' option of
 `less' to the $PAGER environment variable (or $MANPAGER, depending on the
 used version of `man'); alternatively, you can use `man's `\-P' option (or
 adapt its configuration file accordingly).
-See \fBman\fP (1) for more details.
+.I man (1)
+for more details.
@@ -2512,7 +2563,9 @@ specification in its first line (e.g., `/etc/papersize')
 a custom paper size definition like `35c,4i'
-See \fBgroff_font\fP (5) for more details.
+.I groff_font (5)
+for more details.
 This keyword only affects the physical dimensions of the output medium;
 grops, grolj4, and grolbp use it currently.
 troff completely ignores it.

reply via email to

[Prev in Thread] Current Thread [Next in Thread]