HPT 1.4 manual

Highly Portable Tosser

An Overview on HPT

HPT is a Fidonet message tosser and packer with areafix, written by Matthias Tichy, 2:2432/645@fidonet. Now project supported by Max Levenkov, 2:5000/117@fidonet and Husky Development Team.

Features of HPT:

1. tossing packets of 2, 2.0 & 2+ types
2. supporting of Msg, Squish and Jam message bases
3. posting to net & echo areas
4. areafix (on the fly, from command line, limit for areas...)
5. autocreate on the fly
6. forward requests
7. pause and autopause for links
8. linking of net & echo areas
9. carbon copy
10. groups & levels for personal and public access to echo areas
11. powerful dupe checker
12. link defaults

The advantages of HPT is:

1. Open Source (GPL)
2. many supported platforms & operating systems
3. quick bug fixing

Installation Procedures and Release Notes

This chapter provides you with information that is necessary to successfully install and use HPT.

I suppose, that you already has compiled binaries. If not - read "Download" or "Compile the Source Code" chapters.

1. Read FIDOCONFIG documentation about location of config-file
2. Copy sample config files to config directory
3. Edit config files for your purposes
4. Run tparser from FIDOCONFIG package to test your config (read about PublicGroup or AccessGrp if you want to use groups for EchoAreas)
5. It is simply, isn't it? Enjoy! :-)

Download the Source Code & Binary Files

Main page (source code, win32 & os/2 releases) - http://husky.physcip.uni-stuttgart.de/hpt.html

Win32 bins (current, russian) - www.chat.ru/~sirevtov/files

Win32 bins (current, russian) - www.sirevtov.narod.ru

Compiling the Source Code

1. The smapi and fidoconf packages are required for hpt.

2. Put the fidoconfig ans smapi packages in the directory where the other packages of fido linux reside:

/usr/src/packages/

-> smapi/

-> hpt/

-> fidoconfig/

3. Compile and install smapi and fidoconf packages. Use "Makefile" for dynamic executables and makefile.lnx (or what you need) for static ones.

4. Compile and install hpt:

$ make

$ make install

You should use the _same_ makefiles in smapi, fidoconf and hpt.

Support, Contacting the Author, Reporting Bugs, Contributing Code

There are numerous reasons why you might wish to establish contact with me, the author of HPT.

1. You have decided to use HPT on a regular basis. In this case, please do send me an e-mail at the address listed below. How much time I will spend on developing HPT in the future will heavily depend on the number of mails I receive from users that tell me that they do use HPT.
2. You have a general questions on how to configure or on how to use a certain feature of HPT. In other words, you need support. In this case, you'd best post your question to one of the following echos:

   FIDOSOFT.HUSKY

   The international Husky conference. English is the preferred language here.

   RU.HUSKY

   This Russian echo covers Husky Project. I monitor it regularly.

   RU.ECHOPROCESSORS

   Russian talks about echoprocessors. I monitor it regularly.

   If you do not have access to any of these echos, you may of course also contact me via netmail or e-mail at the addresses listed below.
3. You want to report a bug. There are two sorts of bugs:
   1. Normal bugs. You think that a certain function of HPT does not work as expected, e.g. it is producing garbage, or doing strange things, or similar. In this case, either post to the echos listed above, or contact me via netmail. Please do supply all information that is necessary to understand your problem.
   2. Fatal bugs. A fatal bug occurs if HPT crashes. Depending on your operating system, the symptom might be a core dump, or a SYS 3175, or a general protection fault, or a system lockup, or a spontaneous reboot. I do consider a crash untolerable. No matter how stupid things you do, you should not be able to crash HPT. If you are experienced user and get core dump, you can send me gdb report. If you have a crash, locate `core' file that has been generated. Then run $ gdb hpt core, type where. HPT must be compiled with debug information (DEBUG=1 in `huskymak.cfg' file). Then send report to address below. If you are running any other binary version (like Windows), you will not get a core file on a crash. Write down as much information as you can, try to find a way to reproduce the crash and contact me at the addresses below.
4. You want to contribute to HPT. If you are a programmer and have fixed a problem in on your own, please submit your changes to me. The preferred way for doing so is to send me a difference file in GNU diff format (with -c parameter). Your work will be highly appreceated and honored in an appropriate place. If you want to regularly work on HPT, we also have a CVS server online that you can have access to if you like. If you want to write a new feature for HPT, please contact me beforehand to avoid that we do duplicate work. Again, I will appreciate and honor eny efforts done by you. Please note that for writing a HPT enhancement, you should be familiar with C. Also, HPT uses a special indentation style throughout the source code, that I would like you to adhere to.

So here are my addresses if you want to get in contact with me:

• Fidonet: Max Levenkov 2:5000/117
• e-mail: sackett@mail.ru

Credits

Thanks to:

