Date: Fri, 25 Apr 2003 09:30:14 +0300 From: Ruslan Ermilov <ru@freebsd.org> To: "Simon L. Nielsen" <simon@nitro.dk> Cc: freebsd-doc@freebsd.org Subject: Re: .Xr references to ports in man pages Message-ID: <20030425063014.GG32731@sunbay.com> In-Reply-To: <20030424233703.GB48527@nitro.dk> References: <20030424233703.GB48527@nitro.dk>
next in thread | previous in thread | raw e-mail | index | archive | help
--I3tAPq1Rm2pUxvsp Content-Type: text/plain; charset=us-ascii Content-Disposition: inline Content-Transfer-Encoding: quoted-printable Just a clarification. Simon contacted me privately with this issue, and I asked him to re-open this discussion here. In particular, I'm interested in others' opinions on how this should be rendered. [Please don't drop me from the Cc: line, as I'm not subscribed to this mailing list.] On Fri, Apr 25, 2003 at 01:37:04AM +0200, Simon L. Nielsen wrote: > Hello >=20 > I have been looking at fixing bad man references (.Xr) in the FreeBSD man > pages. >=20 > Several system man pages references man pages from ports which of course > might not be available. This was also brought up in Oct 2001 by Murray > Stokely where Ruslan Ermilov made a patch to support this in the > standard .Xr macro. The patch extends .Xr to handled port references > like this : >=20 > .Xr smb.conf 5 net samba >=20 > which would be rendered as >=20 > .Xr smb.conf 5 > .Bq Pa ports/net/samba >=20 > and look like (except that the path is underlined) >=20 > smb.conf(5) [ports/net/samba] >=20 > What do people think about handling it like this? >=20 > It could perhaps be rendered diffently but I personally think that the > way it is handled in the current patch is fine. Mainly because I think > it is rather clear what is meant and it doesn't "conflict" with other > "rendering" that I have seen. >=20 > I would be happy to go through the system man pages and add the > apropriate references (I already have a perl script for detecting bad > references). >=20 > The mail from Ruslan with the patch can be found at > http://www.freebsd.org/cgi/mid.cgi?id=3D20011008191058.B13684@sunbay.com . >=20 > I have extracted the patch if anyone wants to try it (it works at least > againt a recent CURRENT) : > http://simon.nitro.dk/freebsd/files/misc/ru-mdoc-ports.patch . >=20 > Hope somebody has an opinion about this. --=20 Ruslan Ermilov Sysadmin and DBA, ru@sunbay.com Sunbay Software AG, ru@FreeBSD.org FreeBSD committer, +380.652.512.251 Simferopol, Ukraine http://www.FreeBSD.org The Power To Serve http://www.oracle.com Enabling The Information Age --I3tAPq1Rm2pUxvsp Content-Type: application/pgp-signature Content-Disposition: inline -----BEGIN PGP SIGNATURE----- Version: GnuPG v1.2.1 (FreeBSD) iD8DBQE+qNX1Ukv4P6juNwoRAiBPAJ9/EQr08gOdR1VOhImhfxAWyyq9SACfZAC+ 3wMj7VOBddG0SdPTx7pUfe4= =115e -----END PGP SIGNATURE----- --I3tAPq1Rm2pUxvsp--
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20030425063014.GG32731>