> Frank Lichtenheld <fr...@lichtenheld.com> hat am 09.12.2021 14:49 geschrieben: > > Arne Schwabe <a...@rfc2549.org> hat am 07.12.2021 18:02 geschrieben: > > diff --git a/doc/man-sections/link-options.rst > > b/doc/man-sections/link-options.rst > > index b1ae4e75a..f41c0c4f1 100644 > > --- a/doc/man-sections/link-options.rst > > +++ b/doc/man-sections/link-options.rst > > @@ -110,19 +110,25 @@ the local and the remote host. > > (:code:`p2p`). OpenVPN 2.0 introduces a new mode (:code:`server`) which > > implements a multi-client server capability. > > > > ---mssfix max > > +--mssfix max [mtu] > > If you want to denote optional paramters (which I think makes sense, but is > not > consistently done in the documentation so far), then I think it needs to be > --mssfix [max [mtu]]
It turns out that the reason we do not use [] in the option list is that it breaks the rst formatting. Option lists do not seem to have any support for formatting optional arguments (see https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#option-lists). I have verified that this visibly breaks the formatting, both for HTML and man page output. This seems to be the reason that many options use a generic "args" and then specify the actual syntax in the description block instead. Regards, Frank -- Frank Lichtenheld _______________________________________________ Openvpn-devel mailing list Openvpn-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/openvpn-devel