1. Matthias Tichy (basic code)
2. Max Levenkov (areafix, group code, carbon copy, code clean up & speed up and more)
3. Tobias Ernst (some features, stable releases, cvs & www support)
4. Sacha M. Silbe (features, makefiles)
5. Kolya Nesterov (unpack, post, link)
6. Fedor Lizunkov (areafix, autocreate reports, group code, JAM code in SMAPI)
7. Serguei Revtov (win32 version support, hptlink, features & good patches)
8. Alexander Vernigora (dupe detection)
9. Pavel Gulchouk (Perl support, JAM & link hacking)
10. Alex Semenyaka (netmailExtern, processPkt)
11. Alex Bronin (win32 patches)
12. Nikolay Nestyurkin (makefiles)
13. Lev Serebryakov (new %list)
14. ... and all other people (sorry, if I've forget somebody)

P.S. all of this people makes bug fixes, so I don't mention it.

HPT 1.4 Configuration Reference

HPT based on FIDOCONFIG library, so read documentation of FIDOCONFIG about location of config file and keywords ideology.

Using config

HPT uses fidoconfig, but not all config statements references to hpt and hpt ignore all unused config statements. The Husky Fidonet Software project concepts is use one config for all fidonet programs.

Predefined config variables

In some cases need use different values for one statement in hpt, htick and/or other husky programs (called modules). It solve using config variable module: hpt define the module variable with value hpt and you may use if-elseif-else-endif conditions statements sequence like as:

if "[module]"=="hpt"
  Origin   High Portable Tosser at my node
elseif "[module]"=="htick"
  Origin   High Portable Ticker at my node
else
  Origin   My node
endif

HPT define config variable version with value set to hpt version like MAJOR.MINOR.PATHLEVEL, i.e. 1.4.1. You may use this variable too for make common config for several hpt versions.

To test config for hpt only you may call tparser tool with parameters -Dmodule=hpt and (if need) -Dversion=1.4.1 (tparser included into fidoconfig package) like this:

tparser -Dmodule=hpt
tparser -Dmodule=hpt -Dversion=1.4.1

Statements order

Common rule for config statements order is: Define object before ise it!.

Examples:

• define addresses before any link, area and carbone definitions
• define packers before any link definitions
• define links before any area and route definitions
• define links and areas before any carbone definitions

General Keywords

AddToSeen

Syntax:

addToSeen <addr> [<addr> ...]

Example:

addToSeen 99/100 99/101

Add <addr> to SEEN-BYs. If <addr> is present or not - it is always adds.

This statement can be repeated.

Address

Syntax:

Address <addr>

Example:

Address 2:2433/1245

This command specifies which akas your system has. This statement is full 5d compatible, which means you can have also addresses like 2:2433/1245.1@fidonet.org. The first address statement is your main aka which will be used by tossers on different occasions, for example if zone number could not be taken from the @INTL Kludge in netmails.

This statement can be repeated. The domain name is not full supported throughout fidoconfig

AfterUnpack

Syntax:

afterUnpack <string>

Example:

afterUnpack pktpack /home/fido/in.tmp/*.pkt

This <string> executes after unpacking arcmail bundle. You may process your pkt files in tempInbound directory with external utility.

This statement cannot be repeated.

AreafixFromPkt

Syntax:

areafixFromPkt <bool>

Example:

areafixFromPkt

Process areafix requests on the fly. Check "areafix", "areamgr" & "hpt" keywords in toUserName field. Request messages don't saves.

This statement cannot be repeated.

See section AreafixNames.

AreafixKillRequests

Syntax:

areafixKillRequests <bool>

Example:

areafixKillRequests

Delete requests from links to areafix.

This statement cannot be repeated.

AreafixMsgSize

Syntax:

areafixmsgsize <integer>

Example:

areafixmsgsize 20

This option set up maximum areafix message size (20 kb). If not defined, areafix reports will be not splitted...

This statement cannot be repeated.

AreafixNames

Syntax:

AreafixNames <string>

Example:

AreafixNames SqaFix, hptfix

Set additional names for areafix robot. Default is "areafix", "areamgr", "hpt".

This statement cannot be repeated.

AreafixFromName

Syntax:

AreafixFromName <string>

Example:

AreafixFromName "HPT AreaFix"

Use value from AreafixFromName in field From when responding on messages to areafix. If this token not defined, name in original message will be used. Example:

1) AreafixFromName not defined in config:

Original message to areafix:
----------------------------
From: Sysop
To: ArEaFiX

AreaFix's response:
-------------------
From: ArEaFiX
To: Sysop

2) AreafixFromName "HPT AreaFix"

Original message to areafix:
----------------------------
From: Sysop
To: ArEaFiX

AreaFix's response:
-------------------
From: HPT AreaFix
To: Sysop

Also this value is being used when creating reports by qrep command.

AreafixOrigin

Syntax:

areafixOrigin <string>

Example:

areafixOrigin c0()1 $tAt10n

the origin string in areafix reports will be like this: * Origin: c0()1 $tAt10n (<your addr>)

This statement cannot be repeated.

AreafixKillReports

Syntax:

AreafixReportsAttr <attr>

Example:

AreafixReportsAttr pvt,loc,kill

Set attributes to areafix reports.

Valid attributes are:

pvt

crash

read

sent

att

fwd

orphan

k/s

loc

fwd

xx2

frq

rrq

cpt

arq

urq

kfs

tfs

dir

imm

cfm

npd

Default is "pvt loc k/s npd".

This statement cannot be repeated.

AreafixSplitStr

Syntax:

areafixSplitStr <string>

Example:

areafixSplitStr > Message splitted. To be continued...

This string added after splitted areafix messages.

This statement cannot be repeated.

AreafixQueryReports

Syntax:

areafixQueryReports <bool>

Example:

areafixQueryReports off

This statement enables/disables including linked areas list into all areafix replies.

Default: off.

This statement cannot be repeated.

AreafixQueueFile

Syntax:

AreafixQueueFile <string>

Example:

areafixQueueFile /fido/datafiles

This command specifies the queue file containing your delayed forward-requests. Hpt must have read/write rights for this file. To use this feature run hpt qupd periodically.

This statement cannot be repeated.

AreasFileNameCase

Syntax:

areasFileNameCase (Lower|Upper)

Example:

areasFileNameCase Upper

This statement defines case of filemanes of autocreated areas. Default is lower case.

This statement cannot be repeated.

AutoAreaCreateFlag

Syntax:

autoareacreateflag <file>

Example:

autoareacreateflag /etc/ftn/flags/aac.flag

Create file-flag after autocreating echo area. This feature can be used for execute some scripts after tossing.

This statement cannot be repeated.

AutoPassive

Syntax:

autopassive <bool>

Example:

autopassive

If this statement defined, HPT will check for old bundles in every run. You can do it also with command line arg. "pause".

See section AutoPause.

This statement cannot be repeated.

BeforePack

Syntax:

beforePack <string>

Example:

beforePack pktpack /home/fido/out.tmp/*.pkt

This <string> executes before packing pkt files to arcmail bundles. You may process your pkt files in tempOutbound directory with external utility.

This statement cannot be repeated.

BundleNameStyle

Syntax:

bundleNameStyle <timeStamp | addrDiff | addrsCRC32 | addrDiffAlways | addrsCRC32Always | Amiga>

Example:

bundleNameStyle timeStamp

This statement sets rule for creating names of arcmail bundles:

timeStamp

some kind of random names (current time + some counter).

addrDiff

create name from difference of source and destination addreses. Always the same filename for every pair of links. Automatically switched to timeStamp when all alowed extensions were used.

addrsCRC32

create name from CRC32 of string composed from "hpt", source and destination addreses. Always the same filename for every pair of links, very unique. Automatically switched to timeStamp when all alowed extensions were used.

addrDiffAlways

the same as addrDiff but tryes to use lower free numbers of extension in case when all higher numbers are already busy.

addrsCRC32Always

the same as addrsCRC32 but tryes to use lower free numbers of extension in case when all higher numbers are already busy.

Amiga)

Amiga Style Outbound (ASO). Bundles creates in Outbound directory like this:

2.5000.117.1.hut
2.5000.117.1.mo0

If SeparateBundles on and Packer not defined pkt moves to 2.5000.117.1.sep directory. Extensions & prefixes in flo files creates as in addrDiffAlways algorythm.

Default value is timeStamp

This statement cannot be repeated.

See also See section LinkBundleNameStyle.

CreateAreasCase

Syntax:

createAreasCase (Lower|Upper)

Example:

createAreasCase Upper

This statement defines case of areanames in autocreation. Default is lower case.

This statement cannot be repeated.

CreateFwdNonPass

Syntax:

createFwdNonPass <bool>

Example:

createFwdNonPass

Autocreate non-passthru echoes in forward request operations. MsgBaseDir should be not passthrough!

This statement cannot be repeated.

DefArcmailSize

Syntax:

defarcmailsize <integer>

Example:

defarcmailsize 1024

default arcmail size in kb for all links. 500kb if not defined.

This statement cannot be repeated.

DisableTID

Syntax:

DisableTID <bool>

Example:

DisableTID

Don't add TID-line to scanned messages.

This statement cannot be repeated.

DisablePID

Syntax:

DisablePID <bool>

Example:

DisablePID

Don't add PID-line to generated messages.

This statement cannot be repeated.

ForwardRequestTimeout

Syntax:

ForwardRequestTimeout <number>

Example:

ForwardRequestTimeout 7

This statement specifies time to wait (in days) for echoarea requested from uplink. If there is no traffic in this echoarea, hpt qupd unsubscribes area from this uplink and subscribes to it at next uplink. If next uplink for this echoarea not avaiable, hpt qupd removes echoarea from queue.

To use this feature run hpt qupd daily.

Default is 7 days.

This statement cannot be repeated.

IdlePassthruTimeout

Syntax:

IdlePassthruTimeout <number>

Example:

IdlePassthruTimeout 3

This statement specifies time to wait (in days) before unsubscribing echoarea from uplink after the time last downlink unsubscribed (one uplink rest).

To use this feature run hpt qupd daily.

Default is 3 days.

This statement cannot be repeated.

IgnoreCapWord

Syntax:

IgnoreCapWord <bool>

Example:

IgnoreCapWord

Ignoring Capability Word in pkt files. If some pkt moved to bad. This may help, but not recommended. It is better to change old software.

This statement cannot be repeated.

IgnoreSeen

Syntax:

IgnoreSeen <addr> [<addr> ...]

Example:

IgnoreSeen 99/150

Ignore this SEEN-BY & pack mail for link. But no pack it back if the mail was from him.

This statement can be repeated.

KeepTrsFiles

Syntax:

keepTrsFiles <bool>

Example:

keepTrsFiles

Leave transit (routed) files in Inbound directory. If this statement is ommitted transit files wouldn't be kept. Default is "off".

File route possible with "Att" attribute in message header and file name in subject line.

This statement cannot be repeated.

See section RouteFile.

KeepTrsMail

Syntax:

keepTrsMail <bool>

Example:

keepTrsMail

Save transit messages in NetmailArea. If this statement is ommitted transit messages wouldn't be kept in NetmailArea. Default is "off".

This statement cannot be repeated.

KilledRequestTimeout

Syntax:

KilledRequestTimeout <number>

Example:

KilledRequestTimeout 4

This statement specified time wait (days) for delete from config echoarea after unsubscribe it from uplink (last link). Run hpt qupd daily for use this feature.

Default is 4 days.

This statement cannot be repeated.

KludgeAreaNetmail

Syntax:

kludgeAreaNetmail <kill | ignore | echomail>

Example:

kludgeAreaNetmail kill

Default is "kill"

If message started with "AREA:NETMAIL" we have three ways:

1. kill this kludge. process message as netmail. 2. ignore this kludge. process message as netmail. 3. process message as echomail.

This statement cannot be repeated.

LinkWithImportLog

Syntax:

linkWithImportLog <yes | no | kill>

Example:

linkWithImportLog yes

This statement specifies if the importlog-file should be used to determine which echomail areas need to be linked.

yes

importlog-file will be read. areas which are in importlog, will be linked. the importlog-file will not be erased.

kill

like yes, but the importlog-file will be killed after using it.

no

DEFAULT. all areas will be linked.

This statement cannot be repeated.

LogEchoToScreen

Syntax:

logEchoToScreen <bool>

Example:

logEchoToScreen

Set output to screen log messages.

This statement cannot be repeated.

LogLevels

Syntax:

loglevels <string>

Example:

loglevels 345789

In example we output to log messages with levels 3,4,5,7,8,9. The log levels are following:

The log levels are following:

1 - Program start, end;

2 - dupecheck

3 - linking messages

4 - scanning messages

5 - posting messages

6 - execute strings

7 - bundles, pkts, links, freqs, file routing, file attachs, msg packing

8 - areafix, relink, autocreate

9 - error messages (critical: exit on error)

0 - creation of file-flags

A - (reserved for) trivial error messages (print message and continue execution)

B - warnings & alerts

C - informational messages

D - (reserved for) statistics

E - summary

F - print program name & version

G - message send/sent

H - (reserved for) recoding operations & recoding tables read/write

I - Generate or check MSGID

J - Echomail phase

K - Filebox phase

L - Netmail phase

M - File create

N - File delete

O - operations with opened file (read, write, seek, ...)

P - Directory operations (create, delete, rename, ...)

R - Truncate file

S - File send/sent

T - Test files (exist, permittions, etc.)

U - Functions calls (enter to func & leave from it)

V - reserved

W - reserved

X - Filenames construct

Y - reserved

Z - debug messages: source lines (functions control points).

a-z - debug messages

Default value: 1234567890ABCDEF

This statement cannot be repeated.

Name

Syntax:

name <string>

Example:

name Leetebrok BBS

Here you specify your Systems name.

This statement cannot be repeated.

NetmailFlag

Syntax:

netmailFlag <file>

Example:

netmailFlag /etc/ftn/flags/netmail

Create file-flag after unpacking netmail msg. This feature can be used for execute netmail trackers after tossing.

This file also created after scannig NetmailArea without route definition. Scanning is stopped but file-flag created for netmail tracker.

This statement cannot be repeated.

NewAreaRefuseFile

Syntax:

newAreaRefuseFile <file>

Example:

newAreaRefuseFile /etc/ftn/areas/dontcrte.lst

This token defines a file which will be used when autocreating echoarea. File contains list of areas which we don't allow to autocreate. Each line of this file is a mask of echotag.

Example:

RU.LIST.CITYCAT.*

SU.KASCHENKO.LOCAL

This statement cannot be repeated.

NoProcessBundles

Syntax:

noProcessBundles <bool>

Example:

noProcessBundles

Don't unpack arcmail bundles.

This statement cannot be repeated.

Origin

Syntax:

origin <string>

Example:

origin mega cool station

Add this Origin to hpt messages: post, reports about new areas created, areafix (if no areafixOrigin defined).

This statement cannot be repeated.

Pack

Syntax:

Pack zip|tgz|rar|arc|arj|..... <call>

Example:

Pack zip zip -9 -g -q $a $f

This statement sets the command line call for the packer. The file will be moved into the archive, that means the file will be deleted on the harddisk. It only remains in the archive.

$a will be replaced by the archive file.

$f will be replaced by the file which should be packed into the archive.

This statement can be repeated.

Warning

You can't use shell input-output redirection chars under DOS or Win* platforms: hpt implementation uses workaround for command.com bug and doesn't run command.com to execute external commands such as packers/unpackers. hpt calls OS function to execute them instead of command.com.

PackNetMailOnScan

Syntax:

PackNetMailOnScan <bool>

Example:

PackNetMailOnScan off

When PackNetMailOnScan is "on" (default) hpt packs netmail when doing "hpt scan" and netmail area is found in EchoTossLog file. When it is "off" hpt leaves netmail area(s) in EchoTossLog file until "hpt pack" is invoked.

This statement can be repeated (overwrides old setting).

ProcessPkt

Syntax:

processPkt <string>

Example:

processPkt pktdate

The <string> willl be executed before tossing each pkt file. You are able to fix your pkts using pktdate or any other tool before tossing them. Note that pkt file may be renamed depending of tossingExt token value.

This statement cannot be repeated.

PublicGroup

Syntax:

PublicGroup <string>[,<string>,...]

Example:

PublicGroup local,a,b,othernet

This is a list of groups for public echo acess.

This statement cannot be repeated.

Remap

Syntax:

Remap <ToName>,<ToAddress>,<NewAddress>

Examples:

• Remap Max Levenkov,2:5000/117,2:5000/117.1\n
• Remap *,2:5000/117,2:5000/117.1
• Remap Max Levenkov,*,2:5000/117.1

Remap mail to other address. ToName OR ToAddress can be replaced with asterisk to match any value of ToName or ToAddress. Two asterisks can't be defined together. This statement does not touch TOPT & FMPT kludges.

This statement can be repeated.

ReportTo

Syntax:

ReportTo <string>

Example:

ReportTo netmail

Set name of echoarea or netmailarea for autocreate reports.

This statement cannot be repeated.

RobotsArea

Syntax:

robotsArea <string>

Example:

robotsArea SecondNetMail

This area used for areafix scanning. Replyes from areafix will be also stored here. RobotsArea must be NetmailArea for security purposes!

This statement cannot be repeated.

Route

Syntax:

route <flavour> <target> <linkWW> [<linkWW> ...]

Example:

route crash 2:2433/1245 2:2433/* 2:2432/*

This statement defines a route.

flavour:

1. hold (.hlo)
2. normal (.out)
3. crash (.clo)
4. direct (.dlo)
5. immediate (.ilo)

target:

1. <addr> - mail routed to this address
2. host - mail routed to zone:net/0.0 address
3. hub - hub-routing does not use the hubs defined in the nodelist but uses the nodes: addr - (addr.node %100). e.g.: a mail to node 2:2433/1245 is send to 2:2433/1200, but a mail to node 2:2433/355 is send to 2:2433/300 which currently does not exist. BE CAREFUL!
4. boss - mail routed to zone:net/node.0 address
5. no-route (noroute) - direct route according to current flavour
6. no-pack (nopack) - don't process this mail

linkWW is a dos pattern with ? and *.

Route statements are parsed in descending order: Pseudo-code:

  1) actual = first statement

  2) if linkWWW = msg-destination using pattern matching

  2a) take this routing and return

  2b) else actual = next statement

  3) jump to 2)

NOTE! This statement defined after "links" section.

This statement can be repeated.

RouteFile

Syntax:

routeFile <flavour> <target> <linkWW> [<linkWW> ...]

Example:

routeFile crash 2:2433/1245 2:2433/* 2:2432/*

This statement is the same as the Route statement, but considers only msgs with file attaches. Files are routed with netmail msgs. If no RouteFile defined, then files will be not routed at all!

This statement can be repeated.

RouteMail

Syntax:

routeMail <flavour> <target> <linkWW> [<linkWW> ...]

Example:

routeMail crash 2:2433/1245 2:2433/* 2:2432/*

This statement is the same as the Route statement.

This statement can be repeated.

ScreenLogLevels

Syntax:

screenloglevels <string>

Example:

screenloglevels 2345789

Set level of log output to screen. See loglevels for details

This statement cannot be repeated.

SeparateBundles

Syntax:

SeparateBundles <bool>

Example:

SeparateBundles

Move echomail for all links to his own directorys.

This statement cannot be repeated.

SetConsoleTitle

Syntax:

SetConsoleTitle <bool>

Example:

SetConsoleTitle

Set hpt console title while tossing. (WIN32 Only!)

This statement cannot be repeated.

Sysop

Syntax:

sysop <string>

Example:

sysop Matthias Tichy

You specify your name with this keyword.

This statement cannot be repeated.

TearLine

Syntax:

tearline <string>

Example:

tearline We Love HPT! :)

Add this tearline to hpt messages (post, reports about new areas created)

This statement cannot be repeated.

TossingExt

Syntax:

TossingExt [<string>]

Example:

TossingExt tos

Extension of bundle & packet files will be changed to <string> before tossing (and before processPkt string executed if set). That may be used for preventing of permanent tossing fault because of bad file in inbound. Default extension: tos. TossingExt without parameter disables files renaming in tossing.

This statement cannot be repeated.

Unpack

Syntax:

Unpack "<call>" <offset> <matchcode>

Example:

Unpack "unzip -joLqq $a -d $p" 0 504b0304

This statement sets the call of certain unpackers according to a id in the archive file

call: see pack

offset: position of recognition string in packed file.

match code: recognition string for packed file, ?? can be used as don't care

$a will be replaced by the archive file.

$p will be replaced by the temp inbound path.

$f will be replaced by the description file name if any (used by htick, see 'FileDescName' token)

e.g.: unpack "unzip -joLqq $a -d $p $f" 0 504b0304

       files packed by zip can be recognized by
         504b0304(hex) at offset 0(integer)
       they can be unpacked by
       "unzip -joLqq <filename> -d <path> <descrption_filename>"

This statement can be repeated.

Warning

You can't use shell input-output redirection chars under DOS or Win* platforms: hpt implementation uses workaround for command.com bug and doesn't run command.com to execute external commands such as packers/unpackers. hpt calls OS function to execute them instead of command.com.

Files and Paths

AdvisoryLock

Syntax:

AdvisoryLock <integer>

Example:

AdvisoryLock 10

If value AdvisoryLock > 0, then HPT checks if LockFile is locked by another session of HPT or not. Program will not be terminated if the original process which created LockFile is running. Second instance of hpt will check LockFile for locking number of times defined by AdvisoryLock with period of 1 second. And if the file exists, but not locked (stale), HPT will be running... If AdvisoryLock = 0, advisorylock is off.

This statement cannot be repeated.

Don't use this under BeOS! (there is no locking mechanism).

See section LockFile.

AdvStatisticsFile

Syntax:

AdvStatisticsFile <filename>

Example:

AdvStatisticsFile /home/val/fido/log/hpt.sta

Define binary statistic file for calculating links and echo trafic. Parsed by hpt/misc/adv-stat-hpt.pl

AreafixHelp

Syntax:

areafixhelp <file>

Example:

areafixhelp /etc/ftn/areafix.hlp

This is help file, which sends to link if he requests "%HELP".

This statement cannot be repeated.

AreasMaxDupeAge

Syntax:

areasMaxDupeAge <integer>

Example:

areasMaxDupeAge 10

Set maximum days for storing you hashes in CommonDupeBase. Default value is 5.

This statement cannot be repeated.

DupeBaseType

Syntax:

dupeBaseType <TextDupes | HashDupes | HashDupesWMsgId | CommonDupeBase>

Example:

dupeBaseType HashDupesWMsgId

TextDupes

stores from, to, subj & msgid as text lines.

HashDupes

stores src32 of from + to + subj + msgid.

HashDupesWMsgId

same as HashDupes, but stores also msgid as text.

CommonDupeBase

stores hashes of from + to + subj + areatag + msgid in one file (hpt_base.dpa)

Default is HashDupesWMsgId.

This statement cannot be repeated.

DupeHistoryDir

Syntax:

dupeHistoryDir <path>

Example:

dupeHistoryDir /var/spool/fido/dupes

This command specifies the path where the dupe history files are stored. The format and the names of the dupe-files are not standardized.

This statement cannot be repeated.

EchoTossLog

Syntax:

echotosslog <file>

Example:

echotosslog /var/spool/fido/echotoss.log

This statement specifies the file which is filled by a message editor or "hpt post" with the names of the areas where new netmails or echomails have been entered. Each line contains one areaname. When "hpt scan" is invoked, only echomail areas listed in this file will be scanned, when we start "hpt pack" - the same is for netmail areas. If area was processed, its name is removed from echotosslog file. When hpt has finished processing all listed areas and this file became empty, it is removed, otherwise kept for futher processing (maybe by other programs). If this file is not found - all areas will be scaned (depending on value of PackNetMailOnScan). See section PackNetMailOnScan, but if '-f' command line flag specified, scanning will stop. Filename after -f is optional. If it is not set, value of EchoTossLogFile will be taken from config, and from command line otherwise. If scanning from EchoTossLogFile did not make any area scanning, all areas will be processed (depending on 'scan' or 'pack' mode)

This statement cannot be repeated.

FileBoxesDir

Syntax:

FileBoxesDir <directory>

Example:

FileBoxesDir ../boxes

This statement specifies directory where link file boxes are placed (and created if necessary). Currnetly hpt creates file box names in form z.n.f.p (ex.: 2.5021.19.1). Trailing ".h" is added if link echomail flavour is "hold".

This statement cannot be repeated.

HptPerlFile

Syntax:

hptperlfile <file>

Example:

hptperlfile /etc/ftn/filter.pl

This statement specifies the file which contains perl filter functions. If not specified, perl support will be switched off.

This statement cannot be repeated.

ImportLog

Syntax:

importlog <file>

Example:

importlog /var/spool/fido/import.log

This statement specifies the file which a tosser fills with the names of the areas where echomails has been tossed in.

This statement cannot be repeated.

Inbound

Syntax:

inbound <path>

Example:

inbound /var/spool/fido/in

This command specifies where your inbound files are stored. This directory is the base directory which means if you have a connection which is not protected and the other system is not listed. The files go in here. Only non-packed netmails are tossed from this inbound.

This statement cannot be repeated.

Include

Syntax:

include <file>

Example:

include /etc/fido/areas

You can include other files into your config file. For example if you would like to have different config parts, you can include a file and (via cron job or manually) change the content of this file without changing the rest of the config. Additionally you can split your config in different parts. So you can have your fileareas definition in another file than your msgareas definition. This gives your the ability to have some survey about your config.

This statement can be repeated. But dont make recursive includes. eg include a file which includes another which includes the first. Although this will be detected and fixed many times, there is a chance that it will not be detected one time.

Intab

Syntax:

intab <file>

Example:

intab /var/spool/fido/recode/outaltkoi8

This statement specifies the file which should be used to recode the characters of the incoming messages from transport to internal charset. It is useful in russia. If you do not use this statement no recoding will be done.

This statement cannot be repeated.

LocalInbound

Syntax:

localinbound <path>

Example:

localinbound /var/spool/fido/in.loc

This command specifies the path, from which all types of netmail and echomail are tossed without any password checking. You can put pktīs here which were created by a file tosser etc. So created by a you or a programm on your own system.

This statement cannot be repeated.

LockFile

Syntax:

lockfile <file>

Example:

lockfile /var/lock/hpt.lock

Another session of HPT will be terminated if the LockFile is exists (default setting).

This statement cannot be repeated.

See section AdvisoryLock.

LogFileDir

Syntax:

logFileDir <path>

Example:

logFileDir /var/spool/log/fido

This command specifies the path where the log-files of the fido-programs should be stored.

This statement cannot be repeated.

MinDiskFreeSpace

Syntax:

MinDiskFreeSpace <integer>

Example:

MinDiskFreeSpace 10

This is the minimum disk free space in MB to run HPT. The following directories are checked: TempInbound, MsgBaseDir, LinkMsgBaseDirs.

This statement cannot be repeated.

MsgBaseDir

Syntax:

msgBaseDir <path>

Example:

msgBaseDir /var/spool/fido/msgb

This command specifies the path where msgBases of autocreated areas are stored. For example: if an area called LINUX.GER was autocreated and the msgBaseDir is /var/spool/fido/msgb the resulting msgBaseName is

/var/spool/fido/msgb/linux.ger.sqd

If you specify the msgbasedir as PASSTHROUGH, the areas will be created as passthrough areas.

This statement cannot be repeated.

See section LinkMsgBaseDir.

NotValidFileNameChars

Syntax:

NotValidFileNameChars <string>

Example:

NotValidFileNameChars :;<>=*?\/

This characters in message and dupebase filenames will be replaced with %hex analogs. If not defined, default string used: "*/:;<=>?\|%`'&+

This statement cannot be repeated.

Outbound

Syntax:

outbound <path>

Example:

outbound /var/spool/fido/out

This command specifies your outbound path. This outbound path is binkley-style. A binkley style outbound consists of a base path and subdirectories. Each subdirectory represents a place for all the files for one zone. The base path is the zone path for your base zone.

Example:

/var/spool/fido/out

This directory contains the files for your base zone.
/var/spool/fido/out.003

This directory contains the files for zone 3.
/var/spool/fido/out.00A

This directory contains the files for zone 10.

The zone directory contains the flow-files for each node. A Flow-file of a node has the name NNNNFFFF.?lo

NNNN

The 4-digit hex-number of the nodes netnumber.
FFFF

The 4-digit hex-number of the nodes nodenumber.
?

Here the flavour of the mails can be chosen. h-hold, c-crash,
f-normal, d-direct, i-immediate.

For points there is a subdirectory with nodes flowfilename with suffix.pnt. In this subdirectory the flowfiles have the names PPPPPPPP ( 8-digit point number in hex).

For a deeper background on a binkley-style outbound see the binkley-term documentation and source code.

This statement cannot be repeated.

Outtab

Syntax:

outtab <file>

Example:

outtab /var/spool/fido/recode/outkoi8alt

This statement specifies the file which should be used to recode the characters of the outgoing messages from internal to transport charset. It is useful in russia. If you do not use this statement no recoding will be done.

This statement cannot be repeated.

ProtInbound

Syntax:

protinbound <path>

Example:

protinbound /var/spool/fido/in.sec

This command specifies where files should be stored which were received during a password-protected session. All types of mail are tossed from this path. But passwords are checked before.

This statement cannot be repeated.

RulesDir

Syntax:

rulesdir <path>

Example:

rulesdir /home/ftn/rules

This statement specifies where areafix searches for files with echoarea rules which are sent to link via netmail when link is subscribed to areas. File name is the same as message base file with trailing ".rul" (and consistently .ru1-.ru9 files with additional information). Areaname is used when no message base file is set. See also NoRules statement to avoid areafix from sending rules to link.

This statement cannot be repeated.

StatLog

Syntax:

statlog <file>

Example:

statlog /var/spool/fido/stat.log

After tossing (hpt toss), it is checked if there is new personal mail (netmail or personal echo mail). If that's true, it is checked if statlog is defined in config. If yes, then it is checked if the log file exists. If not, then it is created and the number of received netmails or/and personal echo mails is written to the log file. Otherwise, if the file exists, the old counter will be read, added to the new counter and written the actual counter. The log file looks like this: netmail: x CC: x Whereas x is the number of mails. If the log file exists, one of the two or both lines exist.

This is for utils, which can show you how many personal mail you got. The log file is not removed by hpt, only by the util that uses it. Or you could write in your toss script something like this: if exist stat.log type stat.log if exist stat.log del stat.log>nul

This statement cannot be repeated.

TempInbound

Syntax:

tempinbound <path>

Example:

tempinbound /var/spool/fido/in.tmp

This command specifies a path which is used while tossing. The incoming packets are unpacked there.

This statement cannot be repeated.

TempOutbound

Syntax:

tempoutbound <path>

Example:

tempoutbound /var/spool/fido/out.tmp

This command specifies your temporary outbound path. It is used for storing outgoing pkt-files before packing.

This statement cannot be repeated.

Link Keywords

AccessGrp

Syntax:

accessgrp <string>[,<string>...]

Example:

accessgrp A,B,C,Local

This statement connects a link to several echomail groups. See also PublicGroup and -g <group> in echoarea options.

This statement can only be repeated for different links.

AdvancedAreafix

Syntax:

advancedareafix <bool>

Example:

advancedareafix on

If this statement is "on" and our system wants to detele area from remote config then unsubscribe messages to areafix robot of this link looks like "~areaname". The area on the remote system will be deleted from config file, if our system is allowed to delete this area ("allow area delete" in FastEcho, and LinkGrp must be the same as EchoArea's -g <group> in HPT).

Our system sends deleting command only for systems with AdvancedAreafix and only when default uplink (-def) unsubscribing from EchoArea or some link deleting this area by command "~areaname". Of course if this link has the rights to delete this area.

If this "AdvancedAreafix off" (default), then deleting command looks like "-areaname".

This statement can only be repeated for different links.

Aka

Syntax:

aka <addr>

Example:

aka 2:2433/1245

This statement sets the aka for the current link.

This statement can only be repeated for different links.

AllowEmptyPktPwd

Syntax:

allowEmptyPktPwd <off|secure|on>

Example:

allowEmptyPktPwd on

This flag is useful if you want to generate packet passwords for this link, but do not want to check the packet passwords that your link sends to you. This is sometimes necessary as a workaraound if your link sends you netmail packets without packet passwords, for example.

The default state is off. In this case the incoming packet password must match the packet password that you defined. This is the most secure option.

If you set this switch to secure, packets that do not contain a packet password and are received in the protected inbound will be processed. You can use this if your uplink sometimes sends you packets without packet passwords, as a workaround until the uplink has fixed his system. Still, if you receive packets with wrong packet passwords, they will be rejected.

The setting on works like the secure setting, with the difference that packets without packet passwords are allowed even in the unprotected inbound directory. It is not recommended to use this setting.

This statement can only be repeated for different links.

AllowPktAddrDiffer

Syntax:

allowPktAddrDiffer <bool>

Example:

allowPktAddrDiffer on

This keyword is useful if your link has more than one addresses, and therefore the address in PKT header of his areafix request may be different from the address in MSG header.

The default state if off: in this case such letters won't be processed by your areafix. The state on makes areafix ignore this error.

This statement can only be repeated for different links.

ArcmailSize

Syntax:

arcmailsize <integer>

Example:

arcmailsize 300

Maximum arcmail size in kb for this link. Default is 500kb.

This statement can only be repeated for different links.

ArcNetmail

Syntax:

arcnetmail <bool>

Example:

arcnetmail on

This keyword is useful if you want to compress netmail for this link and pack it into arcmail bundles or to filebox like echomail. Netmail will compress only if its flavour is equial with EchoMailFlavour for this link.

The default state if off: in this case netmail will be written to ut-file (i.e. *.?ut) and will not compressed.

This statement can only be repeated for different links.

Areafix

Syntax:

areafix <bool>

Example:

areafix off

By default areafix is "on". You can turn off using of areafix by this link.

This statement can only be repeated for different links.

AreafixEchoLimit

Syntax:

areafixecholimit <integer>

Example:

areafixecholimit 50

This is maximum echo areas which can be subscribed via areafix for this link.

This statement can only be repeated for different links.

AreafixPwd

Syntax:

areafixpwd [<string>]

Example:

areafixpwd geheim

This statement sets the areafix password for the actual link. An empty statement is allowed.

This statement can only be repeated for different links.

AutoAreaCreate

Syntax:

autoareacreate <bool>

Example:

autoareacreate on

This statement gives a link the permission to create areas on your system just by sending msgs in them. The echoarea is created using the AutoAreaCreateDefaults contents:

   EchoArea <areaName> <msgBaseDir><areaName> -a <mypktaddr> -b Squish <linkAddr> <autoAreaCreateDefaults>

Default message base type is Squish. But you can set "-b Jam" or "-b Msg" in AutoAreaCreateDefaults

This statement can only be repeated for different links.

AutoAreaCreateFile

Syntax:

autoAreaCreateFile <file>

Example:

autoAreaCreateFile /etc/fido/areas.matthias

This statement defines where autocreated areas by this link are going to. If you omit this statement the default configuration file will be used. The tosser must have the rights to create and change the file.

You must include the specified file for yourself into fidoconfig, so these autocreated areas will be found in subsequent tosser-runs.

autoAreaCreateFile and Include strings must be the *same*.

This statement can only be repeated for different links.

AutoAreaCreateDefaults

Syntax:

autoareacreatedefaults <string>

Example:

autoareacreatedefaults -$m 200 -dupecheck move

Set defaults to autocreated echoareas. To create PASSTHROUGH areas you can add "passthrough" to AutoAreaCreateDefaults.

This statement can only be repeated for different links.

AutoAreaCreateSubdirs

Syntax:

autoareacreatesubdirs <bool>

Example:

autoareacreatesubdirs on

This switch is turned off by default. When turned off, hpt will create a flat message base. This means that a file echo `FIDOSOFT.HUSKY' would be created in the message base directory with a base file name of `fidosoft.husky', like in `/var/spool/msgbase/fidosoft.husky.sqd' and so on.

When turned on, a structured message base will be created. Each dot in the echo name is treated as directory separator. Thus, `FIDOSOFT.HUSKY' would be created with a base name of `husky' in the `fidosoft' directory, e.g. `/var/spool/msgbase/fidosoft/husky.sqd'.

Please note that this option will not currently work if the -dosfile option is used to create filenames in 8.3 convention. See section EchoArea, for more information on the -dosfile option.

AutoPause

Syntax:

autopause <integer>

Example:

autopause 10

Stop export echomail for this link after 10 days (write Pause token to link section). It works when founding "10 days old" file for this link in Outbound directory with "#" and "^" prefixes.

Link unsubscribed from passrhough echo areas with no downlinks besides him. Unsubscribe request forwards to uplink. This doesn't works with manual "%PAUSE" via AreaFix.

AutoPause don't check FileBoxes!

This statement can only be repeated for different links.

See section AutoPassive.

AvailList

Syntax:

AvailList (Full|Unique|UniqueOne)

Example:

AvailList Full

This statement specify variant for reply to %avail command for current link:

RSB algorithm
-------------
1) add own system to the PATH.
2) all area links not contained in the RSB qualify as recipients.
3) strip RSB addresses not matching an address in the PATH, then
   add own address(es) to the RSB set if not already contained.
