[groff] 03/08: man pages: Don't prefix env variables with "$".

[G. Branden Robinson]

gbranden pushed a commit to branch master
in repository groff.

commit 3d82e2c83ccac178fadcb6f2f9c7c6b545fc4cd8
Author: G. Branden Robinson <address@hidden>
Date:   Sun Nov 11 12:32:55 2018 -0500

    man pages: Don't prefix env variables with "$".
    
        * contrib/groffer/groffer.1.man:
        * man/groff_tmac.5.man:
        * src/devices/grotty/grotty.1.man:
        * src/roff/groff/groff.1.man:
        * tmac/groff_trace.7.man: Stop prefixing environment variable
        references with "$" (except where justified by context, like a
        shell command example).  The weight of practice in the groff man
        page corpus is heavily against it.
    
        * contrib/groffer/groffer.1.man: Also stop suppressing the
        hyphenation of "MANOPT" and "PAGER", which won't get hyphenated
        anyway.
    
    Signed-off-by: G. Branden Robinson <address@hidden>
---
 contrib/groffer/groffer.1.man   | 70 ++++++++++++++++++++---------------------
 man/groff_tmac.5.man            |  4 +--
 src/devices/grotty/grotty.1.man |  4 +--
 src/roff/groff/groff.1.man      |  4 +--
 tmac/groff_trace.7.man          |  2 +-
 5 files changed, 42 insertions(+), 42 deletions(-)

diff --git a/contrib/groffer/groffer.1.man b/contrib/groffer/groffer.1.man
index e7b4b6a..9ba8b03 100644
--- a/contrib/groffer/groffer.1.man
+++ b/contrib/groffer/groffer.1.man
@@ -134,7 +134,7 @@ behaviors.
 This can be done either in configuration files, with the shell
 environment variable
 .SM
-.BR \%$GROFFER_OPT ,
+.BR \%GROFFER_OPT ,
 or on the command line.
 .
 .
@@ -475,7 +475,7 @@ an error is raised.
 .P
 These abbreviations are only allowed in the environment variable
 .SM
-.BR \%$GROFFER_OPT ,
+.BR \%GROFFER_OPT ,
 but not in the configuration files.
 .
 In configuration, all long options must be exact.
@@ -584,7 +584,7 @@ to the default values.
 .
 This is useful to wipe out all former options of the configuration, in
 .SM
-.BR \%$GROFFER_OPT ,
+.BR \%GROFFER_OPT ,
 and restart option processing using only the rest of the command line.
 .
 .
