Menu

Tree [9bc9ed] trunk /
 History

HTTPS access


File Date Author Commit
 .gitignore 2017-03-19 Michael Marking Michael Marking [9bc9ed] oloman.lisp: suppress output of style definitio...
 LICENSE 2017-03-19 Michael Marking Michael Marking [9bc9ed] oloman.lisp: suppress output of style definitio...
 MANIFEST 2017-03-19 Michael Marking Michael Marking [9bc9ed] oloman.lisp: suppress output of style definitio...
 README 2017-02-17 Michael Marking Michael Marking [561d32] Initial commit. UNFINISHED CODE! see README.
 oloman.1.odt 2017-02-17 Michael Marking Michael Marking [561d32] Initial commit. UNFINISHED CODE! see README.
 oloman.asd 2017-02-17 Michael Marking Michael Marking [561d32] Initial commit. UNFINISHED CODE! see README.
 oloman.lisp 2017-03-19 Michael Marking Michael Marking [9bc9ed] oloman.lisp: suppress output of style definitio...
 oloman.sh 2017-02-17 Michael Marking Michael Marking [561d32] Initial commit. UNFINISHED CODE! see README.

Read Me

README for oloman
m. marking 2017.02.17

This code will allow the creation of traditional troff manpages from the
.odt documents produced by OpenOffice and LibreOffice.

The manpage is created using OO/LO, then exported using the default
strict xhtml 1.0 format (resulting in a filename suffix of .html). Then,
this program, oloman, reads the xhtml (.html) file and produces a troff
file which is intelligible to man.

The .odt document must use certain style names to create the man page:
"manpage argument", "manpage section header", and so on. Those style
names are exported in the xhtml file. However, oloman doesn't care about
the specifics of the style, about the font, color, or other such
details.  oloman only cares about the name. Thus, you can make the
manpages look any way you want for web pages, pdf, or other formats, as
long as the special style names are used.

The code is written in Lisp, and is tested with sbcl, but ought to work
with other Lisp implementations which support the Common Lisp standard.
For non-Lisp users, all it should take to run is to install sbcl and a
few widely used packages, then run the accompanying shell script to call
sbcl and load the script. (Windows users may need a replacement for the
simple shell script, which is beyond me. Any suggestions will be
appreciated.)

Of course, the manpages themselves need not have anything to do with
Lisp. I'm planning to use oloman also in another project which is coded
in C.

The code is under development. Now, it will parse my xhtml test files,
but doesn't yet extract the styles or generate the troff. I'm doing this
in parallel with my cl-manpages project, which is an effort to generate
the several hundred manpages needed for Common Lisp. (Surprisingly to
me, I have not found that anyone has done this, and I like manpages, so
I jumped in.)

At his point, there are not yet install scripts, or test code, or other
usual supporting things, but I have included a preliminary .odt file
with the man page for oloman itself. A second manpage for oloman will be
forthcoming: one page to describe use of the script, and the second page
to explain the necessary styles and a few other details of the
requirements for the .odt file.

Tarballs will also be hosted on my own site, at
http://www.tatanka.com/software/oloman/.


Want the latest updates on software, tech news, and AI?
Get latest updates about software, tech news, and AI from SourceForge directly in your inbox once a month.