[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[groff] 01/01: groffer: transform man-pages into claasical style
From: |
Bernd Warken |
Subject: |
[groff] 01/01: groffer: transform man-pages into claasical style |
Date: |
Fri, 04 Jul 2014 21:05:44 +0000 |
bwarken pushed a commit to branch master
in repository groff.
commit 8ee77f23b9396bd9ebd08deaa9f287507732614b
Author: Bernd Warken <address@hidden>
Date: Fri Jul 4 23:05:35 2014 +0200
groffer: transform man-pages into claasical style
---
contrib/groffer/ChangeLog | 4 +
contrib/groffer/groffer.man | 412 +++++++++++++++++++------------------------
contrib/groffer/roff2.man | 28 ++--
3 files changed, 205 insertions(+), 239 deletions(-)
diff --git a/contrib/groffer/ChangeLog b/contrib/groffer/ChangeLog
index 9ece102..d94bb78 100644
--- a/contrib/groffer/ChangeLog
+++ b/contrib/groffer/ChangeLog
@@ -1,5 +1,9 @@
2014-07-04 Bernd Warken <address@hidden>
+ * groffer.manroff2.man: Transform to classical man-page style.
+
+2014-07-04 Bernd Warken <address@hidden>
+
* version.sh: New version 2.2.2
* groffer.man: Rename `.Env_var' to `.Small_CB'.
diff --git a/contrib/groffer/groffer.man b/contrib/groffer/groffer.man
index a85e438..dd3d30c 100644
--- a/contrib/groffer/groffer.man
+++ b/contrib/groffer/groffer.man
@@ -51,96 +51,9 @@ The license text is available in the internet at
.el .char \[Ellipsis] \&.\|.\|.\&\
.\" called by \[Ellipsis]
.
-.
-.\" --------------------------------------------------------------------
-.\" Macro definitions
-.\" --------------------------------------------------------------------
-.
-.\" --------------------------------------------------------------------
-.\" .Small_CB (<information_in_CB> [<punct>])
-.\"
-.\" Display information like an environment variable such as $PATH in
- \" small size CB with optional punctuation.
-.\"
-.de Small_CB
-. nh
-. SM
-. Text \f[CB]\\$1\f[]\\$2
-. hy
-..
-.
-.\" --------------------------------------------------------------------
-.\" .Error (<text>...)
-.\"
-.\" Print error message to terminal and abort.
-.\"
-.de Error
-. tm \\$*
-. ab
-..
-.
-.\" --------------------------------------------------------------------
-.\" .FONT (<font name> <text> [<font name> <text> ...])
-.\"
-.\" in different fonts: R, I, B, CR, CI, CB
-.\"
-.de FONT
-. if (\\n[.$] = 0) \{\
-. \" compatibility to .ft
-. nop \&\f[P]\&
-. return
-. \}
-. ds result \&
-. while (\\n[.$] >= 2) \{\
-. as result \,\f[\\$1]\\$2
-. if !"\\$1"P" .as result \f[P]
-. \" the double-quote " after P above is now ignored in Emacs
-. shift 2
-. \}
-. if (\\n[.$] = 1) .as result \,\f[\\$1]
-.\" nh
-. nop \\*[result]\&
-.\" hy
-. rm result
-..
-.
-.\" --------------------------------------------------------------------
-.\" .Text (<text>...)
-.\"
-.\" Treat the arguments as text, no matter how they look.
-.\"
-.de Text
-. if \\n[.$]=0 \
-. return
-. nh
-. nop \)\\$*\)
-. hy
-..
-.
-.\" --------------------------------------------------------------------
-.\" .Topic ([<indent>])
-.\"
-.\" A bulleted paragraph
-.\"
-.de Topic
-. ie \\n[.$]=0 .ds @indent 2m\"
-. el .ds @indent \\$1\"
-.
-. ie t .IP \[bu] address@hidden
-. el .IP \- address@hidden
-.
-. rm @indent
-..
-.
-.\" --------------------------------------------------------------------
-.\" .UNDERLINE (<text to underline> [<append>])
-.\"
-.\" Underline $1 and append $2 without underline
-.\"
-.de UNDERLINE
-. ie n \fI\\$1\fP\\$2
-. el \Z'\\$1'\v'.25m'\D'l \w'\\$1'u 0'\v'-.25m'\\$2
-..
+.ie t .char \[Bullet] \[bu]
+.el .char \[Bullet] \-
+.\" used it for `.IP \[Bullet] 2m' (former .Topic)
.
.
.\" --------------------------------------------------------------------
@@ -225,7 +138,8 @@ behaviors.
.
This can be done either in configuration files, with the shell
environment variable
-.Small_CB \%$GROFFER_OPT ,
+.SM
+.BR \%$GROFFER_OPT ,
or on the command line.
.
.
@@ -572,7 +486,8 @@ an error is raised.
.
.P
These abbreviations are only allowed in the environment variable
-.Small_CB \%$GROFFER_OPT ,
+.SM
+.BR \%$GROFFER_OPT ,
but not in the configuration files.
.
In configuration, all long options must be exact.
@@ -680,7 +595,8 @@ Reset all configuration from previously processed command
line options
to the default values.
.
This is useful to wipe out all former options of the configuration, in
-.Small_CB \%$GROFFER_OPT ,
+.SM
+.BR \%$GROFFER_OPT ,
and restart option processing using only the rest of the command line.
.
.
@@ -712,7 +628,8 @@ Choose a viewer program for
.IR \%dvi\~mode .
.
This can be a file name or a program to be searched in
-.Small_CB $PATH .
+.SM
+.BR $PATH .
.
Known \%\f[CR]X\~Window\f[]
.I \%dvi
@@ -740,7 +657,7 @@ Choose a web browser program for viewing in
.IR \%html\~mode .
.
It can be the path name of an executable file or a program in
-.Small_CB $PATH .
+.BR $PATH .
.
In each case, arguments can be provided additionally.
.
@@ -768,7 +685,7 @@ when a different mode was specified before.
.
.
.TP
-.FONT CB dvi
+.B dvi
Display formatted input in a
.I \%dvi
viewer program.
@@ -779,7 +696,7 @@ program.
.
.
.TP
-.FONT CB groff
+.B groff
After the file determination, switch
.B \%groffer
to process the input like
@@ -792,7 +709,7 @@ viewing features.
.
.
.TP
-.FONT CB html
+.B html
Translate the input into html format and display the result in a web
browser program.
.
@@ -806,7 +723,7 @@ The text html viewer is
.
.
.TP
-.FONT CB pdf
+.B pdf
Transform
.I roff input files
into a
@@ -827,7 +744,7 @@ is displayed with suitable viewer programs, such as
.
.
.TP
-.FONT CB pdf2
+.B pdf2
This is the traditional
.IR "pdf mode" .
.
@@ -850,7 +767,7 @@ Finally it is displayed using different viewer programs.
.
.
.TP
-.FONT CB ps
+.B ps
Display formatted input in a Postscript viewer program.
.
By default, the formatted input is displayed in one of many viewer
@@ -858,7 +775,7 @@ programs.
.
.
.TP
-.FONT CB text
+.B text
Format in a
.I \%groff\~text\~mode
and write the result to standard output without a pager or viewer
@@ -871,7 +788,7 @@ by default, can be chosen with option
.
.
.TP
-.FONT CB tty
+.B tty
Format in a
.I \%groff\~text\~mode
and write the result to standard output using a text pager program,
@@ -879,13 +796,13 @@ even when in \%\f[CR]X\~Window\f[].
.
.
.TP
-.FONT CB www
+.B www
Equivalent to
.BR \-\-mode=html .
.
.
.TP
-.FONT CB x
+.B x
Display the formatted input in a native
.I roff
viewer.
@@ -927,7 +844,7 @@ the default width of the geometry of the display program is
chosen to
.
.
.TP
-.FONT CB X
+.B X
Equivalent to
.BR \-\-mode=x .
.
@@ -941,7 +858,7 @@ They are only interesting for advanced applications.
.
.
.TP
-.FONT CB groff
+.B groff
Generate device output with plain
.I \%groff
without using the special viewing features of
@@ -956,7 +873,7 @@ is assumed.
.
.
.TP
-.FONT CB source
+.B source
Output the roff source code of the input files without further
processing.
.
@@ -978,7 +895,8 @@ Choose a viewer program for
.IR \%pdf\~mode .
.
This can be a file name or a program to be searched in
-.Small_CB $PATH ;
+.SM
+.BR $PATH ;
arguments can be provided additionally.
.
.
@@ -992,7 +910,8 @@ Choose a viewer program for
.IR \%ps\~mode .
.
This can be a file name or a program to be searched in
-.Small_CB $PATH .
+.SM
+.BR $PATH .
.
Common Postscript viewers include
.BR \%okular (1),
@@ -1040,7 +959,8 @@ This option is equivalent to
option
.BR \-\-pager=\,\fIprog\fP .
The option argument can be a file name or a program to be searched in
-.Small_CB $PATH ;
+.SM
+.BR $PATH ;
arguments can be provided additionally.
.
.
@@ -1066,7 +986,8 @@ Suitable viewer programs are
which is the default and
.BR \%xditview (1).
The argument can be any executable file or a program in
-.Small_CB $PATH ;
+.SM
+.BR $PATH ;
arguments can be provided additionally.
.
.
@@ -1305,22 +1226,22 @@ The display differs from the
.B \%apropos
program by the following concepts:
.RS
-.Topic
+.IP \[Bullet] 2m
Construct a
.I \%groff
frame similar to a
.I \%man\~page
to the output of
.BR \%apropos ,
-.Topic
+.IP \[Bullet] 2m
each
.I \%filespec
argument is searched on its own.
-.Topic
+.IP \[Bullet] 2m
The restriction by
.B \-\-sections
is handled as well,
-.Topic
+.IP \[Bullet] 2m
wildcard characters are allowed and handled without a further option.
.RE
.
@@ -1377,18 +1298,18 @@ This is written from anew, so it differs from
.B whatis
output by the following concepts
.RS
-.Topic
+.IP \[Bullet] 2m
each retrieved file name is added,
-.Topic
+.IP \[Bullet] 2m
local files are handled as well,
-.Topic
+.IP \[Bullet] 2m
the \fIlanguage\fP and \fIsystem\fP locale is supported,
-.Topic
+.IP \[Bullet] 2m
the display is framed by a
.I groff
output format similar to a
.IR \%man\~page ,
-.Topic
+.IP \[Bullet] 2m
wildcard characters are allowed without a further option.
.RE
.
@@ -1476,7 +1397,8 @@ If your system has \f[CR]GNU\f[]
installed the full set of long and short options of the \f[CR]GNU\f[]
.B man
program can be passed via the environment variable
-.Small_CB \%$MANOPT ;
+.SM
+.BR \%$MANOPT ;
see
.BR \%man (1).
.
@@ -1532,7 +1454,8 @@ Set the language for
.IR \%man\~pages .
.
This has the same effect, but overwrites
-.Small_CB $LANG .
+.SM
+.BR $LANG .
.
.
.TP
@@ -1788,7 +1711,8 @@ files, do not delete them during the run of
.TP
.B \-\-debug\-params
Print the parameters, as obtained from the configuration files, from
-.Small_CB \%GROFFER_OPT ,
+.SM
+.BR \%GROFFER_OPT ,
and the command line arguments.
.
.
@@ -1822,23 +1746,24 @@ Instead of displaying the formatted input, a lot of
specific information is printed to standard output:
.
.RS
-.Topic
+.IP \[Bullet] 2m
the output file name in the temporary directory,
.
-.Topic
+.IP \[Bullet] 2m
the display mode of the actual
.B \%groffer
run,
.
-.Topic
+.IP \[Bullet] 2m
the display program for viewing the output with its arguments,
.
-.Topic
+.IP \[Bullet] 2m
the active parameters from the config files, the arguments in
-.Small_CB \%$GROFFER_OPT ,
+.SM
+.BR \%$GROFFER_OPT ,
and the arguments of the command line,
.
-.Topic
+.IP \[Bullet] 2m
the pipeline that would be run by the
.B \%groff
program, but without executing it.
@@ -1980,7 +1905,7 @@ Each
parameter can have one of the following forms in decreasing sequence.
.
.
-.Topic
+.IP \[Bullet] 2m
No
.I \%filespec
parameters means that
@@ -1999,7 +1924,7 @@ use the argument
.BR man:\- .
.
.
-.Topic
+.IP \[Bullet] 2m
Next a
.I \%filespec
is tested whether it is the path name of an existing file.
@@ -2008,7 +1933,7 @@ Otherwise it is assumed to be a searching pattern for a
.IR \%man\~page .
.
.
-.Topic
+.IP \[Bullet] 2m
.BI \%man: name ( section_extension ) ,
.BI \%man: name . section_extension,
.IB \%name ( section_extension ) ,
@@ -2020,7 +1945,7 @@ in \%man\~section and possibly extension of
.IR \%section_extension .
.
.
-.Topic
+.IP \[Bullet] 2m
Now
.BI \%man: name
searches for a
@@ -2031,7 +1956,7 @@ that has a document called
.IR \%name .
.
.
-.Topic
+.IP \[Bullet] 2m
.I \%section_extension\~name
is a pattern of 2 arguments that originates from a strange argument
parsing of the
@@ -2048,7 +1973,7 @@ character optionally followed by an
.IR extension .
.
.
-.Topic
+.IP \[Bullet] 2m
We are left with the argument
.I \%name
which is not an existing file.
@@ -2150,7 +2075,8 @@ environment (or similar implementations within other
windowing
environments).
.
The environment variable
-.Small_CB \%$DISPLAY
+.SM
+.B \%$DISPLAY
and the option
.B \-\-display
are used for specifying the \%\f[CR]X\~Window\f[] display to be used.
@@ -2168,13 +2094,13 @@ You can change this automatic behavior by the option
Known viewers for the graphical display modes and their standard
\%\f[CR]X\~Window\f[] viewer programs are
.
-.Topic
+.IP \[Bullet] 2m
in a PDF viewer
.nh
.RI ( \%pdf\~mode )
.hy
.
-.Topic
+.IP \[Bullet] 2m
in a web browser
.nh
.RI ( html
@@ -2183,13 +2109,13 @@ or
.hy
.RE
.
-.Topic
+.IP \[Bullet] 2m
in a Postscript viewer
.nh
.RI ( \%ps\~mode )
.hy
.
-.Topic
+.IP \[Bullet] 2m
\%\f[CR]X\~Window\f[]
.I roff
viewers such as
@@ -2199,7 +2125,7 @@ or
(in
.IR \%x\~mode )
.
-.Topic
+.IP \[Bullet] 2m
in a dvi viewer program
.nh
.RI ( \%dvi\~mode )
@@ -2240,7 +2166,8 @@ for a text output on a text terminal using some pager
program.
.
.P
If the variable
-.Small_CB \%$DISPLAY
+.SM
+.B \%$DISPLAY
is not set or empty,
.B \%groffer
assumes that it should use
@@ -2267,7 +2194,7 @@ The pager to be used can be specified by one of the
options
and
.BR \-\-viewer ,
or by the environment variable
-.Small_CB \%$PAGER .
+.BR \%$PAGER .
If all of this is not used the
.BR \%less (1)
program with the option
@@ -2456,16 +2383,18 @@ is a list of directories that are separated by colon.
.
It is generated by the following methods.
.
-.Topic
+.IP \[Bullet] 2m
The environment variable
-.Small_CB \%$MANPATH
+.SM
+.B \%$MANPATH
can be set.
.
-.Topic
+.IP \[Bullet] 2m
It can be read from the arguments of the environment variable
-.Small_CB \%$MANOPT .
+.SM
+.BR\%$MANOPT .
.
-.Topic
+.IP \[Bullet] 2m
The
.I man\~path
can be manually specified by using the option
@@ -2474,16 +2403,17 @@ An empty argument disables the
.I \%man\~page
searching.
.
-.Topic
+.IP \[Bullet] 2m
When no
.I man\~path
was set the
.BR \%manpath (1)
program is tried to determine one.
.
-.Topic
+.IP \[Bullet] 2m
If this does not work a reasonable default path from
-.Small_CB $PATH
+.SM
+.B $PATH
is determined.
.
.
@@ -2506,16 +2436,18 @@ The names of such
.I operating systems
can be provided by 3 methods.
.
-.Topic
+.IP \[Bullet] 2m
The environment variable
-.Small_CB \%$SYSTEM
+.SM
+.B \%$SYSTEM
has the lowest precedence.
.
-.Topic
+.IP \[Bullet] 2m
This can be overridden by an option in
-.Small_CB \%$MANOPT .
+.SM
+.BR \%$MANOPT .
.
-.Topic
+.IP \[Bullet] 2m
This again is overridden by the command line option
.BR \-\-systems .
.
@@ -2557,23 +2489,27 @@ The wanted
.I language
can be chosen by several methods.
.
-.Topic
+.IP \[Bullet] 2m
Environment variable
-.Small_CB $LANG .
+.SM
+.BR $LANG .
.
-.Topic
+.IP \[Bullet] 2m
This is overridden by
-.Small_CB \%$LC_MESSAGES .
+.SM
+.BR \%$LC_MESSAGES .
.
-.Topic
+.IP \[Bullet] 2m
This is overridden by
-.Small_CB $LC_ALL .
+.SM
+.BR $LC_ALL .
.
-.Topic
+.IP \[Bullet] 2m
This can be overridden by providing an option in
-.Small_CB \%$MANOPT .
+.SM
+.BR \%$MANOPT .
.
-.Topic
+.IP \[Bullet] 2m
All these environment variables are overridden by the command line
option
.BR \-\-locale .
@@ -2731,21 +2667,22 @@ There are 4 methods to specify a
.I section
on the command line:
.
-.Topic
+.IP \[Bullet] 2m
Environment variable
-.Small_CB \%$MANSECT
+.SM
+.B \%$MANSECT
.
-.Topic
+.IP \[Bullet] 2m
Command line option
.B \-\-sections
.
-.Topic
+.IP \[Bullet] 2m
Appendix to the
.I name
argument in the form
.I <name>.<section>
.
-.Topic
+.IP \[Bullet] 2m
Preargument before the
.I name
argument in the form
@@ -2765,7 +2702,8 @@ search to only some
The multiple
.I sections
are only possible for
-.Small_CB \%$MANSECT
+.SM
+.B \%$MANSECT
and
.BR \-\-sections .
.
@@ -2788,21 +2726,22 @@ on the command line.
But it is not necessary to provide the whole extension name, some
abbreviation is good enough in most cases.
.
-.Topic
+.IP \[Bullet] 2m
Environment variable
-.Small_CB \%$EXTENSION
+.SM
+.B \%$EXTENSION
.
-.Topic
+.IP \[Bullet] 2m
Command line option
.B \-\-extension
.
-.Topic
+.IP \[Bullet] 2m
Appendix to the
.I <name>.<section>
argument in the form
.I <name>.<section><extension>
.
-.Topic
+.IP \[Bullet] 2m
Preargument before the
.I name
argument in the form
@@ -2866,11 +2805,11 @@ and the part
.File_name .7
stand for the
.IR section ;
-.FONT CB groff
+.B groff
is the name of the
.IR \%man\~page ;
the final part
-.FONT CB .gz
+.B .gz
stands for a compression with
.BR gzip (1).
As the
@@ -2885,25 +2824,25 @@ This can be done by one of the following commands.
.EE
.
.TP
-.FONT CB /usr/local/man/man1/ctags.1emacs21.bz2
+.B /usr/local/man/man1/ctags.1emacs21.bz2
Here
.File_name /usr/local/man
must be in
.IR \%man\~path ;
the subdirectory
-.FONT CB man1/
+.B man1/
and the file name part
-.FONT CB .1
+.B .1
stand for
.IR section\~1 ;
the name of the
.I \%man\~page
is
-.FONT CB ctags R ;
+.BR ctags ;
the section has an extension
-.FONT CB emacs21 R ;
+.BR emacs21 ;
and the file is compressed as
-.FONT CB .bz2
+.B .bz2
with
.BR bzip2 (1).
The file can be viewed with one of the following commands
@@ -2917,31 +2856,31 @@ where \f[CR]e\fP works as an abbreviation for the
extension
.
.
.TP
-.FONT CB /usr/man/linux/de/man7/man.7.Z
+.B /usr/man/linux/de/man7/man.7.Z
The directory
-.FONT CB /usr/man
+.B /usr/man
is now part of the
.IR \%man\~path ;
then there is a subdirectory for an
.I operating system
name
-.FONT CB linux/ R ;
+.BR linux/ ;
next comes a subdirectory
-.FONT CB de/
+.B de/
for the German
.IR language ;
the
.I section
names
-.FONT CB man7
+.B man7
and
-.FONT CB .7
+.B .7
are known so far;
-.FONT CB man
+.B man
is the name of the
.IR \%man\~page ;
and
-.FONT CB .Z
+.B .Z
signifies the compression that can be handled by
.BR gzip (1).
We want now show how to provide several values for some options.
@@ -3015,7 +2954,8 @@ and some standard system variables are honored.
.\" --------------------------------------------------------------------
.
.TP
-.Small_CB \%$GROFFER_OPT
+.SM
+.B \%$GROFFER_OPT
Store options for a run of
.BR \%groffer .
.
@@ -3040,7 +2980,8 @@ The following variables have a special meaning for
.
.
.TP
-.Small_CB \%$DISPLAY
+.SM
+.B \%$DISPLAY
If this variable is set this indicates that the \%\f[CR]X\~Window\fP
system is running.
.
@@ -3062,11 +3003,14 @@ can be started on the second monitor by the command
.
.
.TP
-.Small_CB \%$LC_ALL
+.SM
+.B \%$LC_ALL
.TQ
-.Small_CB \%$LC_MESSAGES
+.SM
+.B \%$LC_MESSAGES
.TQ
-.Small_CB $LANG
+.SM
+.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
@@ -3101,7 +3045,8 @@ This is the same behavior as when all 3\~variables are
unset.
.
.
.TP
-.Small_CB \%$PAGER
+.SM
+.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
@@ -3115,7 +3060,8 @@ program
.sp
.
.TP
-.Small_CB $PATH
+.SM
+.B $PATH
All programs within the
.B \%groffer
script are called without a fixed path.
@@ -3144,7 +3090,8 @@ The following variable has a direct meaning for the
program.
.
.TP
-.Small_CB \%$GROFF_TMPDIR
+.SM
+.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
@@ -3175,12 +3122,14 @@ but the user interface is the same.
The
.B man
environment variables can be overwritten by options provided with
-.Small_CB \%$MANOPT ,
+.SM
+.BR \%$MANOPT ,
which in turn is overwritten by the command line.
.
.
.TP
-.Small_CB \%$EXTENSION
+.SM
+.B \%$EXTENSION
Restrict the search for
.I \%man\~pages
to files having this extension.
@@ -3191,7 +3140,8 @@ see there for details.
.
.
.TP
-.Small_CB \%$MANOPT
+.SM
+.B \%$MANOPT
This variable contains options as a preset for
.BR \%man (1).
As not all of these are relevant for
@@ -3207,7 +3157,8 @@ given on the command line.
.
.
.TP
-.Small_CB \%$MANPATH
+.SM
+.B \%$MANPATH
If set, this variable contains the directories in which the
.I \%man\~page
trees are stored.
@@ -3217,7 +3168,8 @@ This is overridden by option
.
.
.TP
-.Small_CB \%$MANSECT
+.SM
+.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.
@@ -3227,7 +3179,8 @@ This is overridden by option
.
.
.TP
-.Small_CB \%$SYSTEM
+.SM
+.B \%$SYSTEM
If this is set to a comma separated list of names these are interpreted
as
.I \%man\~page
@@ -3240,7 +3193,8 @@ see there for details.
.
.P
The environment variable
-.Small_CB \%$MANROFFSEQ
+.SM
+.B \%$MANROFFSEQ
is ignored by
.B \%groffer
because the necessary preprocessors are determined automatically.
@@ -3256,17 +3210,18 @@ program can be preconfigured by two configuration files.
.
.
.TP
-.FONT CB \%/etc/groff/groffer.conf
+.B \%/etc/groff/groffer.conf
System-wide configuration file for
.BR \%groffer .
.
.
.TP
-.FONT CB \%$HOME/.groff/groffer.conf
+.B \%$HOME/.groff/groffer.conf
User-specific configuration file for
.BR \%groffer ,
where
-.Small_CB \%$HOME
+.SM
+.B \%$HOME
denotes the user's home directory.
.
This file is called after the system-wide configuration file to enable
@@ -3276,11 +3231,12 @@ overriding by the user.
.P
Both files are handled for the configuration, but the configuration
file in
-.FONT CB /etc
+.B /etc
comes first; it is overwritten by the configuration file in the home
directory; both configuration files are overwritten by the environment
variable
-.Small_CB \%$GROFFER_OPT ;
+.SM
+.BR \%$GROFFER_OPT ;
everything is overwritten by the command line arguments.
.
.
@@ -3360,7 +3316,7 @@ So there are no shell commands in the configuration files.
.P
As an example, consider the following configuration file that can be
used either in
-.FONT CB \%/etc/groff/groffer.conf
+.B \%/etc/groff/groffer.conf
or
.File_name \%\s+2~\s0/.groff/groffer.conf .
.
@@ -3393,14 +3349,14 @@ options (the lines starting with
This has the following effects:
.
.
-.Topic
+.IP \[Bullet] 2m
Use a text color of
.B \%DarkBlue
in all viewers that support this, such as
.BR \%gxditview .
.
.
-.Topic
+.IP \[Bullet] 2m
Use a resolution of
.B 100dpi
in all viewers that support this, such as
@@ -3412,7 +3368,7 @@ is set to
.BR X100 .
.
.
-.Topic
+.IP \[Bullet] 2m
Force
.BR \%gxditview (@MAN1EXT@)
as the
@@ -3425,7 +3381,7 @@ This geometry is suitable for a resolution of
.BR 100dpi .
.
.
-.Topic
+.IP \[Bullet] 2m
Use
.BR \%xpdf (1)
as the
@@ -3471,7 +3427,7 @@ pager program when not in \%\f[CR]X\~Window\fP.
.EE
.sp
If the file
-.FONT CB \%./groff
+.B \%./groff
exists use it as input.
.
Otherwise interpret the argument as a search for the
@@ -3492,7 +3448,7 @@ search for the
of
.B \%groff
even when the file
-.FONT CB ./groff
+.B ./groff
exists.
.
.sp
@@ -3517,7 +3473,7 @@ a small set.
.EE
.sp
If the file
-.FONT CB ./fb.modes
+.B ./fb.modes
does not exist interpret this as a search for the
.I \%man\~page
of
@@ -3581,7 +3537,7 @@ The option
guarantees that the
.I \%man\~page
is retrieved, even when a local file
-.FONT CB \%ls
+.B \%ls
exists in the actual directory.
.
.
@@ -3618,7 +3574,7 @@ This is a set of abbreviated arguments, it is determined
as
.sp
.
The file
-.FONT CB file.gz
+.B file.gz
is sent to standard input, this is decompressed, and then this is
transported to the
.I \%groff intermediate output mode
@@ -3666,13 +3622,13 @@ and a large set of special characters.
The following standard types of options are supported.
.
.
-.Topic
+.IP \[Bullet] 2m
The option consisting of a single minus
.B \-
refers to standard input.
.
.
-.Topic
+.IP \[Bullet] 2m
A single minus followed by characters refers to a single character
option or a combination thereof; for example, the
.B \%groffer
@@ -3682,7 +3638,7 @@ is equivalent to
.BR \-Q\~\-m\~foo .
.
.
-.Topic
+.IP \[Bullet] 2m
Long options are options with names longer than one character; they
are always preceded by a double minus.
.
@@ -3693,7 +3649,7 @@ is equivalent to
.BR \-\-long\~arg .
.
.
-.Topic
+.IP \[Bullet] 2m
An argument of
.B \-\-
ends option parsing; all further command line arguments are
@@ -3703,7 +3659,7 @@ parameters, i.e.\& file names or constructs for searching
.IR \%man\~pages ).
.
.
-.Topic
+.IP \[Bullet] 2m
All command line arguments that are neither options nor option
arguments are interpreted as
.I \%filespec
diff --git a/contrib/groffer/roff2.man b/contrib/groffer/roff2.man
index 11daeeb..2f944c4 100644
--- a/contrib/groffer/roff2.man
+++ b/contrib/groffer/roff2.man
@@ -9,14 +9,13 @@ address@hidden@.1 - man page for address@hidden@ (section 1).
Source file position: <groff_source_top>/contrib/groffer/roff2.man
Installed position: $prefix/share/man/man1/address@hidden@.1
-
-Last update: 25 Feb 2014
-Simplified to use .SY/.OP/.YS
..
.
.
.de au
This file was written by Bernd Warken <address@hidden>.
+
+Last update: 4 Jul 2014
..
.
.
@@ -47,22 +46,29 @@ The license text is available in the internet at
..
.
.\" --------------------------------------------------------------------
+.\" Characters
+.\" --------------------------------------------------------------------
+.
+.ie t .char \[Ellipsis] \f[S]\N'188'\f[P]
+.el .char \[Ellipsis] \&.\|.\|.\&\
+.\" called by \[Ellipsis]
+.
+.
+.\" --------------------------------------------------------------------
.\" SH "SYNOPSIS"
.
.SY address@hidden@
-.RI [ \%groffer_option .\|.\|.\&]
+.OP \& "\%groffer_option \[Ellipsis]"
.OP \-\-
-.RI [ \%filespec .\|.\|.\&]
+.OP \& "\%filespec \[Ellipsis]"
+.YS
.
.SY address@hidden@
-.B \-h
-|
-.B \-\-help
+.BR \-h | \-\-help
+.YS
.
.SY address@hidden@
-.B \-v
-|
-.B \-\-version
+.BR \-v | \-\-version
.YS
.
.P
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [groff] 01/01: groffer: transform man-pages into claasical style,
Bernd Warken <=