This file documents BSOpack 0.2.

bsopack
*******

This document applies to version 0.2 of BSOpack.

Introdusing BSOpack
*******************

BSOpack is used to pack outgoing netmail for links. It is a part of HUSKY project and requires its files. You should use fidoconfig 0.10c or more recent. If you don't have these packages, download them from http://husky.physcip.uni-stuttgart.de/

FidoConfig keywords and configuration
*************************************

packNetmail
===========

Syntax:
     packNetmail <bool>

Example:
     packNetmail on

Default:
     packNetmail off

Determines if you want to pack outgoing netmail for this link. Used only in link definition.

Attention: If you use packNetmail on - you must define a packer for this link.

This statement can only be repeated for different links.

maxUnpackedNetmail
==================

Syntax:
     maxUnpackedNetmail <integer>

Example:
     maxUnpackedNetmail 0

Default:
     maxUnpackedNetmail 20

Determines how much unpacked netmail in kilobytes we should leave for this link. If we have more outgoing netmail - it will be packed into bundles. You also can have packed & unpacked netmail in your outbound simultaneously - packet, which had had size more than maxUnpackedNetmail was packed into bundle and new packed with size less than maxUnpackedNetmail was created. If you select 0 kb - all netmail will be packed.

Sample link definition
======================

     Link            Dmitry Sergienko
     AKA             2:464/910
     ourAka          2:464/910.1
     Password        xxxxxxxx
     autoAreaCreate  on
     autoFileCreate  on
     forwardRequests on
     AutoAreaCreateDefaults -p 14 -dupeCheck move -dupeHistory 11
     Packer          zip
     allowEmptyPktPwd on
     packNetmail on
     maxUnpackedNetmail 0

Command line switches
*********************

Usage:
     bsopack [-c fidconfig] [options]

Options:
     -q  Quiet mode (ignoring screenLogLevels in fidoconfig)

     -h  Help screen

     --help The same as -h

Example:
     bsopack -qc /etc/fido/config

How this program works
**********************

At first it checks if packNetmail for link is on, this link is not busy and a packer is defined. Then it searches for *.?ut files in the outbound. If the size of all found *.?ut is greater than maxUnpackedNetmail, these files will be renamed to *.pkt (using tempOutbound token) and put into an arcmail bundle. Thus, your mail should never be lost. If any error occurs hpt scan will find this packet and (if this packet is for a link listed in fidoconfig) pack it into a bundle with echomail. The packet will be added to the most recently used bundle until the size of the bundle is more than arcmailSize for the link. If you select bundleNameStyle addrDiff your netmail will be packed together with echomail. Each flavour is processed independently. It creates bundle names using an algorithm of two addresses differences. The log file bsopack.log is located in logFileDir directory.

Contacting the author
*********************

Author:
     Dmitry Sergienko

E-mail:
     trooper@email.dp.ua

FidoNet:
     2:464/910

ICQ:
     38304000

FidoNet conferences:

     ru.husky (Russian)
     fidosoft.husky (English)