unofficial mirror of notmuch@notmuchmail.org
 help / color / mirror / code / Atom feed
From: David Bremner <bremner@unb.ca>
To: "Notmuch Mail" <notmuch@notmuchmail.org>
Subject: have "notmuch help" call man?
Date: Fri, 16 Dec 2011 12:01:42 -0400	[thread overview]
Message-ID: <87zkescxp5.fsf@zancas.localnet> (raw)


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:"1288804736-5173-3-git-send-email-david@tethera.net").

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.

David

             reply	other threads:[~2011-12-16 16:01 UTC|newest]

Thread overview: 15+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2011-12-16 16:01 David Bremner [this message]
2011-12-16 16:41 ` have "notmuch help" call man? Adam Wolfe Gordon
2011-12-16 18:17 ` Kazuo Teramoto
2011-12-16 21:35 ` Jameson Graef Rollins
2011-12-17  9:56 ` Tomi Ollila
2011-12-20  4:16 ` David Bremner
2011-12-22  3:43   ` David Bremner
2011-12-22  4:53     ` Jameson Graef Rollins
2011-12-22 10:49       ` David Bremner
2011-12-27  0:35       ` David Bremner
2011-12-29  2:24         ` Austin Clements
2011-12-29 13:11           ` [PATCH v3] notmuch: replace built-in help with exec of man David Bremner
2011-12-29 13:47             ` David Bremner
2011-12-30 18:50             ` Austin Clements
2011-12-31 19:25               ` 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=87zkescxp5.fsf@zancas.localnet \
    --to=bremner@unb.ca \
    --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).