[Top] [Contents] [Index] [ ? ]

HTICK 1.1.0 - Husky Ticker

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

1. An Overview of HTICK  What is HTICK?
2. Installation Procedures and Release Notes  Installation. Read this!
3. HTICK 1.1.0 Command Line OPTIONS and SWITCHES  Command Line OPTIONS and SWITCHES
4. HTICK 1.1.0 Configuration Reference  Explanation of the configuration file.
2.3 Support  Support information.
A. Configuration File Keyword Index  Configuration File Keywords Index


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

1. An Overview of HTICK

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

HTICK features:

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

The advantages of HTICK are:

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


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

2. Installation Procedures and Release Notes

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

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. Edit config files for your purposes
  3. Run tparser from FIDOCONFIG package to test your config (read about PublicGroup or AccessGrp if you want to use groups for FileEchoAreas)
  4. It is simply, isn't it? Enjoy! :-)

2.1 Download the Source Code & Binary Files  
2.2 Compiling the Source Code  How to compile the source code
2.3 Support  Support, Contacting the Author, Reporting Bugs, Contributing Code


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

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/


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

2.2 Compiling the Source Code

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

2. Put the fidoconfig 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.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

2.3 Support

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

  1. You have decided to use HTICK on a regular basis. In this case, please do send a netmail at the address listed below.

  2. 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 to "Bugs" link if you have post 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.

  3. 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. I 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).

  4. 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, I 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 I would like you to adhere to.

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


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

3. HTICK 1.1.0 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
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 section 4.4 Announce System.)
hatch <file> <area> [replace [<filemask>]] [desc [<desc>] [<ldesc>]]
Hatch file into Area, using Description for file, if exist "replace", then fill replace field in TIC; if not exist <filemask>, 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 1st 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 which includes all files in base.

  • <file> filename for write output to.
  • <dirlist> list of paths to files from filelist.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

4. HTICK 1.1.0 Configuration Reference

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

4.1 Keywords  This chapter describes keywords
4.2 Link Keywords  Keywords that can be repeated for different links
4.3 FileArea Definition  FileAreas definition
4.4 Announce System  Announces definition


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

4.1 Keywords

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


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

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.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

4.1.2 PassFileAreaDir

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

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

This statement cannot be repeated.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

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.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

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.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

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.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

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 cannot be repeated.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

4.1.7 SaveTic

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

<DirToSaveTic>
where put TIC for fileecho[es] <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 file echos

This statement cannot be repeated.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

4.1.8 MaxTicLineLength

Syntax:
MaxTicLineLength <number>
Example:
MaxTicLineLength 79

Set maximum line length in outgoing TICs to number.

This statement cannot be repeated.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

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.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

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.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

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.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

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.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

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.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

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.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

4.1.15 filefixKillRequests

Syntax:
filefixKillRequests <bool>
Example:
filefixKillRequests yes

Kill filefix request after processing.

This statement cannot be repeated.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

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.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

4.1.17 BBSarea

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

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

This statement cannot be repeated.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

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 cannot be repeated.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

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


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

4.1.20 FileAreaCreatePerms

Syntax:
FileAreaCreatePerms <mode>
Example:
FileAreaCreatePerms 644

Define permissions for newly created filearea directories (UNIX only)

This statement cannot be repeated.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

4.1.21 FileFixFromName

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

Originator name in filefix replies.

This statement cannot be repeated.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

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.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

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.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

4.2 Link Keywords

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


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

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.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

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 @xref{echoAreaDefaults,,,hpt}. Defaults are switched off with empty fileAreaDefaults.

This statement can only be repeated for different links.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

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.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

4.2.4 noTIC

Syntax:
noTIC <bool>
Example:
noTIC yes

Disable TIC File Creation

This statement can only be repeated for different links.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

4.2.5 autoFileCreate

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

Allow or deny autocreating fileechoes received from this link.

This statement can only be repeated for different links.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

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.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

4.2.7 AutoFileCreateDefaults

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

Specifies the new filearea defaults.

This statement can only be repeated for different links.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

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.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

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.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

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.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

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.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

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.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

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.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

