HTICK 1.4 - Husky Ticker

Next: Overview, Previous: (dir), Up: (dir)

HTICK

This document describes HTICK 1.4, a Fidonet Fileecho Processor for OS/2, Windows, BeOS and Unix clones.

Next: Installation, Previous: Top, Up: Top

1 An Overview of HTICK

HTICK is a Fidonet fileareas tosser with filefix. Now project is being supported by Husky Development Team (see http://husk.sf.net/team.html).

HTICK features:

Tossing fileareas.
Filefix (on the fly, from command line, limit for areas...).
Autocreate on the fly.
Automatic forwarding of requests for missing areas to the uplinks.
Switching areas into passive (send-only) and back into active mode.
Resending files from passthrough and none passthrough fileareas.
Groups & levels for personal and public access to fileareas.
Security check of tossgroup.
Link defaults.
Posting to net & echo areas.
Flexible file announcements via echo or netmail messages. Wildcards in filearea tags allow easy configuration of multiple announcement areas for different groups of fileareas.
Save announcements to disk, so you are protected from losing announcements because of critical HTICK termination (insufficient disk space, ^Break pressed, power off etc).
much, much more :)

The advantages of HTICK are:

Open Source (GPL)
Many supported platforms & operating systems
Quick bug fixing

Next: Download, Previous: Overview, Up: Top

2 Installation Procedures and Release Notes

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

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

Read FIDOCONFIG documentation about location of config files
Edit config files for your purposes
Run tparser from FIDOCONFIG package to test your config (read about PublicGroup or AccessGrp if you want to use groups for FileEchoAreas)
It is simply, isn't it? Enjoy! :-)

Next: Compiling, Previous: Installation, Up: Installation

2.1 Download the Source Code & Binary Files

Main page (releases, source code, latest beta versions) - http://husky.sf.net/htick.html
Direct link to 'stable' branch sources: http://husky.sf.net/cvs2/stable/
Direct link to 'current' (development) branch sources: http://husky.sf.net/cvs2/current/

Next: Support, Previous: Download, Up: Installation

2.2 Compiling the Source Code

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

2. Put the fidoconf and smapi packages to the directory where the other packages of fido linux reside:

/usr/src/packages/
-> smapi/
-> fidoconfig/
-> htick/

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 HTICK:

$ make
$ make install

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

Next: Command Line, Previous: Compiling, Up: Installation

2.3 Support

There are numerous reasons why you might wish to establish contact with developers.

You have decided to use HTICK on a regular basis. In this case, please do send a netmail at the address listed below.
You have a general questions on how to configure or on how to use a certain feature of HTICK. 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.

If you have access to Internet, you may of course post your support request or bug report into form on husky development site: http://sourceforge.net/projects/husky, click the "Bugs" link if you want to post a bug report.
If you do not have access to any of these echos and internet, you may of course also contact developers via netmail or e-mail at the addresses listed below.
You want to report a bug. There are two sorts of bugs:
1. Normal bugs. You think that a certain function of HTICK 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, bugrack on site or contact developers via netmail. Please do supply all information that is necessary to understand your problem.
2. Fatal bugs. A fatal bug occurs if HTICK 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. We do consider a crash untolerable. No matter how stupid things you do, you should not be able to crash HTICK.
  If you are experienced user and get core dump, you can send developers gdb report. If you have a crash, locate core file that has been generated. Then run $ gdb htick core, type where. HTICK must be compiled with debug information (DEBUG=1 in huskymak.cfg file). Then send report to addresses 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 autors at the addresses below. Please attach log-file with loglevels 1-0A-Za-z (all numbers and letters).
You want to contribute to HTICK. If you are a programmer and have fixed a problem in HTICK on your own, please submit your changes to me. The preferred way for doing so is to send to developers a difference file in GNU diff format (with -c parameter). Your work will be highly appreciated and honored in an appropriate place. If you want to regularly work on HTICK, 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 HTICK, please contact developers beforehand to avoid that we do duplicate work. Again, we will appreciate and honor any efforts done by you. Please note that for writing a HTICK enhancement, you should be familiar with C. Also, HTICK uses a special indentation style throughout the source code, that we would like you to adhere to.

So here are developers' addresses if you want to get in contact with us:

Fidonet: Max Chernogor @ 2:464/108
e-mail: mche@ua.fm

Fidonet: Stas Degteff @ 2:5080/102
e-mail: stas_degteff@users.sf.net

