diff options
| author |   Kristaps Dzonsons <kristaps@bsd.lv> | 2010-06-04 21:49:39 +0000 |
|---|---|---|
| committer | Kristaps Dzonsons <kristaps@bsd.lv> | 2010-06-04 21:49:39 +0000 |
| commit | 67a51824265c8e0d0f41e8cacb1714e5671c7053 (patch) | |
| tree | a42511e4878a1a70863b6e7ac3faa1e566a072a7 /mdoc.7 | |
| parent | 12bd5ba1acfc34cc1274b3b3d2c1a9e28978bb6e (diff) | |
| download | mandoc-67a51824265c8e0d0f41e8cacb1714e5671c7053.tar.gz mandoc-67a51824265c8e0d0f41e8cacb1714e5671c7053.tar.zst mandoc-67a51824265c8e0d0f41e8cacb1714e5671c7053.zip | |
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.7 | 25 |
1 files changed, 22 insertions, 3 deletions
@@ -1,4 +1,4 @@ -.\" $Id: mdoc.7,v 1.117 2010/06/04 20:57:26 kristaps Exp $ +.\" $Id: mdoc.7,v 1.118 2010/06/04 21:49:39 kristaps Exp $ .\" .\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@bsd.lv> .\" @@ -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. |