From: Kristaps Dzonsons <kristaps@bsd.lv>
To: discuss@mdocml.bsd.lv
Subject: Fact: mdoc is awesome.
Date: Tue, 05 Apr 2011 00:47:14 +0200 [thread overview]
Message-ID: <4D9A4A72.7050906@bsd.lv> (raw)
Hi,
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 <unistd.h> 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...
Thanks,
Kristaps
--
To unsubscribe send an email to discuss+unsubscribe@mdocml.bsd.lv
next reply other threads:[~2011-04-04 22:47 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2011-04-04 22:47 Kristaps Dzonsons [this message]
2011-04-05 14:21 ` Kristaps Dzonsons
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
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=4D9A4A72.7050906@bsd.lv \
--to=kristaps@bsd.lv \
--cc=discuss@mdocml.bsd.lv \
/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.
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 NNTP newsgroup(s).