Subject: Re: bin/12390: crypto docs (openssl, ...) do not exist
To: None <itojun@iijlab.net>
From: Jim Bernard <jbernard@mines.edu>
List: netbsd-bugs
Date: 03/12/2001 21:42:47
On Tue, Mar 13, 2001 at 12:43:49PM +0900, itojun@iijlab.net wrote:
> 
> >> >Description:
> >> 	There's no obvious documentation to the crypto related functions
> >> 	new in NetBSD 1.5.
> >> >How-To-Repeat:
> >>       man -k openssl
> >>       man -k ssl
> >>       man -k crypto
> >>       man -k rsa
> >>       man -k rijndael
> >>       man -k aes 	<- state of the art encryption in netbsd?
> >>       man -k encrypt
> >> 	Funny enough, this still works:
> >>       man openssl
> >  Curiously, locate succeeds in finding quite a bit of documentation
> >for openssl.  So it seems there's also a problem with 'man -k'.  Here's
> >the installed subset of docs that "locate openssl" found for me:
> 
> 	normal installation of openssl manpages occupy too many generic names
> 	like "des" or "rsa", and conflicts with lots of existing components.
> 
> 	so i configured Makefiles to install those like below:
> 
> >/usr/share/man/cat1/openssl_asn1parse.0
> >/usr/share/man/cat1/openssl_ca.0
> 
> 	if you have better suggestions please let me know.

  No, that seems like the best approach to avoiding the conflicts.

  The interesting problem right now is that makewhatis isn't indexing any of
the man pages in the .../src/lib/libcrypto/man directory.  It looks to me
like the reason is that those pages have the NAME section header in a
format that parsecatpage (in makewhatis) doesn't recognize---there are
twice as many overstrikes as usual.  For example, the file man.0 has its
name section printed as:

  N^HNA^HAM^HME^HE

whereas in openssl.0 it is:

  N^HN^HN^HNA^HA^HA^HAM^HM^HM^HME^HE^HE^HE

And parsecatpage looks for:

  N\10NA\10AM\10ME\10E

which matches the form in man.0, but not that in openssl.0.

  I've added tron to the cc list---maybe he'll want to modify makewhatis.

--Jim