Accudoc
0.5
Please send
comments,
questions or
corrections to
mikem@cyber.com.au.
If you
implement a
system system
using this
information I'd
love to hear
about it.
Mike |
|
:. |
Easily create comprehensive, good looking documentation for Linux servers.
|
|
|
This application generates good looking, comprehensive, well formatted documentation for Linux servers, aimed at System Administrators.
The script prompts for a couple of settings, but automatically generates as much of the document as possible by asking the system itself.
Features include:
- Good looking comprehensive structured documentation with minimal effort
- It does not require OpenOffice or any XML libraries to be installed on the system being documented
- Comprehensiveness: covers important details that system administartors need to know, like contact details for organizatiosn assocated with the machine, network interface configuration, routing tables, hardware details, upstream information, storage details, what network services are avaliable \ the packages that rpovide those services \ the current installeed package version, etc.
- Output that can be edited with any text editor, or with OpenOffice, a modern friendly structured word processor.
- Output that can be converted into all other major document formats, including Microsoft Word 6, 95, 97, 2000, XP, 2003, text, RTF, PostScript, PDF, and (if the users have XSLT experience) most other XML document formats.
- It is designed for Linux Standard Base systems, not vanilla Unix or random nonstandard OS with a Linux kernel. This means it encourages good system administration practices including packaging in RPM format, Sys V init scripts in /etc/init.d, etc.
- It does not need to be run as the root user.
Requirements
- A Linux machine. This script is primarily tested on Red Hat machines, but should work with most LSB Linux distros.
- dialog (you can use gdialog or kdialog, or have all questions answered with `foo' instead, if you edit the accudoc script accordingly). Packages are included in almost all distros.
- zip. Packages are included in almost all distros.
- the ability to access a whois server (if you don't have this, disable the line in the script).
That's it. You only need OpenOffice to view the document, not to create it.
Use
./accudoc
Then answer the questions. Its complicated like that ;)
Have fun,
Mike
|
|