4.2.14 ForwardFilePriority

Syntax:
ForwardFilePriority <number>
Example:
ForwardFileRequests 1

Priority in uplinks order for filearea subscribing forward-requests

This statement can only be repeated for different links.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

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.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

4.2.16 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.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

4.3 FileArea Definition

4.3.1 FileArea  definition of FileArea


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

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.

-h
Hide area (don't show in %LIST and in an announcement).

-lr <number>
"Read level": Min link level for sending files from this filearea to this link.

-lw <number>
"Write level": Min link level allowed to post into this filearea files received from link.

-mandatory
Disallow remote unsubscribe (disable unsubscribe filefix command).

-manual
Disallow remote subscribe (disable subscribe filefix command).

-noCRC
Disable CRC check for incoming files.

-nodiz
Do not try to get file description from <fileDescName> (for packed files).

-nopause
%PAUSE has no effect to this filearea.

-noreplace
Don't replace exisiting files in this filearea.

-p <integer>
Purge after n days. Setting to 0 to disables purging.

-sendorig
Send files from PassFileAreaDir for non passthrough areas.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

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.

4.4.1 AnnounceSpool  Directory for accumulating report information.
4.4.2 AnnAreaTag  Name of area of file where annouce will be placed.
4.4.3 AnnInclude  Array of fileecho masks that will be announced in this annAreaTag.
4.4.4 AnnExclude  Array of filearea masks that won't be announced in this annAreaTag.
4.4.5 AnnTo  Announce message destination name.
4.4.6 AnnFrom  Announce message originator name.
4.4.7 AnnSubj  Announce message subject.
4.4.8 AnnAddrTo  Announce message destination address (use for netmail area only)
4.4.9 AnnAddrFrom  Announce message originate address.
4.4.10 AnnOrigin  Origin line in announce message.
4.4.11 AnnMessFlags  Announce message attributes (k/s loc hld ...).
4.4.12 AnnFileRFrom  Show in announcement: address of system which file received from
4.4.13 AnnFileOrigin  Show in announce: address of system who hatched file.
4.4.14 Announcements example  Example for understanding announces (from real config)


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

4.4.1 AnnounceSpool

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

Directory for accumulating report information.

This statement cannot be repeated.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

4.4.2 AnnAreaTag

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

Begins new announce 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.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

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.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

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.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

4.4.5 AnnTo

Syntax:
AnnTo <string>
Example:
AnnTo All

Announce message destination name.

This statement can be repeated only for different AnnAreaTag.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

4.4.6 AnnFrom

Syntax:
AnnFrom <string>
Example:
AnnFrom Announce Robot

Announce message originator name.

This statement can be repeated only for different AnnAreaTag.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

4.4.7 AnnSubj

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

Announce message subject.

This statement can be repeated only for different AnnAreaTag.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

4.4.8 AnnAddrTo

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

Announce message destination address (use for netmail area).

This statement can be repeated only for different AnnAreaTag.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

4.4.9 AnnAddrFrom

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

Announce message originate address.

This statement can be repeated only for different AnnAreaTag.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

4.4.10 AnnOrigin

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

Origin line in announce message

This statement can be repeated only for different AnnAreaTag.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

4.4.11 AnnMessFlags

Syntax:
AnnMessFlags <string>
Example:
AnnMessFlags loc hld

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

This statement can be repeated only for different AnnAreaTag.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

4.4.12 AnnFileRFrom

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

Show in announce: address of system which file is received from

This statement can be repeated only for different AnnAreaTag.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

4.4.13 AnnFileOrigin

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

Show in announce: address of system that hatched file

This statement can be repeated only for different AnnAreaTag.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

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 ================================


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

A. Configuration File Keyword Index

Jump to:   A   B   C   D   E   F   L   M   N   P   R   S   T  

Index Entry Section

A
addDLC4.1.12 addDLC
AnnAddrFrom4.4.9 AnnAddrFrom
AnnAddrTo4.4.8 AnnAddrTo
AnnAreaTag4.4.2 AnnAreaTag
AnnExclude4.4.4 AnnExclude
AnnFileOrigin4.4.13 AnnFileOrigin
AnnFileRFrom4.4.12 AnnFileRFrom
AnnFrom4.4.6 AnnFrom
AnnInclude4.4.3 AnnInclude
AnnMessFlags4.4.11 AnnMessFlags
AnnOrigin4.4.10 AnnOrigin
Announcements example4.4.14 Announcements example
AnnounceSpool4.4.1 AnnounceSpool
AnnSubj4.4.7 AnnSubj
AnnTo4.4.5 AnnTo
autoFileCreate4.2.5 autoFileCreate
AutoFileCreateDefaults4.2.7 AutoFileCreateDefaults
AutoFileCreateFile4.2.6 AutoFileCreateFile
AutoFileCreateFlag4.1.22 AutoFileCreateFlag
AutoFileCreateSubdirs4.2.8 AutoFileCreateSubdirs

B
BBSarea4.1.17 BBSarea
BusyFileDir4.1.9 BusyFileDir

C
ConvertLongNames4.1.10 ConvertLongNames
ConvertShortNames4.1.11 ConvertShortNames

D
delNotReceivedTIC4.2.9 delNotReceivedTIC
DLCDigits4.1.13 DLCDigits

E
ExecOnFile4.1.6 ExecOnFile

F
FileArea4.3.1 FileArea
FileAreaBaseDir4.1.1 FileAreaBaseDir
FileAreaCreatePerms4.1.20 FileAreaCreatePerms
fileAreaDefaults4.2.2 fileAreaDefaults
fileDescName4.1.18 fileDescName
FileDescPos4.1.3 FileDescPos
fileEchoFlavour4.2.1 fileEchoFlavour
FileFixEchoLimit4.2.16 FileFixEchoLimit
FileFixFromName4.1.21 FileFixFromName
FileFixFSC87Subset4.2.10 FileFixFSC87Subset
FileFixHelp4.1.5 FileFixHelp
filefixKillRequests4.1.15 filefixKillRequests
FileFixNames4.1.23 FileFixNames
filefixReportsAttr4.1.16 filefixReportsAttr
fileLDescString4.1.4 fileLDescString
ForwardFilePriority4.2.14 ForwardFilePriority
ForwardFileRequestFile4.2.15 ForwardFileRequestFile
ForwardFileRequests4.2.13 ForwardFileRequests

L
LinkFileBaseDir4.2.12 LinkFileBaseDir

M
MaxTicLineLength4.1.8 MaxTicLineLength

N
noTIC4.2.4 noTIC

P
PassFileAreaDir4.1.2 PassFileAreaDir

R
RemoteFileRobotName4.2.3 RemoteFileRobotName

S
SaveTic4.1.7 SaveTic

T
TickerPackToBox4.2.11 TickerPackToBox
ticOutbound4.1.14 ticOutbound

Jump to:   A   B   C   D   E   F   L   M   N   P   R   S   T  


[Top] [Contents] [Index] [ ? ]

Table of Contents


[Top] [Contents] [Index] [ ? ]

Short Table of Contents

1. An Overview of HTICK
2. Installation Procedures and Release Notes
3. HTICK 1.1.0 Command Line OPTIONS and SWITCHES
4. HTICK 1.1.0 Configuration Reference
A. Configuration File Keyword Index

[Top] [Contents] [Index] [ ? ]

About this document

This document was generated on January, 6 2003 using texi2html

The buttons in the navigation panels have the following meaning:

Button Name Go to From 1.2.3 go to
[ < ] Back previous section in reading order 1.2.2
[ > ] Forward next section in reading order 1.2.4
[ << ] FastBack previous or up-and-previous section 1.1
[ Up ] Up up section 1.2
[ >> ] FastForward next or up-and-next section 1.3
[Top] Top cover (top) of document  
[Contents] Contents table of contents  
[Index] Index concept index  
[ ? ] About this page  

where the Example assumes that the current position is at Subsubsection One-Two-Three of a document of the following structure:

This document was generated on January, 6 2003 using texi2html