Next: Configuration Reference, Previous: Support, Up: Top

3 HTICK 1.4 Command Line OPTIONS and SWITCHES

To get help about the command line syntax use HTICK without any arguments

Syntax:

htick [options] <command>

where <command> is:

toss

Reading *.tic and tossing files

scan

ffix

Scanning Netmail area for mails to filefix and process filefix command

ffix <FTN address> <filefix command>

Process filefix command command from command line

ffix! <FTN address> <filefix command>

Does the same job as 'ffix' and send subscride/unsubscribe letter to link that was manualy subscribed/unsubscribed by filefix command like: htick ffix! 2:464/910 -910.TEST This command remove file echo link 2:464/910 from 910.TEST and produce letter to 2:464/910 with body "-910.TEST"

clean

Clean passthrough dir (remove sent files) and remove old files in fileechos

announce

Announce new files as defined in Ann* config statements (See See Announce System.)

hatch <file> <area> [replace [<filemask>]] [desc [<desc>] [<ldesc>]]

Hatch file into Area using Description for file; if "replace" exists then fill replace field in TIC; if <filemask> doesn't exist then put <file> in field. Desc's parameters may be:

@BBS: to load description from files.bbs
@DIZ: to load description from the contained File_Id.Diz
@<file>: to load description from <file>
@@BBS: to use first line from Files.Bbs
@@DIZ: to use first line from the contained File_Id.Diz
@@<file>: to use first line from <file>

send <file> <filearea> <address>

Send file from filearea to address

filelist <file> [<dirlist>]

Generate filelist containing all files in base.

<file> filename to write output to.
<dirlist> list of files' which should be included into filelist paths.

Next: Keywords, Previous: Command Line, Up: Top

4 HTICK 1.4 Configuration Reference

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

Next: FileAreaBaseDir, Previous: Configuration Reference, Up: Configuration Reference

4.1 Keywords

FileAreaBaseDir: Base directory for FileAreas.
PassFileAreaDir: In this directory shall be put files from Passthrough Fileareas.
FileDescPos: Indent position for long descriptions in FILES.BSS.
fileLDescString: Prefix string for long descriptions in FILES.BBS.
FileFixHelp: Help file for FileFix.
FileArea: Filearea definition.
ExecOnFile: Execute some command on receiving file.
SaveTic: Save files with tics.
MaxTicLineLength: Set maximum line length in outgoing TICs to number.
BusyFileDir: Where shall be put TICs for busy links.
ConvertLongNames: What to do with long names when toss or hatch.
ConvertShortNames: What to do with short names when toss or hatch.
addDLC: Add Download counters to FILES.BBS.
DLCDigits: How much digits DLC must be.
ticOutbound: TICs are stored here and killed after transmission.
filefixKillRequests: Kill filefix request after processing.
filefixReportsAttr: Set kill/sent flag to filefix replies.
BBSarea: Filearea without subscribing (for `htick filelist`).
fileDescName: If no LDESC is defined in tic file, use <name> file from archive to fill it.
FileAreaCreatePerms: Set permissions for newly created filearea directories.
FileFixFromName: Originator name in filefix replies.
AutoFileCreateFlag: Create flag when filearea has been autocreated.
FileFixNames: Set of names on which FileFix will respond.

Next: PassFileAreaDir, Previous: Keywords, Up: Keywords

4.1.1 FileAreaBaseDir

Syntax:: FileAreaBaseDir <directory>
Example:: FileAreaBaseDir /var/spool/fido/fileareas

Where the directories for all Fileareas shall be made at autocreate. Same as MsgBaseDir.

This statement cannot be repeated.

Next: FileDescPos, Previous: FileAreaBaseDir, Up: Keywords

4.1.2 PassFileAreaDir

Syntax:: PassFileAreaDir <directory>
Example:: PassFileAreaDir /var/spool/fido/transit

Where shall be put files from Passthrough Fileareas (and TICs, if ticOutbound is not defined).

This statement cannot be repeated.

Next: fileLDescString, Previous: PassFileAreaDir, Up: Keywords

4.1.3 FileDescPos

Syntax:: FileDescPos <number>
Example:: FileDescPos 13

The number of spaces to indent long descriptions in FILES.BBS. Recommend: 13 (8.3+space)

This statement cannot be repeated.

Next: FileFixHelp, Previous: FileDescPos, Up: Keywords

4.1.4 fileLDescString

