Having finally gotten another block of time for the next cleanup on my
list, I've translated the manpage source out of the terrifying,
inconsistent, and not entirely syntactically valid mix of man, ms,
and custom macros, plus a bunch of raw roff escapes, plus $DEITY knows
what else, into a much more consistent, readable, and maintainable
asciidoc source.

(I'll pause here to let everybody catch their breath after that
sorta-like-a-sentence...)

A snapshot of the current HTML output is at
<http://www.ctwm.org/tmp/ctwm.1.html> for perusal.  A pile of
comparison will show you that there are very minimal content changes
from the current manpage, but it's pretty cleaned in its new home.
After it lands, I'll probably do a few rounds of cleanup on it to make
it a little more idiomatic, or useful (or probably correct, in some
places).  Or anybody else can, since you can now do it without chewing
your leg off to escape the roff-hell.


Currently residing in a branch at
<https://code.launchpad.net/~fullermd/ctwm/asciidoc_manual>.  The
build process is updated to find asciidoc(1) (actually a2x(1)) and
build the manpage from the asciidoc source on the fly.  Release
tarballs will include a preprocessed version so release-runners can
get by without having it around, much like is done with the lex/yacc
source files.  It will blow up on install if it couldn't either build
its own manpage or find pre-built.

There's also a target in the doc/ Makefile to build a HTML version,
which will be in release tarballs, but is not built or installed
(currently) as part of the standard build process.  That'll probably
change before release time comes around again, but that fits into a
larger separate step of "reconsider what/where we install files".  I
prefer to make one mess at a time   :)

Most of the conversion actually wound up fairly easy to automate, in
the convert.pl script still sitting in the doc/ dir; it only left a
few things that needed hand-tweaking.  A pleasant surprise.

Lacking objections, I'll probably land it after New Years.  Until
then, everybody enjoy the eggnog!


-- 
Matthew Fuller     (MF4839)   |  [email protected]
Systems/Network Administrator |  http://www.over-yonder.net/~fullermd/
           On the Internet, nobody can hear you scream.

Reply via email to