-- c-tools 0.4 --
$Id: README,v 1.28 1995/08/12 14:47:53 sandro Exp $

c-tools README
Copyright (c) 1995 Sandro Sigala. <sansig@freenet.hut.fi>

This stuff is released under the GNU General Public License.

This release of c-tools consist of four simple programs that can
be useful for programmers and others guys.

cinfo		a C libraries information tool
highlight	highlight C source file with colors
obscure		make a C source file unreadable but compilable
hsort		sort #include directives in C source files

All the programs have an help (-h) option. For more help read the man pages.

---
cinfo usage:
usage: cinfo [-hm] [-l libfile] [-o outfile] [symbol]
       -h         display this help and exit
       -m         make output more program-parseable
       -l libfile specify the library to load instead the default
       -o outfile specify the output file instead the standard output

highlight usage:
usage: highlight [-hd] [input [output]]
       -h        display this help and exit
       -d        tread directives as single characters

obscure usage:
usage: obscure [-huis] [-w width] [-a file] [-n file] [-p prefix]
               [input [output]]
       -h        display this help and exit
       -u        make very unreadable output
       -i        do not change identifiers
       -s        use silly words instead of numbers for the identifiers
       -w width  set the width of the output
       -a file   add first the identifiers contained in this file
       -n file   do not change the identifiers contained in this file
       -p prefix use this prefix as the prefix of the identifiers

hsort usage:
usage: hsort [-h] [input [output]]
       -h        display this help and exit

---

IMHO, the order of utility of the tools:
HIGHEST
...
cinfo (== a must have)
...
obscure
highlight
hsort
LOWEST

---

HOW TO BUILD / TEST

to make the whole thing type:
make

to install the binaries and cinfo files type:
make install

to install the man pages type:
make maninstall

to test the programs type: 
cd examples
make test

NOTICE

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

---

Post Scriptum
 - All those programs were written in a half dozen of days,
   then probably they contain many bugs. Please send me corrections.
 - My english is bad, so send me corrections :).
 - Those programs can be freely used and modified.

Copyright (c) 1995 Sandro Sigala.
Send patches, suggestions, flames, etc. to <sansig@freenet.hut.fi>.
At your option you may send they to /dev/null.

home address
Sandro Sigala
via Zendrini, 1
25047 Darfo Boario Terme
Brescia - ITALY
