From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from localhost (localhost [127.0.0.1]) by olra.theworths.org (Postfix) with ESMTP id 47878431FBF for ; Tue, 28 Jan 2014 18:27:08 -0800 (PST) X-Virus-Scanned: Debian amavisd-new at olra.theworths.org X-Spam-Flag: NO X-Spam-Score: 0 X-Spam-Level: X-Spam-Status: No, score=0 tagged_above=-999 required=5 tests=[none] autolearn=disabled Received: from olra.theworths.org ([127.0.0.1]) by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id c5AEh2esiUlL for ; Tue, 28 Jan 2014 18:27:03 -0800 (PST) Received: from yantan.tethera.net (yantan.tethera.net [199.188.72.155]) (using TLSv1 with cipher DHE-RSA-AES128-SHA (128/128 bits)) (No client certificate requested) by olra.theworths.org (Postfix) with ESMTPS id 8896A431FBD for ; Tue, 28 Jan 2014 18:27:03 -0800 (PST) Received: from remotemail by yantan.tethera.net with local (Exim 4.80) (envelope-from ) id 1W8Krk-000588-6t; Tue, 28 Jan 2014 22:27:00 -0400 Received: (nullmailer pid 32308 invoked by uid 1000); Wed, 29 Jan 2014 02:26:56 -0000 From: David Bremner To: Mark Walters , notmuch@notmuchmail.org Subject: Re: In-Reply-To: <87fvo7btu8.fsf@qmul.ac.uk> References: <87vbxfkdex.fsf@zancas.localnet> <1390925558-15873-1-git-send-email-david@tethera.net> <87fvo7btu8.fsf@qmul.ac.uk> User-Agent: Notmuch/0.17+53~g3e1d7f6 (http://notmuchmail.org) Emacs/24.3.1 (x86_64-pc-linux-gnu) Date: Tue, 28 Jan 2014 22:26:56 -0400 Message-ID: <87txcnjzf3.fsf@zancas.localnet> MIME-Version: 1.0 Content-Type: text/plain X-BeenThere: notmuch@notmuchmail.org X-Mailman-Version: 2.1.13 Precedence: list List-Id: "Use and development of the notmuch mail system." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Wed, 29 Jan 2014 02:27:08 -0000 Mark Walters 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