1\input texinfo @c -*-texinfo-*- 2@c %**start of header 3@setfilename bsopack.info 4@settitle BSOpack Manual 5@set VERSION 1.9 6@setchapternewpage odd 7@c %**end of header 8 9@ifinfo 10This file documents BSOpack @value{VERSION}. 11 12@end ifinfo 13 14@ifhtml 15This file documents BSOpack @value{VERSION}. 16 17@end ifhtml 18 19@titlepage 20@title BSOpack @value{VERSION} Manual 21@author Dmitry Sergienko 22 23@page 24@vskip 0pt plus 1filll 25Copyright @copyright{} 2000-2001 Dmitry Sergienko 26 27@end titlepage 28 29@ifinfo 30 31@dircategory Fidonet Software 32@direntry 33* BSOpack: (bsopack). Binkley-Style outbound netmail packer. 34@end direntry 35 36@node Top, , , (dir) 37@top bsopack 38 39This document applies to version @value{VERSION} of BSOpack. 40 41@end ifinfo 42 43@ifhtml 44 45@dircategory Fidonet Software 46@direntry 47* BSOpack: (bsopack). Binkley-Style outbound netmail packer. 48@end direntry 49 50@node Top, , , (dir) 51@top bsopack 52 53This document applies to version @value{VERSION} of BSOpack. 54 55@end ifhtml 56 57@menu 58* Introduction:: 59* FidoConfig:: 60* Command line switches:: 61* How this program works:: 62* Feedback:: 63@end menu 64 65@node Introduction, FidoConfig, Top, Top 66@chapter Introdusing BSOpack 67BSOpack is used to pack outgoing netmail for links. It is a part of 68@emph{HUSKY} project and requires its files. 69You should use @code{fidoconfig 0.15} or more recent. If you don't have these 70packages, download them from @url{http://husky.sourceforge.net/} 71 72 73@node FidoConfig, Command line switches, Introduction, Top 74@chapter FidoConfig keywords and configuration 75 76@menu 77* packNetmail:: 78* maxUnpackedNetmail:: 79* sample:: 80@end menu 81 82@node packNetmail, maxUnpackedNetmail, FidoConfig, FidoConfig 83@section packNetmail 84@table @asis 85@item Syntax: 86@code{packNetmail <bool>} 87@item Example: 88@code{packNetmail on} 89@item Default: 90@code{packNetmail off} 91@end table 92 93 Determines if you want to pack outgoing netmail for this link. 94Used only in link definition. 95 96Attention: If you use @code{packNetmail on} - you must define a packer for this 97link. 98 99This statement can only be repeated for different links. 100 101 102@node maxUnpackedNetmail, sample, packNetmail, FidoConfig 103@section maxUnpackedNetmail 104@table @asis 105@item Syntax: 106@code{maxUnpackedNetmail <integer>} 107@item Example: 108@code{maxUnpackedNetmail 0} 109@item Default: 110@code{maxUnpackedNetmail 20} 111@end table 112 113 Determines how much unpacked netmail in kilobytes we should leave for 114this link. If we have more outgoing netmail - it will be packed into bundles. 115You also can have packed & unpacked netmail in your outbound 116simultaneously - packet, which had had size more than @code{maxUnpackedNetmail} 117was packed into bundle and new packed with size less than 118@code{maxUnpackedNetmail} was created. 119If you select 0 kb - all netmail will be packed. 120 121@node sample, , maxUnpackedNetmail, FidoConfig 122@section Sample link definition 123 124@example 125Link Dmitry Sergienko 126AKA 2:464/910 127ourAka 2:464/910.1 128Password xxxxxxxx 129autoAreaCreate on 130autoFileCreate on 131forwardRequests on 132AutoAreaCreateDefaults -p 14 -dupeCheck move -dupeHistory 11 133Packer zip 134allowEmptyPktPwd on 135packNetmail on 136maxUnpackedNetmail 0 137@end example 138 139@node Command line switches, How this program works, FidoConfig, Top 140@chapter Command line switches 141@table @asis 142@item Usage: 143@code{bsopack [-c fidconfig] [options]} 144@item Options: 145@code{-q} Quiet mode (ignoring screenLogLevels in fidoconfig) 146@item 147@code{-h} Help screen 148@item 149@code{--help} The same as @code{-h} 150@item Example: 151@code{bsopack -qc /etc/fido/config} 152@end table 153 154@node How this program works, Feedback, Command line switches, Top 155@chapter How this program works 156 157At first it checks if @code{packNetmail} for link is on, this link is not busy 158and a packer is defined. Then it searches for *.?ut files in the outbound. If 159the size of all found *.?ut is greater than maxUnpackedNetmail, these files 160will be renamed to *.pkt (using @code{tempOutbound} token) and put into an 161arcmail bundle. Thus, your mail should never be lost. If any error occurs hpt 162scan will find this packet and (if this packet is for a link listed in 163fidoconfig) pack it into a bundle with echomail. The packet will be added to 164the most recently used bundle until the size of the bundle is more than 165@code{arcmailSize} for the link. 166If you select @code{bundleNameStyle addrDiff} your netmail will be 167packed together with echomail. Each flavour is processed independently. 168It creates bundle names using an algorithm of two addresses differences. 169The log file @code{bsopack.log} is located in @code{logFileDir} directory. 170 171Thanx to Kees Bergwerf <c.bergwerf@@hccnet.nl> for OS/2 porting. 172Thanx to Oleg W Levchenko (2:6035/6) for testing. 173Thanx to Max Chernogor (2:464/108) for MSVC compiler support. 174 175 176@node Feedback, , How this program works, Top 177@chapter Contacting the author 178 179@table @asis 180@item Author: 181@code{Dmitry Sergienko} 182@item E-mail: 183@email{trooper@@email.dp.ua} 184@item FidoNet: 185@code{2:464/910} 186@item ICQ: 187@code{38304000} 188@end table 189 190FidoNet conferences: 191 192@example 193ru.husky (Russian) 194fidosoft.husky (English) 195@end example 196 197@bye 198