manpages for common lisp and a few useful cl packages
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
manomu
LICENSE
README

README

cl-manpages

This project consists of (will consist of) traditional *nix manpages
for Common Lisp and for some useful packages. I will be releasing the
pages as they are done, probably a few a week.

The first few pages are now part of the project, but only the html
versions. I haven't yet finished the scripts to convert html to troff.
Caution: they haven't seen much proofreading, so there may be errors.
Also, there is not yet an install script.

Although I use the hyperspec and a pdf of the standard, along with
various books in electronic and paper form, I find that I miss the
ability to type "man X" and get a quick synopsis of a function or
macro, along with a summary of possible arguments. I haven't seen
such a thing for Common Lisp, so I've decided to go ahead and create
it.

This is a documentation-only project, and the text will be copied
from other documentation.

As for the additional packages, I plan to include asdf, cl-unicode,
cl-interpol, cl-ppcre, and maybe some others. If anyone has any
favourites they'd like to add, please let me know.

This is all certainly not to be taken as a criticism of the other
documentation forms. I'm sure I'll still have those others open in
windows on my own machine, even after this project is complete.

The pages will be produced in traditional troff format, as well as
also in html form. The html pages will be put into a directory,
manomu (for "manpages, other mark up"), having the same basic
structure as the man directory. The idea of calling it manomu came
from the realization that, in the future, other markup languages
(beyond troff, html) might be used; I don't want to clutter up the
well-established man directory to do this.

The pages will follow the general format used in the Common Lisp
specification. That is, they'll have sections

    NAME
    SYNTAX
    ARGUMENTS and VALUES
    DESCRIPTION
    EXAMPLES
    SEE ALSO
    NOTES

and a final section explaining whence the text was copied, with
copyright information and credit to the original author for that
page. These aren't exactly the usual man page sections (for example,
I'm going to use SYNTAX, rather than SYNOPSIS), but it makes sense
to deviate from normal because they'll more closely follow the
specification (which was written as it was for good reason) and,
well, Lisp isn't that normal anyway. (Good thing, too!)

They'll go into section (3cl) and maybe a few into (7cl). I'll use
traditional install scripts with a Makefile.

I plan to release these a few a week until the project is complete.
A possible second phase of the project would be to add notes or
other sections not in the basic documentation. Another possibility
is to figure out how to install the pages using quicklisp, in
addition to the usual "make install" command line mechanism.

Being documentation, a Creative Commons license makes the most sense
to me. Original licenses will apply, but this will be a derivative
work from mixed-origin material, and some kind of license is needed
as an umbrella.

Once again, please let me know if you have comments, suggestions,
or criticisms.

Michael Marking
marking@tatanka.com
2017.01.04, updated 2017.01.12