cfg2html overview, authors, maintenance overview and license agreement

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 an HTML documentation it also creates a plain ASCII system configuration documentation.

Some consider it to be the "Swiss army knife" for the Account Support Engineer, Consultant, Customer Engineer, System administrator 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/Solaris

• Linux systems

• Brocade switches and small Linux routers like OpenWRT, FreiFunk 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 Machines, SCO-UNIX, AIX, Sun OS and Linux systems. Plug-ins for SAP, Oracle, Informix, Serviceguard, Fiber Channel/SAN, TIP/ix, Ignite-UX [2], Mass Storage like MAS, EVAx000, XP48/128/256/512/1024, 1x000/2x000, Network Node Manager and DataProtector etc. are included.

All HP-UX 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 May 2014 the group consists of 12700 members. The email traffic is low, approximately one message per week on the mailing list.

Original HP-UX Version: Ralph Roth, ROSE SWE, http://rose.rult.at

Contents

Contents

cfg2html versions and ports

cfg2html authors

Patching

End-User License Agreement for the cfg2html package

Links and URLS

GNU PGP Keys

cfg2html versions and ports (Contents)

Below you see the development tree cfg2html has taken the last years.

cfg2html authors (Contents)

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! Please don't send support questions. We don't have the time to answer and they'll probably be ignored. Bug fixes, or patches that add something useful will be gratefully accepted, however.

Patching (Contents)

Please note that all contribution to cfg2html must be copyright free, because cfg2html is now under an Open Source License (GPL v3)!

OK, I fixed a bug, how do I make a diff?

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 vendors diff may not know the -u option, in which case you should try -c instead.

5. Now send the compressed diff to my email 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 sub directories. But it is good habit to use it.

How to apply the Patches/Diffs?

$ 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 

Using github to request a pull merge

First of all you need to fork cfg2html/cfg2html at github. That requires that you already have an github account.

1- git clone https://github.com/<userid>/cfg2html

2- Put <yourcode> folder in place.

3- git add <yourcode>

4- git status

5- git commit -m 'what you have enhanced + your name'

6- git push

After you pushed up the changes, goto your <userid>/cfg2html fork at github and push the Pull Request Button.

Add your comments and wait until Ralph or Gratien can merge the changes. ;)

End-User License Agreement for the cfg2html package (Contents)

Note: This license will change in future to the GNU Public License v3

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! The authors do not have the time, budget and equipment to support this free product. The only way to get support is via the cfg2html mailing list!

More Links and URLS ( Contents)

References

If you can, add places where you have seen cfg2html mentioned, particularly "Dead Tree" mentions, please add them to this article.

• David A. Bandel (2003). "Upfront". Linux Journal . On line copy http://www.linuxjournal.com/article/6495

• The newest versions are down loadable at

  • http://www.cfg2html.com (all stuff)

  • http://www.cfg2html.com (only new betas)

• To get a new version visit: http://www.cfg2html.com, and subscribe to the cfg2html mailing list

• Oracle only version http://ora2html.sourceforge.net/

• AIX only version http://cfg2html.sourceforge.net/

• A recommendation of the Public Administration of Switzerland: http://www.opengovernment.ch/software/cfg2html

