[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[groff] 45/51: groffer.man: Formatting.
|
From: |
Werner LEMBERG |
|
Subject: |
[groff] 45/51: groffer.man: Formatting. |
|
Date: |
Thu, 27 Mar 2014 19:39:25 +0000 |
wl pushed a commit to branch master
in repository groff.
commit 92b253241cb4a934cbb5632d23ec735974f41c1e
Author: Bjarni Ingi Gislason <address@hidden>
Date: Thu Mar 27 20:09:46 2014 +0100
groffer.man: Formatting.
---
contrib/groffer/groffer.man | 536 +++++++++++++++++++++---------------------
1 files changed, 268 insertions(+), 268 deletions(-)
diff --git a/contrib/groffer/groffer.man b/contrib/groffer/groffer.man
index 40f21b6..b3c7a07 100644
--- a/contrib/groffer/groffer.man
+++ b/contrib/groffer/groffer.man
@@ -13,7 +13,7 @@ groffer \- display groff files and man\~pages on X and tty
This file was written by Bernd Warken <address@hidden>.
..
.de co
-Copyright (C) 2001, 2002, 2004-2006, 2009-2012, 2014
+Copyright (C) 2001, 2002, 2004\[en]2006, 2009\[en]2012, 2014
Free Software Foundation, Inc.
.
.P
@@ -151,16 +151,16 @@ The license text is available in the internet at
.
.SY groffer
.OP option \*[Ellipsis]
-.OP --
+.OP \-\-
.OP \%filespec \*[Ellipsis]
.YS
.
.SY groffer
-.BR -h | --help
+.BR \-h " | " \-\-help
.YS
.
.SY groffer
-.BR -v | --version
+.BR \-v " | " \-\-version
.YS
.
.
@@ -287,8 +287,8 @@ Long options can be abbreviated in several ways.
.RS
.P
.SY
-.OP -h\~\fR|\fB\~--help
-.OP -v\~\fR|\fB\~--version
+.OP \-h\~\fR|\fB\~\-\-help
+.OP \-v\~\fR|\fB\~\-\-version
.YS
.RE
.
@@ -298,29 +298,29 @@ Long options can be abbreviated in several ways.
.RS
.P
.SY
-.OP --auto
-.OP --default
-.OP --default\-modes mode1,mode2,\*[Ellipsis]
-.OP --dvi
-.OP --dvi\-viewer prog
-.OP --groff
-.OP --html
-.OP --html\-viewer prog
-.OP --mode display_mode
-.OP --pdf
-.OP --pdf2
-.OP --pdf\-viewer prog
-.OP --ps
-.OP --ps\-viewer prog
-.OP --source
-.OP --text
-.OP --to\-stdout
-.OP --tty
-.OP --tty\-viewer prog
-.OP --www
-.OP --www\-viewer prog
-.OP --x\~\fR|\fB\~--X
-.OP --x\-viewer\~\fR|\fB\~--X\-viewer prog
+.OP \-\-auto
+.OP \-\-default
+.OP \-\-default\-modes mode1,mode2,\*[Ellipsis]
+.OP \-\-dvi
+.OP \-\-dvi\-viewer prog
+.OP \-\-groff
+.OP \-\-html
+.OP \-\-html\-viewer prog
+.OP \-\-mode display_mode
+.OP \-\-pdf
+.OP \-\-pdf2
+.OP \-\-pdf\-viewer prog
+.OP \-\-ps
+.OP \-\-ps\-viewer prog
+.OP \-\-source
+.OP \-\-text
+.OP \-\-to\-stdout
+.OP \-\-tty
+.OP \-\-tty\-viewer prog
+.OP \-\-www
+.OP \-\-www\-viewer prog
+.OP \-\-x\~\fR|\fB\~\-\-X
+.OP \-\-x\-viewer\~\fR|\fB\~\-\-X\-viewer prog
.YS
.RE
.
@@ -330,8 +330,8 @@ Long options can be abbreviated in several ways.
.RS
.P
.SY
-.OP -T\~\fR|\fB\~--device device
-.OP -Z\~\fR|\fB\~--intermediate\-output\~\fR|\fB\~--ditroff
+.OP \-T\~\fR|\fB\~\-\-device device
+.OP \-Z\~\fR|\fB\~\-\-intermediate\-output\~\fR|\fB\~\-\-ditroff
.YS
.P
All further
@@ -345,14 +345,14 @@ short options are accepted.
.RS
.P
.SY
-.OP --apropos
-.OP --apropos\-data
-.OP --apropos\-devel
-.OP --apropos\-progs
-.OP --man
-.OP --no\-man
-.OP --no\-special
-.OP --whatis
+.OP \-\-apropos
+.OP \-\-apropos\-data
+.OP \-\-apropos\-devel
+.OP \-\-apropos\-progs
+.OP \-\-man
+.OP \-\-no\-man
+.OP \-\-no\-special
+.OP \-\-whatis
.YS
.RE
.
@@ -362,19 +362,19 @@ short options are accepted.
.RS
.P
.SY
-.OP --all
-.OP --ascii
-.OP --ditroff
-.OP --extension suffix
-.OP --locale language
-.OP --local\-file
-.OP --location\~\fR|\fB\~--where
-.OP --manpath dir1:dir2:\*[Ellipsis]
-.OP --no\-location
-.OP --pager program
-.OP --sections sec1:sec2:\*[Ellipsis]
-.OP --systems sys1,sys2,\*[Ellipsis]
-.OP --troff\-device device
+.OP \-\-all
+.OP \-\-ascii
+.OP \-\-ditroff
+.OP \-\-extension suffix
+.OP \-\-locale language
+.OP \-\-local\-file
+.OP \-\-location\~\fR|\fB\~\-\-where
+.OP \-\-manpath dir1:dir2:\*[Ellipsis]
+.OP \-\-no\-location
+.OP \-\-pager program
+.OP \-\-sections sec1:sec2:\*[Ellipsis]
+.OP \-\-systems sys1,sys2,\*[Ellipsis]
+.OP \-\-troff\-device device
.YS
.P
Further long options of \f[CR]GNU\f[]
@@ -388,17 +388,17 @@ are accepted as well.
.RS
.P
.SY
-.OP --bd\~\fR|\fB\~--bordercolor pixels
-.OP --bg\~\fR|\fB\~--background color
-.OP --bw\~\fR|\fB\~--borderwidth pixels
-.OP --display X-display
-.OP --fg\~\fR|\fB\~--foreground color
-.OP --fn\~\fR|\fB\~--ft\~\fR|\fB\~--font font_name
-.OP --geometry size_pos
-.OP --resolution value
-.OP --rv
-.OP --title string
-.OP --xrm X\-resource
+.OP \-\-bd\~\fR|\fB\~\-\-bordercolor pixels
+.OP \-\-bg\~\fR|\fB\~\-\-background color
+.OP \-\-bw\~\fR|\fB\~\-\-borderwidth pixels
+.OP \-\-display X-display
+.OP \-\-fg\~\fR|\fB\~\-\-foreground color
+.OP \-\-fn\~\fR|\fB\~\-\-ft\~\fR|\fB\~\-\-font font_name
+.OP \-\-geometry size_pos
+.OP \-\-resolution value
+.OP \-\-rv
+.OP \-\-title string
+.OP \-\-xrm X\-resource
.YS
.RE
.
@@ -408,15 +408,15 @@ are accepted as well.
.RS
.P
.SY
-.OP --debug
-.OP --debug\-filenames
-.OP --debug\-grog
-.OP --debug\-keep
-.OP --debug\-params
-.OP --debug\-tmpdir
-.OP --do\-nothing
-.OP --print text
-.OP -V
+.OP \-\-debug
+.OP \-\-debug\-filenames
+.OP \-\-debug\-grog
+.OP \-\-debug\-keep
+.OP \-\-debug\-params
+.OP \-\-debug\-tmpdir
+.OP \-\-do\-nothing
+.OP \-\-print text
+.OP \-V
.YS
.RE
.
@@ -448,7 +448,7 @@ that is optionally followed by an
The name of a
.I man section
is a single character from
-.BR \%[1-9on] ,
+.BR \%[1\[en]9on] ,
the
.I extension
is some word.
@@ -465,7 +465,7 @@ parameters means standard input.
.
.
.TP 10m
-.B -
+.B \-
stands for standard input (can occur several times).
.
.
@@ -540,17 +540,17 @@ Arguments for long option names can be abbreviated in
several ways.
First, the argument is checked whether it can be prolonged as is.
.
Furthermore, each minus sign
-.B -
+.B \-
is considered as a starting point for a new abbreviation.
.
This leads to a set of multiple abbreviations for a single argument.
.
For example,
-.B --de\-n\-f
+.B \-\-de\-n\-f
can be used as an abbreviation for
-.BR --debug\-not\-func ,
+.BR \-\-debug\-not\-func ,
but
-.B --de\-n
+.B \-\-de\-n
works as well.
.
If the abbreviation of the argument leads to several resulting options
@@ -578,13 +578,13 @@ All other arguments are ignored.
.
.
.TP
-.B -h\~\fR|\fB\~--help
+.B \-h\~\fR|\fB\~\-\-help
Print help information with a short explanation of options to
standard output.
.
.
.TP
-.B -v\~\fR|\fB\~--version
+.B \-v\~\fR|\fB\~\-\-version
Print version information to standard output.
.
.
@@ -644,9 +644,9 @@ That need not be some graphical viewer suitable for this
mode.
.
There is a chance to view the output source; for example, the
combination of the options
-.B --mode=ps
+.B \-\-mode=ps
and
-.B --ps\-viewer=less
+.B \-\-ps\-viewer=less
shows the content of the
.I Postscript
output, the source code, with the pager
@@ -654,13 +654,13 @@ output, the source code, with the pager
.
.
.TP
-.B --auto
+.B \-\-auto
Equivalent to
-.BR --mode=auto .
+.BR \-\-mode=auto .
.
.
.TP
-.B --default
+.B \-\-default
Reset all configuration from previously processed command line options
to the default values.
.
@@ -670,13 +670,13 @@ and restart option processing using only the rest of the
command line.
.
.
.TP
-.BI --default\-modes \ mode1,mode2,\*[Ellipsis]
+.BI \-\-default\-modes \ mode1,mode2,\*[Ellipsis]
Set the sequence of modes for
.I \%auto\~mode
to the comma separated list given in the argument.
.
See
-.B --mode
+.B \-\-mode
for details on modes. Display in the default manner; actually, this
means to try the modes
.IR x ,
@@ -688,13 +688,13 @@ in this sequence.
.
.
.TP
-.B --dvi
+.B \-\-dvi
Equivalent to
-.BR --mode=\%dvi .
+.BR \-\-mode=\%dvi .
.
.
.TP
-.BI --dvi\-viewer \ prog
+.BI \-\-dvi\-viewer \ prog
Choose a viewer program for
.IR \%dvi\~mode .
.
@@ -712,19 +712,19 @@ In each case, arguments can be provided additionally.
.
.
.TP
-.B --groff
+.B \-\-groff
Equivalent to
-.BR --mode=groff .
+.BR \-\-mode=groff .
.
.
.TP
-.B --html
+.B \-\-html
Equivalent to
-.BR --mode=html .
+.BR \-\-mode=html .
.
.
.TP
-.B --html\-viewer
+.B \-\-html\-viewer
Choose a web browser program for viewing in
.IR \%html\~mode .
.
@@ -735,7 +735,7 @@ In each case, arguments can be provided additionally.
.
.
.TP
-.BI --mode \ value
+.BI \-\-mode \ value
.
Set the display mode.
.
@@ -748,7 +748,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
-.B --default\-modes
+.B \-\-default\-modes
option.
.
Useful for restoring the
@@ -856,7 +856,7 @@ program.
The text device,
.I \%latin1
by default, can be chosen with option
-.BR -T .
+.BR \-T .
.
.
.TP
@@ -870,7 +870,7 @@ even when in \%\f[CR]X\~Window\f[].
.TP
.Header_CB www
Equivalent to
-.BR --mode=html .
+.BR \-\-mode=html .
.
.
.TP
@@ -886,7 +886,7 @@ program being distributed together with
But the standard \%\f[CR]X\~Window\f[] tool
.BR \%xditview (1)
can also be chosen with the option
-.BR --x\-viewer .
+.BR \-\-x\-viewer .
The default resolution is
.BR 75dpi ,
but
@@ -918,7 +918,7 @@ the default width of the geometry of the display program is
chosen to
.TP
.Header_CB X
Equivalent to
-.BR --mode=x .
+.BR \-\-mode=x .
.
.
.P
@@ -936,7 +936,7 @@ Generate device output with plain
without using the special viewing features of
.IR \%groffer .
If no device was specified by option
-.B -T
+.B \-T
the
.I \%groff
default
@@ -954,19 +954,19 @@ processing.
.
.
.TP
-.B --pdf
+.B \-\-pdf
Equivalent to
-.BR --mode=pdf .
+.BR \-\-mode=pdf .
.
.
.TP
-.B --pdf2
+.B \-\-pdf2
Equivalent to
-.BR --mode=pdf2 .
+.BR \-\-mode=pdf2 .
.
.
.TP
-.BI --pdf\-viewer \ prog
+.BI \-\-pdf\-viewer \ prog
Choose a viewer program for
.IR \%pdf\~mode .
.
@@ -976,13 +976,13 @@ arguments can be provided additionally.
.
.
.TP
-.B --ps
+.B \-\-ps
Equivalent to
-.BR --mode=ps .
+.BR \-\-mode=ps .
.
.
.TP
-.BI --ps\-viewer \ prog
+.BI \-\-ps\-viewer \ prog
Choose a viewer program for
.IR \%ps\~mode .
.
@@ -999,19 +999,19 @@ In each case, arguments can be provided additionally.
.
.
.TP
-.B --source
+.B \-\-source
Equivalent to
-.BR --mode=source .
+.BR \-\-mode=source .
.
.
.TP
-.B --text
+.B \-\-text
Equivalent to
-.BR --mode=text .
+.BR \-\-mode=text .
.
.
.TP
-.B --to\-stdout
+.B \-\-to\-stdout
The file for the chosen mode is generated and its content is printed
to standard output.
.
@@ -1019,13 +1019,13 @@ It will not be displayed in graphical mode.
.
.
.TP
-.B --tty
+.B \-\-tty
Equivalent to
-.BR --mode=tty .
+.BR \-\-mode=tty .
.
.
.TP
-.BI --tty\-viewer \ prog
+.BI \-\-tty\-viewer \ prog
Choose a text pager for mode
.IR tty .
The standard pager is
@@ -1033,32 +1033,32 @@ The standard pager is
This option is equivalent to
.I man
option
-.BR --pager=\fIprog\fP .
+.BR \-\-pager=\,\fIprog\fP .
The option argument can be a file name or a program to be searched in
.Env_var $PATH ;
arguments can be provided additionally.
.
.
.TP
-.B --www
+.B \-\-www
Equivalent to
-.BR --mode=html .
+.BR \-\-mode=html .
.
.
.TP
-.BI --www\-viewer \ prog
+.BI \-\-www\-viewer \ prog
Equivalent to
-.BR --html\-viewer .
+.BR \-\-html\-viewer .
.
.
.TP
-.B --X\~\fR|\fB\~--x
+.B \-\-X\~\fR|\fB\~\-\-x
Equivalent to
-.BR --mode=x .
+.BR \-\-mode=x .
.
.
.TP
-.BI --X\-viewer\~\fR|\fB\~--x\-viewer \ prog
+.BI \-\-X\-viewer\~\fR|\fB\~\-\-x\-viewer \ prog
Choose a viewer program for
.IR \%x\~mode .
Suitable viewer programs are
@@ -1071,7 +1071,7 @@ arguments can be provided additionally.
.
.
.TP
-.B --
+.B \-\-
Signals the end of option processing; all remaining arguments are
interpreted as
.I \%filespec
@@ -1118,7 +1118,7 @@ or make sense for normal usage.
Because of the special outputting behavior of the
.B \%groff
option
-.B -Z
+.B \-Z
.B \%groffer
was designed to be switched into
.IR \%groff\~mode ;
@@ -1133,7 +1133,7 @@ process.
.
.
.TP
-.B --a
+.B \-\-a
This generates an ascii approximation of output in the
.IR \%text\~modes .
.
@@ -1143,7 +1143,7 @@ sequences in
.
.
.TP
-.BI --m \ file
+.BI \-\-m \ file
Add
.I \%file
as a
@@ -1154,7 +1154,7 @@ This is useful in case it cannot be recognized
automatically.
.
.
.TP
-.BI --P \ opt_or_arg
+.BI \-\-P \ opt_or_arg
Send the argument
.I \%opt_or_arg
as an option or option argument to the actual
@@ -1163,7 +1163,7 @@ postprocessor.
.
.
.TP
-.B --T \fIdevname\fR\~\fR|\fB\~--device \fIdevname\fR
+.B \-\-T \fIdevname\fR\~\fR|\fB\~\-\-device \fIdevname\fR
.
This option determines
.BR \%groff 's
@@ -1189,7 +1189,7 @@ The following
.I \%devname
arguments are mapped to the corresponding
.B \%groffer
-.B --mode=\fIdevname\fR
+.B \-\-mode=\,\fIdevname\fR
option:
.BR \%dvi ,
.BR \%html ,
@@ -1207,7 +1207,7 @@ using this device.
.
.
.TP
-.B --X
+.B \-\-X
is equivalent to
.BR "groff \-X" .
It displays the
@@ -1215,7 +1215,7 @@ It displays the
with
.BR gxditview .
As the quality is relatively bad this option is deprecated; use
-.B --X
+.B \-\-X
instead because the
.I \%x\~mode
uses an
@@ -1224,7 +1224,7 @@ device for a better display.
.
.
.TP
-.B -Z\~\fR|\fB\~--intermediate-output\~\fR|\fB\~--ditroff
+.B \-Z\~\fR|\fB\~\-\-intermediate-output\~\fR|\fB\~\-\-ditroff
Switch into
.I \%groff\~mode
and format the input with the
@@ -1232,7 +1232,7 @@ and format the input with the
without postprocessing; see
.BR \%groff_out (@MAN5EXT@).
This is equivalent to option
-.B --ditroff
+.B \-\-ditroff
of
.IR \%man ,
which can be used as well.
@@ -1266,7 +1266,7 @@ options should be needed, except for advanced usage.
.\" --------------------------------------------------------------------
.
.TP
-.B --apropos
+.B \-\-apropos
Start the
.BR \%apropos (1)
command or facility of
@@ -1318,7 +1318,7 @@ each
argument is searched on its own.
.Topic
The restriction by
-.B --sections
+.B \-\-sections
is handled as well,
.Topic
wildcard characters are allowed and handled without a further option.
@@ -1326,7 +1326,7 @@ wildcard characters are allowed and handled without a
further option.
.
.
.TP
-.B --apropos\-data
+.B \-\-apropos\-data
Show only the
.B \%apropos
descriptions for data documents, these are the
@@ -1339,7 +1339,7 @@ declarations are ignored, wildcards are accepted.
.
.
.TP
-.B --apropos\-devel
+.B \-\-apropos\-devel
Show only the
.B \%apropos
descriptions for development documents, these are the
@@ -1352,7 +1352,7 @@ declarations are ignored, wildcards are accepted.
.
.
.TP
-.B --apropos\-progs
+.B \-\-apropos\-progs
Show only the
.B \%apropos
descriptions for documents on programs, these are the
@@ -1365,7 +1365,7 @@ declarations are ignored, wildcards are accepted.
.
.
.TP
-.B --whatis
+.B \-\-whatis
For each
.I \%filespec
argument search all
@@ -1404,7 +1404,7 @@ The default is looking up for local files.
.
.
.TP
-.B --man
+.B \-\-man
Check the non-option command line arguments
.nh
.RI ( filespecs )
@@ -1419,23 +1419,23 @@ is first tested whether it is an existing file.
.
.
.TP
-.B --no-man\~\fR|\fB\~--local-file
+.B \-\-no-man\~\fR|\fB\~\-\-local-file
Do not check for
.IR \%man\~pages .
.
-.B --local-file
+.B \-\-local-file
is the corresponding
.B man
option.
.
.
.TP
-.B --no-special
+.B \-\-no-special
Disable former calls of
-.BR --all ,
-.BR --apropos* ,
+.BR \-\-all ,
+.BR \-\-apropos* ,
and
-.BR --whatis .
+.BR \-\-whatis .
.
.
.\" --------------------------------------------------------------------
@@ -1456,10 +1456,10 @@ so most of them are just ignored.
These ignored
.B man
options are
-.BR --catman ,
-.BR --troff ,
+.BR \-\-catman ,
+.BR \-\-troff ,
and
-.BR --update .
+.BR \-\-update .
.
.
.P
@@ -1482,35 +1482,35 @@ see
.
.
.TP
-.B --all
+.B \-\-all
In searching
.IR \%man\~pages ,
retrieve all suitable documents instead of only one.
.
.
.TP
-.B -7\~\fR|\fB\~--ascii
+.B \-7\~\fR|\fB\~\-\-ascii
In
.IR \%text\~modes ,
display ASCII translation of special characters for critical environment.
.
This is equivalent to
-.BR "groff \%-mtty_char" ;
+.BR "groff \%\-mtty_char" ;
see
.BR groff_tmac (@MAN5EXT@).
.
.
.TP
-.B --ditroff
+.B \-\-ditroff
Produce
.IR "groff intermediate output" .
This is equivalent to
.B \%groffer
-.BR -Z .
+.BR \-Z .
.
.
.TP
-.BI --extension \ suffix
+.BI \-\-extension \ suffix
Restrict
.I \%man\~page
search to file names that have
@@ -1526,7 +1526,7 @@ extension is
.
.
.TP
-.BI --locale \ language
+.BI \-\-locale \ language
.
Set the language for
.IR \%man\~pages .
@@ -1536,22 +1536,22 @@ This has the same effect, but overwrites
.
.
.TP
-.B --location
+.B \-\-location
Print the location of the retrieved files to standard error.
.
.
.TP
-.B --no-location
+.B \-\-no-location
Do not display the location of retrieved files; this resets a former
call to
-.BR --location .
+.BR \-\-location .
.
This was added by
.BR \%groffer .
.
.
.TP
-.BI --manpath \ 'dir1:dir2:\*[Ellipsis]'
+.BI \-\-manpath \ 'dir1:dir2:\*[Ellipsis]'
Use the specified search path for retrieving
.I \%man\~pages
instead of the program defaults.
@@ -1562,17 +1562,17 @@ is disabled.
.
.
.TP
-.B --pager
+.B \-\-pager
Set the pager program in
.IR \%tty\~mode ;
default is
.BR \%less .
This is equivalent to
-.BR --tty\-viewer .
+.BR \-\-tty\-viewer .
.
.
.TP
-.BI --sections \ sec1:sec2:\*[Ellipsis]
+.BI \-\-sections \ sec1:sec2:\*[Ellipsis]
Restrict searching for
.I \%man\~pages
to the given
@@ -1581,7 +1581,7 @@ a colon-separated list.
.
.
.TP
-.BI --systems \ sys1,sys2,\*[Ellipsis]
+.BI \-\-systems \ sys1,sys2,\*[Ellipsis]
Search for
.I \%man\~pages
for the given operating systems; the argument
@@ -1590,9 +1590,9 @@ is a comma-separated list.
.
.
.TP
-.B --where
+.B \-\-where
Equivalent to
-.BR --location .
+.BR \-\-location .
.
.
.\" --------------------------------------------------------------------
@@ -1619,9 +1619,9 @@ that was changed to the standard with using a double
minus for long
options, for example,
.B \%groffer
uses the option
-.B --font
+.B \-\-font
for the \%\f[CR]X\~Window\f[] option
-.BR -font .
+.BR \-font .
.
.
.P
@@ -1632,78 +1632,78 @@ for more details on these options and their arguments.
.
.
.TP
-.BI --background \ color
+.BI \-\-background \ color
Set the background color of the viewer window.
.
.
.TP
-.BI --bd \ pixels
+.BI \-\-bd \ pixels
This is equivalent to
-.BR --bordercolor .
+.BR \-\-bordercolor .
.
.
.TP
-.BI --bg \ color
+.BI \-\-bg \ color
This is equivalent to
-.BR --background .
+.BR \-\-background .
.
.
.TP
-.BI --bw \ pixels
+.BI \-\-bw \ pixels
This is equivalent to
-.BR --borderwidth .
+.BR \-\-borderwidth .
.
.
.TP
-.BI --bordercolor \ pixels
+.BI \-\-bordercolor \ pixels
Specifies the color of the border surrounding the viewer window.
.
.
.TP
-.BI --borderwidth \ pixels
+.BI \-\-borderwidth \ pixels
Specifies the width in pixels of the border surrounding the viewer
window.
.
.
.TP
-.BI --display \ X-display
+.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
syntax of the argument.
.
.
.TP
-.BI --foreground \ color
+.BI \-\-foreground \ color
Set the foreground color of the viewer window.
.
.
.TP
-.BI --fg \ color
+.BI \-\-fg \ color
This is equivalent to
-.BR -foreground .
+.BR \-\-foreground .
.
.
.TP
-.BI --fn \ font_name
+.BI \-\-fn \ font_name
This is equivalent to
-.BR --font .
+.BR \-\-font .
.
.
.TP
-.BI --font \ font_name
+.BI \-\-font \ font_name
Set the font used by the viewer window.
.
The argument is an \%\f[CR]X\~Window\f[] font name.
.
.
.TP
-.BI --ft \ font_name
+.BI \-\-ft \ font_name
This is equivalent to
-.BR --font .
+.BR \-\-font .
.
.
.TP
-.BI --geometry \ size_pos
+.BI \-\-geometry \ size_pos
Set the geometry of the display window, that means its size and its
starting position.
.
@@ -1713,7 +1713,7 @@ for the syntax of the argument.
.
.
.TP
-.BI --resolution \ value
+.BI \-\-resolution \ value
Set \%\f[CR]X\~Window\f[] resolution in dpi (dots per inch) in some
viewer programs.
.
@@ -1731,17 +1731,17 @@ The resolution also sets the default device in
.
.
.TP
-.B --rv
+.B \-\-rv
Reverse foreground and background color of the viewer window.
.
.
.TP
-.BI --title "\ 'some text'"
+.BI \-\-title "\ 'some text'"
Set the title for the viewer window.
.
.
.TP
-.BI --xrm \ 'resource'
+.BI \-\-xrm \ 'resource'
Set \f[CR]\%X\~Window\f[] resource.
.
.
@@ -1750,9 +1750,9 @@ Set \f[CR]\%X\~Window\f[] resource.
.\" --------------------------------------------------------------------
.
.TP
-.B --debug
+.B \-\-debug
Enable all debugging options
-.BR --debug\-\fItype\fP .
+.BR \-\-debug\-\,\fItype\fP .
.
The temporary files are kept and not deleted, the
.B grog
@@ -1761,7 +1761,7 @@ displayed file names are printed, and the parameters are
printed.
.
.
.TP
-.B --debug\-filenames
+.B \-\-debug\-filenames
Print the names of the files and
.I \%man\~pages
that are displayed by
@@ -1769,14 +1769,14 @@ that are displayed by
.
.
.TP
-.B --debug\-grog
+.B \-\-debug\-grog
Print the output of all
.B grog
commands.
.
.
.TP
-.B --debug\-keep
+.B \-\-debug\-keep
Enable two debugging informations.
.
Print the name of the temporary directory and keep the temporary
@@ -1785,35 +1785,35 @@ files, do not delete them during the run of
.
.
.TP
-.B --debug\-params
+.B \-\-debug\-params
Print the parameters, as obtained from the configuration files, from
.Env_var \%GROFFER_OPT ,
and the command line arguments.
.
.
.TP
-.B --debug\-tmpdir
+.B \-\-debug\-tmpdir
Print the name of the temporary directory.
.
.
.TP
-.B --do-nothing
+.B \-\-do-nothing
This is like
-.BR --version ,
+.BR \-\-version ,
but without the output; no viewer is started.
.
This makes only sense in development.
.
.
.TP
-.B --print=\fItext\fR
+.B \-\-print=\,\fItext\fR
Just print the argument to standard error.
.
This is good for parameter check.
.
.
-.TP
-.B -V
+.TP
+.B \-V
This is an advanced option for debugging only.
.
Instead of displaying the formatted input, a lot of
@@ -1848,9 +1848,9 @@ program, but without executing it.
Other useful debugging options are the
.B \%groff
option
-.B -Z
+.B \-Z
and
-.BR --mode=groff .
+.BR \-\-mode=groff .
.
.
.\" --------------------------------------------------------------------
@@ -1884,7 +1884,7 @@ The \f[CR]GNU\f[] behavior to recognize options even when
mixed with
arguments is used throughout.
.
But, as usual, the double minus argument
-.B --
+.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.
@@ -1892,7 +1892,7 @@ arguments; so the \%\f[CR]POSIX\f[] behavior can be
easily adopted.
.
.P
The options
-.B --apropos*
+.B \-\-apropos*
have a special handling of
.I filespec
arguments.
@@ -1902,13 +1902,13 @@ Each argument is taken as a search scheme of its own.
Also a regexp (regular expression) can be used in the filespec.
.
For example,
-.B groffer --apropos '^gro.f$'
+.B groffer \-\-apropos '^gro.f$'
searches
.B groff
in the
.I man\~page
name, while
-.B groffer --apropos groff
+.B groffer \-\-apropos groff
searches
.B groff
somewhere in the name or description of the
@@ -1919,7 +1919,7 @@ somewhere in the name or description of the
All other parts of
.IR groffer ,
such as the normal display or the output with
-.B --whatis
+.B \-\-whatis
have a different scheme for
.IR filespecs .
No regular expressions are used for the arguments.
@@ -1987,13 +1987,13 @@ parameters means that
waits for standard input.
.
The minus option
-.B -
+.B \-
always stands for standard input; it can occur several times.
.
If you want to look up a
.I \%man\~page
called
-.B -
+.B \-
use the argument
.BR man:\- .
.
@@ -2099,13 +2099,13 @@ with options.
.
.
The modes are selected by option the arguments of
-.BR --mode=\fIanymode .
+.BR \-\-mode=\,\fIanymode .
Additionally, each of this argument can be specified as an option of
its own, such as
.BR anymode .
Most of these modes have a viewer program, which can be chosen by an
option that is constructed like
-.BR --\fIanymode\fR\-viewer .
+.BR \-\-\,\fIanymode\/\fR\-viewer .
.
.
.P
@@ -2131,7 +2131,7 @@ This mode testing sequence for
.I \%auto\~mode
can be changed by specifying a comma separated list of modes with the
option
-.B --default\-modes.
+.B \-\-default\-modes.
.
.
.P
@@ -2151,7 +2151,7 @@ environments).
The environment variable
.Env_var \%$DISPLAY
and the option
-.B --display
+.B \-\-display
are used for specifying the \%\f[CR]X\~Window\f[] display to be used.
.
If this environment variable is empty
@@ -2160,7 +2160,7 @@ assumes that no \%\f[CR]X\~Window\f[] is running and
changes to a
.IR \%text\~mode .
.
You can change this automatic behavior by the option
-.BR --default\-modes .
+.BR \-\-default\-modes .
.
.
.P
@@ -2255,22 +2255,22 @@ is chosen for
.IR \%text\~modes .
.
This can be changed by specifying option
-.B -T
+.B \-T
or
-.BR \%--device .
+.BR \%\-\-device .
.
.
.P
The pager to be used can be specified by one of the options
-.B --pager
+.B \-\-pager
and
-.BR --tty\-viewer ,
+.BR \-\-tty\-viewer ,
or by the environment variable
.Env_var \%$PAGER .
If all of this is not used the
.BR \%less (1)
program with the option
-.B -r
+.B \-r
for correctly displaying control sequences is used as the default
pager.
.
@@ -2297,13 +2297,13 @@ and development purposes.
The
.I \%source\~mode
with option
-.B --source
+.B \-\-source
just displays the decompressed input.
.
.
.P
-Otion
-.B --to\-stdout
+Option
+.B \-\-to\-stdout
does not display in a graphical mode.
.
It just generates the file for the chosen mode and then prints its
@@ -2326,7 +2326,7 @@ it into another program.
In
.IR \%groff\~\%mode ,
the option
-.B -Z
+.B \-Z
disables post-processing, thus producing the
.nh
.I groff intermediate
@@ -2361,16 +2361,16 @@ should be handled as file name or
arguments.
.
.TP
-.B --man
+.B \-\-man
forces to interpret all file parameters as
.I \%filespecs
for searching
.IR \%man\~pages .
.
.TP
-.B --no\-man
+.B \-\-no\-man
.TQ
-.B --local\-file
+.B \-\-local\-file
disable the
.I man
searching; so only local files are displayed.
@@ -2468,7 +2468,7 @@ It can be read from the arguments of the environment
variable
The
.I man\~path
can be manually specified by using the option
-.BR --manpath .
+.BR \-\-manpath .
An empty argument disables the
.I \%man\~page
searching.
@@ -2516,7 +2516,7 @@ This can be overridden by an option in
.
.Topic
This again is overridden by the command line option
-.BR --systems .
+.BR \-\-systems .
.
.
.P
@@ -2575,7 +2575,7 @@ This can be overridden by providing an option in
.Topic
All these environment variables are overridden by the command line
option
-.BR --locale .
+.BR \-\-locale .
.
.
.P
@@ -2605,8 +2605,8 @@ In \f[CR]GNU\fP
it is specified in the \%\f[CR]POSIX\~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]]],
+\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]]],
.hy
.P
but the two-letter code in
@@ -2736,7 +2736,7 @@ Environment variable
.
.Topic
Command line option
-.B --sections
+.B \-\-sections
.
.Topic
Appendix to the
@@ -2766,7 +2766,7 @@ The multiple
are only possible for
.Env_var \%$MANSECT
and
-.BR --sections .
+.BR \-\-sections .
.
.
.P
@@ -2793,7 +2793,7 @@ Environment variable
.
.Topic
Command line option
-.B --extension
+.B \-\-extension
.
.Topic
Appendix to the
@@ -2925,7 +2925,7 @@ then there is a subdirectory for an
.I operating system
name
.File_name linux/ ;
-next comes a subdirectory
+next comes a subdirectory
.File_name de/
for the German
.IR language ;
@@ -3092,7 +3092,7 @@ see
.BR \%setlocale (3).
.
The locale values \f[CR]C\fP and \%\f[CR]POSIX\fP
-stand for the default, i.e. the
+stand for the default, i.e.\& the
.I \%man\~page
directories without a language prefix.
.
@@ -3185,7 +3185,7 @@ Restrict the search for
to files having this extension.
.
This is overridden by option
-.BR --extension ;
+.BR \-\-extension ;
see there for details.
.
.
@@ -3212,7 +3212,7 @@ If set, this variable contains the directories in which
the
trees are stored.
.
This is overridden by option
-.BR \%--manpath .
+.BR \%\-\-manpath .
.
.
.TP
@@ -3222,7 +3222,7 @@ If this is a colon separated list of section names, the
search for
is restricted to those manual sections in that order.
.
This is overridden by option
-.BR --sections .
+.BR \-\-sections .
.
.
.TP
@@ -3233,7 +3233,7 @@ as
trees for different operating systems.
.
This variable can be overwritten by option
-.BR --systems ;
+.BR \-\-systems ;
see there for details.
.
.
@@ -3312,7 +3312,7 @@ they must be exact.
The argument for a long option can be separated from the option name
either by an equal sign
.RB ` = '
-or by whitespace, i.e. one or several space or tab characters.
+or by whitespace, i.e.\& one or several space or tab characters.
.
An argument for a short option or short option cluster can be directly
appended to the option name or separated by whitespace.
@@ -3361,7 +3361,7 @@ As an example, consider the following configuration file
that can be
used either in
.File_name \%/etc/groff/groffer.conf
or
-.File_name \%~/.groff/groffer.conf .
+.File_name \%\s+2~\s0/.groff/groffer.conf .
.
.
.P
@@ -3558,7 +3558,7 @@ The formatted files are concatenated and displayed in one
piece.
.
.sp
.EX
-\fIsh#\fR\~LANG=de\~groffer\~--man\~--www\~--www-viewer=galeon\~ls
+\fIsh#\fR\~LANG=de\~groffer\~\-\-man\~\-\-www\~\-\-www-viewer=galeon\~ls
.EE
.sp
Retrieve the German
@@ -3576,7 +3576,7 @@ format
and view the result in the web browser
.BR \%galeon .
The option
-.B --man
+.B \-\-man
guarantees that the
.I \%man\~page
is retrieved, even when a local file
@@ -3586,7 +3586,7 @@ exists in the actual directory.
.
.sp
.EX
-\fIsh#\fR\~groffer\~--source\~'man:roff(7)'
+\fIsh#\fR\~groffer\~\-\-source\~'man:roff(7)'
.EE
.sp
Get the
@@ -3599,14 +3599,14 @@ content, its source code.
.
.sp
.EX
-\fIsh#\fR\~groffer\~--de-p\~--in\~--ap
+\fIsh#\fR\~groffer\~\-\-de-p\~\-\-in\~\-\-ap
.EE
.sp
This is a set of abbreviated arguments, it is determined as
.br
.sp
.EX
-\fIsh#\fR\~groffer\~--debug-params\~--intermediate-output\~--apropos
+\fIsh#\fR\~groffer\~\-\-debug-params\~\-\-intermediate-output\~\-\-apropos
.EE
.sp
.
@@ -3624,19 +3624,19 @@ transported to the
without post-processing
.RB ( groff
option
-.BR -Z ),
+.BR \-Z ),
using macro package
.I \%foo
.RB ( groff
option
-.BR -m ).
+.BR \-m ).
.
.
.sp
.EX
\fIsh#\fR\~echo\~'\[rs]f[CB]WOW!'\~|
-> groffer --x --bg red --fg yellow --geometry 200x100 -
-.EX
+> groffer \-\-x \-\-bg red \-\-fg yellow \-\-geometry 200x100 \-
+.EE
.sp
.
Display the word \f[CB]WOW!\fP in a small window in constant-width
@@ -3667,7 +3667,7 @@ The following standard types of options are supported.
.
.Topic
The option consisting of a single minus
-.B -
+.B \-
refers to standard input.
.
.
@@ -3676,9 +3676,9 @@ A single minus followed by characters refers to a single
character
option or a combination thereof; for example, the
.B \%groffer
short option combination
-.B -Qmfoo
+.B \-Qmfoo
is equivalent to
-.BR -Q\~\-m\~foo .
+.BR \-Q\~\-m\~foo .
.
.
.Topic
@@ -3687,18 +3687,18 @@ are always preceded by a double minus.
.
An option argument can either go to the next command line argument or
be appended with an equal sign to the argument; for example,
-.B --long=arg
+.B \-\-long=arg
is equivalent to
-.BR --long\~arg .
+.BR \-\-long\~arg .
.
.
.Topic
An argument of
-.B --
+.B \-\-
ends option parsing; all further command line arguments are
interpreted as
.I \%filespec
-parameters, i.e. file names or constructs for searching
+parameters, i.e.\& file names or constructs for searching
.IR \%man\~pages ).
.
.
@@ -3711,13 +3711,13 @@ parameters and stored until option parsing has finished.
For example, the command line
.sp
.EX
-\fIsh#\fR\~groffer file1 -a -o arg file2
+\fIsh#\fR\~groffer file1 \-a \-o arg file2
.EE
.sp
is equivalent to
.sp
.EX
-\fIsh#\fR\~groffer -a -o arg -- file1 file2
+\fIsh#\fR\~groffer \-a \-o arg \-\- file1 file2
.EE
.sp
.
@@ -3741,7 +3741,7 @@ anyway.
.
Report bugs to the
.MT address@hidden
-bug-groff mailing list
+bug-groff mailing list
.ME .
.
Include a complete, self-contained example that will allow the bug to
| [Prev in Thread] |
Current Thread |
[Next in Thread] |
- [groff] 45/51: groffer.man: Formatting.,
Werner LEMBERG <=