Make -man check for tabs correctly print the column.

[mandoc.git] / roff.7

diff --git a/roff.7 b/roff.7
index 1f55810d9db90b75ca13ec5aca36b43073e9c555..55991a738a36fa200f3ed211dd0d58ab76ba47a9 100644 (file)
--- a/roff.7
+++ b/roff.7
@@ -1,4 +1,4 @@
-.\"    $Id: roff.7,v 1.26 2011/01/25 01:12:02 schwarze Exp $
+.\"    $Id: roff.7,v 1.32 2011/09/02 19:37:35 kristaps Exp $

 .\"
 .\" Copyright (c) 2010 Kristaps Dzonsons <kristaps@bsd.lv>
 .\" Copyright (c) 2010 Ingo Schwarze <schwarze@openbsd.org>
 .\"
 .\" Copyright (c) 2010 Kristaps Dzonsons <kristaps@bsd.lv>
 .\" Copyright (c) 2010 Ingo Schwarze <schwarze@openbsd.org>


@@ -15,7 +15,7 @@
 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 .\"
 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 .\"

-.Dd $Mdocdate: January 25 2011 $
+.Dd $Mdocdate: September 2 2011 $

 .Dt ROFF 7
 .Os
 .Sh NAME
 .Dt ROFF 7
 .Os
 .Sh NAME


@@ -90,7 +90,7 @@ When called, they follow the same syntax as requests, except that
 macro arguments may optionally be quoted by enclosing them
 in double quote characters
 .Pq Sq \(dq .
 macro arguments may optionally be quoted by enclosing them
 in double quote characters
 .Pq Sq \(dq .

-To be recognized as the beginning of a quoted argument, the opening
+To be recognised as the beginning of a quoted argument, the opening

 quote character must be preceded by a space character.
 .Pp
 A quoted argument may contain whitespace, and pairs of double quote
 quote character must be preceded by a space character.
 .Pp
 A quoted argument may contain whitespace, and pairs of double quote


@@ -118,7 +118,7 @@ but quoting is usually better for clarity.
 The
 .Xr mandoc 1
 .Nm
 The
 .Xr mandoc 1
 .Nm

-parser recognizes the following requests.
+parser recognises the following requests.

 Note that the
 .Nm
 language defines many more requests not implemented in
 Note that the
 .Nm
 language defines many more requests not implemented in


@@ -126,7 +126,7 @@ language defines many more requests not implemented in
 .Ss \&ad
 Set line adjustment mode.
 This line-scoped request is intended to have one argument to select
 .Ss \&ad
 Set line adjustment mode.
 This line-scoped request is intended to have one argument to select

-normal, left, right, or center adjustment for subsequent text.
+normal, left, right, or centre adjustment for subsequent text.

 Currently, it is ignored including its arguments,
 and the number of arguments is not checked.
 .Ss \&am
 Currently, it is ignored including its arguments,
 and the number of arguments is not checked.
 .Ss \&am


@@ -344,6 +344,15 @@ then false is assumed.
 The syntax of this request is similar to
 .Sx \&if
 except that the conditional is missing.
 The syntax of this request is similar to
 .Sx \&if
 except that the conditional is missing.

+.Ss \&EN
+End an equation block.
+See
+.Sx \&EQ .
+.Ss \&EQ
+Begin an equation block.
+See
+.Xr eqn 7
+for a description of the equation language.

 .Ss \&hy
 Set automatic hyphenation mode.
 This line-scoped request is currently ignored.
 .Ss \&hy
 Set automatic hyphenation mode.
 This line-scoped request is currently ignored.


@@ -439,15 +448,20 @@ than having the request or macro follow as
 The scope of a conditional is always parsed, but only executed if the
 conditional evaluates to true.
 .Pp
 The scope of a conditional is always parsed, but only executed if the
 conditional evaluates to true.
 .Pp

-Note that text following an
-.Sq \&.\e}
-escape sequence is discarded.
-Furthermore, if an explicit closing sequence
+Note that the

 .Sq \e}
 .Sq \e}

