Date: Fri, 25 Apr 2003 23:24:27 +0300 From: Ruslan Ermilov <ru@freebsd.org> To: "Gary W. Swearingen" <swear@attbi.com> Cc: freebsd-doc@freebsd.org Subject: Re: .Xr references to ports in man pages Message-ID: <20030425202427.GC28920@sunbay.com> In-Reply-To: <ien0ie9z21.0ie@localhost.localdomain> References: <20030424233703.GB48527@nitro.dk> <ien0ie9z21.0ie@localhost.localdomain>
next in thread | previous in thread | raw e-mail | index | archive | help
--kfjH4zxOES6UT95V Content-Type: text/plain; charset=us-ascii Content-Disposition: inline Content-Transfer-Encoding: quoted-printable On Fri, Apr 25, 2003 at 12:06:46PM -0700, Gary W. Swearingen wrote: > "Simon L. Nielsen" <simon@nitro.dk> writes: >=20 > > Hope somebody has an opinion about this. >=20 > I can't think of a better way to render the information, but I have a > suggestion regarding the ease of manpage source maintenance. >=20 > Unless port names require their category name to be unique (and they > don't, AFAIK), then the inclusion of the port category within the man > pages introduces an unnecessary need to search man pages and make > corrections whenever port categorization is changed, as happens > occasionally. >=20 Throughout the SGML documentation, they are referred as <filename role=3D"package">CATEGORY/PORTNAME</filename> Why the manpages should be different? > Two "solutions" are obvious: 1) Omit the category altogether and expect > users to know how to use the "whereis" command. 2) Make the macro smart > enough to figure out the category name from the port name. This would > still require maintenance, but would localize it to one file. >=20 > I think that all users should know how to use "whereis" and requiring > them to use it is not unreasonable. The rendering would need to be > changed to something like: smb.conf(5) [port "samba"] Cheers, --=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 --kfjH4zxOES6UT95V Content-Type: application/pgp-signature Content-Disposition: inline -----BEGIN PGP SIGNATURE----- Version: GnuPG v1.2.1 (FreeBSD) iD8DBQE+qZl7Ukv4P6juNwoRAo6JAJ4mbTqTtiJ6XOQJF7ZhBGcaneWG6gCcDb4h 2p2dy+NpPeO9KSRI/mW8Gm0= =wW3H -----END PGP SIGNATURE----- --kfjH4zxOES6UT95V--
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20030425202427.GC28920>