summaryrefslogtreecommitdiffstats
path: root/mdoc.7
diff options
context:
space:
mode:
authorKristaps Dzonsons <kristaps@bsd.lv>2010-02-17 19:22:50 +0000
committerKristaps Dzonsons <kristaps@bsd.lv>2010-02-17 19:22:50 +0000
commit8b651017045b6d0c838fc6c177ca83e694c6196a (patch)
tree7360af8e03768f0f33a8ba11a85c8203f893c452 /mdoc.7
parent6c906cf066e8132d41552d3884d7580bf123d792 (diff)
downloadmandoc-8b651017045b6d0c838fc6c177ca83e694c6196a.tar.gz
Macro documentation for `Xr'.
Re-added macros following `Vt' (lost somehow?). Removed `Xr' <3 stipulations.
Diffstat (limited to 'mdoc.7')
-rw-r--r--mdoc.733
1 files changed, 32 insertions, 1 deletions
diff --git a/mdoc.7 b/mdoc.7
index b789ddf4..1e93bc8d 100644
--- a/mdoc.7
+++ b/mdoc.7
@@ -872,7 +872,7 @@ then the macro accepts an arbitrary number of arguments.
.It Sx \&Ux Ta Yes Ta Yes Ta n
.It Sx \&Va Ta Yes Ta Yes Ta n
.It Sx \&Vt Ta Yes Ta Yes Ta >0
-.It Sx \&Xr Ta Yes Ta Yes Ta >0, <3
+.It Sx \&Xr Ta Yes Ta Yes Ta >0
.It Sx \&br Ta \&No Ta \&No Ta 0
.It Sx \&sp Ta \&No Ta \&No Ta 1
.El
@@ -1925,6 +1925,37 @@ See also
and
.Sx \&Va .
.
+.Ss \&Xc
+.Ss \&Xo
+.Ss \&Xr
+Link to another manual
+.Pq Qq cross-reference .
+Its calling syntax is
+.Pp
+.D1 \. Ns Sx \&Xr Cm name section
+.Pp
+The
+.Cm name
+and
+.Cm section
+are the name and section of the linked manual. If
+.Cm section
+is followed by non-punctuation, an
+.Sx \&Ns
+is inserted into the token stream. This behaviour is for compatibility
+with
+.Xr groff 1 .
+.Pp
+Examples:
+.Bd -literal -offset indent
+\&.Xr mandoc 1
+\&.Xr mandoc 1 ;
+\&.Xr mandoc 1 s behaviour
+.Ed
+.
+.Ss \&br
+.Ss \&sp
+.
.
.Sh COMPATIBILITY
This section documents compatibility with other roff implementations, at