-is specified in a free-form line, the entire line is accepted within the
-scope of the prior request, not only the text preceding the close, with the
+is converted into a zero-width escape sequence if not passed as a
+standalone macro
+.Sq \&.\e} .
+For example,
+.Pp
+.D1 \&.Fl a \e} b
+.Pp
+will result in

 .Sq \e}
 .Sq \e}

-collapsing into a zero-width space.
+being considered an argument of the
+.Sq \&Fl
+macro.

 .Ss \&ig
 Ignore input.
 Its syntax can be either
 .Ss \&ig
 Ignore input.
 Its syntax can be either


@@ -558,7 +572,7 @@ The
 will be read and its contents processed as input in place of the
 .Sq \&.so
 request line.
 will be read and its contents processed as input in place of the
 .Sq \&.so
 request line.

-To avoid inadvertant inclusion of unrelated files,
+To avoid inadvertent inclusion of unrelated files,

 .Xr mandoc 1
 only accepts relative paths not containing the strings
 .Qq ../
 .Xr mandoc 1
 only accepts relative paths not containing the strings
 .Qq ../


@@ -570,10 +584,21 @@ This line-scoped request can take an arbitrary number of arguments.
 Currently, it is ignored including its arguments.
 .Ss \&tr
 Output character translation.
 Currently, it is ignored including its arguments.
 .Ss \&tr
 Output character translation.

-This request is intended to have one argument,
-consisting of an even number of characters.
-Currently, it is ignored including its arguments,
-and the number of arguments is not checked.
+Its syntax is as follows:
+.Pp
+.D1 Pf \. Cm \&tr Ar [ab]+
+.Pp
+Pairs of
+.Ar ab
+characters are replaced
+.Ar ( a
+for
+.Ar b ) .
+Replacement (or origin) characters may also be character escapes; thus,
+.Pp
+.Dl tr \e(xx\e(yy
+.Pp
+replaces all invocations of \e(xx with \e(yy.

 .Ss \&T&
 Re-start a table layout, retaining the options of the prior table
 invocation.
 .Ss \&T&
 Re-start a table layout, retaining the options of the prior table
 invocation.


@@ -599,6 +624,19 @@ refers to groff version 1.15.
 .Pp
 .Bl -dash -compact
 .It
 .Pp
 .Bl -dash -compact
 .It

+In mandoc, the
+.Sx \&EQ ,
+.Sx \&TE ,
+.Sx \&TS ,
+and
+.Sx \&T& ,
+macros are considered regular macros.
+In all other
+.Nm
+implementations, these are special macros that must be specified without
+spacing between the control character (which must be a period) and the
+macro name.
+.It

 The
 .Cm nS
 register is only compatible with OpenBSD's groff-1.15.
 The
 .Cm nS
 register is only compatible with OpenBSD's groff-1.15.


@@ -616,6 +654,7 @@ using the next-line syntax.
 .El
 .Sh SEE ALSO
 .Xr mandoc 1 ,
 .El
 .Sh SEE ALSO
 .Xr mandoc 1 ,

+.Xr eqn 7 ,

 .Xr man 7 ,
 .Xr mandoc_char 7 ,
 .Xr mdoc 7 ,
 .Xr man 7 ,
 .Xr mandoc_char 7 ,
 .Xr mdoc 7 ,


@@ -650,9 +689,11 @@ Joseph F. Ossanna rewrote it in PDP-11 assembly in 1973,
 and Brian W. Kernighan rewrote it in C in 1975.
 .Sh AUTHORS
 .An -nosplit
 and Brian W. Kernighan rewrote it in C in 1975.
 .Sh AUTHORS
 .An -nosplit

-This partial
+This

 .Nm
 reference was written by
 .Nm
 reference was written by

-.An Kristaps Dzonsons Aq kristaps@bsd.lv
+.An Kristaps Dzonsons ,
+.Mt kristaps@bsd.lv ;

 and
 and

-.An Ingo Schwarze Aq schwarze@openbsd.org .
+.An Ingo Schwarze ,
+.Mt schwarze@openbsd.org .