summaryrefslogtreecommitdiff
path: root/tmac/groff_mdoc.man
diff options
context:
space:
mode:
authorwl <wl>2007-05-30 13:58:29 +0000
committerwl <wl>2007-05-30 13:58:29 +0000
commit96b23d7aa72aba5720e3b92c8c7d458fe3fbc0db (patch)
tree1aaebd9a450e2e2fd778b4cf29812fa5422b7e22 /tmac/groff_mdoc.man
parent98c1c52c5243b2df8153a486bdb8ef101399618f (diff)
downloadgroff-96b23d7aa72aba5720e3b92c8c7d458fe3fbc0db.tar.gz
* tmac/groff_mdoc.man: Convert `-' to `\-' where appropriate.
Recommend `tbl' instead of `-column' lists for more complicated cases.
Diffstat (limited to 'tmac/groff_mdoc.man')
-rw-r--r--tmac/groff_mdoc.man168
1 files changed, 87 insertions, 81 deletions
diff --git a/tmac/groff_mdoc.man b/tmac/groff_mdoc.man
index 0258d090..e071a162 100644
--- a/tmac/groff_mdoc.man
+++ b/tmac/groff_mdoc.man
@@ -813,9 +813,9 @@ prevents the digit\~7 from being a valid numeric expression.
Local, OS-specific additions might be found in the file
.Pa mdoc.local ;
look for strings named
-.Ql volume-ds-XXX
+.Ql volume\-ds\-XXX
(for the former type) and
-.Ql volume-as-XXX
+.Ql volume\-as\-XXX
(for the latter type);
.Ql XXX
then denotes the keyword to be used with the
@@ -848,7 +848,7 @@ Similar to
local additions might be defined in
.Pa mdoc.local ;
look for strings named
-.Ql operating-system-XXX-YYY ,
+.Ql operating\-system\-XXX\-YYY ,
where
.Ql XXX
is the acronym for the operating system and
@@ -1202,7 +1202,7 @@ line.
If this is not desirable,
.
.Bd -literal -offset indent
-\&.An -nosplit
+\&.An \-nosplit
.Ed
.Pp
.
@@ -1210,7 +1210,7 @@ call will turn this off.
To turn splitting back on, write
.
.Bd -literal -offset indent
-\&.An -split
+\&.An \-split
.Ed
.
.Ss "Arguments"
@@ -1580,10 +1580,10 @@ macro generates text for use in the
.Sx RETURN VALUES
section.
.Pp
-.Dl Usage: .Rv Oo -std Oc Op Ao function Ac ...
+.Dl Usage: .Rv Oo \-std Oc Op Ao function Ac ...
.Pp
For example,
-.Ql ".Rv -std atexit"
+.Ql ".Rv \-std atexit"
produces:
.
.Bd -ragged -offset -indent
@@ -1610,10 +1610,10 @@ macro generates text for use in the
.Sx DIAGNOSTICS
section.
.Pp
-.Dl Usage: .Ex Oo -std Oc Op Ao utility Ac ...
+.Dl Usage: .Ex Oo \-std Oc Op Ao utility Ac ...
.Pp
For example,
-.Ql ".Ex -std cat"
+.Ql ".Ex \-std cat"
produces:
.
.Bd -ragged -offset -indent
@@ -1737,7 +1737,7 @@ and their results are:
Local, OS-specific additions might be found in the file
.Pa mdoc.local ;
look for strings named
-.Ql str-Lb-XXX .
+.Ql str\-Lb\-XXX .
.Ql XXX
then denotes the keyword to be used with the
.Ql .Lb
@@ -1755,16 +1755,16 @@ command causes a line break before and after its arguments are printed.
The
.Ql .Li
literal macro may be used for special characters, variable constants, etc.\&
--- anything which should be displayed as it would be typed.
+\- anything which should be displayed as it would be typed.
.Pp
.Dl Usage: .Li Ao argument Ac ...
.Pp
-.Bl -tag -width ".Li .Li\ cntrl-D\ )\ ," -compact -offset 15n
+.Bl -tag -width ".Li .Li\ cntrl\-D\ )\ ," -compact -offset 15n
.It Li ".Li \een"
.Li \en
.It Li ".Li M1 M2 M3 ;"
.Li M1 M2 M3 ;
-.It Li ".Li cntrl-D ) ,"
+.It Li ".Li cntrl\-D ) ,"
.Li cntrl-D ) ,
.It Li ".Li 1024 ..."
.Li 1024 ...
@@ -1812,7 +1812,7 @@ it can not recall the first argument it was invoked with.
.Bl -tag -width ".Li .Nm\ groff_mdoc" -compact -offset 15n
.It Li ".Nm groff_mdoc"
.Nm groff_mdoc
-.It Li ".Nm \e-mdoc"
+.It Li ".Nm \e\-mdoc"
.Nm \-mdoc
.It Li ".Nm foo ) ) ,"
.Nm foo ) ) ,
@@ -1930,16 +1930,16 @@ are:
.Pp
.Tn ANSI/ISO C
.Pp
-.Bl -tag -width ".Li -iso9945-1-90" -compact -offset indent
-.It Li -ansiC
+.Bl -tag -width ".Li \-p1003.1g\-2000" -compact -offset indent
+.It Li \-ansiC
.St -ansiC
-.It Li -ansiC-89
+.It Li \-ansiC\-89
.St -ansiC-89
-.It Li -isoC
+.It Li \-isoC
.St -isoC
-.It Li -isoC-90
+.It Li \-isoC\-90
.St -isoC-90
-.It Li -isoC-99
+.It Li \-isoC\-99
.St -isoC-99
.El
.Pp
@@ -1947,30 +1947,30 @@ are:
.Tn POSIX
Part 1: System API
.Pp
-.Bl -tag -width ".Li -p1003.1g-2000" -compact -offset indent
-.It Li -iso9945-1-90
+.Bl -tag -width ".Li \-p1003.1g\-2000" -compact -offset indent
+.It Li \-iso9945\-1\-90
.St -iso9945-1-90
-.It Li -iso9945-1-96
+.It Li \-iso9945\-1\-96
.St -iso9945-1-96
-.It Li -p1003.1
+.It Li \-p1003.1
.St -p1003.1
-.It Li -p1003.1-88
+.It Li \-p1003.1\-88
.St -p1003.1-88
-.It Li -p1003.1-90
+.It Li \-p1003.1\-90
.St -p1003.1-90
-.It Li -p1003.1-96
+.It Li \-p1003.1\-96
.St -p1003.1-96
-.It Li -p1003.1b-93
+.It Li \-p1003.1b\-93
.St -p1003.1b-93
-.It Li -p1003.1c-95
+.It Li \-p1003.1c\-95
.St -p1003.1c-95
-.It Li -p1003.1g-2000
+.It Li \-p1003.1g\-2000
.St -p1003.1g-2000
-.It Li -p1003.1i-95
+.It Li \-p1003.1i\-95
.St -p1003.1i-95
-.It Li -p1003.1-2001
+.It Li \-p1003.1\-2001
.St -p1003.1-2001
-.It Li -p1003.1-2004
+.It Li \-p1003.1\-2004
.St -p1003.1-2004
.El
.Pp
@@ -1978,52 +1978,52 @@ Part 1: System API
.Tn POSIX
Part 2: Shell and Utilities
.Pp
-.Bl -tag -width ".Li -p1003.1g-2000" -compact -offset indent
-.It Li -iso9945-2-93
+.Bl -tag -width ".Li \-p1003.1g\-2000" -compact -offset indent
+.It Li \-iso9945\-2\-93
.St -iso9945-2-93
-.It Li -p1003.2
+.It Li \-p1003.2
.St -p1003.2
-.It Li -p1003.2-92
+.It Li \-p1003.2\-92
.St -p1003.2-92
-.It Li -p1003.2a-92
+.It Li \-p1003.2a\-92
.St -p1003.2a-92
.El
.Pp
.
X/Open
-.Bl -tag -width ".Li -p1003.1g-2000" -compact -offset indent
+.Bl -tag -width ".Li \-p1003.1g\-2000" -compact -offset indent
.Pp
-.It Li -susv2
+.It Li \-susv2
.St -susv2
-.It Li -svid4
+.It Li \-svid4
.St -svid4
-.It Li -xbd5
+.It Li \-xbd5
.St -xbd5
-.It Li -xcu5
+.It Li \-xcu5
.St -xcu5
-.It Li -xcurses4.2
+.It Li \-xcurses4.2
.St -xcurses4.2
-.It Li -xns5
+.It Li \-xns5
.St -xns5
-.It Li -xns5.2
+.It Li \-xns5.2
.St -xns5.2
-.It Li -xpg3
+.It Li \-xpg3
.St -xpg3
-.It Li -xpg4
+.It Li \-xpg4
.St -xpg4
-.It Li -xpg4.2
+.It Li \-xpg4.2
.St -xpg4.2
-.It Li -xsh5
+.It Li \-xsh5
.St -xsh5
.El
.Pp
.
Miscellaneous
.Pp
-.Bl -tag -width ".Li -p1003.1g-2000" -compact -offset indent
-.It Li -ieee754
+.Bl -tag -width ".Li \-p1003.1g\-2000" -compact -offset indent
+.It Li \-ieee754
.St -ieee754
-.It Li -iso8802-3
+.It Li \-iso8802\-3
.St -iso8802-3
.El
.
@@ -2113,7 +2113,7 @@ are possible:
.Ss "BSD Macro"
.
.Pp
-.Dl "Usage: .Bx" Bro -alpha | -beta | -devel Brc ...
+.Dl "Usage: .Bx" Bro \-alpha | \-beta | \-devel Brc ...
.Dl " .Bx" Oo Ao version Ac Oo Ao release Ac Oc Oc ...
.Pp
.Bl -tag -width ".Li .Bx\ -devel" -compact -offset 15n
@@ -2384,7 +2384,7 @@ Examples of quoting:
.Dq
.It Li ".Dq string abc ."
.Dq string abc .
-.It Li ".Dq \'^[A-Z]\'"
+.It Li ".Dq \'^[A\-Z]\'"
.Dq \'^[A-Z]\'
.It Li ".Ql man mdoc"
.Ql man mdoc
@@ -2577,7 +2577,7 @@ Example:
\&.%A "Matthew Bar"
\&.%A "John Foo"
\&.%T "Implementation Notes on foobar(1)"
-\&.%R "Technical Report ABC-DE-12-345"
+\&.%R "Technical Report ABC\-DE\-12\-345"
\&.%Q "Drofnats College, Nowhere"
\&.%D "April 1991"
\&.Re
@@ -2750,7 +2750,7 @@ available is small.
.Pp
.Ql .Nd
first prints
-.Ql - ,
+.Ql \- ,
then all its arguments.
.
.It Li ".Sh LIBRARY"
@@ -3157,10 +3157,10 @@ Its default font is set to constant width (literal).
.Ql .Dl
is parsed but not callable.
.Pp
-.Dl % ls -ldg /usr/local/bin
+.Dl % ls \-ldg /usr/local/bin
.Pp
The above was produced by:
-.Li ".Dl % ls -ldg /usr/local/bin" .
+.Li ".Dl % ls \e\-ldg /usr/local/bin" .
.
.It Li .Bd
Begin display.
@@ -3232,7 +3232,7 @@ and
macros, so one is guaranteed the two types of displays will line up.
The indentation value is normally set to\~6n or about two thirds of an inch
(six constant width characters).
-.It Ar indent-two
+.It Ar indent\-two
Indent two times the default indent value.
.It Ar right
This
@@ -3327,7 +3327,7 @@ And now a detailed description of the list types.
A bullet list.
.
.Bd -literal -offset indent
-\&.Bl -bullet -offset indent -compact
+\&.Bl \-bullet \-offset indent \-compact
\&.It
Bullet one goes here.
\&.It
@@ -3351,7 +3351,7 @@ Bullet two here.
A dash list.
.
.Bd -literal -offset indent
-\&.Bl -dash -offset indent -compact
+\&.Bl \-dash \-offset indent \-compact
\&.It
Dash one goes here.
\&.It
@@ -3375,7 +3375,7 @@ Dash two here.
An enumerated list.
.
.Bd -literal -offset indent
-\&.Bl -enum -offset indent -compact
+\&.Bl \-enum \-offset indent \-compact
\&.It
Item one goes here.
\&.It
@@ -3400,10 +3400,10 @@ If you want to nest enumerated lists, use the
flag (starting with the second-level list):
.
.Bd -literal -offset indent
-\&.Bl -enum -offset indent -compact
+\&.Bl \-enum \-offset indent \-compact
\&.It
Item one goes here
-\&.Bl -enum -nested -compact
+\&.Bl \-enum \-nested \-compact
\&.It
Item two goes here.
\&.It
@@ -3438,7 +3438,7 @@ A list of type
without list markers.
.
.Bd -literal -offset indent
-\&.Bl -item -offset indent
+\&.Bl \-item \-offset indent
\&.It
Item one goes here.
Item one goes here.
@@ -3492,7 +3492,7 @@ numerical id of parent of process priority
The raw text:
.
.Bd -literal -offset indent
-\&.Bl -tag -width "PPID" -compact -offset indent
+\&.Bl \-tag \-width "PPID" \-compact \-offset indent
\&.It SL
sleep time of the process (seconds blocked)
\&.It PAGEIN
@@ -3501,10 +3501,10 @@ number of disk
resulting from references by the process
to pages not loaded in core.
\&.It UID
-numerical user-id of process owner
+numerical user\-id of process owner
\&.It PPID
numerical id of parent of process priority
-(non-positive when in non-interruptible wait)
+(non\-positive when in non\-interruptible wait)
\&.El
.Ed
.Pp
@@ -3519,7 +3519,7 @@ flag is not meaningful in this context.
Example:
.
.Bd -literal -offset indent
-\&.Bl -diag
+\&.Bl \-diag
\&.It You can't use Sy here.
The message says all.
\&.El
@@ -3549,7 +3549,7 @@ tagged paragraph labels.
And the unformatted text which created it:
.
.Bd -literal -offset indent
-\&.Bl -hang -offset indent
+\&.Bl \-hang \-offset indent
\&.It Em Hanged
labels appear similar to tagged lists when the
label is smaller than the label width.
@@ -3583,7 +3583,7 @@ numerical id of parent of process priority
The raw text:
.
.Bd -literal -offset indent
-\&.Bl -ohang -offset indent
+\&.Bl \-ohang \-offset indent
\&.It Sy SL
sleep time of the process (seconds blocked)
\&.It Sy PAGEIN
@@ -3592,10 +3592,10 @@ number of disk
resulting from references by the process
to pages not loaded in core.
\&.It Sy UID
-numerical user-id of process owner
+numerical user\-id of process owner
\&.It Sy PPID
numerical id of parent of process priority
-(non-positive when in non-interruptible wait)
+(non\-positive when in non\-interruptible wait)
\&.El
.Ed
.Pp
@@ -3628,7 +3628,7 @@ manuals to other formats.
Here is the source text which produced the above example:
.
.Bd -literal -offset indent
-\&.Bl -inset -offset indent
+\&.Bl \-inset \-offset indent
\&.It Em Tag
The tagged list (also called a tagged paragraph)
is the most common type of list used in the
@@ -3693,12 +3693,18 @@ The table:
was produced by:
.
.Bd -literal
-\&.Bl -column -offset indent ".Sy String" ".Sy Nroff" ".Sy Troff"
+\&.Bl \-column \-offset indent ".Sy String" ".Sy Nroff" ".Sy Troff"
\&.It Sy String Ta Sy Nroff Ta Sy Troff
\&.It Li <= Ta <= Ta \e*(<=
\&.It Li >= Ta >= Ta \e*(>=
\&.El
.Ed
+.Pp
+.
+Don't abuse this list type!
+For more complicated cases it might be far better and easier to use
+.Xr tbl 1 ,
+the table preprocessor.
.El
.Pp
.
@@ -3720,7 +3726,7 @@ Almost all lists in this document use this option.
Example:
.
.Bd -literal -offset indent
-\&.Bl -tag -width ".Fl test Ao Ar string Ac"
+\&.Bl \-tag \-width ".Fl test Ao Ar string Ac"
\&.It Fl test Ao Ar string Ac
This is a longer sentence to show how the
\&.Fl width
@@ -4029,19 +4035,19 @@ to zero while calling
.Xr groff 1 ,
resulting in multiple pages instead of a single, very long page:
.Pp
-.Dl groff -Tlatin1 -rcR=0 -mdoc foo.man > foo.txt
+.Dl groff \-Tlatin1 \-rcR=0 \-mdoc foo.man > foo.txt
.Pp
For double-sided printing, set register
.Ql D
to\~1:
.Pp
-.Dl groff -Tps -rD1 -mdoc foo.man > foo.ps
+.Dl groff \-Tps \-rD1 \-mdoc foo.man > foo.ps
.Pp
To change the document font size to 11pt or 12pt, set register
.Ql S
accordingly:
.Pp
-.Dl groff -Tdvi -rS11 -mdoc foo.man > foo.dvi
+.Dl groff \-Tdvi \-rS11 \-mdoc foo.man > foo.dvi
.Pp
Register
.Ql S
@@ -4055,7 +4061,7 @@ and
.Ql LT ,
respectively:
.Pp
-.Dl groff -Tutf8 -rLL=100n -rLT=100n -mdoc foo.man | less
+.Dl groff \-Tutf8 \-rLL=100n \-rLT=100n \-mdoc foo.man | less
.Pp
If not set, both registers default to 78n for TTY devices and 6.5i
otherwise.