On 04/09/2020 15:21, tincanteksup wrote:
> Hi,
> 
> this is just something to chew-over..
> 
> See:
> https://github.com/OpenVPN/openvpn/blob/master/doc/man-sections/generic-options.rst
> 
> 
> I noticed that generally the option names, eg: --auth-nocache, wrap and the
> result is unpleasant.
> 
> However, further down that same page --daemon progname does not wrap and looks
> much nicer.
> 
> I know which format I prefer, perhaps this can be changed..

Do you mean the wrapping in the HTML rendering on GitHub?  That can only be
changed by changing the number of characters in the option.  It's not
something we control, it's the GitHub .rst rendering.

$ echo -n "--daemon progname" | wc -c
17
$ echo -n "--auth-nocache" | wc -c
14

IIRC, the limit is more than 16 characters, and the option gets a cell on a
single line.

Now, if you find a setting we can tweak (even a .. notation in the .rst files)
where we can reduce this limit to 2 character (which means all options gets
its own line - which will be consistent all over), I'm open to consider that.
 I haven't had time to dig into it.

But I agree, the wrapping is not nice at all.  That said, we have had more
focus on ensuring the man/*roff rendering looks nice and reasonable more than
the HTML rendering on GitHub - in addition files which are more easy to edit
in a text editor.  After all, the HTML rendering was just a bonus over the .8
rendering [1] on GitHub before the .rst conversion.

[1] <https://github.com/OpenVPN/openvpn/blob/release/2.4/doc/openvpn.8>


-- 
kind regards,

David Sommerseth
OpenVPN Inc


Attachment: signature.asc
Description: OpenPGP digital signature

_______________________________________________
Openvpn-devel mailing list
Openvpn-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/openvpn-devel

Reply via email to