Syntax:: fileLDescString <string>
Example:: fileLDescString ">"

This string is put before long descriptions in FILES.BBS (Usually ">" or "+".). Default value: single space.

This statement cannot be repeated.

Next: ExecOnFile, Previous: fileLDescString, Up: Keywords

4.1.5 FileFixHelp

Syntax:: FileFixHelp <string>
Example:: FileFixHelp /usr/local/fido/filefix.hlp

Help file for FileFix, same as AreaFixHelp for HPT's AreaFix

This statement cannot be repeated.

Next: SaveTic, Previous: FileFixHelp, Up: Keywords

4.1.6 ExecOnFile

Syntax:: ExecOnFile <filearea> <filemask> <command>
Example:: ExecOnFile husky *.diff /usr/local/fido/update_source.sh

Execute some command on receiving file. Command gets full filepath as parameter (space and file pathname should be appended to command string before execution).

This statement can be repeated.

Next: MaxTicLineLength, Previous: ExecOnFile, Up: Keywords

4.1.7 SaveTic

Syntax:: SaveTic <FileEchoMask> <FileOption> <DirToSaveTic>
Example:: SaveTic husky -l /usr/local/husky

<DirToSaveTic>

where to put TIC for fileecho[s] <FileEchoMask>

<FileOption>

save files with tics. May be:

empty: files will not be copied

-l: link files from fileechodir to <DirToSaveTic>
-c: copy files from fileechodir to <DirToSaveTic>

Options -l and -c work only for non-Passthrough fileechos

This statement can be repeated.

Next: BusyFileDir, Previous: SaveTic, Up: Keywords

4.1.8 MaxTicLineLength

Syntax:: MaxTicLineLength <number>
Example:: MaxTicLineLength 79

Set maximum line length in outgoing TICs to number.

This statement cannot be repeated.

Next: ConvertLongNames, Previous: MaxTicLineLength, Up: Keywords

4.1.9 BusyFileDir

Syntax:: BusyFileDir <directory>
Example:: BusyFileDir /var/spool/fido/htick.busy/

Where shall be put TICs for busy links (default <outbound>/busy.htk).

This statement cannot be repeated.

Next: ConvertShortNames, Previous: BusyFileDir, Up: Keywords

4.1.10 ConvertLongNames

Syntax:: ConvertLongNames <Upper|Lower|DontTouch>
Example:: ConvertLongNames DontTouch

What to do with long names when toss or hatch. Saying 'long name' we mean a mixed cased name or a name longer than 8.3

This statement cannot be repeated.

Next: addDLC, Previous: ConvertLongNames, Up: Keywords

4.1.11 ConvertShortNames

Syntax:: ConvertShortNames <Upper|Lower|DontTouch>
Example:: ConvertShortNames DontTouch

What to do with short names when toss or hatch. Saying 'short name' we mean a DOS-like name: 8.3, without mixed case.

This statement cannot be repeated.

Next: DLCDigits, Previous: ConvertShortNames, Up: Keywords

4.1.12 addDLC

Syntax:: addDLC <bool>
Example:: addDLC yes

Add Download counters ([000]) to files.bbs. Use with DLCDigits only!

This statement cannot be repeated.

Next: ticOutbound, Previous: addDLC, Up: Keywords

4.1.13 DLCDigits

Syntax:: DLCDigits <number>
Example:: DLCDigits 4

How much digits DLC must be. DLC has [000] form.

This statement cannot be repeated.

Next: filefixKillRequests, Previous: DLCDigits, Up: Keywords

4.1.14 ticOutbound

Syntax:: ticOutbound <directory>
Example:: ticOutbound /var/spool/fido/ticOub

TICs are stored here and killed after transmission. Default: use PassFileAreaDir value

This statement cannot be repeated.

Next: filefixReportsAttr, Previous: ticOutbound, Up: Keywords

4.1.15 filefixKillRequests

Syntax:: filefixKillRequests <bool>
Example:: filefixKillRequests yes

Kill filefix request after processing.

This statement cannot be repeated.

Next: BBSarea, Previous: filefixKillRequests, Up: Keywords

4.1.16 filefixReportsAttr

Syntax:: filefixReportsAttr <attr>
Example:: filefixReportsAttr pvt,kill,loc

Set flags to filefix replies.

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.

Next: fileDescName, Previous: filefixReportsAttr, Up: Keywords

4.1.17 BBSarea

