Re: Showing all possible apropls keys.

[Kristaps Dzonsons <kristaps@bsd.lv>]

>> 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