@@ -1368,7 +1368,7 @@ installed the full set of long and short options of the 
\f(CRGNU\fP
 .B man
 program can be passed via the environment variable
 .SM
-.BR \%$MANOPT ;
+.BR MANOPT ;
 see
 .BR \%man (1).
 .
@@ -1736,7 +1736,7 @@ the display program for viewing the output with its 
arguments,
 .IP \*(BU 2m
 the active parameters from the config files, the arguments in
 .SM
-.BR \%$GROFFER_OPT ,
+.BR \%GROFFER_OPT ,
 and the arguments of the command line,
 .
 .IP \*(BU 2m
@@ -2052,7 +2052,7 @@ environments).
 .
 The environment variable
 .SM
-.B \%$DISPLAY
+.B \%DISPLAY
 and the option
 .B \-\-display
 are used for specifying the X Window System display to be used.
@@ -2144,7 +2144,7 @@ for a text output on a text terminal using some pager 
program.
 .P
 If the variable
 .SM
-.B \%$DISPLAY
+.B \%DISPLAY
 is not set or empty,
 .B \%groffer
 assumes that it should use
@@ -2171,7 +2171,7 @@ The pager to be used can be specified by one of the 
options
 and
 .BR \-\-viewer ,
 or by the environment variable
-.BR \%$PAGER .
+.BR PAGER .
 If all of this is not used the
 .BR \%less (1)
 program with the option
@@ -2363,13 +2363,13 @@ It is generated by the following methods.
 .IP \*(BU 2m
 The environment variable
 .SM
-.B \%$MANPATH
+.B \%MANPATH
 can be set.
 .
 .IP \*(BU 2m
 It can be read from the arguments of the environment variable
 .SM
-.BR \%$MANOPT .
+.BR MANOPT .
 .
 .IP \*(BU 2m
 The
@@ -2416,13 +2416,13 @@ can be provided by 3 methods.
 .IP \*(BU 2m
 The environment variable
 .SM
-.B \%$SYSTEM
+.B \%SYSTEM
 has the lowest precedence.
 .
 .IP \*(BU 2m
 This can be overridden by an option in
 .SM
-.BR \%$MANOPT .
+.BR MANOPT .
 .
 .IP \*(BU 2m
 This again is overridden by the command-line option
@@ -2469,22 +2469,22 @@ can be chosen by several methods.
 .IP \*(BU 2m
 Environment variable
 .SM
-.BR $LANG .
+.BR LANG .
 .
 .IP \*(BU 2m
 This is overridden by
 .SM
-.BR \%$LC_MESSAGES .
+.BR \%LC_MESSAGES .
 .
 .IP \*(BU 2m
 This is overridden by
 .SM
-.BR $LC_ALL .
+.BR LC_ALL .
 .
 .IP \*(BU 2m
 This can be overridden by providing an option in
 .SM
-.BR \%$MANOPT .
+.BR MANOPT .
 .
 .IP \*(BU 2m
 All these environment variables are overridden by the command-line
@@ -2647,7 +2647,7 @@ on the command line:
 .IP \*(BU 2m
 Environment variable
 .SM
-.B \%$MANSECT
+.B \%MANSECT
 .
 .IP \*(BU 2m
 Command line option
@@ -2680,7 +2680,7 @@ The multiple
 .I sections
 are only possible for
 .SM
-.B \%$MANSECT
+.B \%MANSECT
 and
 .BR \-\-sections .
 .
@@ -2706,7 +2706,7 @@ abbreviation is good enough in most cases.
 .IP \*(BU 2m
 Environment variable
 .SM
-.B \%$EXTENSION
+.B \%EXTENSION
 .
 .IP \*(BU 2m
 Command line option
@@ -2932,7 +2932,7 @@ and some standard system variables are honored.
 .
 .TP
 .SM
-.B \%$GROFFER_OPT
+.B \%GROFFER_OPT
 Store options for a run of
 .BR \%groffer .
 .
@@ -2959,7 +2959,7 @@ The following variables have a special meaning for
 .
 .TP
 .SM
-.B \%$DISPLAY
+.B \%DISPLAY
 If set, this variable indicates that the X Window System is running.
 .
 Testing this variable decides on whether graphical or text output is
@@ -2981,13 +2981,13 @@ can be started on the second monitor by the command
 .
 .TP
 .SM
-.B \%$LC_ALL
+.B \%LC_ALL
 .TQ
 .SM
-.B \%$LC_MESSAGES
+.B \%LC_MESSAGES
 .TQ
 .SM
-.B $LANG
+.B LANG
 If one of these variables is set (in the above sequence), its content
 is interpreted as the locale, the language to be used, especially when
 retrieving
@@ -3023,7 +3023,7 @@ This is the same behavior as when all 3\~variables are 
unset.
 .
 .TP
 .SM
-.B \%$PAGER
+.B \%PAGER
 This variable can be used to set the pager for the tty output.
 .
 For example, to disable the use of a pager completely set this
@@ -3038,7 +3038,7 @@ program
 .
 .TP
 .SM
-.B $PATH
+.B PATH
 All programs within the
 .B \%groffer
 script are called without a fixed path.
@@ -3068,7 +3068,7 @@ program.
 .
 .TP
 .SM
-.B \%$GROFF_TMPDIR
+.B \%GROFF_TMPDIR
 If the value of this variable is an existing, writable directory,
 .B \%groffer
 uses it for storing its temporary files, just as
@@ -3100,13 +3100,13 @@ The
 .B man
 environment variables can be overwritten by options provided with
 .SM
-.BR \%$MANOPT ,
+.BR MANOPT ,
 which in turn is overwritten by the command line.
 .
 .
 .TP
 .SM
-.B \%$EXTENSION
+.B \%EXTENSION
 Restrict the search for
 .I \%man\~pages
 to files having this extension.
@@ -3118,7 +3118,7 @@ see there for details.
 .
 .TP
 .SM
-.B \%$MANOPT
+.B MANOPT
 This variable contains options as a preset for
 .BR \%man (1).
 As not all of these are relevant for
@@ -3135,7 +3135,7 @@ given on the command line.
 .
 .TP
 .SM
-.B \%$MANPATH
+.B \%MANPATH
 If set, this variable contains the directories in which the
 .I \%man\~page
 trees are stored.
@@ -3146,7 +3146,7 @@ This is overridden by option
 .
 .TP
 .SM
-.B \%$MANSECT
+.B \%MANSECT
 If this is a colon separated list of section names, the search for
 .I \%man\~pages
 is restricted to those manual sections in that order.
@@ -3157,7 +3157,7 @@ This is overridden by option
 .
 .TP
 .SM
-.B \%$SYSTEM
+.B \%SYSTEM
 If this is set to a comma separated list of names these are interpreted
 as
 .I \%man\~page
@@ -3171,7 +3171,7 @@ see there for details.
 .P
 The environment variable
 .SM
-.B \%$MANROFFSEQ
+.B \%MANROFFSEQ
 is ignored by
 .B \%groffer
 because the necessary preprocessors are determined automatically.
@@ -3213,7 +3213,7 @@ comes first; it is overwritten by the configuration file 
in the home
 directory; both configuration files are overwritten by the environment
 variable
 .SM
-.BR \%$GROFFER_OPT ;
+.BR \%GROFFER_OPT ;
 everything is overwritten by the command line arguments.
 .
 .
diff --git a/man/groff_tmac.5.man b/man/groff_tmac.5.man
index f09135f..804cbff 100644
--- a/man/groff_tmac.5.man
+++ b/man/groff_tmac.5.man
@@ -1200,7 +1200,7 @@ command-line option
 .
 .IP \(bu
 the directories given in the
-.B $GROFF_TMAC_PATH
+.B GROFF_TMAC_PATH
 environment variable
 .
 .IP \(bu
@@ -1250,7 +1250,7 @@ in this installation
 .\" ====================================================================
 .
 .TP
-.B $GROFF_TMAC_PATH
+.B GROFF_TMAC_PATH
 A colon separated list of additional tmac directories in which to search
 for macro files.
 .
diff --git a/src/devices/grotty/grotty.1.man b/src/devices/grotty/grotty.1.man
index a97d55b..2477478 100644
--- a/src/devices/grotty/grotty.1.man
+++ b/src/devices/grotty/grotty.1.man
@@ -141,7 +141,7 @@ For
 in particular, either add
 .B \-R
 to the
-.B $PAGER
+.B PAGER
 environment variable, e.g.\&
 .
 .RS
@@ -164,7 +164,7 @@ in a similar fashion.
 Note that with some
 .BR man (1)
 versions, you have to use the
-.B $MANPAGER
+.B MANPAGER
 environment variable instead.
 .
 .
diff --git a/src/roff/groff/groff.1.man b/src/roff/groff/groff.1.man
index e8da16f..7e17658 100644
--- a/src/roff/groff/groff.1.man
+++ b/src/roff/groff/groff.1.man
@@ -1387,7 +1387,7 @@ For example, DOS and Windows use a semicolon instead.
 .TP
 .EnvVar GROFF_BIN_PATH
 This search path, followed by
-.EnvVar $PATH ,
+.EnvVar PATH ,
 is used for commands that are executed by
 .BR groff .
 .
@@ -1519,7 +1519,7 @@ The directory in which temporary files are created.
 If this is not set but the environment variable
 .EnvVar TMPDIR
 instead, temporary files are created in the directory
-.EnvVar $TMPDIR .
+.EnvVar TMPDIR .
 .
 On MS-DOS and Windows platforms, the environment variables
 .EnvVar TMP
diff --git a/tmac/groff_trace.7.man b/tmac/groff_trace.7.man
index 71772b5..ab64568 100644
--- a/tmac/groff_trace.7.man
+++ b/tmac/groff_trace.7.man
@@ -268,7 +268,7 @@ for details.
 .\" ====================================================================
 .
 .TP
-.B $GROFF_TMAC_PATH
+.B GROFF_TMAC_PATH
 A colon-separated list of additional tmac directories in which to
 search for macro files; see
 .BR groff_tmac (@MAN5EXT@)