[Date Prev][Date Next] [Chronological] [Thread] [Top]

Re: (ITS#6107) Manual pages do not mention -e option

rein@OpenLDAP.org wrote:
> Full_Name: Rein Tollevik
> Version: 2.4.16
> OS: Irrelevant
> URL: 
> Submission from: (NULL) (
> Submitted by: rein
> The manual pages for (at least) ldapmodify, ldapmodrdn and ldapdelete do not
> mention the "-e control" option, nor is the private "-E" documented for
> ldapmodify.
> A lot of the options accepted by the ldap* tools are common to them all.  Should
> they be documented in a separate man page referred to by the tools manuals, or
> at least included from a common source?

I favor documenting everything in each man page, to limit the amount of 
redirection (when reading man pages, one wants to quickly find an answer 
to a specific problem, not learn everything about LDAP :). 
Documentation should be concise enough to minimally impact the amount 
one needs to read to learn how to *use* those controls.  To learn about 
the purpose and the details of those controls, references should be 
used.  My 2c.