home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
ftp.wwiv.com
/
ftp.wwiv.com.zip
/
ftp.wwiv.com
/
pub
/
BBS
/
WCTIC10.ZIP
/
WCTIC.DOC
< prev
next >
Wrap
Text File
|
1994-09-25
|
32KB
|
932 lines
≡≡≡≡≡≡ ≡≡≡≡ ≡≡≡≡
≡ ≡≡ ≡ ≡≡ ≡≡ ≡≡
≡≡ ≡≡ ≡≡≡≡ ≡≡ ≡≡ ≡≡
≡≡ ≡ ≡≡ ≡≡ ≡≡ ≡≡ ≡≡ ≡≡
≡≡≡≡≡≡≡ ≡≡ ≡≡ ≡≡ ≡≡
≡≡≡≡≡≡≡ ≡≡ ≡≡ ≡≡ ≡≡ ≡≡ ≡≡
≡≡ ≡≡ ≡≡≡≡ ≡≡≡≡ ≡≡≡≡ ≡≡≡≡
Version 1.0
Cahn's Axiom:
When all else fails, read the instructions.
Copyright (C) 1994 by Lost Paradise Software
Written by Martin Kuhne
September 1994
1.0 wcTIC User's Guide 1
1. Introduction
This manual describes wcTIC, a TICK/HATCH/RAID file forward program
tailored for Wildcat! BBS software.
1.1. Highlights
■ Built-in RAID ('Areafix') capability
■ Number of file areas only limited by available memory
■ Number of links per file area only limited by available memory
■ CRC-32 integrity checking of files
■ Can run while Wildcat! is online
■ Supports an unlimited number of AKAs
■ Intelligent semaphore system
■ Supports passthrough areas with intelligent cleanup
■ Fast and efficient C code
■ Hatch functionality supplied, both interactive and automatic
■ Runs with WildCat! V3 and V4
■ Top priority support for registered users
1.2. What is a TICK processor?
File distribution in FidoNet (and compatible networks) works very
much like echomail distribution. With echomail, one system adds a
new message into a message area. The message is then distributed to
all other systems connected to this message area. Each message
carries control information about which systems have seen this
message.
With files, the process of entering new data is called hatching.
One node hatches a new file. Since this is usually an archive, no
control information can be attached to it without corrupting the
archive. So the control information is carried in a second file
named .TIC together with the file description.
The new file is then distributed to all nodes connected to the file
area (often called file echo or tick area) very much the same way
as echomail, using the control information in the .TIC file.
Currently, several hundred file echos exist for a lot of platforms
(dos, windows, nt, linux, macintosh, amiga) and topics such as
computers, music, survival, ANSI art and HAM radio (just to name a
few).
Often, file echos carry files from other networks such as
CompuServe and Usenet. Many sysops like the fact that they get all
new files of interest automatically, complete with a clear file
description, without any intervention except configuring file areas
one time.
Much like echomail also, one can connect and disconnect file echos
through special control netmail messages.
Introduction What is a TICK processor?
1.0 wcTIC User's Guide 2
1.3. What is wcTIC?
wcTIC is a .TIC file processor for use with Wildcat! BBS software.
It automatically adds incoming files to the Wildcat! file database,
copies them to the right directory and sends the file to all
downlinks. Other nodes can connect to file areas through
areafix-like messages, and you can protect your file areas from
unwanted access through a powerful security system.
wcTIC is written in heavily optimized C code, by an experienced
programmer who knows how to write both fast and safe to use
programs.
You can try out wcTIC for thirty days. After that evaluation
period, you have to register wcTIC. You can register online through
CompuServe, via a toll-free phone number using a credit cards (U.S.
only) or directly from the author (Please refer to REGISTER.DOC for
registration details)
If you register, you will receive a personal key that will unlock
wcTIC. All minor updates are free, at the time of this writing all
1.X versions.
If you need help, support is available through Fidonet, Usenet and
CompuServe email and by FAX. Updates are available through our
support BBS and from Mustang HQ in the U.S.
2. License
This is a licence agreement between you, the end user, and Martin
Kuhne, hereafter "the author". The wcTIC software and all related
files, hereafter "wcTIC", are the property of the author. If you
for any reason cannot accept the conditions in this agreement, you
are not permitted to use wcTIC.
You acknowledge and agree that wcTIC is a proprietary product of
the author, protected by applicable copyright laws and
international treaty provisions. You further acknowledge and agree
that all rights, title, and interest in and to wcTIC are and shall
remain with the author.
wcTIC may be used for a period of thirty days of trial to allow you
to test this product before you buy it. After this period you must
register each copy of wcTIC that you run simultaneously.
Registration entitles you to a non-transferable personal licence to
use the version of wcTIC included in this distribution and any
future versions with the same major version number for as long as
you wish.
In the event that you are in violation of this licence agreement,
you agree and accept that the author may cancel your license and
any rights to use wcTIC that you may have. In the case of a dispute
over the licence agreement, you further agree and accept to fully
License
1.0 wcTIC User's Guide 3
reimburse the author for legal and other expenses resulting from
the dispute, should the dispute be decided in favor of the author.
wcTIC is provided "as is", without warranty of any kind or fitness
for a particular purpose, either expressed or implied.
The author's liability resulting from your use or inability to use
wcTIC is limited to the amount that the affected party has paid for
it, or in the event that wcTIC was registered with a third party
for payment to the author, liability is limited to the amount that
was received by the author from that third party.
Neither the author nor any of his employees, agents, or other
representatives are in any way obligated to provide future versions
of, or support for, wcTIC.
You may freely distribute and copy wcTIC provided that no fee is
charged and the wcTIC distribution remains unmodified. Pay Bulletin
Board Systems may, however, charge their normal fee provided that
no additional charge for wcTIC is taken. No part of wcTIC may be
modified, altered, reverse engineered, sold, or distributed in any
form without prior written permission from the author.
Place of jurisdiction is Germany and this agreement is subject to
the law and regulations of Germany. In the case of any of the
provisions of this agreement not being legally effective or losing
its legal validity due to some subsequent circumstance, or in the
case of a gap in this agreement coming into light, the legal
validity of the remaining provisions will not be affected. An
appropriate regulation is to take place of the ineffective
provisions or fill the gap, which as far as legally possible, comes
nearest to fulfilling the intentions of the author had he
considered the matter in question. If the invalidity of a provision
is due to a scale of the performance contained therein, then a
legally permissible scale is to be inserted with due regard to the
aforesaid.
Brand and product names are trademarks or registered trademarks of
their respective holders.
3. Installation
3.1. Requirements
An IBM PC, AT or 100% compatible, MS DOS 3.3 or compatible, 550KB
free DOS memory are required to run wcTIC.
wcTIC is made to be used in a FidoNet style network together with
Wildcat! BBS software.
This version requires wcFILE in the WILDCAT directory for proper
operation. (This program comes with the Wildcat! BBS software)
Installation Requirements
1.0 wcTIC User's Guide 4
This manual assumes basic familiarity with FidoNet terms such as
node address or netmail.
3.2. Installing wcTIC
3.2.1. Upgrading from WCFF
If you ran OCR's WCFF software before, you can take over most of
your old area configuration. Please note that the aka setting is
done differently and that you will have to add permissions and
groups for RAID capability. Also make sure MAINADDRESS is set
correctly.
3.2.2. New installation
Create a directory for wcTIC (e.g. C:\WCTIC) and copy all files
from the distribution disk or archive into this direcory.
You will find these files
WCTIC.EXE Main file forward program
WCTHATCH.EXE Program to hatch files
WCTCLEAN.EXE Program for cleanup when running passthrough areas
WCTIC.CFG Example configuration
WCTIC.DOC Documentation (you are reading this file right now)
REGISTER.DOC Registration information
REGISTER.FRM Registration form
You can edit the configuration file WCTIC.CFG with any standard
ASCII text editor.
If you want to use wcTIC's intelligent locking feature, you have to
set the environment variable WCNODEID as described in the Wildcat!
manual.
4. Configuration
4.1. A quick start
If you cannot wait another minute, look at the example
configuration included in this distribution. If you are an
experienced user, this might be enough to get wcTIC up and running.
However, I strongly recommend reading this manual thoroughly even
if you think you know everything already.
4.2. Basics
Most configuration items have one keyword and one or more
arguments. All texts including keywords and passwords are case
insensitive. Any text that follows a semi-colon up to the end of
the line is ignored, as well as empty lines.
In this manual, keywords appear in uppercase print and arguments in
Configuration Basics
1.0 wcTIC User's Guide 5
<brackets>, such as:
MAINADDRESS <address>
This means the keyword MAINADDRESS must remain unchanged, followed
by your actual fidonet address.
4.3. Types of arguments
There are several types of arguments that we will need more than
once throughout this manual.
4.3.1. <address>
Address in this context means a FidoNet address. A FidoNet address
consists of four numbers in the form of zone:net/node.point. You
can leave out parts of the address, these are set to zero so
2:2480/3030 translates to 2:2480/3030.0.
4.3.2. <password>
A password may consist of up to 16 characters. Passwords are, as
mentioned already, not case sensitive.
4.3.3. <path>
A path must be a vaild DOS pathname and may be up to 80 characters
long. A trailing backslash ('\') is not needed, but does no harm
also.
4.3.4. <area name>
The name of a TICK area may consist of up to 32 characters. This
name is not case sensitive.
4.3.5. <area flags>
There are 26 file area flags available, using the letters A through
Z. They are used for area security (more on this later)
4.3.6. <node flags>
Node flags are used to determine how files are sent other systems.
Any combination of these letters is allowed:
* Don't send files
& Allow node to send files
C Send files to this node CRASH
H Send files to this node HOLD
T Don't send .TIC files
The default setting for a node is to send, but not accept files
('downlink') with no special flavor set, and to send .TIC files.
Configuration <node flags>
1.0 wcTIC User's Guide 6
4.4. Configuration keywords
4.4.1. MAINADDRESS
Syntax: MAINADDRESS <address>
Your FidoNet address or 'main AKA'. Note: In a Frontdoor setup,
this is the GLOBAL->ADDRESS->ADDRESS->MAIN parameter.
4.4.2. INFILES
Syntax: INFILES <path>
Path to incoming files or 'inbound directory'. Note: In a
Frontdoor setup, this is the GLOBAL->FILENAMES->FILES parameter.
4.4.3. OUTFILES
Syntax: OUTFILES <path>
Path for outgoing .TIC files or 'outbound directory'. WARNING: Set
this to a separate directory used by wcTIC ONLY if you use
passthrough areas.
4.4.4. MAIL
Syntax: MAIL <path>
Path for netmail folder. Note: In a Frontdoor setup, this is the
GLOBAL->FILENAMES->NETMAIL parameter.
4.4.5. WILDCAT
Syntax: WILDCAT <path>
Your main Wildcat! directory
4.4.6. SYSOP
Syntax: SYSOP <sysop name>
Your name. The sysop name may include spaces
4.4.7. LINK
Syntax: LINK <address> <password> <area flags>
This entry is used to give another system the possibilty to add and
delete file areas through a special control message via netmail.
This works almost equally to an areafix request. You need to
specify the node address of the system you want to give access to,
the password used and the area flags. This node will then be able
Configuration LINK
1.0 wcTIC User's Guide 7
to activate all areas that have no other flags set except <area
flags>
A detailed description of the area manager follows in the next
chapter.
4.4.8. AREA
Syntax: AREA <path> <area name> <wc! file area number> <area flags>
The area command, finally, defines a TICK file area. wcTIC needs
to know the destination path for the files received, the Wildcat!
file area number and the flags necessary to access this file area.
The AREA keyword is usually followed by a list of nodes connected
to this file area:
Syntax: <address> <password> <node flags>
This means node <address> is linked to this file echo using
<password>. The node flags have already been discussed; please
look them up again if you are not sure what they mean.
4.4.9. Passthrough Areas
The letter 'P' instead of a file area number denotes a passthrough
area. This means you are forwarding files from this area to other
nodes, but don't keep the files in your WildCat! base.
Files for passthrough areas are stored in the OUTFILES directory. A
special cleanup program, WCTICCL, has been included in the wcTIC
package to delete files that have been sent to all systems
connected. (This is the case when no .TIC file exists for this
file anymore)
4.4.10. AKA
Syntax: AKA <address>
Your FidoNet address used for this file area ONLY. This statement
is not mandatory, if you omit it the address specified in
MAINADDRESS is used. AKA always refers to the AREA defined
previously.
4.4.11. DESC Syntax: DESC <description>
This text (up to 80 characters) is the decription for this area.
This statement is not mandatory, if you omit it, the file area will
simply have no description. DESC always refers to the AREA defined
previously.
4.4.11.1. An example AREA definition
Area configuration may be a bit tough if you hear it for the first
time. So here is a full-blown example taken out of everyday life
Configuration An example AREA definition
1.0 wcTIC User's Guide 8
of a Fidonet system (2:2480/3030 in this example):
AREA NODEDIFF C:\WILDCAT\DOWNLOAD\NODEDIFF 35
DESC Fidonet nodediffs (weekly)
2:2480/76 secret *&
2:2480/3030.2 topsecret HT
2:2480/3030.3 hidden H
This definition tells wcTIC to add all incoming files from the TICK
echo NODEDIFF to the WILDCAT! file area 35 in
C:\WILDCAT\DOWNLOAD\NODEDIFF. Node 2:2480/76 is linked with node
flags *&, i.e. we receive files from this node, but no files are
sent from us. This is a typical example of an uplink node. There
are also two downlink systems connected, points 2 and 3 of our
system. Both get their files on HOLD. This is OK since the points
will always poll our system and never vice-versa. Also, point two
does only get the files themselves but no .TIC files. This is a
typical point setting since many points want to have a current
nodelist available, but have no tick processor installed for just
one file per week.
5. The Area Manager
5.1. Introduction
To relinquish you of the task of adding or deleting nodes from
areas manually, wcTIC features a built-in area manager. The area
manager is used by sending a netmail to your system, addressed to
the user 'wcTIC' or 'Raid' (The names 'TICK' and 'FILEMGR' are also
recognized). The subject line must contain the password for the
node sending the request, and the command themselves are located in
the message body. An example:
FROM: Joe User
TO : wcTIC
SUBJ: secret
%LIST
NODEDIFF
-ECHOLIST
wcTIC then compares the password for the sender with the one set in
a LINK command in YOUR configuration, and executes all commands in
the message body. (In the example above, it connects Joe User to
the NODEDIFF area, disconnects him from ECHOLIST and sends a list
of available file echos to Joe)
The Area Manager Introduction
1.0 wcTIC User's Guide 9
5.2. Area Manager Commands
5.2.1. Subscribing
An area name alone on a line or an area name preceeded by a plus
('+') character is used to subscibe to a file area. After doing a
security check, wcTIC adds the node to the file area asked for in
hold mode, read-only (files are sent but the node may not hatch
files)
Nodes can only subscibe to areas matching their security pattern
(defined by the LINK command)
5.2.2. Unsubscribing
An area name alone on a line preceeded by a minus ('-') character
is used to unsubscibe to a file area. wcTIC then disconnects the
node from the file area. No security check is done at this point
(except password check of course)
5.2.3. Area List
The %LIST command on a line alone send the user a list of areas
available to him.
5.2.4. Help Request
The %LIST command on a line alone send the user a short text
explaining the area manager commands.
5.3. Invoking The Area Manager
On the sysop side, all you have to do is running the area manager
regularly. It is built into wcTIC, and is invoked by typing
WCTIC AMGR
in the directory you have wcTIC installed in.
I recommend running the area manager anytime you process mail for
fastest reaction. On an average system, this only takes a few
secons. An alternative is to run the area manger once a day. (You
will probably already have set up a script for daily maintenance)
Confused? Don't panic.
Count to ten - THEN panic.
The Area Manager Invoking The Area Manager
1.0 wcTIC User's Guide 10
6. The cleanup program WCTCLEAN
6.1. *** WARNING ***
To use WCTClean, it is absolutely necessary that OUTFILES points to
a directory where no other files reside except those created by
wcTIC! Never, I repeat, never set OUTFILES to your mailer outbound
if you plan to use WCTClean!
6.2. Purpose
Before you read on: You will need this program ONLY if you run
passthrough areas.
When running passthrough areas, you usually don't want to keep the
files longer than necessary. However, it is not possible to delete
the file associated with a TIC file after sending since there might
be other systems the file is sent to.
To solve this problem, WCTClean scans your OUTFILES directory for
files that have already been sent to all systems attached.
It is recommended to run WCTClean once a day or once a week except
if you are extremely low on disk space.
6.3. Usage
WCTClean has no commandline options, just start it by typing
'WCTCLEAN'.
7. The HATCH program WCTHatch
7.1. Purpose
WCTHatch is used for feeding new files into file areas (like
writing a new echomail yourself). This process is called hatching.
In order to hatch a file, it must be present in the directory used
for the file area you want to hatch the file into.
7.2. Usage
WCTHatch operates in two modes: automatic and interactive. If you
just type 'WCTHATCH' from the commandline, WCTHatch automatically
enters interactive mode. It will then prompt you for the file
name, the file area name and the file description.
For automatic operation, you must specify the file name, area and
description on the commandline:
WCTHATCH <file> <area> <description>
The description may contain spaces.
The HATCH program WCTHatch Usage
1.0 wcTIC User's Guide 11
8. Appendix
8.1. Bugs and Problems
8.1.1. Known problems
There are no known problems in this release. We tried to iron out
every problem that could be found, but there might be a few quirks
left.
8.1.2. Troubleshooting
If you are in trouble...
■ read the manual again
■ try to get help from a fellow sysop
■ try to get help in a local sysop echo
■ join the Wildcat! support echo WILDCAT in FidoNet
■ send a netmail or fax to wcTIC support
8.2. Technical info
This product was created using Borland's Turbo C++ 1.0 and the
proff text formatter.
8.2.1. FTSC compatibility notes
This product is compatible with FTS-001 Version 15 and complies
to FSC-057 Version 3.
8.2.2. Program limits
wcTIC makes heavy use of linked lists, so the number of areas,
akas, downlinks etc. is only limited by available memory.
8.3. Acknowledgements
Thanks to everyone who helped creating, testing and improving
this product.
The following names are either trademarks or the efforts of the
person and/or company listed (in alphabetic order):
Fido and FidoNet are trademarks of Tom Jennings, Fido Software.
FrontDoor by Joaquim H. Homrighausen
FSC-057 by Fabiano Fabris and Joaquim H. Homrighausen
FTS-001 by Randy Bush
Tick by Barry Geller
WCFF by Online Computer Resources
WildCat! by Mustang Software
Appendix Acknowledgements
1.0 wcTIC User's Guide 12
8.4. Support
The preferred method for support is email since it is the fastest
and most convenient way. You can reach me through a number of
networks:
Usenet email: p7003ce@sunmail.lrz-muenchen.de
CompuServe user-id: 100416,2660
FidoNet: 2:2480/3030.42
(2:2480/3030.42 is my sysop-point, mail to 2:2480/3030 will also
reach me)
My fax number is +49-89-8949610, and if you want to use
old-fashioned mail, my address is
Martin Kuhne
Langwieder Hauptstrasse 53
81249 Muenchen
Germany
Appendix Support
1.0 wcTIC User's Guide 13
Table Of Contents
wcTIC 1.0
1. Introduction .................................. 1
1.1. Highlights ............................... 1
1.2. What is a TICK processor? .................... 1
1.3. What is wcTIC? ............................. 1
2. License ....................................... 2
3. Installation .................................. 3
3.1. Requirements ............................. 3
3.2. Installing wcTIC .......................... 4
3.2.1. Upgrading from WCFF ................... 4
3.2.2. New installation ..................... 4
4. Configuration ................................. 4
4.1. A quick start .............................. 4
4.2. Basics ................................... 4
4.3. Types of arguments ......................... 5
4.3.1. <address> ........................... 5
4.3.2. <password> .......................... 5
4.3.3. <path> .............................. 5
4.3.4. <area name> .......................... 5
4.3.5. <area flags> ......................... 5
4.3.6. <node flags> ......................... 5
4.4. Configuration keywords .................... 6
4.4.1. MAINADDRESS ......................... 6
4.4.2. INFILES ............................. 6
4.4.3. OUTFILES ............................ 6
4.4.4. MAIL ................................ 6
4.4.5. WILDCAT ............................. 6
4.4.6. SYSOP ............................... 6
4.4.7. LINK ................................ 6
4.4.8. AREA ................................ 7
4.4.9. Passthrough Areas .................... 7
4.4.10. AKA ................................ 7
4.4.11. DESC ............................... 7
4.4.11.1. An example AREA definition .......... 7
5. The Area Manager ................................ 8
5.1. Introduction ............................. 8
5.2. Area Manager Commands ...................... 8
5.2.1. Subscribing ......................... 8
5.2.2. Unsubscribing ....................... 9
5.2.3. Area List ............................ 9
5.2.4. Help Request ......................... 9
5.3. Invoking The Area Manager ................... 9
6. The cleanup program WCTCLEAN ..................... 10
6.1. *** WARNING *** ............................ 10
6.2. Purpose .................................. 10
6.3. Usage .................................... 10
7. The HATCH program WCTHatch ....................... 10
7.1. Purpose .................................. 10
7.2. Usage .................................... 10
8. Appendix ...................................... 10
- 13 -
1.0 wcTIC User's Guide 14
8.1. Bugs and Problems .......................... 11
8.1.1. Known problems ....................... 11
8.1.2. Troubleshooting ..................... 11
8.2. Technical info ............................ 11
8.2.1. FTSC compatibility notes .............. 11
8.2.2. Program limits ....................... 11
8.3. Acknowledgements ......................... 11
8.4. Support .................................. 11
Real users don't read manuals.
Reliance on a reference is a hallmark
of the novice and the coward.
- 14 -
