Creating Documents
Documentation Formats
| Format | Details |
|---|---|
| docbook | An SGML/XML based documentation markup format that can be used to create documents in a variety of formats |
| info | A more modern Unix documentation format, but not supported everywhere |
| man | The original Unix documentation format. |
| POD | Plain Old Documenation format for PERL documentation |
Tools
docbook2x
Converts DocBook/XML documents into man pages and Texinfo
The resultant Texinfo documents can be converted to info pages using makeinfo or to PDF using texi2pdf (both utilities are part of the Texinfo package).
info2man
Uses info2pod and pod2man to convert info format pages into either man or POD documents.
help2man
Quick way to create man pages from the output of a program's '--help' option.
Resources
http://docbook2x.sourceforge.net/http://www.tldp.org/HOWTO/Man-Page/index.htmlhttp://xml.openoffice.org/xmerge/docbook/UserGuide.html- A Software Design Specification Template
Related Topics: DocumentFormats, DocBook
-- Frank Dean - 02 Feb 2009