Syntax:: BBSarea <name> <bbsareapath>
Example:: bbsarea bbs /var/spool/fido/bbsareas/bbs

Filearea without subscribing, not shown in filefix reports. Use for filelist generation only (`htick filelist` command).

This statement cannot be repeated.

Next: FileAreaCreatePerms, Previous: BBSarea, Up: Keywords

4.1.18 fileDescName

Syntax:: fileDescName <name>
Example:: fileDescName file_id.diz

If LDESC is not defined in tic file, use <name> file from archive to fill it (usually file_id.diz).

This statement can be repeated.

4.1.19 Note

unpack action should be defined for archive and contain $f parameter ($f is replaced with file name while unpacking).

Examples:

     Unpack  "/path/to/unrar e -y -c- -o+ -inul $a $p $f"   0 52617221 # *.rar
     Unpack  "d:\path\unrar  e -y -c- -o+ -inul $a $p $f"  28 52534658 # rar-sfx/DOS
     Unpack "\path\pkzipc -ext -dir=none -over=all -nozip -silent $a $p $f" 0 504b0304
     Unpack "unzip -joLqq $a -d $p" 0 504b0304
     Unpack "pkunzip -njCL $a -d $p $f" 0 504b0304
     Unpack "pkzip25 -ext -silent -over=all -nofix -nozip $a $p $f" 0

Next: FileFixFromName, Previous: fileDescName, Up: Keywords

4.1.20 FileAreaCreatePerms

Syntax:: FileAreaCreatePerms <mode>
Example:: FileAreaCreatePerms 644

Define permissions for newly created filearea directories (UNIX only)

This statement cannot be repeated.

Next: AutoFileCreateFlag, Previous: FileAreaCreatePerms, Up: Keywords

4.1.21 FileFixFromName

Syntax:: FileFixFromName <string>
Example:: FileFixFromName FileFix

Originator name in filefix replies.

This statement cannot be repeated.

Next: FileFixNames, Previous: FileFixFromName, Up: Keywords

4.1.22 AutoFileCreateFlag

Syntax:: AutoFileCreateFlag <file>
Example:: AutoFileCreateFlag /usr/local/fido/flags/new_filearea

Create flag when filearea has been autocreated.

This statement cannot be repeated.

Next: Link Keywords, Previous: AutoFileCreateFlag, Up: Keywords

4.1.23 FileFixNames

Syntax:: FileFixNames <string>
Example:: FileFixNames allfix filefix htick

Set of names separated by space on which FileFix will respond

This statement cannot be repeated.

Next: fileEchoFlavour, Previous: FileFixNames, Up: Configuration Reference

4.2 Link Keywords

fileEchoFlavour: This statement sets the flavour which outgoing files in fileechos for this link get.
fileAreaDefaults: Set defaults for filearea definitions that follow.
RemoteFileRobotName: Name of remote filefix robot (need for FileForwardRequest).
FileFix: filefix access for this link
FileFixEchoLimit: Area subscription limit.
noTIC: Disable TIC file creation.
autoFileCreate: Allow or deny autocreating fileechos received from this link.
AutoFileCreateFile: Specifies the file new filearea will be placed into.
AutoFileCreateDefaults: Specifies the new filearea defaults.
AutoFileCreateSubdirs: Whether to autocreate areas like /fils/gfd.app.edit (off) or /files/gfd/app/edit (on).
delNotReceivedTIC: If file not received then remove TIC.
FileFixFSC87Subset: This boolean switch will change on a per link basis how TIC files are processed.
TickerPackToBox: If link has file box - toss files and tics there.
LinkFileBaseDir: Where autocreated fileareas will be placed.
ForwardFileRequests: Allow fileareas subscribe requests to be forwarded to link.
ForwardFilePriority: Priority in uplinks order for filearea subscribing forward-requests.
ForwardFileRequestFile: List of available fileareas from this link.
FileFixEchoLimit: Area subscribe limit.

Next: fileAreaDefaults, Previous: Link Keywords, Up: Link Keywords

4.2.1 fileEchoFlavour

Syntax:: fileEchoFlavour <hold|normal|crash|direct|immediate>
Example:: fileEchoFlavour direct

This statement sets the flavour which outgoing files in fileechos for this link get. For example set fileEchoFlavour to hold for points and to crash for uplinks.

This statement can only be repeated for different links.

Next: RemoteFileRobotName, Previous: fileEchoFlavour, Up: Link Keywords

