From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from smtp-1.sys.kth.se (smtp-1.sys.kth.se [130.237.32.175]) by krisdoz.my.domain (8.14.3/8.14.3) with ESMTP id pAM8wtIu009279 for ; Tue, 22 Nov 2011 03:58:56 -0500 (EST) Received: from mailscan-1.sys.kth.se (mailscan-1.sys.kth.se [130.237.32.91]) by smtp-1.sys.kth.se (Postfix) with ESMTP id A6099156371 for ; Tue, 22 Nov 2011 09:58:49 +0100 (CET) X-Virus-Scanned: by amavisd-new at kth.se Received: from smtp-1.sys.kth.se ([130.237.32.175]) by mailscan-1.sys.kth.se (mailscan-1.sys.kth.se [130.237.32.91]) (amavisd-new, port 10024) with LMTP id 87D+DWG6j74u for ; Tue, 22 Nov 2011 09:58:48 +0100 (CET) X-KTH-Auth: kristaps [193.10.49.5] X-KTH-mail-from: kristaps@bsd.lv X-KTH-rcpt-to: tech@mdocml.bsd.lv Received: from ctime.hhs.se (ctime.hhs.se [193.10.49.5]) by smtp-1.sys.kth.se (Postfix) with ESMTP id 5AD561558A9 for ; Tue, 22 Nov 2011 09:58:46 +0100 (CET) Message-ID: <4ECB6446.4090201@bsd.lv> Date: Tue, 22 Nov 2011 09:58:46 +0100 From: Kristaps Dzonsons User-Agent: Mozilla/5.0 (X11; U; OpenBSD amd64; en-US; rv:1.9.2.13) Gecko/20110223 Thunderbird/3.1.7 X-Mailinglist: mdocml-tech Reply-To: tech@mdocml.bsd.lv MIME-Version: 1.0 To: tech@mdocml.bsd.lv Subject: Re: Showing all possible apropls keys. References: <4ECA86C8.1030100@bsd.lv> <20111121223702.GA22285@iris.usta.de> In-Reply-To: <20111121223702.GA22285@iris.usta.de> Content-Type: text/plain; charset=ISO-8859-1; format=flowed Content-Transfer-Encoding: 7bit >> Enclosed is a patch to show all possible apropos keys with apropos >> -k. I chose "-k" more or less arbitrarily. >> >> Thoughts? > > I think that shouldn't go in. > This information doesn't belong into the program, but into the manual. > > Usage() as a reaction to an unsupported option is ok, but any > additional user documentation in a program is seriously misplaced. > Well, maybe with the exception of programs intended for use in an > environment where man(1) is not available, like fdisk(8) in an > installation ramdisk. Ingo, I'm also more comfortable with this being in the manual -- the patch came about in my hesitation on just how to encode the information in a meaningful way, where there's bound to be many possibilities that might overwhelm the user for such a simple utility. My initial thought, however, was just to cut out parts of your macro synopsis documentation for a two-column display, e.g., Accepted keywords are as follows: Nd description of manual page Nm name of manual page Fn a function name ... Better? Kristaps -- To unsubscribe send an email to tech+unsubscribe@mdocml.bsd.lv