From: Kristaps Dzonsons <kristaps@bsd.lv>
To: discuss@mdocml.bsd.lv
Subject: Update: mandoc-cgi
Date: Tue, 03 May 2011 17:23:16 +0200 [thread overview]
Message-ID: <4DC01DE4.7030203@bsd.lv> (raw)
Hi,
This is the last note about mandoc-cgi to this list: if you have
comments about it, please let me know as soon as possible! I'll be
putting it aside except for little tweaks before BSDCan. But I'll be
happy to hack in any neat suggestions.
So if you haven't heard, mandoc-cgi pushes the "MDOC IS SEMANTIC!" line
by actually mining for data in manuals. To the best of my knowledge,
it's the only utility that takes advantage of semantic UNIX manual
content. ("Apropos" doesn't count.)
For example...
Which manuals reference the POSIX real-time extension?
http://mdocml.bsd.lv/cgi-bin/mandoc.cgi?key=1003.1b
Which manuals list deraadt@ as an author?
http://mdocml.bsd.lv/cgi-bin/mandoc.cgi?key=de+raadt
Which manuals list "stdlib.h" as an includes, sorted by title?
http://mdocml.bsd.lv/cgi-bin/mandoc.cgi?key=stdlib.h&sort=mtitle
Where can you find the "opterr" variable documented?
http://mdocml.bsd.lv/cgi-bin/mandoc.cgi?key=opterr
Anyway, the CGI is generic (uses templating for its output) and thus has
its own project page. See
http://mdocml.bsd.lv/mandoc-cgi/index.html
for a list of its goodies. For example, you can search using UTF-8
strings, sort output by relevance/title/etc., use a text-based browser
(this was very important), and so on.
I've focussed on the CGI aspect, but of course, this can easily be
changed around to be a CLI application, a GNOME-browser plugin for
manuals, or whatever. I'm remarkably unimaginative in this regard, so
speak up (with code, preferrably) if you've suggestions.
I do, however, foresee mandoc-db mining for more and more data, which of
course would be searchable via mandoc-cgi.
Thanks,
Kristaps
P.S., note that mandoc-cgi uses the CVS version of mandoc for its stuff,
so if you want to play with it on your own and you don't have CVS
access, let me know.
--
To unsubscribe send an email to discuss+unsubscribe@mdocml.bsd.lv
reply other threads:[~2011-05-03 15:23 UTC|newest]
Thread overview: [no followups] expand[flat|nested] mbox.gz Atom feed
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=4DC01DE4.7030203@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).