4.2.2 fileAreaDefaults

Syntax:: fileAreaDefaults <options> [links]
Example:: fileAreaDefaults -lw 100 -g Z 2:5097/31.1

Set defaults for filearea definitions that follow. All options are possible, except areatag and path. Settings in the filearea definition override fileAreaDefaults See also See echoAreaDefaults. Defaults are switched off with empty fileAreaDefaults.

This statement can only be repeated for different links.

Next: noTIC, Previous: fileAreaDefaults, Up: Link Keywords

4.2.3 RemoteFileRobotName

Syntax:: RemoteFileRobotName <name>
Example:: RemoteFileRobotName allfix

Name of remote filefix robot (needed for FileForwardRequest)

This statement can only be repeated for different links.

Next: autoFileCreate, Previous: RemoteFileRobotName, Up: Link Keywords

4.2.4 noTIC

Syntax:: noTIC <bool>
Example:: noTIC yes

Disable TIC File Creation

This statement can only be repeated for different links.

Next: AutoFileCreateFile, Previous: noTIC, Up: Link Keywords

4.2.5 autoFileCreate

Syntax:: autoFileCreate <on|off>
Example:: autoFileCreate on

Allow or deny autocreating fileechos received from this link.

This statement can only be repeated for different links.

Next: AutoFileCreateDefaults, Previous: autoFileCreate, Up: Link Keywords

4.2.6 AutoFileCreateFile

Syntax:: AutoFileCreateFile <file>
Example:: AutoFileCreateFile /usr/local/fido/hpt/config.filefix

Specifies the file new filearea definitions will be placed into

This statement can only be repeated for different links.

Next: AutoFileCreateSubdirs, Previous: AutoFileCreateFile, Up: Link Keywords

4.2.7 AutoFileCreateDefaults

Syntax:: AutoFileCreateDefaults <string>
Example:: AutoFileCreateDefaults -lw 100 -g Z

Specifies the new filearea defaults. Please don't set any paths here, use LinkFileBaseDir for these purposes. See LinkFileBaseDir.

This statement can only be repeated for different links.

Next: delNotReceivedTIC, Previous: AutoFileCreateDefaults, Up: Link Keywords

4.2.8 AutoFileCreateSubdirs

Syntax:: AutoFileCreateSubdirs <on|off>
Example:: AutoFileCreateSubdirs on

Whether to autocreate areas like /filebase/gfd.app.edit (off) or /filebase/gfd/app/edit (on). If you want to configure this globally instead of on per-link basis, set this in the deflink section. For more information see 'AutoAreaCreateSubdirs' in the hpt manual.

This statement can only be repeated for different links.

Next: FileFixFSC87Subset, Previous: AutoFileCreateSubdirs, Up: Link Keywords

4.2.9 delNotReceivedTIC

Syntax:: delNotReceivedTIC <on|off>
Example:: delNotReceivedTIC on

Remove TIC if file was not received

This statement can only be repeated for different links.

Next: TickerPackToBox, Previous: delNotReceivedTIC, Up: Link Keywords

4.2.10 FileFixFSC87Subset

Syntax:: FileFixFSC87Subset <on|off>
Example:: FileFixFSC87Subset on

This boolean switch will change on a per link basis how TIC files are processed. By default this switch is ON. htick will then operate only on FSC87-compliant keywords and ignore unknown keywords in the TIC file processed. If this switch is set to OFF all implemented keywords will be used which can (and, in interaction with some tick processors, WILL) lead to severe problems. Unknown keywords found in a TIC file will make htick stop processing that file. If you don't know what all this is about set FileFixFSC87Subset to ON for all your links. It won't hurt.

This statement can only be repeated for different links.

Next: LinkFileBaseDir, Previous: FileFixFSC87Subset, Up: Link Keywords

4.2.11 TickerPackToBox

Syntax:: TickerPackToBox <on|off>
Example:: TickerPackToBox on

If link has file box - toss files and tics there

This statement can only be repeated for different links.

Next: ForwardFileRequests, Previous: TickerPackToBox, Up: Link Keywords

4.2.12 LinkFileBaseDir

Syntax:: LinkFileBaseDir <directory>
Example:: LinkFileBaseDir /usr/local/fido/fileareas/2.5097.64.0

Where autocreated fileareas will be placed to (may be "passthrough")

This statement can only be repeated for different links.

Next: ForwardFilePriority, Previous: LinkFileBaseDir, Up: Link Keywords

