From mboxrd@z Thu Jan 1 00:00:00 1970 X-Msuck: nntp://news.gmane.org/gmane.linux.lib.musl.general/3997 Path: news.gmane.org!not-for-mail From: Rich Felker Newsgroups: gmane.linux.lib.musl.general Subject: Re: Initial draft of musl documentation/manual Date: Sun, 1 Sep 2013 12:57:15 -0400 Message-ID: <20130901165715.GV20515@brightrain.aerifal.cx> References: <20130901044106.GA29630@brightrain.aerifal.cx> <52230C48.8060502@gentoo.org> Reply-To: musl@lists.openwall.com NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii X-Trace: ger.gmane.org 1378054645 9022 80.91.229.3 (1 Sep 2013 16:57:25 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Sun, 1 Sep 2013 16:57:25 +0000 (UTC) To: musl@lists.openwall.com Original-X-From: musl-return-4001-gllmg-musl=m.gmane.org@lists.openwall.com Sun Sep 01 18:57:28 2013 Return-path: Envelope-to: gllmg-musl@plane.gmane.org Original-Received: from mother.openwall.net ([195.42.179.200]) by plane.gmane.org with smtp (Exim 4.69) (envelope-from ) id 1VGAxr-0003et-ST for gllmg-musl@plane.gmane.org; Sun, 01 Sep 2013 18:57:28 +0200 Original-Received: (qmail 15962 invoked by uid 550); 1 Sep 2013 16:57:27 -0000 Mailing-List: contact musl-help@lists.openwall.com; run by ezmlm Precedence: bulk List-Post: List-Help: List-Unsubscribe: List-Subscribe: Original-Received: (qmail 15954 invoked from network); 1 Sep 2013 16:57:27 -0000 Content-Disposition: inline In-Reply-To: <52230C48.8060502@gentoo.org> User-Agent: Mutt/1.5.21 (2010-09-15) Xref: news.gmane.org gmane.linux.lib.musl.general:3997 Archived-At: On Sun, Sep 01, 2013 at 11:43:36AM +0200, Luca Barbato wrote: > On 01/09/13 06:41, Rich Felker wrote: > > One more thing: the format of the document is presently Markdown > > (http://daringfireball.net/projects/markdown/). I may switch to > > something else in the future, but Markdown tends to be my favorite > > from a standpoint of being fully readable as plain text and also > > producing decent formatted output in HTML (and other formats, via > > conversion from HTML). Comments on this bikeshed topic are also > > welcome, I suppose, unless it gets out of hand... > > Markdown to man converters are the best available (e.g. kramdown-man) > and markdown is usually easy to grok. Excellent. I'm not sure man format would be terribly useful for the musl documentation I'm working on now, but it's good to know for future reference, especially if we do want to provide a few man pages that could be installed for musl. For the big doc, HTML and PDF are probably the more interesting output formats. The big thing I don't see how to do easily is produce a nice table of contents or index. Rich