David Bremner
david at tethera.net
Tue Jan 28 18:26:56 PST 2014
Mark Walters <markwalters1009 at gmail.com> writes:
>
> The particular thing is the indentation for options (eg options in the
> notmuch.1 page) In the original pages it looks like
>
> OPTIONS
> Supported global options for notmuch include
>
> --help
>
> Print a synopsis of available commands and exit.
>
> and in the new ones
>
> OPTIONS
> Supported global options for notmuch include
>
> --help
>
> Print a synopsis of available commands and exit.
>
> I find this makes it more difficult to scan the man page quickly.
This rst is mainly autogenerated, and hence a bit ugly.
This particular example doesn't seem too hard to fix; try replacing the
relevant bit of notmuch.rst with
Supported global options for \ **notmuch**\ include
\ --help
Print a synopsis of available commands and exit.
\ --version
Print the installed version of notmuch, and exit.
\ --config=FILE
Specify the configuration file to use. This overrides any
configuration file specified by ${NOTMUCH_CONFIG}.
or
Supported global options for \ **notmuch**\ include
--help Print a synopsis of available commands and exit.
--version Print the installed version of notmuch, and exit.
--config=FILE Specify the configuration file to use. This overrides any
configuration file specified by ${NOTMUCH_CONFIG}.
--help Print a synopsis of available commands and exit.
The latter is an "option list" [1], so I guess is the most official way
to do it.
The former is a more generic "definition list"
[1]
http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#option-lists
More information about the notmuch
mailing list