Subject: misc/5562: mdoc(7) .Xr macro should require two arguments
To: None <gnats-bugs@gnats.netbsd.org>
From: Erik E. Fair <fair@cuckoo.clock.org>
List: netbsd-bugs
Date: 06/09/1998 18:39:49
>Number: 5562
>Category: misc
>Synopsis: mdoc(7) .Xr macro should require two arguments
>Confidential: no
>Severity: serious
>Priority: medium
>Responsible: misc-bug-people (Misc Bug People)
>State: open
>Class: change-request
>Submitter-Id: net
>Arrival-Date: Tue Jun 9 18:50:00 1998
>Last-Modified:
>Originator: Erik E. Fair
>Organization:
International Organization of Internet Clock Watchers
>Release: NetBSD-current 19980608
>Environment:
System: NetBSD cuckoo.clock.org 1.3E NetBSD 1.3E (SHARK) #0: Fri May 22 15:46:25 EDT 1998 root@nc1.home.duh.org:/usr/SRC/netbsd/src/sys/arch/arm32/compile/SHARK arm32
>Description:
The mdoc(7) .Xr macro is for establishing references within
the document text to other related manual pages, much as
an HTML anchor is used to make a link on the WWW. Unfortunately,
the .Xr macro as specified does not require all the
information in its arguments to make an unambiguous reference.
For programs that attempt to convert macro source to HTML
(or any other similar format), the .Xr macro is a boon;
but it should be changed to require both the manual page
name, and the section number, so that it is possible to
distinguish between references to (for example), man(1)
and man(7); apm(4) and apm(8); crontab(1) and crontab(5), etc.
>How-To-Repeat:
cd /usr/share/misc/tmac
examine the mdoc(7) definition of .Xr
>Fix:
>Audit-Trail:
>Unformatted: