unofficial mirror of notmuch@notmuchmail.org
 help / color / mirror / code / Atom feed
From: David Bremner <david@tethera.net>
To: Mark Walters <markwalters1009@gmail.com>, notmuch@notmuchmail.org
Subject: Re:
Date: Tue, 28 Jan 2014 22:26:56 -0400	[thread overview]
Message-ID: <87txcnjzf3.fsf@zancas.localnet> (raw)
In-Reply-To: <87fvo7btu8.fsf@qmul.ac.uk>

Mark Walters <markwalters1009@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

  reply	other threads:[~2014-01-29  2:27 UTC|newest]

Thread overview: 39+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2014-01-18 16:00 [RFC Patch] start of sphinx based docs David Bremner
2014-01-19 13:48 ` Tomi Ollila
2014-01-19 18:57   ` David Bremner
2014-01-28 16:12     ` David Bremner
2014-01-28 16:12       ` [RFC Patch v2 1/2] doc: start of sphinx based docs David Bremner
2014-01-28 16:12       ` [RFC Patch v2 2/2] doc: add target rst2man to build man pages using rst2man David Bremner
2014-01-28 22:54       ` Mark Walters
2014-01-29  2:26         ` David Bremner [this message]
2014-02-23  0:16         ` v3 of sphinx docs David Bremner
2014-02-23  0:16           ` [RFC Patch v3 1/3] doc: start of sphinx based docs David Bremner
2014-02-23  0:16           ` [RFC Patch v3 2/3] doc: add target rst2man to build man pages using rst2man David Bremner
2014-02-23 17:42             ` Tomi Ollila
2014-02-23 23:57               ` David Bremner
2014-02-23  0:16           ` [RFC Patch v3 3/3] doc: fix for conversion errors David Bremner
2014-02-24  0:54           ` v3 of sphinx docs Mark Walters
  -- strict thread matches above, loose matches on Subject: below --
2018-02-01 20:53 Matthew Lear
2018-02-03 22:38 ` Jani Nikula
2017-06-11 11:00 [PATCH] Add Emacs' imenu support in notmuch-show and notmuch-search David Bremner
2017-06-12 13:30 ` Damien Cassou
2017-06-14  1:22   ` David Bremner
2017-06-14  9:44     ` Re: David Bremner
2017-06-14  9:54       ` Re: Damien Cassou
2017-05-23 18:54 Tomi Ollila
2017-05-26 10:40 ` David Bremner
2016-10-15  8:44 Re: Matthew Lear
2016-10-13 19:37 Matt Armstrong
2016-10-13 19:42 ` Matt Armstrong
2016-10-11 21:24 matt
2016-10-12  7:51 ` Mark Walters
2016-10-15  7:09   ` Re: Mark Walters
2016-10-17 12:01 ` Re: David Bremner
2015-01-25 17:58 [PATCH 1/3] doc: add details about Xapian search syntax David Bremner
2015-02-23 20:05 ` David Bremner
2015-02-24  7:32   ` David Bremner
2014-10-03 21:18 David Bremner
2014-10-03 21:22 ` David Bremner
2014-10-16 21:14 ` Re: Jani Nikula
2014-05-06 13:06 David Bremner
2014-05-06 18:14 ` Jameson Graef Rollins
2014-05-06 18:26 ` Re: Tomi Ollila
2014-03-11 18:16 v2 man page build fixups Tomi Ollila
2014-03-13  3:21 ` David Bremner
2014-03-17 10:55   ` Tomi Ollila
2014-03-18 10:52   ` Re: David Bremner
2013-02-25 20:44 Martin Owens
2013-02-25 21:02 ` David Bremner
2013-01-16 12:44 david
2013-01-17 10:36 ` David Bremner
2012-12-11  9:00 Damien Cassou
2012-12-13 11:45 ` Mark Walters
2012-02-01  2:49 emacs: quote MML tags in replies Dmitry Kurochkin
2012-02-02  4:01 ` David Bremner
2012-02-03 10:22   ` Pieter Praet
2012-01-23  8:33 show-mode message/thread archiving improvements Jameson Graef Rollins
2012-01-25  0:06 ` Jameson Graef Rollins
2012-01-31  3:28   ` David Bremner
2011-10-09 16:01 output file argument to notmuch dump David Bremner
2011-10-10 13:49 ` david
2011-10-16 20:34   ` Thomas Schwinge
2011-10-16 23:25     ` Re: David Bremner

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://notmuchmail.org/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=87txcnjzf3.fsf@zancas.localnet \
    --to=david@tethera.net \
    --cc=markwalters1009@gmail.com \
    --cc=notmuch@notmuchmail.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://yhetil.org/notmuch.git/

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).