The ManPage class provides documentation output to a UNIX man page.
It implements the same functions as Output, but they're not static, and is called when Output's static functions are called.
Constructs an empty man page generator which will write man pages in the dir directory.
As Output::addArgument(). text is used italicized.
Add boilerplate describing the author. Will need configurability.
As Output::addClass(). text is output as-is, and the name of c is remembered for later mention in the See Also section.
As Output::addFunction(). At present this outputs text in the regular font, maybe it should use a different font?
The class to which f belongs is mentioned in the "see also" section.
Adds a See Also section mentioning everything we've mentioned (using addClass()).
As Output::addText(). text is escaped (how?).
Returns a pointer to the most recently constructed ManPage object, or a null pointer if none has been constructed yet.
Emits the routing verbiage at the end of a manpage.
Write s to the output file.
As Output::startHeadline(). c is used only to generate a suitable man page named.
For the moment, we do not generate introductory manual pages. Perhaps it would be possible. This function makes ManPage discard output until startHeadline() is called for a Class.
Destroys the man page object, flushing and closing the generated file.
This web page based on source code belonging to Oryx Mail Systems GmbH. All rights reserved.