aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/mdoc.7
diff options
context:
space:
mode:
authorKristaps Dzonsons <kristaps@bsd.lv>2010-06-04 22:16:27 +0000
committerKristaps Dzonsons <kristaps@bsd.lv>2010-06-04 22:16:27 +0000
commit7f67988eac2d1c3957c780d882706906cbb3b441 (patch)
treeb4526ffa0e17b6ebc86b96b943b82f6375387e0a /mdoc.7
parent67a51824265c8e0d0f41e8cacb1714e5671c7053 (diff)
downloadmandoc-7f67988eac2d1c3957c780d882706906cbb3b441.tar.gz
mandoc-7f67988eac2d1c3957c780d882706906cbb3b441.tar.zst
mandoc-7f67988eac2d1c3957c780d882706906cbb3b441.zip
Fixed `Fn' newline behaviour and added some regression tests to this
extent. Documented `Fn'. Please note the COMPATIBILITY note regarding historic groff.
Diffstat (limited to 'mdoc.7')
-rw-r--r--mdoc.735
1 files changed, 34 insertions, 1 deletions
diff --git a/mdoc.7 b/mdoc.7
index 11d947ff..439383c3 100644
--- a/mdoc.7
+++ b/mdoc.7
@@ -1,4 +1,4 @@
-.\" $Id: mdoc.7,v 1.118 2010/06/04 21:49:39 kristaps Exp $
+.\" $Id: mdoc.7,v 1.119 2010/06/04 22:16:27 kristaps Exp $
.\"
.\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@bsd.lv>
.\"
@@ -1656,6 +1656,33 @@ Examples:
See also
.Sx \&Cm .
.Ss \&Fn
+A function name.
+Its calling syntax is as follows:
+.Bd -ragged -offset indent
+.Pf \. Ns Sx \&Fn
+.Op Cm functype
+.Cm funcname
+.Op Oo Cm argtype Oc Cm argname
+.Ed
+If invoked in the
+.Em SYNOPSIS
+section, vertical space is asserted before and after the macro.
+In all cases, the function arguments are surrounded in parenthesis and
+are delimited by commas.
+If no arguments are specified, blank parenthesis are output.
+.Pp
+Examples:
+.D1 \&.Fn "int funcname" "int arg0" "int arg1"
+.D1 \&.Fn funcname
+.D1 \&.Fn funcname "int arg0"
+.D1 \&.Fn funcname arg0
+.Pp
+See also
+.Sx \&Fa ,
+.Sx \&Fo ,
+.Sx \&Fc ,
+and
+.Sx \&Ft .
.Ss \&Fo
.Ss \&Fr
.Ss \&Ft
@@ -2048,6 +2075,12 @@ Heirloom troff, the other significant troff implementation accepting
.Pp
.Bl -dash -compact
.It
+Historic groff does not break before an
+.Sx \&Fn
+when not invoked as the line macro in the
+.Em SYNOPSIS
+section.
+.It
Historic groff formats the
.Sx \&In
badly: trailing arguments are trashed and