[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[groff] 01/02: doc/webpage.ms: Fix style problems.
G. Branden Robinson
[groff] 01/02: doc/webpage.ms: Fix style problems.
Sun, 19 Jan 2020 08:28:23 -0500 (EST)
gbranden pushed a commit to branch master
in repository groff.
Author: Bjarni Ingi Gislason <address@hidden>
AuthorDate: Sun Jan 19 02:02:16 2020 +1100
doc/webpage.ms: Fix style problems.
Change of point size is too large, +-2 is usual.
Change a HYPHEN-MINUS (code 0x55, 2D) to a minus (\-), if in front of a
name for an option.
Put a '\&' directly after a period (.), that is not an end of sentence.
Use a straight quote (apostrophe, apostrophe quote, quotesingle, \[aq])
in examples (using a constant width font, for example Courier (C, CR).
See for example "www.cl.cam.ac.uk/~mgk25/ucs/quotes.html".
Use a hyphen to combine two words used as an attributive, see for example
"32-bit" in man-pages(7).
Use the name of units in text, not the symbol, except in tables,
calculations, and equations.
Use the unit 'p' (roff), not 'pt' (TeX).
Set the name of a man page in bold type, but the section in roman.
Make '~' (tilde) bigger (+2) or use "\[ti]", if it means "approximate",
as the character is too small in the output of troff.
Change <X>[\]-<Y> to <X>\[en]Y> if it is a range.
Add a comma after "e.g." and "i.e.", or use English words
Add the missing 'l' (landscape) in 'a4'.
[I have a few tweaks I'd like to make to some of the above, but I'll
place those in a separate commit. --GBR]
Signed-off-by: G. Branden Robinson <address@hidden>
doc/webpage.ms | 111 ++++++++++++++++++++++++++++++---------------------------
1 file changed, 58 insertions(+), 53 deletions(-)
diff --git a/doc/webpage.ms b/doc/webpage.ms
index ee4f440..ca1b9bb 100644
@@ -105,7 +105,7 @@ is now maintained by the team at
-\s[-4]\f[I]This document was produced using
+\s[-2]\f[I]This document was produced using
.URL http://\:www.gnu.org/\:software/\:groff groff-\n[.x].\n[.y].\n[.Y] .
The image at the top has been contributed by Imogen Mulley,
@@ -210,7 +210,7 @@ The same is true for some other preprocessors like `chem'.
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.
+otherwise `groff' does not install `gxditview' and the `\-TX*' devices.
In Debian, the developer packages are `libxaw7-dev' and `libxmu-dev'.
@@ -342,7 +342,7 @@ option by default, unless a request similar to:
-is invoked during input file processing; (`.if !\en[PHASE] ...' ensures
+is invoked during input file processing; (`.if !\en[PHASE] ...\&' ensures
that the effect of the `.tm' request is restricted to the document setup
phase of processing, as pdfroff sets it to 1 or\~2 in the output phase,
but leaves it unset in the setup phase).
@@ -368,7 +368,7 @@ A French introduction to the \-me macro package has been
-In -mdoc, command %C is now available, providing a city or place reference.
+In \-mdoc, command %C is now available, providing a city or place reference.
@@ -619,7 +619,7 @@ This allows reliable modification of requests.
\&. tm before bp
\&. ie \e\en[.br] .bp@orig
-\&. el 'bp@orig
+\&. el \[aq]bp@orig
\&. tm after bp
@@ -745,7 +745,7 @@ eqn
-Eric S. Raymond has added a new device type to eqn, MathML.
+Eric S.\& Raymond has added a new device type to eqn, MathML.
When \-TMathML is enabled, eqn now emits MathML formula markup rather than
The new groff \-Txhtml device uses this.
@@ -783,7 +783,7 @@ grotty
-\eD'p...' is now supported if the polygon consists entirely of horizontal
+\eD'p...\&' is now supported if the polygon consists entirely of horizontal
and vertical lines.
@@ -869,12 +869,12 @@ Here the same table using a more expanded syntax:
-\&. TD 1*1
-\&. TD 1*2
-\&. TD 2*1
-\&. TD 2*2
+\&.\& TD 1*1
+\&.\& TD 1*2
+\&.\& TD 2*1
+\&.\& TD 2*2
@@ -892,7 +892,7 @@ This package currently works with `\-Tps' only.
Fabrice M\['e]nard contributed locales support.
In particular, it is now possible to get French localization of the main
macro packages (\-ms, \-mm, \-me, and \-mom, but not \-man and \-mdoc
-which are localized differently) by appending `-mfr' to the list of macro
+which are localized differently) by appending `\-mfr' to the list of macro
@@ -939,11 +939,11 @@ is loaded in troffrc at start-up.
A new auxiliary macro package `62bit' has been added which provides some
-macros for adding, multiplying, and dividing signed 62bit integers (mainly
+macros for adding, multiplying, and dividing signed 62-bit integers (mainly
to handle normal groff number operations without risking overflow errors).
-For \-ms, Eric S. Raymond contributed support for ancient Bell Labs
+For \-ms, Eric S.\& Raymond contributed support for ancient Bell Labs
localisms `.SC', `.UC', `.P1', and `.P2'.
The latter three are enabled only after .SC is called.
@@ -1162,8 +1162,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 14pt headings, `.NH\~2' produces 12pt, and all other levels
-remain at 10pt (because \en[PS]\~=\~10).
+produces 14 points (p) headings, `.NH\~2' produces 12 points,
+and all other levels
+remain at 10 points (because \en[PS]\~=\~10).
The `SH' macro now accepts a numeric argument, to make heading size
@@ -1352,7 +1353,8 @@ grolj4
-A new man page `lj4_font(5)' documents how fonts are accessed with
+A new man page `\fBlj4_font\fP (5)'
+documents how fonts are accessed with
@@ -1434,7 +1436,7 @@ Example use:
-groff -Tdvi -mlatin9 my_file > my_file.dvi
+groff \-Tdvi \-mlatin9 my_file > my_file.dvi
@@ -1451,7 +1453,7 @@ is used to construct glyph names based on Unicode
The existing groff glyph names are frozen; no glyph names which can't be
constructed algorithmically will be added in the future.
-The \e[...] escape sequence has been extended to specify multiple glyph
+The \e[...\&] escape sequence has been extended to specify multiple glyph
@@ -1508,16 +1510,16 @@ They are searched after the list of fonts declared with
`special' request but before the already mounted special fonts.
-In groff versions 1.18 and 1.18.1, \eD'f\~...'\& didn't move the current
+In groff versions 1.18 and 1.18.1, \eD'f\~...\&' didn't move the current
Despite of being silly, this change has been reverted for backwards
Consequently, the intermediate output command `Df' also moves the
position horizontally again.
-\eD'f\~...'\& is deprecated since it depends on the horizontal resolution
+\eD'f\~...\&' is deprecated since it depends on the horizontal resolution
of the output device (given with the `hor' parameter in the DESC file).
-Use the new \eD'Fg\~...'\& escape instead.
+Use the new \eD'Fg\~...\&' escape instead.
For orthogonality, new \eD subcommands to change the fill color are
@@ -1525,15 +1527,15 @@ available:
-\eD'Fr ...' \f[R](rgb)\f
+\eD\[aq]Fr ...\&\[aq] \f[R](rgb)\f
-\eD'Fc ...' \f[R](cmy)\f
+\eD\[aq]Fc ...\&\[aq] \f[R](cmy)\f
-\eD'Fg ...' \f[R](gray)\f
+\eD\[aq]Fg ...\&\[aq] \f[R](gray)\f
-\eD'Fk ...' \f[R](cmyk)\f
+\eD\[aq]Fk ...\&\[aq] \f[R](cmyk)\f
-\eD'Fd' \f[R](default color)\f
+\eD\[aq]Fd\[aq] \f[R](default color)\f
@@ -1626,8 +1628,9 @@ The glyphs \e[*e] and \e[+e] have been exchanged to be in
all other devices.
-The glyph \e[~=] is now called \e[|=].
-Similar to other devices, \e[~=] is now another name for glyph \e[~~].
+The glyph \e[\s'+2'~\s'-2'=] is now called \e[|=].
+Similar to other devices,
+\e[\s'+2'~\s'-2'=] is now another name for glyph \e[\s'+2'~~\s'-2'].
@@ -1726,13 +1729,13 @@ explicitly specified on the command line.
troff's start-up file `troffrc' now includes `papersize.tmac' to set
-the paper size with the command-line option `-dpaper=<size>'.
+the paper size with the command-line option `\-dpaper=<size>'.
Possible values for `<size>' are the same as the predefined `papersize'
values in the DESC file (only lowercase; see the groff_font man page)
An appended `l' (ell) character denotes landscape orientation.
-Examples: `a4', `c3l', `letterl'.
+Examples: `a4l', `c3l', `letterl'.
Most output drivers need additional command-line switches `\-p' and
`\-l' to override the default paper length and orientation as set in
@@ -1743,7 +1746,7 @@ orientation:
-groff -Tps -dpaper=a4l -P-pa4 -P-l -ms foo.ms > foo.ps
+groff \-Tps \-dpaper=a4l \-P\-pa4 \-P\-l \-ms foo.ms > foo.ps
@@ -1849,7 +1852,7 @@ 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.
Similar to the normal font searching process, files must be placed into
-a dev\f[I]XXX\f subdirectory, e.g.
+a dev\f[I]XXX\f subdirectory, e.g.\&\" not a end of sentence
@@ -1890,7 +1893,7 @@ grops, grodvi, grotty, and grohtml \[en] other
preprocessors and drivers will
A new function `defcolor' defines colors; the escape sequence `\em' sets the
drawing color, the escape sequence `\eM' specifies the background color for
-closed objects created with \eD'.\|.\|.' commands.
+closed objects created with \eD'.\|.\|.\&' commands.
`\em' and `\eM' switch back to the previous color.
`\em' and `\eM' correspond to the new troff output command sets starting
with `m' and `DF'.
@@ -1970,11 +1973,11 @@ Example:
-\&. nop Hello, I'm `foo'.
-\&. nop I will now define `bar'.
-\&. de bar !
-\&. nop Hello, I'm `bar'.
+\&.\& nop Hello, I\[aq]m \[aq]foo\[aq].
+\&.\& nop I will now define \[aq]bar\[aq].
+\&.\& de bar !
+\&.\& nop Hello, I\[aq]m \[aq]bar\[aq].
@@ -2110,10 +2113,10 @@ Please see groff_diff.man 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~' are converted to single space characters.
+Additionally `\e\ ' and `\e\s+2~\s-2' are converted to single space characters.
-The default tab distance in nroff mode is now 0.8i to be compatible
+The default tab distance in nroff mode is now 0.8 inches (i) to be compatible
with Unix troff.
@@ -2137,7 +2140,7 @@ It comes with a complete reference (in HTML format) and
`mom' has been designed to format documents for PostScript output only.
-Two macros `AT' (AT&T) and `UC' (Univ. of California) have been added to
+Two macros `AT' (AT&T) and `UC' (Univ.\& of California) have been added to
the man macros for compatibility with older BSD releases.
@@ -2145,7 +2148,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 78n in nroff mode and 6.5i in troff mode.
+package itself, they default to 78 en (n) in nroff mode and
+6.5 inches in troff mode.
The `\-xwidth' specifier in the mdoc macro package has been removed.
@@ -2364,15 +2368,16 @@ Grodvi
-By default, font sizes are now available in the range 5\-10000pt, similar
-to PS fonts.
+font sizes are now available in the range 5\[en]10000\~points (p),
+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:
-\&.if '\e*[.T]'dvi' \e
+\&.if \[aq]\e*[.T]\[aq]dvi\[aq] \e
\&. sizes 500 600 700 800 900 1000 1095 1200 1400 1440 1600 \e
\& 1728 1800 2000 2074 2200 2400 2488 2800 3600
@@ -2426,7 +2431,7 @@ 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 man(1) for more details.
+See \fBman\fP (1) for more details.
@@ -2497,17 +2502,17 @@ Its argument is either
-a predefined paper format (e.g. `A4' or `letter')
+a predefined paper format (e.g., `A4' or `letter')
a file name pointing to a file which must contain a paper size
-specification in its first line (e.g. `/etc/papersize')
+specification in its first line (e.g., `/etc/papersize')
a custom paper size definition like `35c,4i'
-See groff_font(5) for more details.
+See \fBgroff_font\fP (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.
|[Prev in Thread]
||[Next in Thread]|
- [groff] 01/02: doc/webpage.ms: Fix style problems.,
G. Branden Robinson <=