
THIS PROGRAM IS CURRENTLY INCOMPLETE

It:
1. Lists all entries in WFBID.SYS
2. Searches WFBID.SYS for any given MID/BID
3. Builds a new WFBID.SYS from the current message list in DIRMES.SYS

                     Documentation for BID-TOOL (XFBB)
                    by Stewart Wilkinson G0LGS Sysop GB7LGS
                    ---------------------------------------

COPYRIGHT

This software is Copyright (c) 2000 - 2005 by Stewart Wilkinson G0LGS.

Distribution and use of this software is permitted provided that all
copies retain the above copyright notice and the Warranty disclaimer below

WARRANTY

THIS SOFTWARE IS PROVIDED BY THE AUTHOR `AS IS' AND ANY EXPRESS OR IMPLIED
WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN
NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

IMPORTANT

Please ensure you read the whole of this README document before using the
program, failure to do so could leave you with an unusable XFBB system.

INTRODUCTION

This software was written for use on systems using the Linux F6FBB BBS
software V7.01 and later. (However it may also work with V7.00 - see
later).

WHAT DOES IT DO

BID-TOOL performs various checks on the XFBB MID/BID database and will
remove invalid & corrupted entries (when used with appropriate command
line arguments/options).

PRECAUTIONS

As BID-TOOL manipulates 'wfbid.sys' which is essential to the correct
operation of FBB, it is highly recommended that you make a backup copy of
'wfbid.sys' before you use the program. This will ensure that should the
power fail or some other unforeseen event occur during the few moments the
program takes to do its work you will be able to restore the system to
normal operation.

As a further precaution to try and prevent corruption of the FBB system
files, once the process has started the program will silently ignore the
SIGINT (and CTRL-C) signals.

WARNINGS

Although this program has been tested by the author on GB7LGS it is
provided with no warranty, guarantee or even possibility that it will work
for you on your system or in your configuration. The author will not be
responsible for any damages that may be caused by the use of this program.

The program makes changes directly to 'wfbid.sys' and so should NOT
under any circumstances be used whilst FBB is active.

The program will attempt to check if FBB is currently active, it should
refuse to continue if it finds any active processes of 'xfbbd' or 'xfbb'.

Note: The program uses the linux program 'pidof' to perform this check, if
'pidof' is not available (on the current PATH) the program will exit with
the message 'Unable to determine if XFBB is active.'




USING THE PROGRAM

After closing XFBB and backing up the important FBB files you can simply
start the program with a command line like:

	bid-tool                   : Display Help
	bid-tool --help            : & exit.

	bid-tool --version         : Display Version & exit.

	bid-tool [options] --check : Report on what would be done.

	bid-tool --tidy            : Remove empty / invalid entries.

	bid-tool [options] --verbose : Be more Verbose.

	Some options may be combined (ie: --tidy and --clean).

The program reads the information it requires from your fbb.conf and will
perform some initial checks on 'wfbid.sys' before it attempts to make any
changes.

Note: When the program is started using any option that might cause
changes to be made the original 'wfbid.sys' will first be copied to
'wfbid.old' - if the program cannot complete this process it should simply
refuse to continue.

USING BID-TOOL DURING FBB's DAILY MAINTENANCE CYCLE.

Once you are happy that the program works satisfactorily and with no
unwanted side effects on your system you might want to run the program as
part of the FBB daily maintainance cycle.

To do this you might install the program in /usr/lib/fbb/tool and create
yourself a suitable script in /usr/lib/fbb/script/maintenance that calls
the program with appropriate parameters.


USING with XFBB V7.00

Whilst the program has not been tested with XFBB 7.00, I believe It should
work correctly if you create a /etc/ax25/fbb.conf file with at least the 
following lines:

	# Path to find wfbid.sys
	data = /var/ax25/fbb

	# Path to config dir (if fbb.conf is not in /etc/ax25)
	conf = /etc/fbb

	where /var/ax25/fbb is replaced with the path where your
	'wfbid.sys' file resides (ie: /home/xfbb).

---
Stewart G0LGS
Sysop GB7LGS
