From owner-freebsd-doc@FreeBSD.ORG Fri Apr 25 12:06:46 2003 Return-Path: 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 7F6C237B401; Fri, 25 Apr 2003 12:06:46 -0700 (PDT) Received: from sccrmhc02.attbi.com (sccrmhc02.attbi.com [204.127.202.62]) by mx1.FreeBSD.org (Postfix) with ESMTP id A119243FBF; Fri, 25 Apr 2003 12:06:45 -0700 (PDT) (envelope-from swear@attbi.com) Received: from localhost.localdomain (unknown[12.242.158.67]) by sccrmhc02.attbi.com (sccrmhc02) with ESMTP id <2003042519064400200o01m5e>; Fri, 25 Apr 2003 19:06:44 +0000 Received: from localhost.localdomain (localhost [127.0.0.1]) by localhost.localdomain (8.12.6/8.12.5) with ESMTP id h3PJ6wsg050296; Fri, 25 Apr 2003 12:06:58 -0700 (PDT) (envelope-from swear@attbi.com) Received: (from jojo@localhost) by localhost.localdomain (8.12.6/8.12.5/Submit) id h3PJ6l3Q050291; Fri, 25 Apr 2003 12:06:47 -0700 (PDT) (envelope-from swear@attbi.com) X-Authentication-Warning: localhost.localdomain: jojo set sender to swear@attbi.com using -f To: "Simon L. Nielsen" References: <20030424233703.GB48527@nitro.dk> From: swear@attbi.com (Gary W. Swearingen) Date: 25 Apr 2003 12:06:46 -0700 In-Reply-To: <20030424233703.GB48527@nitro.dk> Message-ID: Lines: 21 User-Agent: Gnus/5.0808 (Gnus v5.8.8) XEmacs/21.1 (Cuyahoga Valley) MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii cc: freebsd-doc@freebsd.org cc: Ruslan Ermilov Subject: Re: .Xr references to ports in man pages X-BeenThere: freebsd-doc@freebsd.org X-Mailman-Version: 2.1.1 Precedence: list List-Id: Documentation project List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Fri, 25 Apr 2003 19:06:46 -0000 "Simon L. Nielsen" writes: > Hope somebody has an opinion about this. I can't think of a better way to render the information, but I have a suggestion regarding the ease of manpage source maintenance. 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. 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. 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"]