summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorIngo Schwarze <schwarze@cvs.openbsd.org>2012-08-29 23:38:42 +0000
committerIngo Schwarze <schwarze@cvs.openbsd.org>2012-08-29 23:38:42 +0000
commit7c2016e04b7360510ca31791e9cb94a974dc12dc (patch)
treea3ea98b9189512ee311017555066389f3c6d7084
parent7493eeb58e78138fb71a17ae74e69b32d25fb7cd (diff)
1) Remove documentation of the groff-1.15 compatibility quirk
of suppressing spacing before a third .Xr argument because that quirk was removed in mdoc_macro.c rev. 1.72. 2) Mark the "section" argument to .Xr as (syntactically) optional, but still do not encourage omitting it. The missing .Op was reported by espie@. Wording tweaked by and ok jmc@, ok millert@.
-rw-r--r--share/man/man7/mdoc.718
1 files changed, 6 insertions, 12 deletions
diff --git a/share/man/man7/mdoc.7 b/share/man/man7/mdoc.7
index d48a66ac5b8..4b78aa6070a 100644
--- a/share/man/man7/mdoc.7
+++ b/share/man/man7/mdoc.7
@@ -1,4 +1,4 @@
-.\" $OpenBSD: mdoc.7,v 1.93 2012/06/20 22:00:23 jmc Exp $
+.\" $OpenBSD: mdoc.7,v 1.94 2012/08/29 23:38:41 schwarze Exp $
.\"
.\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
.\" Copyright (c) 2010, 2011 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: June 20 2012 $
+.Dd $Mdocdate: August 29 2012 $
.Dt MDOC 7
.Os
.Sh NAME
@@ -2550,20 +2550,14 @@ Link to another manual
.Pq Qq cross-reference .
Its syntax is as follows:
.Pp
-.D1 Pf \. Sx \&Xr Ar name section
+.D1 Pf \. Sx \&Xr Ar name Op section
.Pp
-The
+Cross reference the
.Ar name
and
.Ar section
-are the name and section of the linked manual.
-If
-.Ar section
-is followed by non-punctuation, an
-.Sx \&Ns
-is inserted into the token stream.
-This behaviour is for compatibility with
-GNU troff.
+number of another man page;
+omitting the section number is rarely useful.
.Pp
Examples:
.Dl \&.Xr mandoc 1