4.2.13 ForwardFileRequests

Syntax:: ForwardFileRequests <on|off>
Example:: ForwardFileRequests on

Allow fileareas forward-requests to this link.

This statement can only be repeated for different links.

Next: ForwardFileRequestFile, Previous: ForwardFileRequests, Up: Link Keywords

4.2.14 ForwardFilePriority

Syntax:: ForwardFilePriority <number>
Example:: ForwardFilePriority 1

Priority in uplinks order for filearea subscribing forward-requests

This statement can only be repeated for different links.

Next: FileFix, Previous: ForwardFilePriority, Up: Link Keywords

4.2.15 ForwardFileRequestFile

Syntax:: ForwardFileRequestFile <file>
Example:: ForwardFileRequestFile /usr/local/fido/hpt/uplink1.lst

List of available fileareas from this link

This statement can only be repeated for different links.

Next: FileFixEchoLimit, Previous: ForwardFileRequestFile, Up: Link Keywords

4.2.16 FileFix

Syntax:: filefix <bool>
Example:: filefix off

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

This statement can only be repeated for different links.

Next: FileArea Definition, Previous: FileFix, Up: Link Keywords

4.2.17 FileFixEchoLimit

Syntax:: FileFixEchoLimit <number>
Example:: FileFixEchoLimit 10

Area subscribe limit (max fileareas number this link is allowed to subscribe to)

This statement can only be repeated for different links.

Next: FileArea, Previous: FileFixEchoLimit, Up: Configuration Reference

4.3 FileArea Definition

Next: Announce System, Previous: FileArea Definition, Up: FileArea Definition

4.3.1 FileArea

Syntax:: FileArea <name> <fileareapath> [options] <uplink> <downlinks>
Example:: FileArea husky /var/spool/fido/fileareas/husky -a 2:5097/31 -p 28 -g Z -d "HUSKY fileecho" 2:5097/64 2:5097/303

Same as EchoArea, most options are valid:

