In -Tman mode, support automatic word keeps in the SYNOPSIS

[mandoc.git] / roff.7

diff --git a/roff.7 b/roff.7
index 76169d876dbf1dce51bd00f0ccd5e45a3300619d..2221251431280d49b2817972459d6befb29cb028 100644 (file)
--- a/roff.7
+++ b/roff.7
@@ -1,4 +1,4 @@
-.\"    $Id: roff.7,v 1.35 2011/11/21 22:19:23 kristaps Exp $
+.\"    $Id: roff.7,v 1.39 2012/06/12 20:21:04 kristaps Exp $

 .\"
 .\" Copyright (c) 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
 .\" Copyright (c) 2010, 2011 Ingo Schwarze <schwarze@openbsd.org>
 .\"
 .\" Copyright (c) 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
 .\" Copyright (c) 2010, 2011 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: November 21 2011 $
+.Dd $Mdocdate: June 12 2012 $

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


@@ -83,7 +83,7 @@ depends on the respective processing context.
 .Nm
 documents may contain only graphable 7-bit ASCII characters, the space
 character, and, in certain circumstances, the tab character.
 .Nm
 documents may contain only graphable 7-bit ASCII characters, the space
 character, and, in certain circumstances, the tab character.

-The back-space character
+The backslash character

 .Sq \e
 indicates the start of an escape sequence for
 .Sx Comments ,
 .Sq \e
 indicates the start of an escape sequence for
 .Sx Comments ,


@@ -417,6 +417,18 @@ The syntax of this request is the same as that of
 It is currently ignored by
 .Xr mandoc 1 ,
 as are its children.
 It is currently ignored by
 .Xr mandoc 1 ,
 as are its children.

+.Ss \&cc
+Changes the control character.
+Its syntax is as follows:
+.Bd -literal -offset indent
+.Pf . Cm \&cc Op Ar c
+.Ed
+.Pp
+If
+.Ar c
+is not specified, the control character is reset to
+.Sq \&. .
+Trailing characters are ignored.

 .Ss \&de
 Define a
 .Nm
 .Ss \&de
 Define a
 .Nm


@@ -844,6 +856,22 @@ only accepts relative paths not containing the strings
 .Qq ../
 and
 .Qq /.. .
 .Qq ../
 and
 .Qq /.. .

+.Pp
+This request requires
+.Xr man 1
+to change to the right directory before calling
+.Xr mandoc 1 ,
+per convention to the root of the manual tree.
+Typical usage looks like:
+.Pp
+.Dl \&.so man3/Xcursor.3
+.Pp
+As the whole concept is rather fragile, the use of
+.Sx \&so
+is discouraged.
+Use
+.Xr ln 1
+instead.

 .Ss \&ta
 Set tab stops.
 This line-scoped request can take an arbitrary number of arguments.
 .Ss \&ta
 Set tab stops.
 This line-scoped request can take an arbitrary number of arguments.


@@ -952,8 +980,8 @@ Saltzer in 1964.
 Doug McIlroy rewrote it in BCPL in 1969, renaming it
 .Nm .
 Dennis M. Ritchie rewrote McIlroy's
 Doug McIlroy rewrote it in BCPL in 1969, renaming it
 .Nm .
 Dennis M. Ritchie rewrote McIlroy's

-.Nm 
-in PDP-11 assmebly for
+.Nm
+in PDP-11 assembly for

 .At v1 ,
 Joseph F. Ossanna improved roff and renamed it nroff
 for
 .At v1 ,
 Joseph F. Ossanna improved roff and renamed it nroff
 for