aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/mdoc.7
diff options
context:
space:
mode:
authorIngo Schwarze <schwarze@openbsd.org>2015-02-15 17:57:45 +0000
committerIngo Schwarze <schwarze@openbsd.org>2015-02-15 17:57:45 +0000
commit4082a2a86f5c0ab3d58aad7ac968c049407695ca (patch)
treecd49056a1735523fa7c9824981b5675496991fd1 /mdoc.7
parent7ce97d9a565bdb748de6db4d2e48ae32d727c511 (diff)
downloadmandoc-4082a2a86f5c0ab3d58aad7ac968c049407695ca.tar.gz
mandoc-4082a2a86f5c0ab3d58aad7ac968c049407695ca.tar.zst
mandoc-4082a2a86f5c0ab3d58aad7ac968c049407695ca.zip
Tweak the wording to avoid the possible misunderstanding that .In
could only be used in the SYNOPSIS section. It is fine anywhere. Issue noticed by bentley@.
Diffstat (limited to 'mdoc.7')
-rw-r--r--mdoc.715
1 files changed, 8 insertions, 7 deletions
diff --git a/mdoc.7 b/mdoc.7
index 89825205..df25d8cb 100644
--- a/mdoc.7
+++ b/mdoc.7
@@ -1,4 +1,4 @@
-.\" $Id: mdoc.7,v 1.250 2015/01/29 00:33:57 schwarze Exp $
+.\" $Id: mdoc.7,v 1.251 2015/02/15 17:57:45 schwarze Exp $
.\"
.\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
.\" Copyright (c) 2010, 2011, 2013 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.
.\"
-.Dd $Mdocdate: January 29 2015 $
+.Dd $Mdocdate: February 15 2015 $
.Dt MDOC 7
.Os
.Sh NAME
@@ -1758,17 +1758,18 @@ is preferred for displaying code; the
.Sx \&Ic
macro is used when referring to specific instructions.
.Ss \&In
-An
-.Dq include
-file.
+The name of an include file.
+This macro is most often used in section 2, 3, and 9 manual pages.
+.Pp
When invoked as the first macro on an input line in the
.Em SYNOPSIS
section, the argument is displayed in angle brackets
and preceded by
-.Dq #include ,
+.Qq #include ,
and a blank line is inserted in front if there is a preceding
function declaration.
-This is most often used in section 2, 3, and 9 manual pages.
+In other sections, it only encloses its argument in angle brackets
+and causes no line break.
.Pp
Examples:
.Dl \&.In sys/types.h