Re: libmandoc

Re: libmandoc

[Kristaps Dzonsons]

> I'm thinking of separating libmandoc and mandoc(1) in DragonFly,
> assuming libmandoc will make it easier for us to write custom tools for
> checking things in manpages. Am I correct in assuming this?
>
> The headers that should be publically visible in /usr/include should be
> <man.h>, <mdoc.h> and <mandoc.h> (as per mandoc(3) manual page), right?
>
> One last thing: The mandoc(3) manual page has no
>
> .Sh LIBRARY
> .Lb mandoc
>
> section. Are there plans to add one?

Hi Sascha,

Hope you don't mind me cross-posting to discuss@, as this deals with 
deployment and others may be interested.

Yes, mandoc(3) is simple and easy (alloc, parsefd, free).  Although 
making sense of what comes out of it can be tricky... ;)

In the Makefile, I stipulate `.../include/mandoc' as the installation 
prefix for include (and library in .../lib/mandoc) files.  This is just 
because I don't like spewing includes all over.  If anybody has strong 
feelings either way, please let me know and I can adjust the default 
path (this particular part should be in sync with downstream).

In thinking carefully about this, I don't suggest flipping on this 
installation unless you're Ok with having a WIP in base.  E.g., I 
anticipate adding <tbl.h> (separating the "tbl" prefixed stuff) and 
<eqn.h> also.  Ingo and I fought about whether to have a single 
<mandoc.h> file, but in the end his reasoning made more sense than mine.

In general, the mandoc.3 library is still `under development', although 
it's pretty stable in terms of existing functions.  Though if anybody's 
writing a application using mandoc.3 without contacting me first, 
they're in for some mean surprises (e.g., binary characters for 
soft-hyphens and such).  There are three utilities to date interfacing 
with libmandoc: mandoc and makewhatis in the mandoc packages, and 
mandoc.cgi in http://mdocml.bsd.lv/mandoc-cgi/index.html.

The mandoc.3 file should also have some more loving before being widely 
used.  The exported types, for instances, are only partially documented.

As for `Sh LIBRARY', that's a bug I just fixed.  Thanks!

Take care,

Kristaps
--
 To unsubscribe send an email to discuss+unsubscribe@mdocml.bsd.lv