4) add recipients to RSB, sort RSB and forward mail to recipients.

EchoArea fidosoft.husky /var/spool/fido/msgb/fidosoft.husky -d "husky
develpment" 2:280/6207

This will internally be expanded to:

EchoArea fidosoft.husky /var/spool/fido/msgb/fidosoft.husky -d "husky
develpment" -b Squish -a 2:280/1507 -g F -dupeCheck move -dupehistory 11
-p 14 2:280/1126 2:280/6207

EchoArea evolution /var/spool/fido/msgb/evolution -d "about fantasies" -p 100

that will be expanded to:

EchoArea evolution /var/spool/fido/msgb/evolution -d "about fantasies"
-b Squish -a 2:280/1507 -g F -dupeCheck move -dupehistory 11 -p 100
2:280/1126

EchoAreaDefaults [OFF]

	ReadOnly 2:5021/19.* tver.sysop*
	ReadOnly 2:5021/19.1 !tver.sysop*
	ReadOnly 2:5021/19.2 !tver.sysop.talks

     CarbonCopy *my.mail
     CarbonMove *my.mail
     CarbonExtern *<command line>

CarbonFromArea Interuser
CarbonRule NOT
CarbonText " Israel "
CarbonCopy my.news

carbonKludge "REPLY: 2:5000/117 "

        CarbonText beatles
        CarbonRule NOT
        CarbonText bugs
        CarbonCopy my.mail

        CarbonText female
        CarbonRule NOT
        CarbonText connector
        CarbonRule OR
        CarbonSubj beer
        CarbonRule AND
        CarbonText drink
        CarbonText holliday
        CarbonCopy my.mail

        CarbonRule NOT
        CarbonText connector
        CarbonRule AND
        CarbonText female
        CarbonRule OR
        CarbonRule AND
        CarbonSubj beer
        CarbonText drink
        CarbonText holliday
        CarbonCopy my.mail