From a913b241e04efe61d833822399668e714e62f5ef Mon Sep 17 00:00:00 2001 From: David Bremner Date: Sat, 18 Jan 2014 16:09:12 +2000 Subject: [PATCH] Re: [Patch v3 2/3] man: partial conversion to pod. --- 8b/65090a0cad112c0ada3fafd77bd2d533f52a39 | 81 +++++++++++++++++++++++ 1 file changed, 81 insertions(+) create mode 100644 8b/65090a0cad112c0ada3fafd77bd2d533f52a39 diff --git a/8b/65090a0cad112c0ada3fafd77bd2d533f52a39 b/8b/65090a0cad112c0ada3fafd77bd2d533f52a39 new file mode 100644 index 000000000..be8181a3f --- /dev/null +++ b/8b/65090a0cad112c0ada3fafd77bd2d533f52a39 @@ -0,0 +1,81 @@ +Return-Path: +X-Original-To: notmuch@notmuchmail.org +Delivered-To: notmuch@notmuchmail.org +Received: from localhost (localhost [127.0.0.1]) + by olra.theworths.org (Postfix) with ESMTP id 217ED431FBC + for ; Fri, 17 Jan 2014 12:09:27 -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 TjOp4RzVPN7u for ; + Fri, 17 Jan 2014 12:09:21 -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 40ADE431FB6 + for ; Fri, 17 Jan 2014 12:09:21 -0800 (PST) +Received: from remotemail by yantan.tethera.net with local (Exim 4.80) + (envelope-from ) + id 1W4FjA-0003YH-KL; Fri, 17 Jan 2014 16:09:16 -0400 +Received: (nullmailer pid 9065 invoked by uid 1000); Fri, 17 Jan 2014 + 20:09:12 -0000 +From: David Bremner +To: Jani Nikula , notmuch@notmuchmail.org +Subject: Re: [Patch v3 2/3] man: partial conversion to pod. +In-Reply-To: <87lhyer3lf.fsf@nikula.org> +References: + <1389791332-21719-1-git-send-email-david@tethera.net> + <1389791332-21719-3-git-send-email-david@tethera.net> + <87lhyer3lf.fsf@nikula.org> +User-Agent: Notmuch/0.17+30~g50677dd (http://notmuchmail.org) Emacs/24.3.1 + (x86_64-pc-linux-gnu) +Date: Fri, 17 Jan 2014 16:09:12 -0400 +Message-ID: <87bnzagyl3.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: Fri, 17 Jan 2014 20:09:27 -0000 + +Jani Nikula writes: + +> On Wed, 15 Jan 2014, David Bremner wrote: +>> From: David Bremner + +> In short, I'm really tempted by using markdown as the format, not least +> because it's what we use for the web pages. The big (also literally) +> downside is pandoc (http://johnmacfarlane.net/pandoc/), the tool for +> converting markdown to man. I don't mind its dependencies, others may +> disagree. Are there any sensible alternatives to pandoc? + +To complicate things, if we did decide on something heavyweight I think +I'd propose we think about rst instead of markdown. I don't rst as well +as markdown, but markdown does feel a little too adhoc to me from time +to time (e.g. a verbatim block forcing the end of a list and so on). +As far as I can tell, there are many incompatible versions of markdown +as soon as you start to want e.g. tables. + +In any case, rst -> man is supported by python-docutils. sphinx supports +both man page generation and texinfo output. So that would be relatively +lighter weight alternative (??) to pandoc. + +A more radical proposal would be to skip generating info and assuming +everybody can browse html in emacs. That assumption is supposed to +become less ludicrous in emacs24.4 with the inclusion of "eww". + +d -- 2.26.2