From owner-freebsd-doc Tue Aug 27 11:40:19 2002 Delivered-To: freebsd-doc@freebsd.org Received: from mx1.FreeBSD.org (mx1.FreeBSD.org [216.136.204.125]) by hub.freebsd.org (Postfix) with ESMTP id B996637B400; Tue, 27 Aug 2002 11:40:12 -0700 (PDT) Received: from abigail.blackend.org (blackend.org [212.11.50.35]) by mx1.FreeBSD.org (Postfix) with ESMTP id 973BC43E3B; Tue, 27 Aug 2002 11:40:10 -0700 (PDT) (envelope-from marc@blackend.org) Received: from abigail.blackend.org (localhost [127.0.0.1]) by abigail.blackend.org (8.12.3/8.12.3/ - 15/04/02) with ESMTP id g7RIbNke042096; Tue, 27 Aug 2002 20:37:23 +0200 (CEST) (envelope-from marc@abigail.blackend.org) Received: (from marc@localhost) by abigail.blackend.org (8.12.3/8.12.3/Submit) id g7RIbN1f042095; Tue, 27 Aug 2002 20:37:23 +0200 (CEST) (envelope-from marc) Date: Tue, 27 Aug 2002 20:37:23 +0200 From: Marc Fonvieille To: Nik Clayton Cc: freebsd-doc@FreeBSD.org Subject: Re: [HEAD UP] Support for manpath in the links to manual pages Message-ID: <20020827203722.A41285@abigail.blackend.org> References: <20020827164338.B39381@abigail.blackend.org> <20020827175059.GB66096@clan.nothing-going-on.org> Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline User-Agent: Mutt/1.2.5.1i In-Reply-To: <20020827175059.GB66096@clan.nothing-going-on.org>; from nik@FreeBSD.org on Tue, Aug 27, 2002 at 06:50:59PM +0100 X-Useless-Header: blackend.org X-Operating-System: FreeBSD 4.6-PRERELEASE Content-Transfer-Encoding: 8bit X-MIME-Autoconverted: from quoted-printable to 8bit by abigail.blackend.org id g7RIbNke042096 Sender: owner-freebsd-doc@FreeBSD.ORG Precedence: bulk List-ID: List-Archive: (Web Archive) List-Help: (List Instructions) List-Subscribe: List-Unsubscribe: X-Loop: FreeBSD.org On Tue, Aug 27, 2002 at 06:50:59PM +0100, Nik Clayton wrote: > On Tue, Aug 27, 2002 at 04:43:38PM +0200, Marc Fonvieille wrote: > > > > > > > > in man-refs.ent for a FreeBSD ports manual page. > > I will change soon man-refs.ent to point on the correct manual pages. > > Note that in the docs the entities remain similar to &man.xdm.1; > > I'm not sure they should. Apart from anything else, we'll probably get > to a situation at some point where we have a binary in FreeBSD, and a > binary that's installed from the ports tree that has the same name. Or > binaries from different BSD's that we want to be able to distinguish > between. > > [ Also, we might want to refer to different versions of the same FreeBSD > man page -- for example, fsck(8) for 4.x vs fsck(8) for 5.x. . . . ] > > Without giving it a huge amount of thought, I suspect that something > like > > &man.xfree86.xdm.1; > &man.netbsd.ls.1; Yes, it will be the easiest solution and the transition will be simple. We just have to keep old entities in man-refs.ent till all docs are fixed. Maybe this can be already done for XFree86 related manual pages. > > is going to make more sense in the long run. We might want to include > version numbers in that as well. The entity might then expand to > something like > > > xdm > 1 > (XFree86) > > so that the generated HTML is going to look something like > > xdm(1) (XFree86) > > to make it clear to the reader that this is not in the base system. > Indeed, for the moment a newcomer to FreeBSD can't guess what is from the base system and what is from a third party software. Maybe we could use some different colors for the manual pages links, but it'd be useless for printing version or text browsers. Marc To Unsubscribe: send mail to majordomo@FreeBSD.org with "unsubscribe freebsd-doc" in the body of the message