<div dir="ltr">Rich,<div><br></div><div>If no-one else tells you, keeping the docs up to date is amazing work and thank you for it.</div><div><br></div><div>My general thought is that all docs should be consistent with one another for ease of cross referncing and skimming and the manpages should follow the same layout.</div><div><br></div><div>Cheers,</div><div><br></div><div>Ethan</div></div><br><div class="gmail_quote"><div dir="ltr" class="gmail_attr">On Tue, Jan 28, 2020 at 11:21 AM Salz, Rich via openssl-users <<a href="mailto:openssl-users@openssl.org">openssl-users@openssl.org</a>> wrote:<br></div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">





<div lang="EN-US">
<div class="gmail-m_2823918120407409617WordSection1">
<p class="MsoNormal"><span style="font-size:11pt">The next release of OpenSSL splits the “help” for commands into sections, like this:<u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:11pt"><u></u> <u></u></span></p>
<p class="MsoNormal"><span style="font-size:11pt">; ./apps/openssl rehash --help<u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:11pt">Usage: rehash [options] [directory...]<u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:11pt"><u></u> <u></u></span></p>
<p class="MsoNormal"><span style="font-size:11pt">General options:<u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:11pt">-help        Display this summary<u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:11pt">-h           Display this summary<u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:11pt">-compat      Create both new- and old-style hash links<u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:11pt">-old         Use old-style hash to generate links<u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:11pt">-n           Do not remove existing links<u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:11pt"><u></u> <u></u></span></p>
<p class="MsoNormal"><span style="font-size:11pt">Output options:<u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:11pt">-v           Verbose output<u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:11pt"><u></u> <u></u></span></p>
<p class="MsoNormal"><span style="font-size:11pt">Parameters:<u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:11pt">directory    One or more directories to process (optional)<u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:11pt"><u></u> <u></u></span></p>
<p class="MsoNormal"><span style="font-size:11pt">Should the order of options in the manpages follow this layout?  Should there be a blank line (in the SYNOPSIS section!) between the option sections?  Please take a look at
<a href="https://github.com/openssl/openssl/pull/10885" target="_blank">https://github.com/openssl/openssl/pull/10885</a> which does this for s_client.  You can see just the changed file here:
<a href="https://github.com/openssl/openssl/blob/71d8c19554a65cf0717f6b7e7b34849456e76888/doc/man1/openssl-s_client.pod.in" target="_blank">
https://github.com/openssl/openssl/blob/71d8c19554a65cf0717f6b7e7b34849456e76888/doc/man1/openssl-s_client.pod.in</a><u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:11pt"><u></u> <u></u></span></p>
<p class="MsoNormal"><span style="font-size:11pt">Replies to me will be summarized for the list.  Thanks!<u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:11pt"><u></u> <u></u></span></p>
</div>
</div>

</blockquote></div>