cfg2html is short for "Config to HTML" and is a UNIX shell script initially developed by Ralph Roth [1], for creating system configuration summaries in HTML. Besides it creates a HTML documentation it also creates an plain ASCII system configuration documentation.
Some consider it to be the "Swiss army knife" for the Account Support Engineer, Consultant, Customer Engineer, SYS admin etc. Originally developed in 1998/1999 to plan a system update, it was also found useful to perform basic troubleshooting or performance analysis. The production of a nice HTML and plain ASCII documentation is part of this utility.
Originally developed strictly for HP-UX, it now supports
* HP-UX 10.xx/11.xx * SCO-UNIX * AIX * Sun OS * Linux systems * Brocade switches and small Linux routers like OpenWRT and embedded systems
Cfg2html is a UNIX shell script similar to check_config or get_config, except that it creates a HTML (and plain ASCII) system documentation for HP-UX 10.xx/11.xx, Integrity Virtual Machine, SCO-UNIX, AIX, Sun OS and Linux systems. Plug-ins for SAP, Oracle, Informix, Serviceguard, Fibre Channel/SAN, TIP/ix, Ignite-UX [2], Mass Storage like MAS, EVAx000, XP48/128/256/512/1024, 1x000/2x000, Network Node Manager and OmniBack/DataProtector etc. are included. The first versions of cfg2html were written for HP-UX. Meanwhile the cfg2html HP-UX stream was ported to major *NIX platforms and small embedded systems.
For HP-UX 11.31 and better you need at last cfg2html-hpux version 3.74/4.29 or higher! All 11.31 (v3) issues should be fixed with version 4.41 or higher - any feedback is welcome. Legacy view and agile view should work.
All support, downloads and discussion for cfg2html is preformed through Yahoo Groups, see http://tech.groups.yahoo.com/group/cfg2html. As of Nov. 2009 the group consists of 10400 members. The email traffic is low, approximately one message per week on the mailing list.
Original HPUX Version: Ralph Roth, ROSE SWE, http://come.to/rose_swe
End-User License Agreement for the cfg2html package
Below you see the development tree cfg2html has taken the last years.
| Operating System | Sourcecode Maintainer (CVS) | Main authors | Contributors | Remarks/ToDo's |
| HP-UX 11.xx PA-RISC/IA64 | Ralph Roth | Ralph Roth | Martin Kalmbach
Marc Heinrich Thomas Brix and others.... |
see ToDo.txt |
| Linux IA32 | Ralph Roth
Michael Meifert |
Michael Meifert
Ralph Roth |
Jeroen Kleen
Kareem Galal Michael Meier |
Development platform is Debian Linux
Problem: Merge side project (cfg2html-linux120HP/124HP) by Jeroen Kleen into common a stream. |
| Linux IA64/IPF |
-- // -- |
<you?> |
Ralph Roth | EFI releated stuff has to be included! |
| Linux PA-RISC |
-- // -- |
Ralph Roth | Linux 2.4.26-32 #1 Sat Jul 31 20:01:18 CEST 2004 parisc GNU/Linux | |
| Brocade 4.xx Switches | Ralph Roth | Ralph Roth | Linux 2.4.19 kernel only? | |
| Sun Solaris | Ralph Roth |
Gert Leerdam
Marc van Laethem Trond Eirik Aune |
Eduardo Diaz
Keiran Sweet Jeroen Kleen |
Problem: Merge 1.10 and 2.1 streams
|
| AIX | Andreas Wizemann |
Olaf Morgenstern
Jim Lane Marco Stork Witold Owoc Chris Paulheim Andreas Wizemann |
Problem: Various (buggy) version exists and should be merged into one common 2.x stream!
2.7 stream is now hosted on sf.net |
|
| OpenWRT |
Ralph Roth |
Ralph Roth | early beta stage | |
| SCO | -- // -- | Jan Damen | ||
| Tools and plugins | ||||
| do-cfg | -- // -- | Albert Wanders | Giuseppe Gentile | HP-UX and SUN tested |
| runcfg2html | -- // -- | Andrew Wilkin | runcfg2html will be updated by Andrew (09.2004?). | |
| user plugins | Andre Naumann | Linux + HP-UX | ||
| ora2html | -- // -- | Yngve Clausen | Last updated: Aug 31 2005 | |
| Webspace | ||||
| www.cfg2html.com |
-- // -- |
Marc Eberhart - e-projecta GmbH | Newest beta stuff only! | |
| New cfg2html version (aka cfg2html II or cfg2html v5.x) | ||||
| cfg2html | Chris, Ralph Roth | Chris | New version (2009), supports Linux, HP-UX and AIX | |
If you want to send us an email, use [cfg2html] in the beginning of the subject - otherwise the chance is high that our spam filters simply deletes your message! The best way to contact Ralph is via instant messenger!
That is quite easy. First, get yourself GNU diff. The other diffs will work, too, but this tutorial only applies to GNU diff. We want unified diffs!
1. If you change cfg2html, please mark your changes with for example # <name>,<date>. Do not forget to remove all backup files from your editor.
2. Rename the directory with your new, patched cfg2html-x.xx to, say, cfg2html-x.xx.patched
3. Unpack the original distribution tar ball. DO NOT LEAVE in this directory files e.g. from a cfg2html run. Only the original distribution!
4. Now type:
diff -uNr cfg2html-x.xx cfg2html-x.xx.patched | gzip -c > cfg2html-x.xx.diff.gz
This is for GNU diff. You vendor’s diff may not know the -u option, in which case you should try -c instead.
5. Now send the compressed diff to my e-mail address: cfg2hthml@hotmail.com (subject [cfg2html] PATCH: + your text)
The “-u” creates a unified diff, which has 3 lines of context per default. This has the advantage that patches can be applied to other versions of cfg2html, too.
The “-N” treats new files as empty. That means if you add a file, diff will put it in the diff, too. This has the advantage that your file is not lost. It has the disadvantage that “Makefile” and so on are put into the diff, too. So for patches where you do not add new files, you can omit the “-N”.
The “-r” means recursive. For cfg2html this is only important if you change stuff in subdirectories. But it is good habit to use it.
$ gunzip delta-1-14-3rar.gz
$ patch -p0 < delta-1-14-3rar
patching file cfg2html-linux-1.14/cfg2html-linux
patching file cfg2html-linux-1.14/cfg2html_urls.html
This End-User License Agreement ("EULA") is a legal agreement between you
(either an individual or a single entity) and the mentioned authors (ROSE
SWE and cfg2html authors, see this file or AUTHORS/Linux or readme.txt/hpux) of this
Software for the software product identified above, which includes computer
software and may include associated media, printed materials, and "online"
or electronic documentation ("SOFTWARE PRODUCT"). By installing, copying, or
otherwise using the SOFTWARE PRODUCT, you agree to be bounded by the terms
of this EULA. If you do not agree to the terms of this EULA, do not install
or use the SOFTWARE PRODUCT.
SOFTWARE PRODUCT LICENSE. All versions of the SOFTWARE PRODUCT are protected by
copyright laws and international copyright treaties, as well as other
intellectual property laws and treaties. The sole property belongs to ROSE SWE,
the cfg2html authors and maybe 3rd party (status currently unknown).
1. GRANT OF LICENSE. This EULA grants you the following rights:
Installation and use. You may install and use an unlimited number of copies of
the SOFTWARE PRODUCT.
Reproduction and Distribution. You may reproduce and distribute an unlimited
number of copies of the SOFTWARE PRODUCT; provided that each copy shall be a
true and complete copy, including all copyright and trademark notices, and shall
be accompanied by a copy of this EULA (e.g. original tar/depot/rpm/deb archives).
2. DESCRIPTION OF OTHER RIGHTS AND LIMITATIONS. You can reverse engineer,
decompile, or disassemble the SOFTWARE PRODUCT. Please send modified versions
back to the authors using diff(1) files suitable for patch(1). See the file
readme.txt for details.
Separation of Components. The SOFTWARE PRODUCT is licensed as a single product.
Termination. Without prejudice to any other rights, the authors of this Software
may terminate this EULA if you fail to comply with the terms and conditions of
this EULA. In such event, you must destroy all copies of the SOFTWARE PRODUCT
and all of its component parts.
3. COPYRIGHT. All title and copyrights in and to the SOFTWARE PRODUCT
(including but not limited to any images, photographs, animations, video, audio,
music, text, and "applets" incorporated into the SOFTWARE PRODUCT),
the accompanying printed materials, and any copies of the SOFTWARE PRODUCT are
owned by the authors of this Software. The SOFTWARE PRODUCT is protected by
copyright laws and international treaty provisions. Therefore, you must treat
the SOFTWARE PRODUCT like any other copyrighted material.
LIMITED WARRANTY
NO WARRANTIES. The authors of this Software expressly disclaims any warranty
for the SOFTWARE PRODUCT. The SOFTWARE PRODUCT and any related documentation
is provided "as is" without warranty of any kind, either express or implied,
including, without limitation, the implied warranties or merchantability,
fitness for a particular purpose, or disarrangement. The entire risk arising
out of use or performance of the SOFTWARE PRODUCT remains with you.
NO LIABILITY FOR DAMAGES. In no event shall the authors of this Software be
liable for any special, consequential, incidental or indirect damages
whatsoever (including, without limitation, damages for loss of business
profits, business interruption, loss of business information, or any other
pecuniary loss) arising out of the use of or inability to use this product,
even if the authors of this Software is aware of the possibility of such
damages and known defects.
WARNING: cfg2html may hang or harm your productive system! This is caused by
faulty or hardware related software such as *FDISK, diagnostic tools etc. For
this reason the usage of cfg2html on a productive or mission critical system is not
encouraged! cfg2html also tends to fill up your file system with large log
files and uses your CPU for collecting.
If this is a problem for you or your system then simply do not use this program.
This software contains bugs!
This software is not supported at all - neither by HP (Hewlett-Packard) nor by the authors! The authors does not have the time, budget and equipment to support this free product. The only way to get support is via the cfg2html mailing list!
If you can, add places where you have seen cfg2html mentioned, particularly "Dead Tree" mentions, please add them to this article.
| come.to/cfg2html -
cfg2html.sh
A Free UNIX/Win32 System Configuration to HTML Converter Utility |
www.cfg2html.com
(Download Area only) currently under construction |
Yahoo! Groups: cfg2html |
cfg2html - Related stuff
|
|
|
|
cfg2html - HP Internal Stuff