[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
problems in eqn.1, geqn.1, groff.1
From: |
esr |
Subject: |
problems in eqn.1, geqn.1, groff.1 |
Date: |
Mon, 1 Jan 2007 19:05:49 -0500 |
This is automatically generated email about problems in a man page for which
you appear to be responsible. If you are not the right person or list, tell
me and I will attempt to correct my database.
See http://catb.org/~esr/doclifter/problems.html for details on how and
why these patches were generated. Feel free to email me with any questions.
Note: These patches do not change the mod date of any manual page. You
may wish to do that by hand.
Problems with eqn.1:
1. Unbalanced .RS or .RE macro
--- eqn.1-orig 2003-12-19 21:22:48.000000000 -0500
+++ eqn.1 2003-12-19 21:26:15.000000000 -0500
@@ -459,13 +459,12 @@
of the object.
The number registers must also be modified so that they correspond to the
result.
-.RS
.LP
For example, suppose you wanted a construct that `cancels' an expression
by drawing a diagonal line through it.
-.IP
+.RS
.nf
-.ft B
+.ft CW
.if t .ne 6+\n(.Vu
\&.EQ
define cancel 'special Ca'
@@ -475,16 +474,18 @@
\&..
.ft
.fi
+.RE
.LP
Then you could cancel an expression
.I e
with
.BI cancel\ {\ e\ }
.LP
-Here's a more complicated construct that draws a box round an expression:
-.IP
+Here's a more complicated construct that draws a box round an
+expression:
+.RS
.nf
-.ft B
+.ft CW
.if t .ne 11+\n(.Vu
\&.EQ
define box 'special Bx'
-----------------------------
Problems with geqn.1:
1. Unbalanced .RS or .RE macro
--- geqn.1-orig 2003-12-19 21:22:48.000000000 -0500
+++ geqn.1 2003-12-19 21:26:15.000000000 -0500
@@ -459,13 +459,12 @@
of the object.
The number registers must also be modified so that they correspond to the
result.
-.RS
.LP
For example, suppose you wanted a construct that `cancels' an expression
by drawing a diagonal line through it.
-.IP
+.RS
.nf
-.ft B
+.ft CW
.if t .ne 6+\n(.Vu
\&.EQ
define cancel 'special Ca'
@@ -475,16 +474,18 @@
\&..
.ft
.fi
+.RE
.LP
Then you could cancel an expression
.I e
with
.BI cancel\ {\ e\ }
.LP
-Here's a more complicated construct that draws a box round an expression:
-.IP
+Here's a more complicated construct that draws a box round an
+expression:
+.RS
.nf
-.ft B
+.ft CW
.if t .ne 11+\n(.Vu
\&.EQ
define box 'special Bx'
-----------------------------
Problems with groff.1:
My records indicate that you have accepted this patch, so this is just
a reminder. Please try to get a release with the patch incorporated
to the Fedora folks in time for Fedora Core 7.
--- groff.1-orig 2006-12-26 16:09:20.000000000 -0500
+++ groff.1 2006-12-26 16:10:10.000000000 -0500
@@ -1,232 +1,22 @@
-.ig
-groff.man
-
-Last update: 14 July 2002
-
-Copyright (C) 1989, 2002 Free Software Foundation, Inc.
-Rewritten in 2002 by Bernd Warken <address@hidden>
-
-Permission is granted to copy, distribute and/or modify this document
-under the terms of the GNU Free Documentation License, Version 1.1 or
-any later version published by the Free Software Foundation; with the
-Invariant Sections being this .ig-section and AUTHOR, with no
-Front-Cover Texts, and with no Back-Cover Texts.
-
-A copy of the Free Documentation License is included as a file called
-FDL in the main directory of the groff source package.
-..
-.
-.\" --------------------------------------------------------------------
-.\" Setup
-.\" --------------------------------------------------------------------
-.
-.mso www.tmac
-.
-.\" set adjust to both
-.ad b
-.
-.\" fonts of fixed length
-.
-.if n \{\
-. mso tty-char.tmac
-. ftr CR R
-. ftr CI I
-. ftr CB B
-.\}
-.
-.if '\*[.T]'dvi' \
-. ftr CB CW
-.
-.\" --------------------------------------------------------------------
-.\" String definitions
-.
-.ds @- "\-\"
-.ds @-- "\-\^\-\"
-.
-.ds Ellipsis .\|.\|.\"
-.
-.
-.\" --------------------------------------------------------------------
-.\" Begin of macro definitions
-.de c
-.\" this is like a comment request when escape mechanism is off
-..
-.eo
-.
-.c --------------------------------------------------------------------
-.de TP+
-.br
-.ns
-.TP \$1
-..
-.c --------------------------------------------------------------------
-.c Like TP, but if specified indent is more than half
-.c the current line-length - indent, use the default indent.
-.de Tp
-. ie \n[.$]=0:((0\$1)*2u>(\n.lu-\n(.iu)) .TP
-. el .TP "\$1"
-..
-.c --------------------------------------------------------------------
-.de Text
-. nop \)\$*
-..
-.c --------------------------------------------------------------------
-.de Synopsis
-. ds @arg1 \$1\"
-. nr @old_indent \n[.i]
-. ad l
-. in +\w'address@hidden'u
-. ti address@hidden
-. B address@hidden
-. rr @old_indent
-. rm @arg1
-..
-.c --------------------------------------------------------------------
-.de EndSynopsis
-. ad
-. in
-..
-.c --------------------------------------------------------------------
-.c ShortOpt[] (name [arg])
-.c
-.c short option in synopsis
-.c
-.de ShortOpt[]
-. if \n[.$]=0 \
-. return
-. ds @opt \$1\"
-. shift
-. ie \n[.$]=0 \
-. Text address@hidden@opt]\f[]\f[R]]\f[]
-. el \
-. Text address@hidden@opt]\~\f[]\f[I]\/\$*\f[]\f[R]]\f[]
-. rm @opt
+.\"
+.\" Rewritten groff.1 with drastically simplified markup.
+.\" Only these content changes:
+.\" 1. Changed email addresses from old-school
+.\" "address@hidden (J. Fred Muggs)"
+.\" to new-school
+.\" "J. Fred Muggs <address@hidden>"
+.\" 2. It was not consistent before whether environment variable
+.\" names had a $ prefix. Now they all do.
+.\" 3. Fixed a few writing-with-a-German-accent usage glitches.
+.\" (example: "The software collection GNU").
+.\" 4. Added myself to history list.
+.\"
+.\" This comment need not be preserved.
+.\"
+.ds sh \fIsh#\fR
+.de OP
+.B \\$1 \\fI\\$2\\fR
..
-.c --------------------------------------------------------------------
-.c Option in synopsis (short option)
-.de SynOpt
-. if \n[.$]=0 \
-. return
-. ds @opt \$1\"
-. shift
-. ie \n[.$]=0 \
-. Text address@hidden@opt]\f[]\f[R]]\f[]
-. el \
-. Text address@hidden@opt]\~\f[]\f[I]\/\$*\f[]\f[R]]\f[]
-. rm @opt
-..
-.c --------------------------------------------------------------------
-.c ShortOpt ([char [punct]])
-.c
-.c `-c' somewhere in the text
-.c second arg is punctuation
-.c
-.de ShortOpt
-. ds @opt \$1\"
-. shift
-. Text address@hidden@opt]\f[]\/\$*
-. rm @opt
-..
-.c --------------------------------------------------------------------
-.c LongOpt ([name [punct]])
-.c
-.c `--name' somewhere in the text
-.c second arg is punctuation
-.c
-.de LongOpt
-. ds @opt \$1\"
-. shift
-. Text address@hidden@opt]\f[]\/\$*
-. rm @opt
-..
-.c --------------------------------------------------------------------
-.c OptDef (shortopt [longopt [argument]])
-.c
-.c option documentation
-.c args : `shortopt', `longopt' can be ""
-.c
-.de OptDef
-. ds @short
-. ds @long
-. ds @arg
-. if \n[.$]>=1 \{\
-. ds @arg1 "\$1\"
-. if !'address@hidden'' \
-. ds @short "address@hidden@arg1]\f[]\"
-. if \n[.$]>=2 \{\
-. if !'address@hidden'' \
-. as @short \f[CW]\0\f[]
-. ds @arg2 "\$2\"
-. if !'address@hidden'' \
-. ds @long "address@hidden@arg2]\f[]\"
-. if \n[.$]>=3 \{\
-. if !'address@hidden'' \
-. as @long \|=\|\"
-. shift 2
-. ds @arg \f[I]\$*\"
-. \}
-. \}
-. \}
-. IP "address@hidden@address@hidden"
-. rm @arg
-. rm @arg1
-. rm @arg2
-. rm @short
-. rm @long
-..
-.c --------------------------------------------------------------------
-.c Continuation of an OptDef header.
-.de OptDef+
-. br
-. ns
-. OptDef \$@
-..
-.c --------------------------------------------------------------------
-.c Environment variable
-.de EnvVar
-. SM
-. BR \$1 \$2
-..
-.c --------------------------------------------------------------------
-.c a shell command line
-.de ShellCommand
-. nr @font \n[.f]
-. c replace argument separator by unbreakable space
-. ds @args \$1\""
-. shift
-. while (\n[.$]>0) \{\
-. ds @args address@hidden
-. shift
-. \}
-. br
-. ad l
-. nh
-. Text \f[I]sh#\h'1m'address@hidden&\"
-. ft R
-. ft P
-. hy
-. ad
-. ft address@hidden
-. br
-. rr @font
-. rm @args
-..
-.c --------------------------------------------------------------------
-.c `char or string'
-.de Quoted
-. ft CR
-. Text \[oq]\$*\[cq]
-. ft
-..
-.c --------------------------------------------------------------------
-.c End of macro definitions
-.ec
-.
-.
-.\" --------------------------------------------------------------------
-.\" Title
-.\" --------------------------------------------------------------------
-.
.TH GROFF 1 "12 July 2006" "Groff Version 1.18.1.1"
.SH NAME
groff \- front-end for the groff document formatting system
@@ -236,54 +26,53 @@
.SH SYNOPSIS
.\" --------------------------------------------------------------------
.
-.ad l
-.Synopsis groff
-.ShortOpt[] abcegilpstzCEGNRSUVXZ
-.ShortOpt[] d cs
-.ShortOpt[] f fam
-.ShortOpt[] F dir
-.ShortOpt[] I dir
-.ShortOpt[] L arg
-.ShortOpt[] m name
-.ShortOpt[] M dir
-.ShortOpt[] n num
-.ShortOpt[] o list
-.ShortOpt[] P arg
-.ShortOpt[] r cn
-.ShortOpt[] T dev
-.ShortOpt[] w name
-.ShortOpt[] W name
-.RI [ file
-.Text \*[Ellipsis]]
-.EndSynopsis
-.
-.Synopsis groff
-.ShortOpt h
-|
-.LongOpt help
-.EndSynopsis
-.
-.Synopsis groff
-.ShortOpt v
-|
-.LongOpt version
-.RI [ option
-.Text \*[Ellipsis]]
-.EndSynopsis
-.
-.P
-The command line is parsed according to the usual GNU convention.
-.
-The whitespace between a command line option and its argument is
-optional.
-.
-Options can be grouped behind a single
-.ShortOpt
-(minus character).
-.
-A filename of
-.ShortOpt
-(minus character) denotes the standard input.
+.B groff
+[
+.OP -abcegilpstzCEGNRSUVXZ
+] [
+.OP -d cs
+] [
+.OP -f fam
+] [
+.OP -F dir
+] [
+.OP -I dir
+] [
+.OP -L arg
+] [
+.OP -m name
+] [
+.OP -M dir
+] [
+.OP -n num
+] [
+.OP -o list
+] [
+.OP -P arg
+] [
+.OP -r cn
+] [
+.OP -T dev
+] [
+.OP -w name
+] [
+.OP -W name
+] [
+.I file...
+]
+.br
+.B groff
+.OP -h
+|
+.B --help
+.br
+.B groff
+.OP -v
+|
+.B --version
+[
+.IR option ...
+]
.
.
.\" --------------------------------------------------------------------
@@ -300,16 +89,18 @@
.I groff
program and macro suite is the implementation of a
.BR roff (7)
-system within the free software collection
-.URL http://\:www.gnu.org "GNU" .
-.
+system within the
+.UR http:\&//www.gnu.org
+GNU
+.UE
+free software collection.
The
.I groff
system has all features of the classical
.IR roff ,
-but adds many extensions.
+and adds many extensions.
.
-.P
+.PP
The
.B groff
program allows to control the whole
@@ -324,6 +115,19 @@
.SH OPTIONS
.\" --------------------------------------------------------------------
.
+.PP
+The command line is parsed according to the usual GNU conventions.
+The whitespace between a command line option and its argument is
+optional.
+.
+Options can be grouped behind a single
+-
+(minus character).
+.
+A filename of
+-
+(minus character) denotes the standard input.
+.
As
.B groff
is a wrapper program for
@@ -353,36 +157,41 @@
.BR groff .
.
.
-.OptDef e
+.TP
+.OP -e
Preprocess with
.BR eqn .
.
.
-.OptDef g
+.TP
+.OP -g
Preprocess with
.BR grn .
.
.
-.OptDef G
+.TP
+.OP -G
Preprocess with
.BR grap .
.
.
-.OptDef h help
+.TP
+.OP -h help
Print a help message.
.
.
-.OptDef I "" dir
+.TP
+.OP -I dir
Add search directory for
.BR \%soelim (1).
This option implies the
-.ShortOpt s
+.B -s
option.
.
.
-.OptDef l
+.TP
+.B -l
Send the output to a spooler program for printing.
-.
The command that should be used for this is specified by the
.B print
command in the device description file, see
@@ -392,71 +201,77 @@
program by default.
.
See options
-.ShortOpt L
+.OP -L
and
-.ShortOpt X .
+.BR -X .
.
.
-.OptDef L "" arg
+.TP
+.OP -L arg
Pass
.I arg
to the spooler program.
Several arguments should be passed with a separate
-.ShortOpt L
+.B -L
option each.
.
Note that
.B groff
does not prepend
-.ShortOpt\" just a minus sign
+-
(a minus sign) to
.I arg
before passing it to the spooler program.
.
.
-.OptDef N
+.TP
+.B -N
Don't allow newlines within
.I eqn
delimiters.
.
This is the same as the
-.ShortOpt N
+.B -N
option in
.BR eqn .
.
.
-.OptDef p
+.TP
+.B -p
Preprocess with
.BR pic .
.
.
-.OptDef P "" "-option"
-.OptDef+ P "" "-option \f[CB]-P\f[] arg"
+.TP
+.OP -P "-option"
+.TP
+.OP -P arg
Pass
-.I -option
+.OP -option
or
-.I -option arg
+.OP -option arg
to the postprocessor.
.
The option must be specified with the necessary preceding minus
sign(s)
-.Quoted address@hidden
+\&'-'
or
-.Quoted address@hidden
+\&'--'
because groff does not prepend any dashes before passing it to the
postprocessor.
.
For example, to pass a title to the gxditview postprocessor, the shell
command
-.IP
-.ShellCommand groff -X -P -title -P 'groff it' \f[I]foo\f[]
-.IP
+.sp
+\(sh groff -X -P -title -P 'groff it' \f[I]foo\f[]
+.sp
is equivalent to
-.IP
-.ShellCommand groff -X -Z \f[I]foo\f[] | gxditview -title 'groff it' -
-.
+.sp
+\fIsh#\fR groff -X -Z \f[I]foo\f[] | gxditview -title 'groff it' -
+.sp
.
-.OptDef R
+.TP
+.OP -R
Preprocess with
.BR refer .
.
@@ -472,16 +287,18 @@
for more details.
.
.
-.OptDef s
+.TP
+.OP -s
Preprocess with
.BR soelim .
.
.
-.OptDef S
+.TP
+.OP -S
Safer mode.
.
Pass the
-.ShortOpt S
+.OP -S
option to
.B pic
and disable the following
@@ -496,12 +313,14 @@
For security reasons, safer mode is enabled by default.
.
.
-.OptDef t
+.TP
+.OP -t
Preprocess with
.BR tbl .
.
.
-.OptDef T "" dev
+.TP
+.OP -T dev
Set output device to
.IR dev .
The possible values in
@@ -530,37 +349,41 @@
.BR ps .
.
.
-.OptDef U
+.TP
+.OP -U
Unsafe mode.
.
Reverts to the (old) unsafe behaviour; see option
-.ShortOpt S .
+.BR -S .
.
.
-.OptDef v version
+.TP
+.OP -v version
Output version information of
.B groff
and of all programs that are run by it; that is, the given command line
is parsed in the usual way, passing
-.ShortOpt v
+.OP -v
to all subprograms.
.
.
-.OptDef V
+.TP
+.OP -V
Output the pipeline that would be run by
.BR groff
(as a wrapper program), but do not execute it.
.
.
-.OptDef X
+.TP
+.OP -X
Use
.B gxditview
instead of using the usual postprocessor to (pre)view a document.
.
The printing spooler behavior as outlined with options
-.ShortOpt l
+.OP -l
and
-.ShortOpt L
+.OP -L
is carried over to
.BR \%gxditview (1)
by determining an argument for the
@@ -572,34 +395,36 @@
.B Print
action and the corresponding menu entry to that value.
.
-.ShortOpt X
+.OP -X
only produces good results with
-.ShortOpt Tps ,
-.ShortOpt TX75 ,
-.ShortOpt TX75-12 ,
-.ShortOpt TX100 ,
+.BR -Tps ,
+.BR -TX75 ,
+.BR -TX75-12 ,
+.BR -TX100 ,
and
-.ShortOpt TX100-12 .
+.BR -TX100-12 .
.
The default resolution for previewing
-.ShortOpt Tps
+-Tps
output is 75\|dpi; this can be changed by passing the
-.ShortOpt resolution
+-resolution
option to
.BR gxditview ,
for example
+.sp
+.RS
+\*(sh groff -X -P-resolution -P100 -man foo.1
+.RE
.
-.IP
-.ShellCommand groff -X -P-resolution -P100 -man foo.1
-.
-.
-.OptDef z
+.TP
+.OP -z
Suppress output generated by
.BR troff .
Only error messages will be printed.
.
.
-.OptDef Z
+.TP
+.OP -Z
Do not postprocess the output of
.B troff
that is normally
@@ -621,61 +446,79 @@
These options are described in more detail in
.BR troff (1).
.
-.OptDef a
+.TP
+.OP -a
ascii approximation of output.
.
-.OptDef b
+.TP
+.OP -b
backtrace on error or warning.
.
-.OptDef c
+.TP
+.OP -c
disable color output.
.
-.OptDef C
+.TP
+.OP -C
enable compatibility mode.
.
-.OptDef d "" cs
-.OptDef+ d "" name=s
+.TP
+.OP -d cs
+.TP
+.BI name=s
define string.
.
-.OptDef E
+.TP
+.OP -E
disable
.B troff
error messages.
.
-.OptDef f "" fam
+.TP
+.OP -f fam
set default font family.
.
-.OptDef F "" dir
+.TP
+.OP -F dir
set path for font DESC files.
.
-.OptDef i
+.TP
+.OP -i
process standard input after the specified input files.
.
-.OptDef m "" name
+.TP
+.OP -m name
include macro file \f[I]name\f[]\f[B].tmac\f[] (or
\f[B]tmac.\f[]\f[I]name\f[]); see also
.BR \%groff_tmac (5).
.
-.OptDef M "" dir
+.TP
+.OP -M dir
path for macro files.
.
-.OptDef n "" num
+.TP
+.OP -n num
number the first page
.IR num .
.
-.OptDef o "" list
+.TP
+.OP -o list
output only pages in
.IR list .
.
-.OptDef r "" cn
-.OptDef+ r "" name=n
+.TP
+.OP -r cn
+.TP
+.OP -r name=n
set number register.
.
-.OptDef w "" name
+.TP
+.OP -w name
enable warning
.IR name .
.
-.OptDef W "" name
+.TP
+.OP -W name
disable warning
.IR name .
.
@@ -702,7 +545,7 @@
.BR roff (7)
with groff-specific features.
.
-This section can be regarded as a guide to the documentation around
+This section can be read as a guide to the documentation around
the groff system.
.
.
@@ -720,17 +563,17 @@
automatically runs the postprocessor that is appropriate for the
selected device.
.
-Doing so, the sometimes tedious piping mechanism of classical
+In this way, the sometimes tedious piping mechanism of classical
.BR roff (7)
can be avoided.
.
-.P
+.PP
The
.BR grog (1)
program can be used for guessing the correct groff command line to
format a file.
.
-.P
+.PP
The
.BR \%groffer (1)
program is an allround-viewer for groff files and man pages.
@@ -765,13 +608,13 @@
.BR \%soelim (1)
for including macro files from standard locations,
.
-.P
+.PP
and
.TP
.BR tbl (1)
for tables.
.
-.P
+.PP
Besides these, there are some internal preprocessors that are
automatically run with some devices.
.
@@ -783,7 +626,7 @@
.\" --------------------------------------------------------------------
.
Macro packages can be included by option
-.ShortOpt m .
+.BR -m .
.
The groff system implements and extends all classical macro packages
in a compatible way and adds some packages of its own.
@@ -796,10 +639,10 @@
The traditional man page format; see
.BR \%groff_man (7).
It can be specified on the command line as
-.ShortOpt man
+.OP -man
or
-.ShortOpt m
-.BR man .
+.OP -m man
+\&.
.
.TP
.B mandoc
@@ -811,20 +654,20 @@
format and branches to the corresponding macro package.
.
It can be specified on the command line as
-.ShortOpt mandoc
+.OP -mandoc
or
-.ShortOpt m
-.BR mandoc .
+.OP -m mandoc .
+\&.
.
.TP
.B mdoc
The BSD-style man page format; see
.BR \%groff_mdoc (7).
It can be specified on the command line as
-.ShortOpt mdoc
+.OP -mdoc
or
-.ShortOpt m
-.BR mdoc .
+.OP -m mdoc
+\&.
.
.TP
.B me
@@ -833,10 +676,10 @@
document format; see
.BR \%groff_me (7).
It can be specified on the command line as
-.ShortOpt me
+.OP -me
or
-.ShortOpt m
-.BR me .
+.OP -m me
+\&.
.
.TP
.B mm
@@ -845,10 +688,10 @@
document format; see
.BR \%groff_mm (7).
It can be specified on the command line as
-.ShortOpt mm
+.OP -mm
or
-.ShortOpt m
-.BR mm .
+.OP -m mm
+\&.
.
.TP
.B ms
@@ -857,17 +700,17 @@
document format; see
.BR \%groff_ms (7).
It can be specified on the command line as
-.ShortOpt ms
+.OP -ms
or
-.ShortOpt m
-.BR ms .
+.OP -m ms
+\&.
.
.TP
.B www
HTML-like macros for inclusion in arbitrary groff documents; see
.BR \%groff_www (7).
.
-.P
+.PP
Details on the naming of macro files and their placement can be found
in
.BR \%groff_tmac (5).
@@ -881,11 +724,11 @@
described in
.BR roff (7).
.
-.P
+.PP
The groff extensions to the classical troff language are documented in
.BR \%groff_diff (7).
.
-.P
+.PP
The groff language as a whole is described in the (still incomplete)
.IR "groff info file" ;
a short (but complete) reference can be found in
@@ -902,14 +745,14 @@
well as the groff extensions.
.
The command line option
-.ShortOpt C
+.OP -C
switches
.B troff
into
.I "compatibility mode"
which tries to emulate classical roff as much as possible.
.
-.P
+.PP
There is a shell script
.BR nroff (1)
that emulates the behavior of classical nroff.
@@ -917,7 +760,7 @@
It tries to automatically select the proper output encoding, according to
the current locale.
.
-.P
+.PP
The formatter program generates
.IR "intermediate output" ;
see
@@ -934,7 +777,7 @@
file format.
.
A device is specified by the option
-.ShortOpt T .
+.BR -T .
The groff devices are as follows.
.
.TP
@@ -1007,7 +850,7 @@
A variant for a 12\|pt document base font is
.BR X100-12 .
.
-.P
+.PP
The postprocessor to be used for a device is specified by the
.B postpro
command in the device description file; see
@@ -1017,7 +860,7 @@
.B \-X
option.
.
-.P
+.PP
The default device is
.BR ps .
.
@@ -1039,7 +882,7 @@
for text output using various encodings, e.g. on text-oriented
terminals or line-printers.
.
-.P
+.PP
Today, most printing or drawing hardware is handled by the operating
system, by device drivers, or by software interfaces, usually accepting
PostScript.
@@ -1047,7 +890,7 @@
Consequently, there isn't an urgent need for more hardware device
postprocessors.
.
-.P
+.PP
The groff software devices for conversion into other document file
formats are
.
@@ -1061,7 +904,7 @@
.BR grops (1)
for PostScript.
.
-.P
+.PP
Combined with the many existing free conversion tools this should
be sufficient to convert a troff document into virtually any existing
data format.
@@ -1128,18 +971,18 @@
For example, DOS and Windows use a semicolon instead.
.
.TP
-.EnvVar GROFF_BIN_PATH
+.B $GROFF_BIN_PATH
This search path, followed by
-.EnvVar $PATH ,
+.B $PATH ,
will be used for commands that are executed by
.BR groff .
.
If it is not set then the directory where the groff binaries were
installed is prepended to
-.EnvVar PATH .
+.B $PATH .
.
.TP
-.EnvVar GROFF_COMMAND_PREFIX
+.B $GROFF_COMMAND_PREFIX
When there is a need to run different roff implementations at the same
time
.I groff
@@ -1162,7 +1005,7 @@
.BR tbl .
.
By setting
-.EnvVar GROFF_COMMAND_PREFIX
+.B $GROFF_COMMAND_PREFIX
to different values, the different roff installations can be
addressed.
.
@@ -1193,20 +1036,20 @@
.
.
.TP
-.EnvVar GROFF_FONT_PATH
+.B $GROFF_FONT_PATH
A list of directories in which to search for the
.BI dev name
directory in addition to the default ones.
.
See
-.BR troff (1)
+.BR \%troff (1)
and
.BR \%groff_font (5)
for more details.
.
.
.TP
-.EnvVar GROFF_TMAC_PATH
+.B $GROFF_TMAC_PATH
A list of directories in which to search for macro files in addition to
the default directories.
.
@@ -1218,13 +1061,13 @@
.
.
.TP
-.EnvVar GROFF_TMPDIR
+.B $GROFF_TMPDIR
The directory in which temporary files will be created.
.
If this is not set but the environment variable
-.EnvVar TMPDIR
+.B $TMPDIR
instead, temporary files will be created in the directory
-.EnvVar $TMPDIR .
+.B $TMPDIR .
.
Otherwise temporary files will be created in
.BR /tmp .
@@ -1238,7 +1081,7 @@
.
.
.TP
-.EnvVar GROFF_TYPESETTER
+.B $GROFF_TYPESETTER
Preset the default device.
.
If this is not set the
@@ -1246,7 +1089,7 @@
device is used as default.
.
This device name is overwritten by the option
-.ShortOpt T .
+.BR -T .
.
.
.\" --------------------------------------------------------------------
@@ -1298,7 +1141,7 @@
.
.TP
.IB name .tmac
-.TP+
+.TP
.BI tmac. name
Macro file for macro package
.IR name .
@@ -1347,7 +1190,7 @@
program as a wrapper around
.BR troff .
.
-.P
+.PP
To process a roff file using the preprocessors
.B tbl
and
@@ -1356,37 +1199,37 @@
.B me
macro set, classical troff had to be called by
.
-.P
-.ShellCommand pic foo.me | tbl | troff -me -Tlatin1 | grotty
+.PP
+\*(sh pic foo.me | tbl | troff -me -Tlatin1 | grotty
.
-.P
+.PP
Using
.BR groff ,
this pipe can be shortened to the equivalent command
-.P
-.ShellCommand groff -p -t -me -T latin1 foo.me
+.PP
+\*(sh groff -p -t -me -T latin1 foo.me
.
-.P
+.PP
An even easier way to call this is to use
.BR grog (1)
to guess the preprocessor and macro options and execute the generated
command (by specifying shell left quotes)
-.P
-.ShellCommand `grog -Tlatin1 foo.me`
+.PP
+\*(sh `grog -Tlatin1 foo.me`
.
-.P
+.PP
The simplest way is to view the contents in an automated way by
calling
.
-.P
-.ShellCommand groffer foo.me
+.PP
+\*(sh groffer foo.me
.
.
.\" --------------------------------------------------------------------
.SH BUGS
.\" --------------------------------------------------------------------
.
-.P
+.PP
On EBCDIC hosts (e.g. OS/390 Unix), output devices
.B ascii
and
@@ -1397,7 +1240,7 @@
.B cp1047
is not available on ASCII based operating systems.
.
-.P
+.PP
Report bugs to address@hidden
.
Include a complete, self-contained example that will allow the bug to
@@ -1410,41 +1253,45 @@
.
Information on how to get groff and related information is available
at the
-.URL http://\:www.gnu.org/\:software/\:groff "GNU website" .
+.UR http://\:www.gnu.org/\:software/\:groff
+GNU website.
+.UE
The most recent released version of groff is available for anonymous
ftp at the
-.URL ftp://ftp.ffii.org/\:pub/\:groff/\:devel/\:groff-current.tar.gz \
- "groff development site" .
+.UR ftp://ftp.ffii.org/\:pub/\:groff/\:devel/\:groff-current.tar.gz
+groff development site.
+.UE
.
-.P
+.PP
Three groff mailing lists are available:
.TP
-.MTO address@hidden
address@hidden
for reporting bugs,
.
.TP
-.MTO address@hidden
address@hidden
for general discussion of groff,
.
.TP
-.MTO address@hidden
address@hidden
a read-only list showing logs of commitments to the CVS repository.
.
-.P
+.PP
Details on CVS access and much more can be found in the file
.B README
at the top directory of the groff source package.
.
-.P
+.PP
There is a free implementation of the
.B grap
preprocessor, written by
-.MTO address@hidden " Ted Faber" .
+Ted Faber <address@hidden>.
.
The actual version can be found at the
.
-.URL http://\:www.lunabase.org/\:~faber/\:Vault/\:software/\:grap/ \
- "grap website" .
+.UR http://\:www.lunabase.org/\:~faber/\:Vault/\:software/\:grap/
+grap website.\&
+.UE
This is the only grap version supported by groff.
.
.
@@ -1454,25 +1301,30 @@
.
Copyright \(co 1989, 2002 Free Software Foundation, Inc.
.
-.P
+.PP
This document is distributed under the terms of the FDL (GNU Free
Documentation License) version 1.1 or later.
.
You should have received a copy of the FDL on your system, it is also
available on-line at the
-.URL http://\:www.gnu.org/\:copyleft/\:fdl.html "GNU copyleft site" .
+.UR http://\:www.gnu.org/\:copyleft/\:fdl.html
+GNU copyleft site.
+.UE
.
-.P
+.PP
This document is based on the original groff man page written by
-.MTO address@hidden "James Clark" .
+James Clark <address@hidden>.
.
It was rewritten, enhanced, and put under the FDL license by
-.MTO address@hidden "Bernd Warken" .
+Bernd Warken <address@hidden>.
.
+German accent and over-elaborate macro hackery (which broke several
+viewers) were removed by Eric S. Raymond <address@hidden>.
+
It is maintained by
-.MTO address@hidden "Werner Lemberg" .
+Werner Lemberg <address@hidden>.
.
-.P
+.PP
.I groff
is a GNU free software project.
.
@@ -1500,7 +1352,7 @@
.BR info (1)
on how to read it.
.
-.P
+.PP
Due to its complex structure, the groff system has many man pages.
.
They can be read with
@@ -1544,7 +1396,7 @@
Roff formatter programs:
.BR \%nroff (1),
.BR \%troff (1),
-.BR ditroff (7).
+.BR \%ditroff (7).
.
.TP
The intermediate output language:
-----------------------------
--
Eric S. Raymond
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- problems in eqn.1, geqn.1, groff.1,
esr <=