From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from smtp-2.sys.kth.se (smtp-2.sys.kth.se [130.237.32.160]) by krisdoz.my.domain (8.14.3/8.14.3) with ESMTP id p35ELJPr018397 for ; Tue, 5 Apr 2011 10:21:20 -0400 (EDT) Received: from mailscan-1.sys.kth.se (mailscan-1.sys.kth.se [130.237.32.91]) by smtp-2.sys.kth.se (Postfix) with ESMTP id DDEDF14DB0D for ; Tue, 5 Apr 2011 16:21:13 +0200 (CEST) X-Virus-Scanned: by amavisd-new at kth.se Received: from smtp-2.sys.kth.se ([130.237.32.160]) by mailscan-1.sys.kth.se (mailscan-1.sys.kth.se [130.237.32.91]) (amavisd-new, port 10024) with LMTP id qWyzOJlea-XB for ; Tue, 5 Apr 2011 16:21:09 +0200 (CEST) X-KTH-Auth: kristaps [193.10.49.5] X-KTH-mail-from: kristaps@bsd.lv X-KTH-rcpt-to: discuss@mdocml.bsd.lv Received: from [172.16.18.84] (unknown [193.10.49.5]) by smtp-2.sys.kth.se (Postfix) with ESMTP id 8BF9914DC5F for ; Tue, 5 Apr 2011 16:21:07 +0200 (CEST) Message-ID: <4D9B2553.8080308@bsd.lv> Date: Tue, 05 Apr 2011 16:21:07 +0200 From: Kristaps Dzonsons User-Agent: Mozilla/5.0 (X11; U; Linux x86_64; en-US; rv:1.9.1.16) Gecko/20110303 Icedove/3.0.11 X-Mailinglist: mdocml-discuss Reply-To: discuss@mdocml.bsd.lv MIME-Version: 1.0 To: discuss@mdocml.bsd.lv Subject: Re: Fact: mdoc is awesome. References: <4D9A4A72.7050906@bsd.lv> In-Reply-To: <4D9A4A72.7050906@bsd.lv> Content-Type: text/plain; charset=ISO-8859-1; format=flowed Content-Transfer-Encoding: 7bit > With this last version, as mentioned, it's now easy to interface with > mandoc(3) and parse manuals. > > This is still a work-in-progress, as many areas aren't documented or are > rough around the edges. For example, parsed manuals represent "soft" > hyphens with an obscure byte sequence, and this isn't [yet] documented > anywhere. Like I said, work-in-progress, so if you're suddenly inspired > to write a whiz-bang manual thingy, think twice... > > That said, I've written a whiz-bang manual thingy that might interest > you. I plan on using this as an mdoc propoganda tool at BSDCan this > year, but I'd like to air it for suggestions here, first. Please keep it > to yourselves, as I don't want to ruin the fun... > > http://mdocml.bsd.lv/mandoc-cgi/ > > This is basically a semantic search over manuals, piping requested > manuals through mandoc. You can search, for, say, all manuals that > mention as an includes: > > http://mdocml.bsd.lv/cgi-bin/mandoc.cgi?key=unistd.h&type=incl > > or find where that pesky optarg variable is documented: > > http://mdocml.bsd.lv/cgi-bin/mandoc.cgi?key=optarg&type=var > > Handy stuff. > > Here's the bad news. -man documents are, for the time being, completely > left out. I'll do some rinky-dink heuristics to grab the name of a > manual, but for the most part it's just unstructured text. > > Anyway, please post any suggestions or comments you may have! There's a > lot of work that needs to be done---the tool is brand new---but I'd > really appreciate your [reasonable] input on what you think is useful. > Joerg, I know, is gunning for full-text search... A small update... mandoc-db.c can now also do some preliminary -man stuff, parsing out NAME information. In fact, I think this about catches all -man NAME stuff. So, for example, the g++ manual is now available as grabbed from the GNU sources: http://mdocml.bsd.lv/cgi-bin/mandoc.cgi?key=g%2B%2B Note that escapes (e.g., \s, \f) are still passing through mandoc-db. This will require some heavier work, which will come soon. Kristaps -- To unsubscribe send an email to discuss+unsubscribe@mdocml.bsd.lv