
README file for HTB-tools installer - SETUP -
---------------------------------------------

1) HELP
----------
This help.

2) INSTALL
-----------
FULL ->
This option is recommended when HTB-tools is installed for the first time.
After you have selected the INSTALL option, SETUP will compile HTB-tools
and then install the binary files to the /sbin directory. After detecting
your init script directory, SETUP will install the rc.htb init script.
This will be useful if you wish to start/stop htb-tools from the command
line. After all this is done, SETUP will ask you to provide a valid
directory for web htb. For detailed information about how to configure 
and use web htb, please see docs/README-web-en.

UPGRADE ->
This option is useful when a new version of HTB-tools is released.
This will upgrade only the binary files installed in /sbin directory.
Configuration files and web htb will not be altered.


3) CONFIGURE
------------
 GENERATE -> this is under development

 EDIT ->
Using this option, you can edit HTB-tools default
configuration files, installed in /etc/htb, using different text editors. 
This version supports: pico, nano, joe, vi and vim text editor.
Let me know if you want to add another text editor.

 CHECK ->
After you have edited and created the configuration files, you must check
if they are syntactically correct. This is the right place to do that.
All results will be displayed in a dialog box. 
If you have errors in the configuration files then q_checkcfg will 
return something like this: Error at line n (Unknown statement), 
where n is the line number in configuration file.

4) START/STOP
--------------
This is the main control of HTB-tools. From here you can start, stop
and restart HTB-tools on all interfaces in the same time, or you can 
start, stop and restart on different interfaces.

5) TRAFFIC
----------      
Q_show is used to watch real time traffic. Before starting to watch 
real time traffic, you can pass different options to q_show.
By default the -f and -i options are set.

6) UNINSTALL    
-------------
Using this, you can remove all the files from HTB-tools.

7) LOG          
--------
From here you can watch htb-tools.log file.
If the lines are too long, you can use the '->' key to 
see the entire line.

8) CHANGELOG
-------------
HTB-tools change log.

9) CREDITS
-----------
People who made HTB-tools.

--
arny <arny[at]arny[.]ro>
http://htb-tools.arny.ro
