cfg2html(8) - Linux man page
Name
cfg2html-linux - creates a nice HTML and plain ASCII documentation of your GNU/Linux system. WARNING, use this script AT YOUR OWN RISK.Synopsis
cfg2html-linux [-oxshcSflkenaHvh] option...
Description
The cfg2html-linux script is the "swiss army knife" for the ASE, CE, sysadmin etc. I wrote it to get the necessary information to plan an update, to perform basic trouble shooting or performance analysis. As a bonus cfg2html creates a nice HTML and plain ASCII documentation. If you like, write your description of the system into /etc/cfg2html/systeminfo
example:
Main database server using special software.
Contact: Micky Mouse <admin@foo.bar>
Location: Mars Moon
and so on.
- /etc/cfg2html/files
- if this file exists, you can add your own files to collect - see example included.
Switches
The following switches are available from the command line:- -o
- set directory to write or use the environment variable OUTDIR="/path/to/dir" (directory must exist)
- -v
- output version information and exit
use the following options to disable collections:
- -s
- disable: System
- -c
- disable: Cron
- -S
- disable: Software
- -f
- disable: Filesystem
- -l
- disable: LVM
- -k
- disable: Kernel
- -e
- disable: Enhancements
- -n
- disable: Network
- -a
- disable: Applications
- -H
- disable: Hardware
- -x
- don't create background images
Files
- /usr/bin/cfg2html-linux
- The script.
- /etc/cfg2html/systeminfo
- your
system description
- /etc/cfg2html/files
- collect your own files
- <hostname>.html
-
the documentation in html form
- <hostname>.txt
- the documentation in ascii
form
- <hostname>.err
- error logfile
- <hostname>.partitions.save
- Disk Partitions
to restore from
- <hostname>._xpinfo.csv
- (only on systems connected to HP Surestore Arrays): the output of the xpinfo command
- /usr/share/man/man8/cfg2html-linux.8.gz
- The man page.
- README
- Additional documentation and installation instructions.
- changelog
- Revision history for cfg2html-linux.
See Also
README, License.txt and changelog file in the source directory.
Notes
Only root can run the cfg2html-linux script. For security reasons it is better to store the HTML and ASCII files in a safe place where only root user have access or remove the files from your file system.Contacting
If you like the script, and you want to learn more about the script, or want to see a feature added to it that isn't already here, then please subscribe to the project mailing list. The project web page is at http://come.to/cfg2htmlWarnings
use the cfg2html-linux script at your own risk! See License.txt for details!Diagnostics
cfg2html-linux writes errors to <hostname>.err
Bugs
There are probably a lot of bugs. We are currently using this script successfully for our own systems, but there are lot of features included that we don't have any way to test right now. If you find a bug or have a comment or suggestion about the script, please email them at the address in the AUTHORS section. We love to hear from you. :-)Authors
cfg2html HP-UX version written by Ralph Roth <rose_swe@hotmail.com> and ported to Linux by Michael Meifert <dk3hg@users.sourceforge.net>.See the source code and changelog for complete history and credits.