• Sun BigAdmin System Administration Portal (yes, there's a typo in the link): http://www.sun.com/bigadmin/jsp/descFile.jsp?url=descAll/coniguration_to_html

• Mentioned at http://www.cyberpro.com.au/Tips_n_Tricks/Linux_Related_Tips/Setup_cfg2html_-_System_Reporting_Tool/

• Mentioned at the Weblog of Thomas Schimana: http://schimana.net/2006/07/25/system-dokumentation-mit-cfg2html/

• At CentOS forum: http://www.centos.org/modules/newbb/viewtopic.php?topic_id=6670

• At John's Unix Resource: http://www.dogs-chod.co.uk/howto/aixhow.htm#perf

• At the Linux Journal: http://www.linuxjournal.com/article/6495

• An Interview with Siem Korteweg about the System Configuration Collector at Linux Security.com: http://www.linuxsecurity.com/content/view/117330/49/

• Freshmet page: http://freshmeat.net/projects/cfg2html/?topic_id=253

GNU PGP Keys ( Contents)

GPG key is used for secure email communication and to sign/verify the Linux packages

    

pub  1024D/3426A369 1998-04-29 ROSE SWE, Dipl.-Ing. Ralph Roth 
     Key fingerprint = 5128 28B8 C884 4F86 5245  8076 4CEA 247E 3426 A369
uid                            ROSE SWE, Dipl.-Ing. Ralph Roth 
sub  1536g/1D5D72F1 1998-04-29
-----BEGIN PGP PUBLIC KEY BLOCK-----
Version: GnuPG v1.2.4 (GNU/Linux)
Comment: http://rose.rult.at
mQGiBDVHgrERBADJUnA7XSGy/5h/LaaoVIgfrBrN/+e33JDnOlpi8qnsy//HQgjV
BG02COM52VQx6st8SXIh5UA06KZwzc4ntUJtVr1oJ7PN5EwmrfKWU/lOiPXIFNfD
+6dnOXqy52R9REGdGKIAqMSkq02GaosQImiHdl8z7Z7pvBWrWYhxvX8qDQCg/3VD
x4UOGRMg0JHYY70F/X8nQk8D/07FTYLSs04g5lo2qipl1xbBLuH3lw8DLceQzDkQ
9exovKbvIpHVOQDUZWFalm7d8j49kZSYa/0PGAr/r7yHveErYE+MASn/hLWtqjLZ
0SVDaP4w5GBSUCpAq05JwYRTmAaaIt8cfAYk82pB4pLQyykCQRMDAyzKwn/012PW
ZCVjA/9YkqEMIPRUvBFQmyJ6JMxgR18sBajziLCZxaIGj6/x+gd01GTUJR9k0Nyz
VmPwWcal1J//Gzo5qKO5rAFYJMTL5t9I5Q08UOJJIpx5UmUFgFKrFD4e5NTr7PEy
xphPr4RFjmHazv3imlDotioDF2oKuejSIOwbUJg2WAzyxhuVvLQ2Uk9TRSBTV0Us
IERpcGwuLUluZy4gUmFscGggUm90aCA8cm9zZV9zd2VAaG90bWFpbC5jb20+iFYE
EBECAA4FAjrXdeUECwMCAQIZAQASCRBM6iR+NCajaQdlR1BHAAEBMtEAniCGwsiW
vnk8zia2tYjWJy9bcdXLAJ44FXDDVKZLzvpP9oVIuWk9oHbMZokBHAQQAQEABgUC
Otd2GQAKCRCcxWwzNQ9rU2urB/45mx2SX6m6yf2vYSXhQJkPnsgCQTNBmTjsIbB7
SAhd1SPks9Br6YLaVWQXaurKREzXmZjReiUWS9MAshXW+MyshEx4C4Y8xLIWy9pF
TjVU9I3iIXDQpWDaPYCG549Xfj/vS+o1ZaHdczrKF8fv08AadQYCzY6zIZFBe7zm
6eXEpFoqk4a+svBAuwUwhgdVlp76k9he2JsgpVzZe7jdSgGs+sGOZ6cb5AU36+3z
6JNeyHHSh7vAew9zx+jScMYHzr+hijic0nuVkTfXhRqFwVKRIgk2c7Pu0O1xsw0M
XUqka4dan05LVRHxLUnh/5dBJddLKQ6Vw8tI/SEbJg3P0i/PtDNST1NFIFNXRSwg
RGlwbC4tSW5nLiBSYWxwaCBSb3RoIDxSYWxwaFJvdGhAZ214Lm5ldD6IUwQQEQIA
CwUCNUeCsQQLAwIBABIJEEzqJH40JqNpB2VHUEcAAQF49ACgxx3Ft8/y+wF/ynRt
6fTFPka/BlIAn0RXO/i1S7GQqUm8WSYDzSvN3PMJiEYEEBECAAYFAjW1VdwACgkQ
eVn+TOMsnWOA8wCgw/suUSfga65YEEB8jjb4W1WpD94An2G95O3gkHymBnNDCJZi
KX8izpxjiEYEEBECAAYFAjY4VEcACgkQmsp4k2gPOscHNQCfdrJLNDxgOT+geNQn
HYvuwqG/kk0AmgLyc85KAMO46YfG0laNNQM5arAyiQEcBBABAQAGBQI613S7AAoJ
EJzFbDM1D2tT73YIAOnTqgLshSfEQmkbbXScS8nNzjAhdNnJBdkkB9+EHe1fNBHf
kIqQ2P8KYVKiTqb4JRW6Fzf/vOfNXFVfKJAP5n34h2flzhFMW7n2tUSqb8XtrlfP
aEeiFslGO0Xb627aJHCDd1Xtw2QXM8hQHrCfTSG7yYsCNroGP9UDsYw60UBYhgE9
ZdlVIv1FpeEqEBlBh+eJ7tBucxXpaWxWdGnaCLu/xnlWUmmYOrXScUNv7yOiw24W
e/6rL/4DNbHY5W8Kd1/pGAGNmQwfRh1GalAy9tQnJPAEN1s27xU0BKvfjWdaF0Na
/L0p33LrTiewSp4CX1TGdDo28R8TBGT/oA1nwauJAFUDBRA2OPVO//pgOsw3QqUB
AeE+Af9H7cjueHQqZfTIhxQs5A/f6ZC/xoV/U84vEsTtdYjfNezCOYdQtWwquMlw
9gfC+Y0m35ekrXfLcsptsCz+uH7zuQGNBDVHgrEQBgD49Vlf3HZSTz09jdvOmeFX
klnN/biudE/F/Ha8g8VHMGHOfMlm/xX5u/2RXscBqtNbno2gpXI61Brwv0YAWCvl
9Ij9WE5J280gtJ3kkQc2azNsOA1FHQ98iLMcfFstjvbzySPAQ/ClWxiNjrtVjLhd
ONM0/XwXV0OjHRhs3jMhLLUq/zzhsSlAGBGNfISnCnLWhsQDGcgHKXrKlQzZlp+r
0ApQmwJG0wg9ZqRdQZ+cfL2JSyIZJrqrol7DVelYfEcAAgIGAN4ZMTzwL+bkAcU+
FTdZmI5UKjplHkV6z3LNfANpiKq6TMlToI/iffe4Jy4K35LYzXj3A78fCsIkOHGI
eH4u7Fe/9GJd/Tc5yuDl0wK/d43JLA3M27ZxKxQxaWHJ8P7lxBGmFbnZpaIR4rvh
qTXRElnK9swSNVASF3mSS8AJjY+KwidoFkulXxyPL0DFpUZah3zyETaKFNNI0Alz
7l1k+3MRuB2rYLfLjFePPTMcRpOINrbZ96EcEzV/qJqmN5DhD4hOBBgRAgAGBQI1
R4KxABIJEEzqJH40JqNpB2VHUEcAAQF6IwCgh0fqSraIVy1/s0Julv8rMuSbG0wA
nA5v4lyYqsa/9e5Hz3LLzV3QMWat
=afAR
-----END PGP PUBLIC KEY BLOCK-----

Linux user #364373

Last edited: @(#) $Id: cfg2html.html,v 5.18 2014/05/19 14:08:28 ralph Exp $