On Mon, Aug 22, 2011 at 10:16, Karel Zak <kzak@xxxxxxxxxx> wrote: >> IMHO the following looks quite ok, and not too different to >> usage(). >> >> .TP >> \fB\-n\fR, \fB\-\-no\-argument\fR >> This option does not use argument. >> .TP >> \fB\-o\fR, \fB\-\-optional\fR[=<\fIarg\fR>] >> This option uses optional argument. >> .TP >> \fB\-r\fR, \fB\-\-required\fR <\fIarg\fR> >> This option requires an argument. > > I have no strong opinion about it. Benno is probably right that > italics for the arguments is enough. > > We already use option arguments without diamond brackets in our man > pages, so let's continue with this convention to minimize number of > changes in the man pages ;-) The howto-man-page.txt now has arguments underlined without diamond brackets. Optional argument has square brackets surrounding it. Is the patch set ready now? Have a look, and in absence of comments merge might be reasonable thing to do after few days. https://github.com/kerolasa/lelux-utiliteetit/tree/docs-dir/Documentation -- Sami Kerola http://www.iki.fi/kerolasa/ -- To unsubscribe from this list: send the line "unsubscribe util-linux" in the body of a message to majordomo@xxxxxxxxxxxxxxx More majordomo info at http://vger.kernel.org/majordomo-info.html
