[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[groff] 01/15: [groffer] groffer.man: Make it work in compatibility mode
From: |
Werner LEMBERG |
Subject: |
[groff] 01/15: [groffer] groffer.man: Make it work in compatibility mode. (EL): Fix typo. |
Date: |
Fri, 03 Apr 2015 15:28:46 +0000 |
wl pushed a commit to branch master
in repository groff.
commit f8376a6e22761d1cef5ac5b453623c61d8ee479c
Author: Werner Lemberg <address@hidden>
Date: Fri Apr 3 07:53:24 2015 +0200
[groffer] groffer.man: Make it work in compatibility mode.
(EL): Fix typo.
---
contrib/groffer/ChangeLog | 5 ++
contrib/groffer/groffer.man | 148 +++++++++++++++++++++++--------------------
2 files changed, 84 insertions(+), 69 deletions(-)
diff --git a/contrib/groffer/ChangeLog b/contrib/groffer/ChangeLog
index fbee325..3b9a02a 100644
--- a/contrib/groffer/ChangeLog
+++ b/contrib/groffer/ChangeLog
@@ -1,3 +1,8 @@
+2015-04-04 Werner LEMBERG <address@hidden>
+
+ * groffer.man: Make it work in compatibility mode.
+ (EL): Fix typo.
+
2015-03-20 Werner LEMBERG <address@hidden>
* subs.pl (where_is_prog): Fix typo.
diff --git a/contrib/groffer/groffer.man b/contrib/groffer/groffer.man
index 46b1104..4c76aa6 100644
--- a/contrib/groffer/groffer.man
+++ b/contrib/groffer/groffer.man
@@ -4,12 +4,22 @@ groffer \- display groff files and man\~pages on X and tty
.
.\" The .SH was moved to this place in order to appease `apropos'.
.
+.
+.\"*********************************************************************
+.\"
+.\" This man page doesn't use extended groff syntax!
+.\" Formatting it with and without groff's option `-C' should always
+.\" give the same result.
+.\"
+.\"*********************************************************************
+.
+.
.\" --------------------------------------------------------------------
.\" Legalese
.\" --------------------------------------------------------------------
.
.de co
-Copyright \[co] 2001-2014 Free Software Foundation, Inc.
+Copyright \(co 2001-2014 Free Software Foundation, Inc.
This file is part of groffer, which is part of groff, a free software
project.
@@ -35,12 +45,12 @@ Bernd Warken
.\" --------------------------------------------------------------------
.
.\" Ellipsis ...
-.ie t .ds EL \fS\N'188'\fP
-.el .ds EL \&.\|.\|.\&\
+.ie t .ds EL \fS\N'188'\fP\"
+.el .ds EL \&.\|.\|.\&\"
.\" called with \*(EL
.
.\" Bullet
-.ie t .ds BU \[bu]
+.ie t .ds BU \(bu
.el .ds BU *
.\" used in `.IP \*(BU 2m' (former .Topic)
.
@@ -102,7 +112,7 @@ preprocessors, such as
The
.B \%groffer
program also includes many of the features for finding and displaying
-the \%\f[CR]Unix\f[] manual pages
+the \%\f(CRUnix\fP manual pages
.nh
.RI ( man\~pages ),
.hy
@@ -139,7 +149,7 @@ available for
.
This includes the
.I \%groff
-native \%\f[CR]X\~Window\f[] viewer
+native \%\f(CRX\~Window\fP viewer
.BR \%gxditview (@MAN1EXT@),
each
.IR \%Postcript ,
@@ -175,7 +185,7 @@ They are transformed into a single document in the normal
way of
.
.
.P
-Option handling is done in \f[CR]GNU\f[] style.
+Option handling is done in \f(CRGNU\fP style.
.
Options and file names can be mixed freely.
.
@@ -294,7 +304,7 @@ short options are accepted.
.OP \-\-troff\-device device
.YS
.P
-Further long options of \f[CR]GNU\f[]
+Further long options of \f(CRGNU\fP
.B man
are accepted as well.
.RE
@@ -365,7 +375,7 @@ that is optionally followed by an
The name of a
.I man section
is a single character from
-.BR \%[1\[en]9on] ,
+.BR \%[1\(en9on] ,
the
.I extension
is some word.
@@ -524,7 +534,7 @@ The default modes are
.IR "mode x" ,
and
.I "mode dvi"
-in \%\f[CR]X\~Window\f[] with different viewers and
+in \%\f(CRX\~Window\fP with different viewers and
.I mode tty
with device
.I utf8
@@ -535,14 +545,14 @@ default mode do not exist.
.
.
.P
-In \%\f[CR]X\~Window\f[], many programs create their own window when
+In \%\f(CRX\~Window\fP, many programs create their own window when
called.
.
.B \%groffer
can run these viewers as an independent program in the background.
.
As this does not work in text mode on a terminal (tty) there must be a
-way to know which viewers are \%\f[CR]X\~Window\f[] graphical
+way to know which viewers are \%\f(CRX\~Window\fP graphical
programs.
.
The
@@ -550,7 +560,7 @@ The
script has a small set of information on some viewer names.
.
If a viewer argument of the command\-line chooses an element that is
-kept as \%\f[CR]X\~Window\f[] program in this list it is treated as a
+kept as \%\f(CRX\~Window\fP program in this list it is treated as a
viewer that can run in the background.
.
All other, unknown viewer calls are not run in the background.
@@ -620,7 +630,7 @@ This can be a file name or a program to be searched in
.SM
.BR $PATH .
.
-Known \%\f[CR]X\~Window\f[]
+Known \%\f(CRX\~Window\fP
.I \%dvi
viewers include
.BR \%xdvi (1)
@@ -781,7 +791,7 @@ by default, can be chosen with option
Format in a
.I \%groff\~text\~mode
and write the result to standard output using a text pager program,
-even when in \%\f[CR]X\~Window\f[].
+even when in \%\f(CRX\~Window\fP.
.
.
.TP
@@ -800,7 +810,7 @@ By default, the formatted input is displayed with the
.BR \%gxditview (@MAN1EXT@)
program being distributed together with
.BR \%groff .
-But the standard \%\f[CR]X\~Window\f[] tool
+But the standard \%\f(CRX\~Window\fP tool
.BR \%xditview (1)
can also be chosen with the option
.BR \-\-viewer .
@@ -1281,7 +1291,7 @@ For each
.I \%filespec
argument search all
.I \%man\~pages
-and display their description \[em] or say that it is not a
+and display their description \(em or say that it is not a
.IR \%man\~page .
This is written from anew, so it differs from
.IR man 's
@@ -1355,10 +1365,10 @@ and
.
The long options of
.B \%groffer
-were synchronized with the long options of \f[CR]GNU\f[]
+were synchronized with the long options of \f(CRGNU\fP
.BR man .
.
-All long options of \f[CR]GNU\f[]
+All long options of \f(CRGNU\fP
.B man
are recognized, but not all of these options are important to
.BR \%groffer ,
@@ -1382,9 +1392,9 @@ are documented.
.
.
.P
-If your system has \f[CR]GNU\f[]
+If your system has \f(CRGNU\fP
.B man
-installed the full set of long and short options of the \f[CR]GNU\f[]
+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
@@ -1514,11 +1524,11 @@ Equivalent to
.\" --------------------------------------------------------------------
.
The following long options were adapted from the corresponding
-\%\f[CR]X\~Window\~Toolkit\f[] options.
+\%\f(CRX\~Window\~Toolkit\fP options.
.
.B \%groffer
will pass them to the actual viewer program if it is an
-\%\f[CR]X\~Window\f[] program.
+\%\f(CRX\~Window\fP program.
.
Otherwise these options are ignored.
.
@@ -1534,14 +1544,14 @@ options, for example,
.B \%groffer
uses the option
.B \-\-font
-for the \%\f[CR]X\~Window\f[] option
+for the \%\f(CRX\~Window\fP option
.BR \-font .
.
.
.P
See
.BR X (7)
-and the documentation on the \%\f[CR]X\~Window\~Toolkit\f[] options
+and the documentation on the \%\f(CRX\~Window\~Toolkit\fP options
for more details on these options and their arguments.
.
.
@@ -1581,8 +1591,8 @@ window.
.
.TP
.BI \-\-display \ X-display
-Set the \%\f[CR]X\~Window\f[] display on which the viewer program
-shall be started, see the \%\f[CR]X\~Window\f[] documentation for the
+Set the \%\f(CRX\~Window\fP display on which the viewer program
+shall be started, see the \%\f(CRX\~Window\fP documentation for the
syntax of the argument.
.
.
@@ -1607,7 +1617,7 @@ This is equivalent to
.BI \-\-font \ font_name
Set the font used by the viewer window.
.
-The argument is an \%\f[CR]X\~Window\f[] font name.
+The argument is an \%\f(CRX\~Window\fP font name.
.
.
.TP
@@ -1628,7 +1638,7 @@ for the syntax of the argument.
.
.TP
.BI \-\-resolution \ value
-Set \%\f[CR]X\~Window\f[] resolution in dpi (dots per inch) in some
+Set \%\f(CRX\~Window\fP resolution in dpi (dots per inch) in some
viewer programs.
.
The only supported dpi values are
@@ -1656,7 +1666,7 @@ Set the title for the viewer window.
.
.TP
.BI \-\-xrm \ 'resource'
-Set \f[CR]\%X\~Window\f[] resource.
+Set \f(CR\%X\~Window\fP resource.
.
.
.\" --------------------------------------------------------------------
@@ -1790,12 +1800,12 @@ does.
.
.
.P
-The strange \%\f[CR]POSIX\f[] behavior to regard all arguments behind
+The strange \%\f(CRPOSIX\fP behavior to regard all arguments behind
the first non-option argument as
.I \%filespec
arguments is ignored.
.
-The \f[CR]GNU\f[] behavior to recognize options even when mixed with
+The \f(CRGNU\fP behavior to recognize options even when mixed with
.I \%filespec
arguments is used throughout.
.
@@ -1803,7 +1813,7 @@ But, as usual, the double minus argument
.B \-\-
ends the option handling and interprets all following arguments as
.I \%filespec
-arguments; so the \%\f[CR]POSIX\f[] behavior can be easily adopted.
+arguments; so the \%\f(CRPOSIX\fP behavior can be easily adopted.
.
.
.P
@@ -2026,7 +2036,7 @@ option
.
.P
Several different modes are offered, graphical modes for
-\f[CR]\%X\~Window\f[],
+\f(CR\%X\~Window\fP,
.IR \%text\~modes ,
and some direct
.I \%groff\~modes
@@ -2060,7 +2070,7 @@ and the decompression of the input are active in every
mode.
.SS "Graphical Display Modes"
.\" --------------------------------------------------------------------
.
-The graphical display modes work mostly in the \%\f[CR]X\~Window\f[]
+The graphical display modes work mostly in the \%\f(CRX\~Window\fP
environment (or similar implementations within other windowing
environments).
.
@@ -2069,11 +2079,11 @@ The environment variable
.B \%$DISPLAY
and the option
.B \-\-display
-are used for specifying the \%\f[CR]X\~Window\f[] display to be used.
+are used for specifying the \%\f(CRX\~Window\fP display to be used.
.
If this environment variable is empty
.B \%groffer
-assumes that no \%\f[CR]X\~Window\f[] is running and changes to a
+assumes that no \%\f(CRX\~Window\fP is running and changes to a
.IR \%text\~mode .
.
You can change this automatic behavior by the option
@@ -2082,7 +2092,7 @@ You can change this automatic behavior by the option
.
.P
Known viewers for the graphical display modes and their standard
-\%\f[CR]X\~Window\f[] viewer programs are
+\%\f(CRX\~Window\fP viewer programs are
.
.IP \*(BU 2m
in a PDF viewer
@@ -2106,7 +2116,7 @@ in a Postscript viewer
.hy
.
.IP \*(BU 2m
-\%\f[CR]X\~Window\f[]
+\%\f(CRX\~Window\fP
.I roff
viewers such as
.BR \%gxditview (@MAN1EXT@)
@@ -2125,7 +2135,7 @@ in a dvi viewer program
.P
The
.I \%pdf\~mode
-has a major advantage \[em] it is the only graphical display mode that
+has a major advantage \(em it is the only graphical display mode that
allows to search for text within the viewer; this can be a really
important feature.
.
@@ -2135,12 +2145,12 @@ format, so it was not chosen as the major mode.
.
.P
These graphical viewers can be customized by options of the
-\%\f[CR]X\~Window\~Toolkit\f[].
+\%\f(CRX\~Window\~Toolkit\fP.
.
But the
.B \%groffer
options use a leading double minus instead of the single minus used by
-the \%\f[CR]X\~Window\~Toolkit\f[].
+the \%\f(CRX\~Window\~Toolkit\fP.
.
.
.\" --------------------------------------------------------------------
@@ -2315,7 +2325,7 @@ program provides a search facility for
.IR \%man\~pages .
.
All long options, all environment variables, and most of the
-functionality of the \f[CR]GNU\fP
+functionality of the \f(CRGNU\fP
.BR \%man (1)
program were implemented.
.
@@ -2509,7 +2519,7 @@ option
The
.I default language
can be specified by specifying one of the pseudo-language parameters
-\f[CR]C\fP or \f[CR]\%POSIX\fP.
+\f(CRC\fP or \f(CR\%POSIX\fP.
.
This is like deleting a formerly given
.I language
@@ -2527,13 +2537,13 @@ Of course, the
.I language
name is determined by
.BR man .
-In \f[CR]GNU\fP
+In \f(CRGNU\fP
.BR man ,
-it is specified in the \%\f[CR]POSIX\~1003.1\fP based format:
+it is specified in the \%\f(CRPOSIX\~1003.1\fP based format:
.P
.nh
-\f[I]<language>\/\f[][\f[CB]_\f[]\,\f[I]<territory>\/\f[][\f[CB].\fP\
-\f[I]<character-set>\/\f[][\f[CB],\fP\,\f[I]<version>\/\fP]]],
+\fI<language>\/\fP[\f(CB_\fP\,\fI<territory>\/\fP[\f(CB.\fP\
+\fI<character-set>\/\fP[\f(CB,\fP\,\fI<version>\/\fP]]],
.hy
.P
but the two-letter code in
@@ -2613,8 +2623,8 @@ Each
file in a
.I section
directory has the form
-.IR \%\f[CB]man\fP<section>\f[CB]/\fP<name>\f[CB].\fP<section>\
-[<extension>][\f[CB].\fP<compression>] ,
+.IR \%\f(CBman\fP<section>\f(CB/\fP<name>\f(CB.\fP<section>\
+[<extension>][\f(CB.\fP<compression>] ,
where
.I \%<extension>
and
@@ -2753,7 +2763,7 @@ searching, see
.B /usr/share/man/man1/groff.1
This is an uncompressed file for the
.I \%man\~page
-\f[CR]groff\fP in
+\f(CRgroff\fP in
.IR section\~1 .
.
It can be called by
@@ -2841,8 +2851,8 @@ The file can be viewed with one of the following commands
\fIsh#\fR\~groffer\~1e\~ctags
\fIsh#\fR\~groffer\~\-\-extension=e\~\-\-sections=1\~ctags
.EE
-where \f[CR]e\fP works as an abbreviation for the extension
-\f[CR]emacs21\fP.
+where \f(CRe\fP works as an abbreviation for the extension
+\f(CRemacs21\fP.
.
.
.TP
@@ -2912,7 +2922,7 @@ or
.BR \%bzip2 (1)
it is decompressed on-the-fly.
.
-This includes the \f[CR]GNU\fP
+This includes the \f(CRGNU\fP
.BR \%.gz ,
.BR \%.bz2 ,
and the traditional
@@ -2934,7 +2944,7 @@ other programs.
.
All environment variables of
.BR \%groff (@MAN1EXT@)
-and \f[CR]GNU\fP
+and \f(CRGNU\fP
.BR \%man (1)
and some standard system variables are honored.
.
@@ -2972,7 +2982,7 @@ The following variables have a special meaning for
.TP
.SM
.B \%$DISPLAY
-If this variable is set this indicates that the \%\f[CR]X\~Window\fP
+If this variable is set this indicates that the \%\f(CRX\~Window\fP
system is running.
.
Testing this variable decides on whether graphical or text output is
@@ -2981,7 +2991,7 @@ generated.
This variable should not be changed by the user carelessly, but it can
be used to start the graphical
.B \%groffer
-on a remote \%\f[CR]X\~Window\fP terminal.
+on a remote \%\f(CRX\~Window\fP terminal.
.
For example, depending on your system,
.B \%groffer
@@ -3026,7 +3036,7 @@ is a character set or encoding identifier like ISO-8859-1
or UTF-8;
see
.BR \%setlocale (3).
.
-The locale values \f[CR]C\fP and \%\f[CR]POSIX\fP
+The locale values \f(CRC\fP and \%\f(CRPOSIX\fP
stand for the default, i.e.\& the
.I \%man\~page
directories without a language prefix.
@@ -3407,9 +3417,9 @@ in the directory
.BR /usr/local/share/doc/groff ,
using the standard viewer
.B \%gxditview
-as graphical viewer when in \%\f[CR]X\~Window\fP, or the
+as graphical viewer when in \%\f(CRX\~Window\fP, or the
.BR \%less (1)
-pager program when not in \%\f[CR]X\~Window\fP.
+pager program when not in \%\f(CRX\~Window\fP.
.
.sp
.EX
@@ -3476,7 +3486,7 @@ not split to a search for
.
.sp
.EX
-\fIsh#\fR\~groffer\~groff\~\[cq]troff(1)\[cq]\~man:roff
+\fIsh#\fR\~groffer\~groff\~\(cqtroff(1)\(cq\~man:roff
.EE
.sp
The arguments that are not existing files are looked-up as the
@@ -3492,13 +3502,13 @@ and
.
The quotes around
.nh
-.I \[cq]troff(1)\[cq]
+.I \(cqtroff(1)\(cq
.hy
are necessary because the parentheses are special shell characters;
escaping them with a backslash character
-.I \[rs](
+.I \(rs(
and
-.I \[rs])
+.I \(rs)
would be possible, too.
.
The formatted files are concatenated and displayed in one piece.
@@ -3581,12 +3591,12 @@ option
.
.sp
.EX
-\fIsh#\fR\~echo\~'\[rs]f[CB]WOW!'\~|
+\fIsh#\fR\~echo\~'\(rsf(CBWOW!'\~|
> groffer \-\-x \-\-bg red \-\-fg yellow \-\-geometry 200x100 \-
.EE
.sp
.
-Display the word \f[CB]WOW!\fP in a small window in constant-width
+Display the word \f(CBWOW!\fP in a small window in constant-width
bold font, using color yellow on red background.
.
.
@@ -3602,9 +3612,9 @@ program is written in Perl, the Perl version during
writing was v5.8.8.
.P
.B \%groffer
provides its own parser for command line arguments that is compatible
-to both \%\f[CR]POSIX\fP
+to both \%\f(CRPOSIX\fP
.BR \%getopts (1)
-and \%\f[CR]GNU\fP
+and \%\f(CRGNU\fP
.BR \%getopt (1).
It can handle option arguments and file names containing white space
and a large set of special characters.
@@ -3673,7 +3683,7 @@ The free mixing of options and
.I \%filespec
parameters follows the GNU principle.
.
-That does not fulfill the strange option behavior of \%\f[CR]POSIX\fP
+That does not fulfill the strange option behavior of \%\f(CRPOSIX\fP
that ends option processing as soon as the first non-option argument
has been reached.
.
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [groff] 01/15: [groffer] groffer.man: Make it work in compatibility mode. (EL): Fix typo.,
Werner LEMBERG <=