Re: have "notmuch help" call man?
authorTomi Ollila <tomi.ollila@iki.fi>
Sat, 17 Dec 2011 09:56:57 +0000 (11:56 +0200)
committerW. Trevor King <wking@tremily.us>
Fri, 7 Nov 2014 17:40:58 +0000 (09:40 -0800)
72/6aded7609c60d7470009732d7d52e0204f8640 [new file with mode: 0644]

diff --git a/72/6aded7609c60d7470009732d7d52e0204f8640 b/72/6aded7609c60d7470009732d7d52e0204f8640
new file mode 100644 (file)
index 0000000..653bc74
--- /dev/null
@@ -0,0 +1,108 @@
+Return-Path: <tomi.ollila@nixu.com>\r
+X-Original-To: notmuch@notmuchmail.org\r
+Delivered-To: notmuch@notmuchmail.org\r
+Received: from localhost (localhost [127.0.0.1])\r
+       by olra.theworths.org (Postfix) with ESMTP id 0A886431FD0\r
+       for <notmuch@notmuchmail.org>; Sat, 17 Dec 2011 01:57:03 -0800 (PST)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: 0\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=0 tagged_above=-999 required=5 tests=[none]\r
+       autolearn=disabled\r
+Received: from olra.theworths.org ([127.0.0.1])\r
+       by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024)\r
+       with ESMTP id E+grm-G50HJj for <notmuch@notmuchmail.org>;\r
+       Sat, 17 Dec 2011 01:57:02 -0800 (PST)\r
+Received: from mail-gw3.nixu.fi (mail-gw3.nixu.fi [193.209.237.7])\r
+       (using TLSv1 with cipher DHE-RSA-AES256-SHA (256/256 bits))\r
+       (No client certificate requested)\r
+       by olra.theworths.org (Postfix) with ESMTPS id 1EA10431FB6\r
+       for <notmuch@notmuchmail.org>; Sat, 17 Dec 2011 01:57:01 -0800 (PST)\r
+Received: from pps.filterd (mail-gw3 [127.0.0.1])\r
+       by mail-gw3.nixu.fi (8.14.4/8.14.4) with SMTP id pBH9uxIn016751;\r
+       Sat, 17 Dec 2011 11:56:59 +0200\r
+Received: from taco2.nixu.fi (taco2.nixu.fi [194.197.118.31])\r
+       by mail-gw3.nixu.fi with ESMTP id 114cs0u07v-1\r
+       (version=TLSv1/SSLv3 cipher=AES256-SHA bits=256 verify=NOT);\r
+       Sat, 17 Dec 2011 11:56:59 +0200\r
+Received: from taco2.nixu.fi (taco2.nixu.fi [194.197.118.31])\r
+       by taco2.nixu.fi (8.14.3/8.14.3/Debian-5+lenny1) with ESMTP id\r
+       pBH9uv0J009276; Sat, 17 Dec 2011 11:56:58 +0200\r
+From: Tomi Ollila <tomi.ollila@iki.fi>\r
+To: David Bremner <bremner@unb.ca>, Notmuch Mail <notmuch@notmuchmail.org>\r
+Subject: Re: have "notmuch help" call man?\r
+In-Reply-To: <87zkescxp5.fsf@zancas.localnet>\r
+References: <87zkescxp5.fsf@zancas.localnet>\r
+User-Agent: Notmuch/0.10.2+93~g631d290 (http://notmuchmail.org) Emacs/23.3.1\r
+       (i686-pc-linux-gnu)\r
+X-Face: HhBM'cA~<r"^Xv\KRN0P{vn'Y"Kd;zg_y3S[4)KSN~s?O\"QPoL\r
+       $[Xv_BD:i/F$WiEWax}R(MPS`^UaptOGD`*/=@\1lKoVa9tnrg0TW?"r7aRtgk[F\r
+       !)g;OY^,BjTbr)Np:%c_o'jj,Z\r
+Date: Sat, 17 Dec 2011 11:56:57 +0200\r
+Message-ID: <yf61us35xna.fsf@taco2.nixu.fi>\r
+MIME-Version: 1.0\r
+Content-Type: text/plain; charset=us-ascii\r
+X-Proofpoint-Virus-Version: vendor=fsecure engine=2.50.10432:5.5.7110,\r
+ 1.0.211,      0.0.0000        definitions=2011-12-17_01:2011-12-16, 2011-12-17,\r
+       1970-01-01 signatures=0\r
+X-Proofpoint-Spam-Details: rule=notspam policy=default score=0 spamscore=0\r
+       ipscore=0 suspectscore=0\r
+       phishscore=0 bulkscore=0 adultscore=0 classifier=spam adjust=0\r
+       reason=mlx\r
+       scancount=1 engine=6.0.2-1012030000 definitions=main-1112170029\r
+X-BeenThere: notmuch@notmuchmail.org\r
+X-Mailman-Version: 2.1.13\r
+Precedence: list\r
+List-Id: "Use and development of the notmuch mail system."\r
+       <notmuch.notmuchmail.org>\r
+List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,\r
+       <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
+List-Archive: <http://notmuchmail.org/pipermail/notmuch>\r
+List-Post: <mailto:notmuch@notmuchmail.org>\r
+List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
+List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,\r
+       <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
+X-List-Received-Date: Sat, 17 Dec 2011 09:57:03 -0000\r
+\r
+On Fri, 16 Dec 2011 12:01:42 -0400, David Bremner <bremner@unb.ca> wrote:\r
+> \r
+> Hi All;\r
+> \r
+> Currently help strings are compiled into the notmuch binary. This is a\r
+> bit a of pain, since we have the same help text in two places.\r
+> What do you think about having "notmuch help foo" invoke "man\r
+> notmuch-foo" and create appropriate man pages (or links).\r
+\r
++1\r
+\r
+> There are other ways around the maintenance dilemma, including\r
+> generating man pages and online help from some common source (e.g. in\r
+> the style of id:"1288804736-5173-3-git-send-email-david@tethera.net").\r
+\r
+In that case we dilemma is what would be the most suitable source format\r
+(pod, mdwn, rst, nroff, ...)...\r
+\r
+> For downsides, it might complicate things slightly for people who\r
+> install notmuch in "odd" places. On the other hand, it is no worse than\r
+> setting LD_LIBRARY_PATH. Also, there is the question of common text like\r
+> search-terms, which could be included in every page, or maybe contained\r
+> in man notmuch.\r
+\r
+Those people who install notmuch in "odd" places (I'm one of those) can\r
+also define MANPATH...\r
+\r
+Nroff provides the .so "request" which includes other nroff source.\r
+\r
+for example /usr/share/man/man1/zshall.1.gz includes all other zsh\r
+namual pages.\r
+\r
+... however it is common to have SEE ALSO at the end of each manual page\r
+\r
+SEE ALSO\r
+    notmuch(1), notmuch-search-terms(7)\r
+\r
+> \r
+> David\r
+\r
+Tomi\r