-a <address>: Our own address for this area.
-d "<string>": Description for this filearea.
-g <group>: Group for this filearea.
-hide: Hide area (don't show in %LIST and in an announcement).
-nohide: Show area in %LIST and in an announcement if fileareadefaults set to -hide.
-lr <number>: "Read level": min link level for sending files from this filearea to this link. Value can't be negative.
-lw <number>: "Write level": Min link level allowed to post into this filearea files received from link. Value can't be negative.
-mandatory: Disallow remote unsubscribe (disable unsubscribe filefix command).
-nomandatory: Allow remote unsubscribe (enable unsubscribe filefix command) if fileareadefaults set to -mandatory.
-manual: Disallow remote subscribe (disable subscribe filefix command)
-nomanual: Allow remote subscribe (enable subscribe filefix command) if fileareadefaults set to -manual.
-noCRC: Disable CRC check for incoming files.
-CRC: Enable CRC check for incoming files if fileareadefaults set to -noCRC.
-nodiz: Do not try to get file description from <fileDescName> (for packed files).
-diz: Try to get file description from <fileDescName> (for packed files) if fileareadefaults set to -nodiz.
-pause: %PAUSE has effect to this filearea.
-nopause: %PAUSE has no effect to this filearea if fileareadefaults set to -pause.
-noreplace: Don't replace exisiting files in this filearea.
-replace: Replace exisiting files in this filearea if fileareadefaults set to -noreplace.
-p <integer>: Purge after n days. Setting to 0 to disables purging (this is default value).
-sendorig: Send files from PassFileAreaDir for non passthrough areas.
-nosendorig: Send files from FileArea directory for non passthrough areas if fileareadefaults set to -sendorig.

Next: AnnounceSpool, Previous: FileArea, Up: Configuration Reference

4.4 Announce System

Htick announcements are selective, they can be different for different fileareas. Token AnnAreaTag starts a new section of announce definition, other tokens define lists of fileareas included into announcement and describe announce message.

To post announcements run htick announce.

You may turn announcements off: just remove AnnounceSpool definition from config.

AnnounceSpool: Directory for accumulating report information.
AnnAreaTag: Name of area or file where annoucement will be placed.
AnnInclude: Array of fileecho masks that will be announced in this annAreaTag.
AnnExclude: Array of filearea masks that won't be announced in this annAreaTag.
AnnTo: Announcement message destination name.
AnnFrom: Announcement message originator name.
AnnSubj: Announcement message subject.
AnnAddrTo: Announcement message destination address (use for netmail area only).
AnnAddrFrom: Announcement message originator address.
AnnOrigin: Origin line in announcement message.
AnnMessFlags: Announcement message attributes (k/s loc hld ...).
AnnFileRFrom: Show in announcement: address of system which file was received from.
AnnFileOrigin: Show in announcement: address of system who has hatched file.
Announcements example: Example for understanding announcements (from real config).

Next: AnnAreaTag, Previous: Announce System, Up: Announce System

4.4.1 AnnounceSpool

Syntax:: AnnounceSpool <path>
Example:: AnnounceSpool /var/spool/fido/announce

Directory for accumulating report information.

This statement cannot be repeated.

Next: AnnInclude, Previous: AnnounceSpool, Up: Announce System

4.4.2 AnnAreaTag

Syntax:: AnnAreaTag <AREATAG|@filename>
Example:: AnnAreaTag local.announce

Begins new announcement definition section. <AREATAG> is name of an area where annoucement will be placed to; <@filename> is filename with leading '@' where annoucement will be placed to.

This statement can be repeated.

Next: AnnExclude, Previous: AnnAreaTag, Up: Announce System

4.4.3 AnnInclude

Syntax:: AnnInclude <fileecho mask list>
Example:: AnnInclude *

Array of fileecho names|masks that will be announced in this annAreaTag. Default: all fileareas.

This statement can be repeated only for different AnnAreaTag.

Next: AnnTo, Previous: AnnInclude, Up: Announce System

4.4.4 AnnExclude

Syntax:: AnnExclude <fileecho mask list>
Example:: AnnExclude aftnged

Array of filearea names|masks that won't be announced in this annAreaTag

This statement can be repeated only for different AnnAreaTag.

Next: AnnFrom, Previous: AnnExclude, Up: Announce System

4.4.5 AnnTo

Syntax:: AnnTo <string>
Example:: AnnTo All

Announcement message destination name.

This statement can be repeated only for different AnnAreaTag.

Next: AnnSubj, Previous: AnnTo, Up: Announce System

4.4.6 AnnFrom

Syntax:: AnnFrom <string>
Example:: AnnFrom Announce Robot

Announcement message originator name.

This statement can be repeated only for different AnnAreaTag.

Next: AnnAddrTo, Previous: AnnFrom, Up: Announce System

4.4.7 AnnSubj

Syntax:: AnnSubj <string>
Example:: AnnSubj New files arrived

Announcement message subject.

This statement can be repeated only for different AnnAreaTag.

Next: AnnAddrFrom, Previous: AnnSubj, Up: Announce System

4.4.8 AnnAddrTo

Syntax:: AnnAddrTo <address>
Example:: AnnAddrTo 2:5097/31.1

Announcement message destination address (use for netmail area).

This statement can be repeated only for different AnnAreaTag.

Next: AnnOrigin, Previous: AnnAddrTo, Up: Announce System

4.4.9 AnnAddrFrom

Syntax:: AnnAddrFrom <address>
Example:: AnnAddrFrom 2:5097/31

Announcement message originator address.

This statement can be repeated only for different AnnAreaTag.

Next: AnnMessFlags, Previous: AnnAddrFrom, Up: Announce System

4.4.10 AnnOrigin

Syntax:: AnnOrigin <string>
Example:: AnnOrigin News files!

Origin line in announcement message.

This statement can be repeated only for different AnnAreaTag.

Next: AnnFileRFrom, Previous: AnnOrigin, Up: Announce System

4.4.11 AnnMessFlags

Syntax:: AnnMessFlags <string>
Example:: AnnMessFlags loc hld

Announcement message flags (k/s loc hld ...).

This statement can be repeated only for different AnnAreaTag.

Next: AnnFileOrigin, Previous: AnnMessFlags, Up: Announce System

4.4.12 AnnFileRFrom

Syntax:: AnnFileRFrom <on|off>
Example:: AnnFileRFrom on

Show in announcement: address of system which file was received from.

This statement can be repeated only for different AnnAreaTag.

Next: Announcements example, Previous: AnnFileRFrom, Up: Announce System

4.4.13 AnnFileOrigin

Syntax:: AnnFileOrigin <on|off>
Example:: AnnFileOrigin on

Show in announcement: address of system that has hatched file.

This statement can be repeated only for different AnnAreaTag.

Next: Common husky keywords, Previous: AnnFileOrigin, Up: Announce System

4.4.14 Announcements example

The following text is taken from a real config file.

     #= Announcements definitions =====================================
     AnnounceSpool   E:\FIDO\EXCH\report
     
     # report all arrived files to file e:\fido\rep.txt
     AnnAreaTag      @e:\fido\rep.txt
     AnnFileOrigin   on
     
     # report into area 'seumbieky.news'
     # files posted to 'union.*' group of fileechos
     AnnAreaTag      seumbieky.news
     AnnInclude      union.*
     AnnSubj         New mp3's arrives
     AnnTo           United mp3 fans
     AnnFrom         Fullfeed Distribution Site
     AnnOrigin       *** seumbieky forever ***
     AnnFileOrigin   on
     AnnFileRfrom    on
     
     # report 'uue.*' group of fileechos into area 'seumbieky.news'
     AnnAreaTag      seumbieky.news
     AnnInclude      uue.*
     
     # report into area 'seumbieky.news'
     # all other exept of 'uue.* and union.*' groups
     AnnAreaTag      seumbieky.news
     AnnExclude      uue.* union.*
     
     # report via netmail to defined address
     AnnAreaTag      netmail
     AnnInclude      union.*
     AnnSubj         New mp3's arrives
     AnnTo           Max Inda Houze
     Annaddrto       2:464/108
     AnnFrom         Fullfeed Distribution Site
     Annaddrfrom     2:464/910.108
     AnnOrigin       *** seumbieky forever ***
     AnnMessFlags    k/s loc hld
     AnnFileOrigin   on
     AnnFileRfrom    on
     #= Announces definitions ends ================================

Next: Keyword Index, Previous: Announcements example, Up: Configuration Reference

4.4.15 Common husky keywords

List of keywords used in many husky programs. For details see fidoconfig manual.

BBSArea
LogLevels: ...

Previous: Common husky keywords, Up: Top

Appendix A Configuration File Keyword Index

addDLC: addDLC
AnnAddrFrom: AnnAddrFrom
AnnAddrTo: AnnAddrTo
AnnAreaTag: AnnAreaTag
AnnExclude: AnnExclude
AnnFileOrigin: AnnFileOrigin
AnnFileRFrom: AnnFileRFrom
AnnFrom: AnnFrom
AnnInclude: AnnInclude
AnnMessFlags: AnnMessFlags
AnnOrigin: AnnOrigin
Announcements example: Announcements example
AnnounceSpool: AnnounceSpool
AnnSubj: AnnSubj
AnnTo: AnnTo
autoFileCreate: autoFileCreate
AutoFileCreateDefaults: AutoFileCreateDefaults
AutoFileCreateFile: AutoFileCreateFile
AutoFileCreateFlag: AutoFileCreateFlag
AutoFileCreateSubdirs: AutoFileCreateSubdirs
BBSarea: BBSarea
BusyFileDir: BusyFileDir
Common husky keywords: Common husky keywords
ConvertLongNames: ConvertLongNames
ConvertShortNames: ConvertShortNames
delNotReceivedTIC: delNotReceivedTIC
DLCDigits: DLCDigits
ExecOnFile: ExecOnFile
FileArea: FileArea
FileAreaBaseDir: FileAreaBaseDir
FileAreaCreatePerms: FileAreaCreatePerms
fileAreaDefaults: fileAreaDefaults
fileDescName: fileDescName
FileDescPos: FileDescPos
fileEchoFlavour: fileEchoFlavour
FileFixEcho: FileFix
FileFixEchoLimit: FileFixEchoLimit
FileFixFromName: FileFixFromName
FileFixFSC87Subset: FileFixFSC87Subset
FileFixHelp: FileFixHelp
filefixKillRequests: filefixKillRequests
FileFixNames: FileFixNames
filefixReportsAttr: filefixReportsAttr
fileLDescString: fileLDescString
ForwardFilePriority: ForwardFilePriority
ForwardFileRequestFile: ForwardFileRequestFile
ForwardFileRequests: ForwardFileRequests
LinkFileBaseDir: LinkFileBaseDir
MaxTicLineLength: MaxTicLineLength
noTIC: noTIC
PassFileAreaDir: PassFileAreaDir
RemoteFileRobotName: RemoteFileRobotName
SaveTic: SaveTic
TickerPackToBox: TickerPackToBox
ticOutbound: ticOutbound