summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorwl <wl>2005-05-21 07:08:00 +0000
committerwl <wl>2005-05-21 07:08:00 +0000
commit92770508fef8b7fa2b8b837abe1320409e396ded (patch)
treeeb5e20272ebf68afea94b66fb6b79269b48b32c2
parent187a9bbfe94d924faa0fe24b3f46b1028c07e3d0 (diff)
downloadgroff-92770508fef8b7fa2b8b837abe1320409e396ded.tar.gz
* release of groffer 0.9.14
* groffer.man: correction of non-hyphenation
-rw-r--r--contrib/groffer/ChangeLog6
-rw-r--r--contrib/groffer/groffer.man892
2 files changed, 488 insertions, 410 deletions
diff --git a/contrib/groffer/ChangeLog b/contrib/groffer/ChangeLog
index 9d27df57..8e46f33d 100644
--- a/contrib/groffer/ChangeLog
+++ b/contrib/groffer/ChangeLog
@@ -1,3 +1,9 @@
+2005-05-20 Bernd Warken
+ ________________________________________________________________
+ * release of groffer 0.9.14
+
+ * groffer.man: correction of non-hyphenation
+
2005-05-17 Bernd Warken
________________________________________________________________
* release of groffer 0.9.13
diff --git a/contrib/groffer/groffer.man b/contrib/groffer/groffer.man
index af9864fa..b9492602 100644
--- a/contrib/groffer/groffer.man
+++ b/contrib/groffer/groffer.man
@@ -15,7 +15,7 @@ groffer.1 - man page for groffer (section 1).
Source file position: <groff_source_top>/contrib/groffer/groffer.man
Installed position: $prefix/share/man/man1/groffer.1
-Last update : 20 May 2005
+Last update : 21 May 2005
Source file position: <groff-source>/contrib/groffer/groffer.man
..
@@ -60,15 +60,6 @@ Suite 330, Boston, MA 02111-1307, USA.
. ftr CB CW
.\}
.
-.ds @- "\-\""
-.ds @-- "\-\^\-\""
-.
-.ds @b- "\f[CB]-\f[]\""
-.ds @b-- "\f[CB]--\f[]\""
-.
-.ds @i- "\f[CI]-\f[]\""
-.ds @i-- "\f[CI]--\f[]\""
-.
.ds Ellipsis ".\|.\|.\""
.
.\" --------------------------------------------------------------------
@@ -286,7 +277,7 @@ Suite 330, Boston, MA 02111-1307, USA.
.c Alternating options; base macro for many others; do not use directly.
.c
.c Arguments:
-.c <pre>: prefix, resulted is preceded by this.
+.c <pre>: prefix, result is preceded by this.
.c <sep>: separator between minus/opt pairs.
.c <post>: postfix, is appended to the result.
.c <minus>: either `-' or `--' (font CB).
@@ -296,7 +287,8 @@ Suite 330, Boston, MA 02111-1307, USA.
.c Result:
.c String `<pre>' followed by the <minus>/<opt> argument pairs, each
.c separated by string `<sep>', optionally add '<arg>', separated by
-.c a single space ` ', followed by the string `<post>'.
+.c a single space ` ', followed by the string `<post>'. Terminated
+.c by the optional punctuation <punct>.
.c
.de Opt_alt_base
. nr @font \\n[.f]\"
@@ -316,9 +308,13 @@ Suite 330, Boston, MA 02111-1307, USA.
. \}
. c separator
. if (\\n[@count] > 0) \
-. as @res \f[CR]\\*[@sep]\"
+. as @res \f[CR]\\*[@sep]\:\"
. nr @count +1
-. as @res \f[CB]\\$1\\$2\:\" combine minus with option name
+. c combine minus with option name
+. as @res \f[CB]\\-\"
+. if '\\$1'--' \
+. as @res \\-\"
+. as @res \\$2\"
. shift 2
. \}
. if (\\n[.$] >= 3) \
@@ -555,7 +551,9 @@ Suite 330, Boston, MA 02111-1307, USA.
.de Text
. if (\\n[.$] == 0) \
. return
+. nh
. nop \)\\$*\)
+. hy
..
.c --------------------------------------------------------------------
.c .Topic ([<indent>])
@@ -671,28 +669,32 @@ Suite 330, Boston, MA 02111-1307, USA.
.\" --------------------------------------------------------------------
.
The
-.I groffer
+.I \%groffer
program is the easiest way to use
-.BR groff (@MAN1EXT@).
+.BR \%groff (@MAN1EXT@).
It can display arbitrary documents written in the
-.BR groff (@MAN7EXT@)
+.BR \%groff (@MAN7EXT@)
language or other
-.BR roff (@MAN7EXT@)
-languages that are compatible to the original troff language.
+.BR \%roff (@MAN7EXT@)
+languages that are compatible to the original
+.I \%troff
+language.
.
The
-.I groffer
+.I \%groffer
program also includes many of the features for finding and displaying
-the UNIX manual pages
+the \%UNIX manual pages
+.nh
.RI ( man\~pages ),
+.hy
such that it can be used as a replacement for a
-.BR man (1)
+.BR \%man (1)
program.
.
Moreover, compressed files that can be handled by
-.BR gzip (1)
+.BR \%gzip (1)
or
-.BR bzip2 (1)
+.BR \%bzip2 (1)
are decompressed on-the-fly.
.
.
@@ -705,28 +707,33 @@ behaviors.
.
This can be done in configuration files, with the shell environment
variable
-.BR $GROFFER_OPT ,
+.BR \%$GROFFER_OPT ,
or on the command line.
.
.
.P
The output can be generated and viewed in several different ways
available for
-.IR groff .
+.IR \%groff .
.
-This includes the groff native X viewer
+This includes the
+.I \%groff
+native X viewer
.BR \%gxditview (@MAN1EXT@),
-each Postcript or dvi display program, a web browser by generating
-html in www-mode, or several text modes in text terminals.
+each Postcript or
+.I \%dvi
+display program, a web browser by generating
+.I \%html
+in www-mode, or several text modes in text terminals.
.
.
.P
Most of the options that must be named when running
-.I groff
+.I \%groff
directly are determined automatically for
-.IR groffer ,
+.IR \%groffer ,
due to the internal usage of the
-.BR grog (@MAN1EXT@)
+.BR \%grog (@MAN1EXT@)
program.
.
But all parts can also be controlled manually by arguments.
@@ -736,7 +743,7 @@ But all parts can also be controlled manually by arguments.
Several file names can be specified on the command line arguments.
.
They are transformed into a single document in the normal way of
-.IR groff .
+.IR \%groff .
.
.
.\" --------------------------------------------------------------------
@@ -748,40 +755,40 @@ They are transformed into a single document in the normal way of
.RS
.P
.Opt_[alt] -- apropos name
-.Opt_[alt] -- apropos-data name
-.Opt_[alt] -- apropos-devel name
-.Opt_[alt] -- apropos-progs name
+.Opt_[alt] -- apropos\-data name
+.Opt_[alt] -- apropos\-devel name
+.Opt_[alt] -- apropos\-progs name
.Opt_[alt] - h -- help
.Opt_[alt] - v -- version
.RE
.
.
.TP
-.I groffer mode options
+.I \%groffer mode options
.RS
.P
.Opt_[alt] -- auto
.Opt_[alt] -- default
-.Opt_[alt] -- default-modes mode1,mode2,\*[Ellipsis]
+.Opt_[alt] -- default\-modes mode1,mode2,\*[Ellipsis]
.Opt_[alt] -- dvi
-.Opt_[alt] -- dvi-viewer prog
+.Opt_[alt] -- dvi\-viewer prog
.Opt_[alt] -- groff
.Opt_[alt] -- html
-.Opt_[alt] -- html-viewer prog
+.Opt_[alt] -- html\-viewer prog
.Opt_[alt] -- man
.Opt_[alt] -- mode display_mode
.Opt_[alt] -- no-man
.Opt_[alt] -- pdf
-.Opt_[alt] -- pdf-viewer prog
+.Opt_[alt] -- pdf\-viewer prog
.Opt_[alt] -- ps
-.Opt_[alt] -- ps-viewer prog
+.Opt_[alt] -- ps\-viewer prog
.Opt_[alt] -- text
.Opt_[alt] -- tty
-.Opt_[alt] -- tty-viewer prog
+.Opt_[alt] -- tty\-viewer prog
.Opt_[alt] -- www
-.Opt_[alt] -- www-viewer prog
+.Opt_[alt] -- www\-viewer prog
.Opt_[alt] -- x -- X
-.Opt_[alt] -- x-viewer -- X-viewer prog
+.Opt_[alt] -- x\-viewer -- X\-viewer prog
.RE
.
.
@@ -795,16 +802,16 @@ They are transformed into a single document in the normal way of
.
.
.TP
-.I options related to groff
+.I options related to \%groff
.RS
.P
-.Opt_[alt] - P -- postproc-arg opt_or_arg
+.Opt_[alt] - P -- postproc\-arg opt_or_arg
.Opt_[alt] - Q -- source
.Opt_[alt] - T -- device device
-.Opt_[alt] - Z -- intermediate-output -- ditroff
+.Opt_[alt] - Z -- intermediate\-output -- ditroff
.P
All further
-.I groff
+.I \%groff
short options are accepted.
.RE
.
@@ -874,8 +881,8 @@ the path name of an existing file.
.TP+
.IB name ( section )
search the man\~page
-.I name
-in man\~section\~\c
+.I \%name
+in man\~section
.IR section .
.
.
@@ -886,9 +893,9 @@ in man\~section\~\c
if
.I s
is a character in
-.BR [1-9on] ,
+.BR \%[1-9on] ,
search for a man\~page
-.I name
+.I \%name
in man\~section
.IR s .
.
@@ -896,7 +903,7 @@ in man\~section
.TP
.BI man: name
man\~page in the lowest man\~section that has
-.IR name .
+.IR \%name .
.
.
.TP
@@ -904,9 +911,9 @@ man\~page in the lowest man\~section that has
if
.I s
is a character in
-.BR [1-9on] ,
+.BR \%[1-9on] ,
search for a man\~page
-.I name
+.I \%name
in man\~section
.IR s .
.
@@ -914,9 +921,9 @@ in man\~section
.TP
.I name
if
-.I name
+.I \%name
is not an existing file search for the man\~page
-.I name
+.I \%name
in the lowest man\~section.
.
.RE
@@ -927,7 +934,7 @@ in the lowest man\~section.
.\" --------------------------------------------------------------------
.
The
-.I groffer
+.I \%groffer
program can usually be run with very few options.
.
But for special purposes, it supports many options.
@@ -937,14 +944,14 @@ These can be classified in 5 option classes.
.
.P
All short options of
-.I groffer
+.I \%groffer
are compatible with the short options of
-.BR groff (@MAN1EXT@).
+.BR \%groff (@MAN1EXT@).
.
All long options of
-.I groffer
+.I \%groffer
are compatible with the long options of
-.BR man (1).
+.BR \%man (1).
.
.
.\" --------------------------------------------------------------------
@@ -953,7 +960,7 @@ are compatible with the long options of
.
As soon as one of these options is found on the command line it is
executed, printed to standard output, and the running
-.I groffer
+.I \%groffer
is terminated thereafter.
.
All other arguments are ignored.
@@ -961,29 +968,29 @@ All other arguments are ignored.
.
.Opt_def -- apropos name
Start the
-.BR apropos (1)
-command for searching within man page
+.BR \%apropos (1)
+command for searching within man\~page
descriptions.
.
That slightly differs from the strange behavior of the
.Opt_long apropos
program of
-.BR man (1),
+.BR \%man (1),
which has no argument of its own, but takes the file arguments
instead.
.
Practically both concepts are compatible.
.
.
-.Opt_def -- apropos-data name
+.Opt_def -- apropos\-data name
Show only the
-.BR apropos (1)
+.BR \%apropos (1)
descriptions for data documents, in the
-.BR man (7)
+.BR \%man (7)
sections 4, 5, and 7.
.
.
-.Opt_def -- apropos-devel name
+.Opt_def -- apropos\-devel name
Show only the
.BR apropos (1)
descriptions for development documents, in the
@@ -991,11 +998,11 @@ descriptions for development documents, in the
sections 2, 3, and 9.
.
.
-.Opt_def -- apropos-progs name
+.Opt_def -- apropos\-progs name
Show only the
-.BR apropos (1)
+.BR \%apropos (1)
descriptions for documents on programs, in the
-.BR man (7)
+.BR \%man (7)
sections 1, 6, and 8.
.
.
@@ -1016,7 +1023,7 @@ The display mode and the viewer programs are determined by these
options.
.
If none of these mode and viewer options is specified
-.I groffer
+.I \%groffer
tries to find a suitable display mode automatically.
.
.
@@ -1034,9 +1041,9 @@ This is useful to wipe out all former options of the configuration, in
and restart option processing using only the rest of the command line.
.
.
-.Opt_def -- default-modes mode1,mode2,\*[Ellipsis]
+.Opt_def -- default\-modes mode1,mode2,\*[Ellipsis]
Set the sequence of modes for
-.I auto mode
+.I \%auto mode
to the comma separated list given in the argument.
.
See
@@ -1046,26 +1053,28 @@ means to try the modes
.IR x ,
.IR ps ,
and
-.I tty
+.I \%tty
in this sequence.
.
.
.
.Opt_def -- dvi
Equivalent to
-.Opt_long_arg mode dvi .
+.Opt_long_arg mode \%dvi .
.
.
-.Opt_def -- dvi-viewer prog
+.Opt_def -- dvi\-viewer prog
Set the viewer program for dvi mode.
.
This can be a file name or a program to be searched in
.Env_var $PATH .
.
-Known dvi viewers inlude
-.BR xdvi (1)
+Known
+.I \%dvi
+viewers inlude
+.BR \%xdvi (1)
and
-.BR dvilx (1)
+.BR \%dvilx (1)
.
In each case, arguments can be provided additionally.
.
@@ -1080,13 +1089,13 @@ Equivalent to
.Opt_long_arg mode html .
.
.
-.Opt_def -- html-viewer
+.Opt_def -- html\-viewer
Set the web browser program for viewing in
-.I html
+.I \%html
mode.
.
Each program that accepts html input and allows the
-.BI file://localhost/ dir / file
+.BI \%file://localhost/ dir / file
syntax on the command line is suitable as viewer program; it can be
the path name of an executable file or a program in
.Env_var $PATH .
@@ -1107,7 +1116,7 @@ The following mode values are recognized:
Select the automatic determination of the display mode.
.
The sequence of modes that are tried can be set with the
-.Opt_long default-modes
+.Opt_long default\-modes
option.
.
Useful for restoring the default mode when a different mode was
@@ -1117,11 +1126,11 @@ specified before.
.TP
.Header_CB dvi
Display formatted input in a
-.I dvi
+.I \%dvi
viewer program.
.
By default, the formatted input is displayed with the
-.BR xdvi (1)
+.BR \%xdvi (1)
program.
.Opt_long dvi .
.
@@ -1129,13 +1138,13 @@ program.
.TP
.Header_CB groff
After the file determination, switch
-.I groffer
+.I \%groffer
to process the input like
-.BR groff (@MAN1EXT@)
-would do .
+.BR \%groff (@MAN1EXT@)
+would do.
.
This disables the
-.I groffer
+.I \%groffer
viewing features.
.
.
@@ -1146,27 +1155,27 @@ browser program.
.
By default, the existence of a sequence of standard web browsers is
tested, starting with
-.BR konqueror (1)
+.BR \%konqueror (1)
and
-.BR mozilla (1).
+.BR \%mozilla (1).
The text html viewer is
-.BR lynx (1).
+.BR \%lynx (1).
.
.
.TP
.Header_CB pdf
Display formatted input in a
-.I PDF
+.I \%PDF
(Portable Document Format) viewer
program.
.
By default, the input is formatted by groff using the Postscript
device, then it is transformed into the PDF file format using
-.BR gs (1),
+.BR \%gs (1),
and finally displayed either with the
-.BR xpdf (1)
+.BR \%xpdf (1)
or the
-.BR acroread (1)
+.BR \%acroread (1)
program.
.
PDF has a big advantage because the text is displayed graphically and
@@ -1181,19 +1190,19 @@ mode is not suitable as a default device for the auto mode.
Display formatted input in a Postscript viewer program.
.
By default, the formatted input is displayed with the
-.BR ghostview (@MAN1EXT@)
+.BR \%ghostview (@MAN1EXT@)
program.
.
.
.TP
.Header_CB text
Format in a
-.I groff
+.I \%groff
text mode and write the result to standard output without a pager or
viewer program.
.
The text device,
-.I latin1
+.I \%latin1
by default, can be chosen with option
.Opt_short T .
.
@@ -1201,9 +1210,9 @@ by default, can be chosen with option
.TP
.Header_CB tty
Format in a
-.I groff
+.I \%groff
text mode and write the result to standard output using a text pager
-program, even when in X Window.
+program, even when in X\~\%Window.
.
.
.TP
@@ -1231,7 +1240,7 @@ Equivalent to
.
.P
The following modes do not use the
-.I groffer
+.I \%groffer
viewing features.
.
They are only interesting for advanced applications.
@@ -1240,15 +1249,15 @@ They are only interesting for advanced applications.
.TP
.Header_CB groff
Generate device output with plain
-.I groff
+.I \%groff
without using the special viewing features of
-.IR groffer .
+.IR \%groffer .
If no device was specified by option
.Opt_short T
the
-.I groff
+.I \%groff
default
-.B ps
+.B \%ps
is assumed.
.
.
@@ -1268,7 +1277,7 @@ Equivalent to
.
.Opt_def -- pdf-viewer prog
Set the viewer program for
-.I pdf
+.I \%pdf
mode.
.
This can be a file name or a program to be searched in
@@ -1284,17 +1293,17 @@ Equivalent to
.
.Opt_def -- ps-viewer prog
Set the viewer program for
-.I ps
+.I \%ps
mode.
.
This can be a file name or a program to be searched in
.Env_var $PATH .
.
Common Postscript viewers inlude
-.BR gv (1),
-.BR ghostview (1),
+.BR \%gv (1),
+.BR \%ghostview (1),
and
-.BR gs (1),
+.BR \%gs (1),
.
In each case, arguments can be provided additionally.
.
@@ -1309,7 +1318,7 @@ Equivalent to
.Opt_long_arg mode tty .
.
.
-.Opt_def -- tty-viewer
+.Opt_def -- tty\-viewer
Choose tty display mode, that means displaying in a text pager even
when in X; eqivalent to
.Opt_long_arg mode tty .
@@ -1320,9 +1329,9 @@ Equivalent to
.Opt_long_arg mode html .
.
.
-.Opt_def -- www-viewer prog
+.Opt_def -- www\-viewer prog
Equivalent to
-.Opt_long html-viewer .
+.Opt_long html\-viewer .
.
.
.Opt_def - X -- X -- x
@@ -1330,7 +1339,7 @@ Equivalent to
.Opt_long_arg mode X .
.
.
-.Opt_def -- X-viewer -- x-viewer prog
+.Opt_def -- X\-viewer -- x\-viewer prog
Set the viewer program for
.I x
mode.
@@ -1350,24 +1359,24 @@ In each case, arguments can be provided additionally.
.Opt_--
Signals the end of option processing; all remaining arguments are
interpreted as
-.I filespec
+.I \%filespec
parameters.
.
.
.P
Besides these,
-.I groffer
+.I \%groffer
accepts all arguments that are valid for the
-.BR groff (@MAN1EXT@)
+.BR \%groff (@MAN1EXT@)
program.
.
All non-groffer options are sent unmodified via
-.I grog
+.I \%grog
to
-.IR groff .
+.IR \%groff .
.
Postprocessors, macro packages, compatibility with classical
-.IR troff ,
+.IR \%troff ,
and much more can be manually specified.
.
.
@@ -1401,7 +1410,7 @@ This is the equivalent
.
.P
Other useful debugging options are the
-.I groff
+.I \%groff
options
.Opt_short V
and
@@ -1415,33 +1424,33 @@ and option
.\" --------------------------------------------------------------------
.
All short options of
-.I groffer
+.I \%groffer
are compatible with the short options of
-.BR groff (@MAN1EXT@).
+.BR \%groff (@MAN1EXT@).
.
The following of
-.I groff
+.I \%groff
options have either an additional special meaning within
-.I groffer
+.I \%groffer
or make sense for normal usage.
.
.
.P
Because of the special outputting behavior of the
-.I groff
+.I \%groff
options
.Opt_short V
and
.Opt_short Z
-.I groffer
+.I \%groffer
was designed to be switched into
-.I groff
+.I \%groff
mode by these; the
-.I groffer
+.I \%groffer
viewing features are disabled there.
.
The other
-.I groff
+.I \%groff
options do not switch the mode, but allow to customize the formatting
process.
.
@@ -1455,9 +1464,9 @@ sequences.
.
.Opt_def - m file
Add
-.I file
+.I \%file
as a
-.I groff
+.I \%groff
macro file.
.
This is useful in case it cannot be recognized automatically.
@@ -1465,61 +1474,61 @@ This is useful in case it cannot be recognized automatically.
.
.Opt_def - P opt_or_arg
Send the argument
-.I opt_or_arg
+.I \%opt_or_arg
as an option or option argument to the actual
-.I groff
+.I \%groff
postprocessor.
.
.
.Opt_def - T -- device devname
.
This option determines
-.IR groff 's
+.IR \%groff 's
output device.
.
The most important devices are the text output devices for referring
to the different character sets, such as
-.BR ascii ,
-.BR utf8 ,
-.BR latin1 ,
+.BR \%ascii ,
+.BR \%utf8 ,
+.BR \%latin1 ,
and others.
.
Each of these arguments switches
-.I groffer
+.I \%groffer
into a text mode using this device, to
-.I mode tty
+.I mode \%tty
if the actual mode is not a text mode.
.
The following
-.I devname
+.I \%devname
arguments are mapped to the corresponding
-.I groffer
+.I \%groffer
.Opt_long_arg mode \fIdevname\fR
option:
-.BR dvi ,
-.BR html ,
+.BR \%dvi ,
+.BR \%html ,
and
-.BR ps .
+.BR \%ps .
All
-.B X*
+.B \%X*
arguments are mapped to mode
-.BR X .
+.BR \%X .
Each other
-.I devname
+.I \%devname
argument switches to
-.I mode groff
+.I mode \%groff
using this device.
.
.
.Opt_def - V
Switch into
-.I groff
+.I \%groff
mode and show only the
-.I groff
+.I \%groff
calling pipe without formatting the input.
.
This an advanced option from
-.BR groff (@MAN1EXT@) ,
+.BR \%groff (@MAN1EXT@) ,
only useful for debugging.
.
.
@@ -1527,44 +1536,44 @@ only useful for debugging.
was made equivalent to
.Opt_long_arg mode x ;
this slightly enhances the facility of
-.IR groff 's
+.IR \%groff 's
option.
.
.
.Opt_def - Z -- intermediate-output -- ditroff
Switch into
-.I groff
+.I \%groff
mode and format the input with
-.I groff
+.I \%groff
intermediate output without postprocessing; see
-.BR groff_out (@MAN1EXT@).
+.BR \%groff_out (@MAN1EXT@).
This is equivalent to option
.Opt_long ditroff
of
-.IR man ,
+.IR \%man ,
which can be used as well.
.
.
.P
All other
-.I groff
+.I \%groff
options are supported by
-.IR groffer ,
+.IR \%groffer ,
but they are just transparently transferred to
-.I groff
+.I \%groff
without any intervention.
.
The options that are not explicitly handled by
-.I groffer
+.I \%groffer
are transparently passed to
-.IR groff .
+.IR \%groff .
.
Therefore these transparent options are not documented here, but in
-.BR groff (@MAN1EXT@).
+.BR \%groff (@MAN1EXT@).
Due to the automatism in
-.IR groffer ,
+.IR \%groffer ,
none of these
-.I groff
+.I \%groff
options should be needed, except for advanced usage.
.
.
@@ -1575,7 +1584,7 @@ options should be needed, except for advanced usage.
The following long options were adapted from the corresponding X
Toolkit options.
.
-.I groffer
+.I \%groffer
will pass them to the actual viewer program if it is an X Window
program.
.
@@ -1587,10 +1596,10 @@ Unfortunately these options use the old style of a single minus for
long options.
.
For
-.I groffer
+.I \%groffer
that was changed to the standard with using a double minus for long
options, for example,
-.I groffer
+.I \%groffer
uses the option
.Opt_long font
for the
@@ -1601,8 +1610,8 @@ option
.
.P
See
-.BR X (1),
-.BR X (7),
+.BR \%X (1),
+.BR \%X (7),
and the documentation on the X toolkit options for more details on
these options and their arguments.
.
@@ -1627,7 +1636,7 @@ window.
.
.Opt_def -- display X-display
Set the X display on which the viewer program shall be started, see the
-.I X Window
+.I X\~\%Window
documentation for the syntax of the argument.
.
.
@@ -1656,7 +1665,7 @@ Set the geometry of the display window, that means its size and its
starting position.
.
See
-.BR X (7)
+.BR \%X (7)
for the syntax of the argument.
.
.
@@ -1669,7 +1678,7 @@ and
.BR 100 .
.
Actually, the default resolution for
-.I groffer
+.I \%groffer
is set to
.BR 75 .
.
@@ -1691,20 +1700,20 @@ Set X resource.
.\" --------------------------------------------------------------------
.
The long options of
-.I groffer
+.I \%groffer
were synchronized with the long options of
.IR GNU man .
.
All long options of
.I GNU man
are recognized, but not all of these options are important to
-.IR groffer ,
+.IR \%groffer ,
so most of them are just ignored.
.
.
.P
The following two options were added to
-.I groffer
+.I \%groffer
for choosing whether the file name arguments are interpreted as names
for local files or as a search pattern for man pages.
.
@@ -1713,12 +1722,14 @@ The default is looking up for local files.
.
.Opt_def -- man
Check the non-option command line arguments
+.nh
.RI ( filespecs )
+.hy
first on being man\~pages, then whether they represent an existing
file.
.
By default, a
-.I filespec
+.I \%filespec
is first tested whether it is an existing file.
.
.
@@ -1735,7 +1746,7 @@ option.
In the following, the
.I man
options that have a special meaning for
-.I groffer
+.I \%groffer
are documented.
.
.
@@ -1745,7 +1756,7 @@ The full set of long and short options of the
program can be passed via the environment variable
.Env_var $MANOPT ;
see
-.BR man (1)
+.BR \%man (1)
if your system has
.I GNU man
installed.
@@ -1762,19 +1773,19 @@ In text modes, display ASCII translation of special characters.
.
.Opt_def -- ditroff
Eqivalent to
-.I groffer
+.I \%groffer
.Opt_short Z .
.
.
.Opt_def -- extension suffix
Restrict man\~page search to file names that have
-.I suffix
+.I \%suffix
appended to their section element.
.
For example, in the file name
-.I /usr/share/man/man3/terminfo.3ncurses.gz
+.I \%/usr/share/man/man3/terminfo.3ncurses.gz
the man\~page extension is
-.IR ncurses .
+.IR \%ncurses .
.
.
.Opt_def -- locale language
@@ -1795,7 +1806,7 @@ call to
.Opt_long location .
.
This was added by
-.IR groffer .
+.IR \%groffer .
.
.
.Opt_def -- manpath "'dir1:dir2:\*[Ellipsis]'"
@@ -1808,7 +1819,7 @@ is disabled.
.
.Opt_def -- pager
Set the pager program in tty mode; default is
-.IR less .
+.IR \%less .
This is equivalent to
.Opt_long tty-viewer .
.
@@ -1821,7 +1832,7 @@ a colon-separated list.
.
.Opt_def -- systems "'sys1,sys2,\*[Ellipsis]'"
Search for man pages for the given operating systems; the argument
-.I systems
+.I \%systems
is a comma-separated list.
.
.
@@ -1837,7 +1848,7 @@ Eqivalent to
.
.P
Additionally, the following short option of
-.I man
+.I \%man
is supported as well.
.
.
@@ -1846,43 +1857,44 @@ is supported as well.
.\" --------------------------------------------------------------------
.
A
-.I filespec
+.I \%filespec
parameter is an argument meaning an input source, such as a file name
or template for searching man\~pages.
.
These input sources are collected and composed into a single output
file such as
-.I groff
+.I \%groff
does.
.
.
.P
The strange POSIX behavior that maps all arguments behind the first
non-option argument into
-.I filespec
+.I \%filespec
arguments is ignored.
.
The GNU behavior to recognize options even when mixed with
-.I filespec
+.I \%filespec
arguments is used througout.
.
But, as usual, the double minus argument
.Opt_long
still takes all following arguments as
-.IR filespecs .
+.I \%filespec
+arguments.
.
.
.P
Each
-.I filespec
+.I \%filespec
parameters can have one of the following forms.
.
.
.P
No
-.I filespec
+.I \%filespec
parameters means that
-.I groffer
+.I \%groffer
waits for standard input.
.
The minus option
@@ -1890,7 +1902,7 @@ The minus option
stands for standard input, too, but can occur several times.
.
Next
-.I filespec
+.I \%filespec
is tested whether it is the path name of an existing file.
.
Otherwise it is assumed as a searching pattern for a man\~page.
@@ -1918,7 +1930,7 @@ means this scheme.
.
.P
The internal precedence of
-.I man
+.I \%man
for searching man pages with the same name within several sections
goes according to the classical single-character sequence.
.
@@ -1926,22 +1938,22 @@ On some systems, this single character can be extended by a following
string.
.
But the special
-.I groffer
-man page facility is based on the classical single character sections.
+.I \%groffer
+man\~page facility is based on the classical single character sections.
.
.
.P
-.BI man: name ( section )
+.BI \%man: name ( section )
and
-.IB name ( section )
+.IB \%name ( section )
search the man\~page
-.I name
+.I \%name
in man\~section\~\c
-.IR section ,
+.IR \%section ,
where
-.I section
+.I \%section
can be any string, but it must exist in the
-.I man
+.I \%man
system.
.
.
@@ -1950,11 +1962,11 @@ Next some patterns based on the
.I classical man sections
were constructed.
.
-.BI man: name . s
+.BI \%man: name . s
and
-.IB name . s
+.IB \%name . s
search for a man\~page
-.I name
+.I \%name
in man\~section
.I s
if
@@ -1964,23 +1976,23 @@ is a
mentioned above.
.
Otherwise search for a man\~page named
-.IR name.s
+.IR \%name.s
in the lowest
-.I man
-section.
+.I man\~\c
+.IR section .
.
.
.P
Now
-.BI man: name
+.BI \%man: name
searches for a man\~page in the lowest man\~section that has a
document called
-.IR name .
+.IR \%name .
.
.
.P
The pattern
-.I "s name"
+.I \%s\~name
originates from a strange argument parsing of the
.I man
program.
@@ -1990,25 +2002,25 @@ If
is a
.I classical man section
interpret it as a search for a man\~page called
-.I name
+.I \%name
in man\~section
.IR s ,
otherwise interpret
.I s
as a file argument and
-.I name
+.I \%name
as another
-.I filespec
+.I \%filespec
argument.
.
.
.P
We are left with the argument
-.I name
+.I \%name
which is not an existing file.
.
So this searches for the man\~page called
-.I name
+.I \%name
in the lowest man\~section that has a document for this name.
.
.
@@ -2016,14 +2028,14 @@ in the lowest man\~section that has a document for this name.
Several file name arguments can be supplied.
.
They are mixed by
-.I groff
+.I \%groff
into a single document.
.
Note that the set of option arguments must fit to all of these file
arguments.
.
So they should have at least the same style of the
-.I groff
+.I \%groff
language.
.
.
@@ -2032,19 +2044,19 @@ language.
.\" --------------------------------------------------------------------
.
By default, the
-.I groffer
+.I \%groffer
program collects all input into a single file, formats it with the
-.I groff
+.I \%groff
program for a certain device, and then chooses a suitable viewer
program.
.
The device and viewer process in
-.I groffer
+.I \%groffer
is called a
-.IR mode .
+.IR \%mode .
.
The mode and viewer of a running
-.I groffer
+.I \%groffer
program is selected automatically, but the user can also choose it
with options.
.
@@ -2062,23 +2074,23 @@ option that is constructed like
.P
Several different modes are offered, graphical X modes, text modes,
and some direct
-.I groff
+.I \%groff
modes for debugging and development.
.
.
.P
By default,
-.I groffer
+.I \%groffer
first tries whether
.B x
mode is possible, then
-.B ps
+.B \%ps
mode, and finally
-.B tty
+.B \%tty
mode.
.
This mode testing sequence for
-.B auto
+.B \%auto
mode can be changed by specifying a comma separated list of modes
with the option
.Opt_long default\-modes.
@@ -2093,8 +2105,9 @@ active in every mode.
.SS "Graphical Display Modes"
.\" --------------------------------------------------------------------
.
-The graphical display modes work only in the X Window environment (or
-similar implementations within other windowing environments).
+The graphical display modes work only in the
+.I X\~Window environment
+(or similar implementations within other windowing environments).
.
The environment variable
.Env_var $DISPLAY
@@ -2103,7 +2116,7 @@ and the option
are used for specifying the X display to be used.
.
If neither is given,
-.I groffer
+.I \%groffer
assumes that no X and changes to one text mode.
.
You can change this automatic behavior by the option
@@ -2127,31 +2140,39 @@ mode),
.
.Topic
in a Postscript viewer
+.nh
.RI ( ps
mode),
+.hy
.
.Topic
in a dvi viewer program
+.nh
.RI ( dvi
mode),
+.hy
.
.Topic
in a PDF viewer
+.nh
.RI ( pdf
mode),
+.hy
.
.Topic
in a web browser
+.nh
.RI ( html
or
.I www
mode),
+.hy
.RE
.
.
.P
The
-.I pdf
+.I \%pdf
mode has a major advantage \[em] it is the only graphical diplay mode
that allows to search for text within the viewer; this can be a really
important feature.
@@ -2165,9 +2186,11 @@ These graphical viewers can be customized by options of the X Window
Toolkit.
.
But the
-.I groffer
+.I \%groffer
options use a leading double minus instead of the single minus used by
-the X Window Toolkit.
+the
+.I X\~Window\~\c
+.IR Toolkit .
.
.
.\" --------------------------------------------------------------------
@@ -2175,9 +2198,9 @@ the X Window Toolkit.
.\" --------------------------------------------------------------------
.
There are to modes for text output, mode
-.I text
+.I \%text
for plain output without a pager and mode
-.I tty
+.I \%tty
for a text output on a text terminal using some pager program.
.
.
@@ -2185,13 +2208,13 @@ for a text output on a text terminal using some pager program.
If the variable
.Env_var $DISPLAY
is not set or empty, groffer assumes that it should use
-.I tty
+.I \%tty
mode.
.
.
.P
In the actual implementation, the groff output device
-.I latin1
+.I \%latin1
is chosen for text modes.
.
This can be changed by specifying option
@@ -2208,7 +2231,7 @@ and
or by the environment variable
.Env_var $PAGER .
If all of this is not used the
-.BR less (1)
+.BR \%less (1)
program with the option
.Opt_short r
for correctly displaying control sequences is used as the default
@@ -2220,13 +2243,13 @@ pager.
.\" --------------------------------------------------------------------
.
These modes use the
-.I groffer
+.I \%groffer
file determination and decompression.
.
This is combined into a single input file that is fed directly into
-.I groff
+.I \%groff
with different strategy without the
-.I groffer
+.I \%groffer
viewing facilities.
.
These modes are regarded as advanced, they are useful for debugging
@@ -2235,15 +2258,15 @@ and development purposes.
.
.P
The
-.I source
+.I \%source
mode with just displays the generated input.
.
The
-.I groff
+.I \%groff
mode passes the input to
-.I groff
+.I \%groff
using only some suitable options provided to
-.IR groffer .
+.IR \%groffer .
.
This enables the user to save the generated output into a file or pipe
it into another program.
@@ -2251,23 +2274,25 @@ it into another program.
.
.P
In
-.I groff
+.I \%groff
mode, the option
.Opt_short Z
disables post-processing, thus producing the
+.nh
.I groff intermediate
.IR output .
+.hy
.
In this mode, the input is formatted, but not postprocessed; see
-.BR groff_out (@MAN5EXT@)
+.BR \%groff_out (@MAN5EXT@)
for details.
.
.
.P
All
-.I groff
+.I \%groff
short options are supported by
-.IR groffer .
+.IR \%groffer .
.
.
.\" --------------------------------------------------------------------
@@ -2304,22 +2329,22 @@ The groffer program provides a search facility for man\~pages.
.
All long options, all environment variables, and most of the
functionality of the GNU
-.BR man (1)
+.BR \%man (1)
program were implemented.
.
This inludes the extended file names of man\~pages, for example,
the man\~page of
-.I groff
+.I \%groff
in man\~section 7 may be stored under
.File_name /usr/share/man/man7/groff.7.gz ,
where
.File_name /usr/share/man/
is part of the man\~path, the subdirectory
-.I man7
+.I \%man7
and the file extension
.I .7
refer to the man\~section 7;
-.I .gz
+.I \%.gz
shows the compression of the file.
.
.
@@ -2367,7 +2392,7 @@ is searched for man\~pages.
.
.Topic
If this does not work, the
-.BR manpath (1)
+.BR \%manpath (1)
program for determining a path of man directories is tried.
.
.
@@ -2377,9 +2402,9 @@ system specific man\~pages are added to the man\~path; their sequence
is determined automatically.
.
For example, both
-.I /usr/share/man/linux/fr
+.File_name /usr/share/man/linux/fr
and
-.I /usr/share/man/fr/linux
+.File_name /usr/share/man/fr/linux
for french linux man\~pages are found.
.
The language and operating system names are determined from both
@@ -2412,18 +2437,22 @@ highest to lowest precedence:
The language locale is usually specified in the POSIX 1003.1 based
format:
.P
+.nh
\f[I]<language>\f[][\f[CB]_\f[]\f[I]<territory>\f[][\f[CB].\f[]\
\f[I]<character-set>\f[][\f[CB],\f[]\f[I]<version>\f[]]]],
+.hy
.P
but the two-letter code in
+.nh
.I <language>
+.hy
is sufficient for most purposes.
.
.
.P
If no man\~pages for a complicated locale are found the country part
consisting of the first two characters (without the `\f[CB]_\f[]',
-`\f[CB].\f[]', and `\f[CB],\f[]', parts) of the locale is searched as
+`\f[CB].\f[]', and `\f[CB],\f[]' parts) of the locale is searched as
well.
.
.
@@ -2493,7 +2522,7 @@ or environment variable
.
.P
For further details on man\~page searching, see
-.BR man (1).
+.BR \%man (1).
.
.
.\" --------------------------------------------------------------------
@@ -2504,16 +2533,16 @@ The program has a decompression facility.
.
If standard input or a file that was retrieved from the command line
parameters is compressed with a format that is supported by either
-.BR gzip (1)
+.BR \%gzip (1)
or
-.BR bzip2 (1)
+.BR \%bzip2 (1)
it is decompressed on-the-fly.
.
This includes the GNU
-.BR .gz ,
-.BR .bz2 ,
+.BR \%.gz ,
+.BR \%.bz2 ,
and the traditional
-.B .Z
+.B \%.Z
compression.
.
The program displays the concatenation of all decompressed input in
@@ -2528,9 +2557,9 @@ The groffer programs supports many system variables, most of them by
courtesy of other programs.
.
All environment variables of
-.BR groff (@MAN1EXT@)
+.BR \%groff (@MAN1EXT@)
and GNU
-.BR man (1)
+.BR \%man (1)
and some standard system variables are honored.
.
.
@@ -2555,9 +2584,9 @@ be quoted.
.\" --------------------------------------------------------------------
.
The groffer program is a shell script that is run through
-.BR /bin/sh ,
+.File_name /bin/sh ,
which can be internally linked to programs like
-.BR bash (1).
+.BR \%bash (1).
The corresponding system environment is automatically effective.
.
The following variables have a special meaning for groffer.
@@ -2590,6 +2619,7 @@ is interpreted as the locale, the language to be used, especially when
retrieving man\~pages.
.
A locale name is typically of the form
+.nh
.IR language [\c
.B _\c
.IR territory [\c
@@ -2597,20 +2627,21 @@ A locale name is typically of the form
.IR codeset [\c
.B @\c
.IR modifier ]]],
+.hy
where
-.I language
+.I \%language
is an ISO 639 language code,
-.I territory
+.I \%territory
is an ISO 3166 country code, and
-.I codeset
+.I \%codeset
is a character set or encoding identifier like ISO-8859-1 or UTF-8;
see
-.BR setlocale (3).
+.BR \%setlocale (3).
.
The locale values\~\c
.B C
and
-.B POSIX
+.B \%POSIX
stand for the default, i.e. the man\~page directories without a
language prefix.
.
@@ -2623,7 +2654,7 @@ 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
variable to the
-.BR cat (1)
+.BR \%cat (1)
program
.Shell_cmd PAGER=cat\~groffer\~ anything
.
@@ -2643,13 +2674,13 @@ If set to a non-empty value this chooses the POSIX mode.
.
This is done internally by some shells.
.
-.I groffer
+.I \%groffer
ignores the bad POSIX behavior for option processing, that means that
option processing will be finished as soon as a non-option argument is
found.
.
Instead the GNU behavior of freely mixing options and
-.I filespec
+.I \%filespec
arguments is used in any case.
.
Usually, you do not want to set this environment variable externally.
@@ -2661,7 +2692,7 @@ Usually, you do not want to set this environment variable externally.
.
The groffer program internally calls groff, so all environment
variables documented in
-.BR groff (@MAN1EXT@)
+.BR \%groff (@MAN1EXT@)
are internally used within groffer as well.
.
The following variables have a direct meaning for the groffer program.
@@ -2669,7 +2700,8 @@ The following variables have a direct meaning for the groffer program.
.TP
.Env_var $GROFF_TMPDIR
If the value of this variable is an existing, writable directory,
-groffer uses it for storing its temporary files, just as groff does.
+.I \%groffer
+uses it for storing its temporary files, just as groff does.
.
.
.\" --------------------------------------------------------------------
@@ -2678,7 +2710,7 @@ groffer uses it for storing its temporary files, just as groff does.
.
Parts of the functionality of the man\~program were implemented in
groffer; support for all environment variables documented in
-.BR man (1)
+.BR \%man (1)
was added to groffer, but the meaning was slightly modified due to the
different approach in groffer; but the user interface is the same.
.
@@ -2700,7 +2732,7 @@ see there for details.
.TP
.Env_var $MANOPT
This variable contains options as a preset for
-.BR man (1).
+.BR \%man (1).
As not all of these are relevant for groffer only the essential parts
of its value are extracted.
.
@@ -2751,7 +2783,7 @@ determined automatically.
.\" --------------------------------------------------------------------
.
The
-.I groffer
+.I \%groffer
program can be preconfigured by two configuration files.
.
This configuration can be overridden at each program start by command
@@ -2783,26 +2815,32 @@ The lines with the beginning minus are appended to the existing value
of $GROFFER_OPT.
.
This easily allows to set general
-.I groffer
+.I \%groffer
options that are used with any call of
-.IR groffer .
+.IR \%groffer .
.
.
.P
-After the transformation of the minus lines the emerging shell scripts
-that are called by
-.I groffer
-using the `\c
-.CB .\~\c
+After the transformation of the minus lines, the emerging
+configuration shell scripts are called using the `\c
+.nh
+.CB \.\~\c
.IR filename '
-syntax.
+.hy
+shell syntax within
+.IR \%groffer .
.
.
.P
-The only option that needs a minus line in the configuration files is
+In the configuration files, there is only one option that really needs
+a line starting with a minus character because it cannot be restored
+by any shell tricks.
+.
+This is
.Opt_long shell .
-The reason is that its argument must be called at a very early stage
-before the whole syntax of the configuration can be transformed.
+The reason is that its argument must be retrieved at a very early
+stage of
+.IR \%groffer .
.
.
.P
@@ -2814,11 +2852,12 @@ Preset command line options by writing them into lines starting with a
minus sign.
.
.Topic
-Preset environment variables recognized by groffer.
+Preset environment variables recognized by
+.IR \%groffer .
.
.Topic
Write a function for calling a viewer program for a special
-.I mode
+.I \%mode
and feed this name into its corresponding
.Opt_long \f[I]mode\f[]\-viewer
option.
@@ -2831,7 +2870,8 @@ in order to be recognized by groffer.
.
.P
As an example, consider the following configuration file in
-~/.groff/groffer.conf, say.
+.File_name ~/.groff/groffer.conf ,
+say.
.
.P
.ft CR
@@ -2857,32 +2897,30 @@ date >>~/mygroffer.log
.
.P
This configuration sets four
-.I groffer
-options and runs two shell commands.
+.I \%groffer
+options (the lines starting with `-') and runs two shell commands (the
+rest of the script).
.
This has the following effects:
.
.
.Topic
-Lines starting with a
-.B #
-character
-are
-.
-.
-.Topic
Use
.B /bin/bash
as the shell to run the
-.I groffer
+.I \%groffer
script.
.
.
.Topic
-Take a resolution of
-.B 100 dpi
-and a text color of
-.B DarkBlue
+Use a resolution of
+.B 100\~dpi
+in all viewers that support this.
+.
+.
+.Topic
+Use a text color of
+.B \%DarkBlue
in all viewers that support this.
.
.
@@ -2891,28 +2929,29 @@ Force
.BR \%gxditview (@MAN1EXT@)
as the X-mode viewer using the geometry option for setting the width
to
-.B 850 dpi
+.B 850\~dpi
and the height to
-.B 800
+.B 800\~\c
.BR dpi .
.
.
.Topic
-The variable
+If the environment variable
.Env_var $DISPLAY
-is set to
-.IR localhost:0.0
-which allows to start
-.I groffer
-in the standard X display, even when the program is called from a text
+is empty set it to
+.IR localhost:0.0 .
+.
+That allows to start
+.I \%groffer
+in the standard X\~display, even when the program is called from a text
console.
.
.
.Topic
Just for fun, the date of each
-.I groffer
+.I \%groffer
start is written to the file
-.B mygroffer.log
+.File_name mygroffer.log
in the home directory.
.
.
@@ -2920,7 +2959,9 @@ in the home directory.
.SH "EXAMPLES"
.\" --------------------------------------------------------------------
.
-The usage of groffer is very easy.
+The usage of
+.I \%groffer
+is very easy.
.
Usually, it is just called with a file name or man\~page.
.
@@ -2931,33 +2972,33 @@ capabilities.
.TP
.Shell_cmd "groffer\~/usr/local/share/doc/groff/meintro.ms.gz"
Decompress, format and display the compressed file
-.I meintro.ms.gz
+.File_name meintro.ms.gz
in the directory
-.IR /usr/local/share/doc/groff ,
+.File_name /usr/local/share/doc/groff ,
using
.I \%gxditview
as graphical viewer when in X Window, or the
-.BR less (1)
+.BR \%less (1)
pager program when not in X.
.
.
.TP
.Shell_cmd "groffer\~groff"
If the file
-.I ./groff
+.I \%./groff
exists use it as input.
.
Otherwise interpret the argument as a search for the man\~page named
-.I groff
-in the smallest possible man\~section, being secion 1 in this case.
+.I \%groff
+in the smallest possible man\~section, being section 1 in this case.
.
.
.TP
.Shell_cmd "groffer\~man:groff"
search for the man\~page of
-.I groff
+.I \%groff
even when the file
-.I ./groff
+.File_name ./groff
exists.
.
.
@@ -2966,7 +3007,7 @@ exists.
.TP+
.Shell_cmd "groffer\~7\~groff"
search the man\~page of
-.I groff
+.I \%groff
in man\~section
.BR 7 .
This section search works only for a digit or a single character from
@@ -2976,11 +3017,11 @@ a small set.
.TP
.Shell_cmd "groffer\~fb.modes"
If the file
-.I ./fb.modes
+.File_name ./fb.modes
does not exist interpret this as a search for the man\~page of
.IR fb.modes .
As the extension
-.I modes
+.I \%modes
is not a single character in classical section style the argument is
not split to a search for
.IR fb .
@@ -2991,16 +3032,18 @@ not split to a search for
.
The arguments that are not existing files are looked-up as the
following man\~pages:
-.I groff
+.I \%groff
(automatic search, should be found in man\~section\~1),
-.I troff
+.I \%troff
(in section\~1),
and
-.I roff
+.I \%roff
(in the section with the lowest number, being\~7 in this case).
.
The quotes around
+.nh
.I \[cq]troff(1)\[cq]
+.hy
are necessary because the paranthesis are special shell characters;
escaping them with a backslash character
.I \[rs](
@@ -3019,15 +3062,18 @@ Retrieve the German man\~page (language
for the
.B ls
program, decompress it, format it to
-.I html
+.I \%html
format
+.nh
.RI ( www
-mode) and view the result in the web browser
-.I galeon .
+mode)
+.hy
+and view the result in the web browser
+.IR \%galeon .
The option
.Opt_long man
guarantees that the man\~page is retrieved, even when a local file
-.I ls
+.I \%ls
exists in the actual directory.
.
.
@@ -3035,7 +3081,7 @@ exists in the actual directory.
.Shell_cmd "groffer\~--source\~'man:roff(7)'"
.
Get the man\~page called
-.I roff
+.I \%roff
in man\~section 7, decompress it, and print its unformatted content,
its source code.
.
@@ -3044,11 +3090,11 @@ its source code.
.Shell_cmd "cat\~file.gz\~|\~groffer\~-Z\~-mfoo"
.
Decompress the standard input, send this to
-.I groff
+.I \%groff
intermediate mode without post-processing (groff option
.Opt_short Z ),
using macro package by
-.I foo
+.I \%foo
(groff option
.Opt_short m ) .
.
@@ -3067,7 +3113,7 @@ bold font, using color yellow on red background.
.\" --------------------------------------------------------------------
.
The
-.B groffer
+.B \%groffer
shell script is compatible with both GNU and POSIX.
.
POSIX compatibility refers to
@@ -3091,25 +3137,33 @@ provide much more facilities.
Nevertheless this script uses only a restricted set of shell language
elements and shell builtins.
.
-The groffer script should work on most actual free and commercial
-operating systems.
+The
+.I \%groffer
+script should work on most actual free and commercial operating
+systems.
.
.
.P
-The groffer program provides its own parser for command line options;
-it can handle option arguments and file names containing white space
-and a large set of special characters.
+The
+.I \%groffer
+program provides its own parser for command line options; it can
+handle option arguments and file names containing white space and a
+large set of special characters.
.
.
.P
-The groffer shell script was tested with the following common
-implementations of the GNU shells:
-POSIX
-.BR sh (1),
-.BR bash (1),
+The
+.I \%groffer
+shell script was tested with the following common implementations of
+the GNU shells:
+.I \%POSIX
+.BR \%sh (1),
+.BR \%bash (1),
and others.
.
-Free POSIX compatible shells and shell utilities for most operating
+Free
+.I \%POSIX
+compatible shells and shell utilities for most operating
systems are available at the
.URL http://\:www.gnu.org/software/ "GNU software archive" .
.
@@ -3120,18 +3174,22 @@ The shell can be chosen by the option
This option can also be given to the environment variable
.Env_var $GROFF_OPT .
If you want to write it to one of the
-.I groffer
+.I \%groffer
configuration files you must use the single option style, a line
starting with
.Opt_long shell .
.
.
.P
-The groffer program provides its own parser for command line arguments
-that is compatible to both POSIX
-.BR getopts (1)
-and GNU
-.BR getopt (1)
+The
+.I \%groffer
+program provides its own parser for command line arguments that is
+compatible to both
+.I \%POSIX
+.BR \%getopts (1)
+and
+.I \%GNU
+.BR \%getopt (1)
except for shortcuts of long options.
.
The following standard types of options are supported.
@@ -3140,7 +3198,7 @@ The following standard types of options are supported.
.Topic
A single minus always refers to single character option or a
combination thereof, for example, the
-.I groffer
+.I \%groffer
short option combination
.Opt_short Qmfoo
is equivalent to
@@ -3199,116 +3257,130 @@ want to set
.\" --------------------------------------------------------------------
.
.TP
-.BR groff (@MAN1EXT@)
+.BR \%groff (@MAN1EXT@)
.TP+
-.BR troff (@MAN1EXT@)
+.BR \%troff (@MAN1EXT@)
Details on the options and environment variables available in
-.IR groff ;
+.IR \%groff ;
all of them can be used with groffer.
.
.
.TP
-.BR groff (@MAN7EXT@)
+.BR \%groff (@MAN7EXT@)
Documentation of the
-.I groff
+.I \%groff
language.
.
.
.TP
-.BR grog (@MAN1EXT@)
-Internally, groffer tries to guess the groff command line options from
-the input using this program.
+.BR \%grog (@MAN1EXT@)
+Internally,
+.I \%groffer
+tries to guess the
+.I \%groff
+command line options from the input using this program.
.
.
.TP
.BR groff_out (@MAN5EXT@)
-Documentation on the groff intermediate output (ditroff output).
+Documentation on the
+.I \%groff intermediate output
+.nh
+.RI ( ditroff
+output).
+.hy
.
.
.TP
-.BR man (1)
+.BR \%man (1)
The standard program to diplay man\~pages.
.
The information there is only useful if it is the man\~page for
.IR "GNU\~man" .
Then it documents the options and environment variables that are
-supported by groffer.
+supported by
+.IR \%groffer .
.
.
.TP
-.BR gxditview (@MAN1EXT@)
+.BR \%gxditview (@MAN1EXT@)
.TP+
-.BR xditview (1x)
-Viewers for groffer's
+.BR \%xditview (1x)
+Viewers for
+.IR \%groffer 's
.I x
mode.
.
.
.TP
-.BR kghostview (1)
+.BR \%kghostview (1)
.TP+
-.BR ggv (1)
+.BR \%ggv (1)
.TP+
-.BR gv (1)
+.BR \%gv (1)
.TP+
-.BR ghostview (1)
+.BR \%ghostview (1)
.TP+
-.BR gs (1)
-Viewers for groffer's
+.BR \%gs (1)
+Viewers for
+.IR \%groffer 's
.I ps
mode.
.
.
.TP
-.BR kghostview (1)
+.BR \%kghostview (1)
.TP+
-.BR ggv (1)
+.BR \%ggv (1)
.TP+
-.BR xpdf (1)
+.BR \%xpdf (1)
.TP+
-.BR acroread (1)
+.BR \%acroread (1)
.TP+
-.BR kpdf (1)
-Viewers for groffer's
-.I pdf
+.BR \%kpdf (1)
+Viewers for
+.IR \%groffer 's
+.I \%pdf
mode.
.
.
.TP
-.BR kdvi (1)
+.BR \%kdvi (1)
.TP+
-.BR xdvi (1)
+.BR \%xdvi (1)
.TP+
-.BR dvilx (1)
-Viewers for groffer's
-.I dvi
+.BR \%dvilx (1)
+Viewers for
+.IR \%groffer 's
+.I \%dvi
mode.
.
.
.TP
-.BR konqueror (1)
+.BR \%konqueror (1)
.TP+
-.BR mozilla (1)
+.BR \%mozilla (1)
.TP+
-.BR lynx (1)
-Web-browsers for groffer's
-.I html
+.BR \%lynx (1)
+Web-browsers for
+.IR \%groffer 's
+.I \%html
or
-.I www
+.I \%www
mode.
.
.
.TP
-.BR less (1)
+.BR \%less (1)
Standard pager program for the
-.I tty
+.I \%tty
.IR mode .
.
.
.TP
-.BR gzip (1)
+.BR \%gzip (1)
.TP+
-.BR bzip2 (1)
+.BR \%bzip2 (1)
The decompression programs supported by groffer.
.
.