summaryrefslogtreecommitdiffstats
path: root/mdoc.7
diff options
context:
space:
mode:
authorKristaps Dzonsons <kristaps@bsd.lv>2010-06-04 21:49:39 +0000
committerKristaps Dzonsons <kristaps@bsd.lv>2010-06-04 21:49:39 +0000
commit14deda6326abdec269681291139d0ae022db56f9 (patch)
treee54066223fec52451a6c76fe663d1ea51c445ff7 /mdoc.7
parent8c29167218188f6baf91ea99e4a5cd3e70080638 (diff)
downloadmandoc-14deda6326abdec269681291139d0ae022db56f9.tar.gz
Documented `In' in full.
Fixed `In' to behave properly: it wasn't properly breaking lines, formatting, or really anything else. Noted COMPATIBILITY with OpenBSD's groff, which pukes all over `In'.
Diffstat (limited to 'mdoc.7')
-rw-r--r--mdoc.723
1 files changed, 21 insertions, 2 deletions
diff --git a/mdoc.7 b/mdoc.7
index b8b787ca..73f0ecf6 100644
--- a/mdoc.7
+++ b/mdoc.7
@@ -33,7 +33,7 @@ section describes compatibility with other troff \-mdoc implementations.
.Pp
An
.Nm
-document follows simple rules: lines beginning with the control
+document follows simple rules: lines beginning with the control
character
.Sq \.
are parsed for macros. Other lines are interpreted within the scope of
@@ -122,7 +122,7 @@ escape followed by an indicator: B (bold), I, (italic), R (Roman), or P
A numerical representation 3, 2, or 1 (bold, italic, and Roman,
respectively) may be used instead.
A text decoration is valid within
-the current font scope only: if a macro opens a font scope alongside
+the current font scope only: if a macro opens a font scope alongside
its own scope, such as
.Sx \&Bf
.Cm \&Sy ,
@@ -1679,6 +1679,19 @@ and
.Ss \&Hf
.Ss \&Ic
.Ss \&In
+An
+.Qq include
+file.
+In the
+.Em SYNOPSIS
+section (only if invoked as the line macro), the first argument is
+preceded by
+.Qq #include ,
+the arguments is enclosed in angled braces, and a newline is asserted.
+In all other invocations, only angled braces will enclose the argument.
+.Pp
+Examples
+.D1 \&.In sys/types
.Ss \&It
A list item. The syntax of this macro depends on the list type.
.Pp
@@ -2035,6 +2048,12 @@ Heirloom troff, the other significant troff implementation accepting
.Pp
.Bl -dash -compact
.It
+Historic groff formats the
+.Sx \&In
+badly: trailing arguments are trashed and
+.Em SYNOPSIS
+is not specially treated.
+.It
groff does not accept the
.Sq \&Ta
pseudo-macro as a line macro.