Re: have "notmuch help" call man?

Subject: Re: have "notmuch help" call man?

Date: Sat, 17 Dec 2011 11:56:57 +0200

To: David Bremner, Notmuch Mail


From: Tomi Ollila

On Fri, 16 Dec 2011 12:01:42 -0400, David Bremner <> wrote:
> Hi All;
> Currently help strings are compiled into the notmuch binary. This is a
> bit a of pain, since we have the same help text in two places.
> What do you think about having "notmuch help foo" invoke "man
> notmuch-foo" and create appropriate man pages (or links).


> There are other ways around the maintenance dilemma, including
> generating man pages and online help from some common source (e.g. in
> the style of id:"").

In that case we dilemma is what would be the most suitable source format
(pod, mdwn, rst, nroff, ...)...

> For downsides, it might complicate things slightly for people who
> install notmuch in "odd" places. On the other hand, it is no worse than
> setting LD_LIBRARY_PATH. Also, there is the question of common text like
> search-terms, which could be included in every page, or maybe contained
> in man notmuch.

Those people who install notmuch in "odd" places (I'm one of those) can
also define MANPATH...

Nroff provides the .so "request" which includes other nroff source.

for example /usr/share/man/man1/zshall.1.gz includes all other zsh
namual pages.

... however it is common to have SEE ALSO at the end of each manual page

    notmuch(1), notmuch-search-terms(7)

> David