notmuch/doc/man1/notmuch-show.rst, branch feature/git-remote

cli: add options --offset and --limit to notmuch show

2022-11-05T17:18:15Z

notmuch search does not output header values. However, when browsing through a large email corpus, it can be time saving to be able to paginate without running notmuch show for each message/thread. Add --offset and --limit options to notmuch show. This is inspired from commit 796b629c3b82 ("cli: add options --offset and --limit to notmuch search"). Update man page, shell completion and add a test case to ensure it works as expected. Cc: Tim Culverhouse Cc: Tomi Ollila Signed-off-by: Robin Jarry

CLI/show: initial support for --duplicate for (raw output only)

2022-07-30T11:39:13Z

Add command line argument --duplicate, analogous with that already supported for notmuch-search. Use of a seperate function for _get_filename is mainly a form of documentation at this point. md5sum is of course a weak hash, but it is good enough for this (non-adversarial) test suite use.

doc: define and use semantic markup for configuration items

2022-05-21T01:40:32Z

This makes sure each configuration item is cross referenceable without extra markup, and also adds index entries.

doc: document new option `show.extra_headers`

2022-01-25T11:51:48Z

Increase discoverability by cross referencing from the notmuch-show manual entry to the notmuch-config manual entry.

doc: remove explicit formatting of terms in definition lists

2021-10-25T11:25:22Z

Sphinx-doc already formats the terms appropriately for a given backend (bold in html and man). `makeinfo` complains noisily about formatting inside a @item if we add our own explicit formatting. This change may change the formatting in the info output. On the other hand, the existing use of quotes for bold is not that great anyway. In some places blank lines were removed to preserve the logical structure of a definition list.

doc: new notmuch show --sort and related emacs commands

2021-07-03T23:38:34Z

New --sort CLI option documented in notmuch-show's man page, and notmuch-search-toggle-order mentioned in doc/notmuch-emacs.rst and devel/emacs-keybindings.org (in the latter, there's also some whitespace changes in a table introduced by org-mode).

doc: use program and option directives to document options

2021-05-22T19:43:24Z

Use the program and option directives to document the subcommand options. This unifies a lot of option documentation throughout. This also makes it possible to reference options with :option:`--foo` (within .. program::) or :option:`subcommand --foo` (globally). This is left for later work. See https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#directive-program Note: There is a lot of indentation change, but intentionally there is no reflow. Using 'git diff -w' or 'git show -w' to ignore white space changes makes this a very easy change to review.

doc: cross-reference notmuch man pages with actual links

2021-05-22T19:38:56Z

Add internal hyperlink targets for man pages and cross-reference them using the any role reference. There are a number of alternatives to accomplish this, but this seems like the combination that retains the man page section number and the same boldface style in the man pages. As a bonus, we get sanity checking on the links; for example notmuch-search-terms.rst had a reference to notmuch-properties(1) i.e. the wrong section. The obvious semantic follow-up change would be to only have meaningful "see also" references instead of having them all everywhere.

doc: use manpage role references to external man pages

2021-05-22T12:56:52Z

Using manpage role references generates helpful links in html documentation, while retaining the same boldface style in the man pages. The external man page site is configurable. The Debian manpage site seems like a good fit for Notmuch.

doc: fix references to search.exclude_tags

2019-01-27T12:18:38Z

The documentation incorrectly referred to a configuration item "search.tag_exclude" in some places, instead of "search.exclude_tags".