| HSLK-TGI v1.00 Beta Documentation
|
| HS\Link Bidirectional Protocol Interface for Telegard.
|
| Copyright 1991,1992 by Tim Strike and
| Forbidden Knights [BBS] Software Systems and Programming.
_________________
TABLE OF CONTENTS
_________________
I Introduction ........................................ 1
II Required to Run HSLK-TGI ............................ 1
III Command Line Parameters ............................. 2
IV Other Notes
- Status Line ...................................... 3
- After Upload Processing .......................... 3
V Example Installation ................................ 4
VI Verion Listings ..................................... 5
VII Legalities
- Warranty ......................................... 6
- Copyright ........................................ 6
- Credits .......................................... 6
VIII Registration ...................................... 7
IX Contacting The Author ............................... 7
The contents of this document are Copyright 1991, 1992 by Tim
Strike and Forbididden Knights [BBS] Software Systems and
Programming. They are not to be modified in any way, shape or
form.
____________
INTRODUCTION
____________
For use with Telegard 2.7. If used with any other versions
of TG, HSLK-TGI will cause unpredictable and unrepairable results.
Upon the release of HS\Link, a bidirectional protocol, it was
again discovered how much Telegard lacked in the file protocol
handling. While HS\Link could be setup as a single-way
protocol in Telegard, it couldn't be installed proplerly as a
bidirectional protocol, without a lot of hassle, and inconvenience
for the Sysop. HSLK-TGI was designed to interface HS\Link with
Telegard so this would no longer be a problem. HSLK-TGI takes
care of the uploading portion, letting Telegard handle the
downloading side.
HSLK-TGI when fully setup replicates the Telegard file
section, or how Telegard would normally act, except that it
handles both uploads and downloads at the same time. However
HSLK-TGI doesn't replicate Telegards file section in all regards,
o not all setups will work correctly with this version (though if
you explain to me what the problem is I'll get around to
programming it.).
THIS COPY OF HSLK-TGI IS STILL IN IT'S BETA STAGES. IT HAS
BEEN TESTED, BUT IS NOT GUARENTEED TO RUN OR OPERATE CORRECTLY ON
YOUR SYSTEM. ALL ATTEMPTS WILL BE MADE TO MAKE SURE THAT IT DOES
RUN ON YOUR SYSTEM, BUT TIM STRIKE AND FORBIDDEN KNIGHTS SOFTWARE
ARE NOT RESPONSIBLE FOR ANY PROBLEMS THAT OCCUR FROM THE USE OR
MISUSE OF THIS PROGRAM.
________________________
REQUIRED TO RUN HSLK-TGI
________________________
HSLK-TGI requires access to STATUS.DAT, LASTON.DAT, your
USER.LST and the file directories. From these files, HSLK-TGI
determines who was last on (Since there are no drop files created)
and loads in their user data. It also gathers information about
your file bases and manages the total uploads/user uploads for the
transfer.
HSLK-TGI also requires that HS\Link be setup and working upon
this installation. There will be a few minor modifications, but
for the most part setup HS\Link following the guidelines outlined
in the HSLINK.DOC file provided with your copy of HS\Link.
- Page 1 -
Telegard Hs\Link Interface v1.00 Beta Documentation
Copyright 1991,1992 by Tim Strike. All rights reserved.
_______________________
COMMAND LINE PARAMETERS
_______________________
HSLK-TGI needs a rather extensive command line. Wherever
possible, all "defaults" for HS\Link should be setup in a config
file so that the command line doesn't excess the maximum allowed
by Telegard.
HSLK-TGI must be run in this fassion, else it will not work
properly:
HSLK-TGI BBS_PATH # PORT BAUD <HS\Link Commands>
BBS_PATH is the direct path to your STATUS.DAT file. The #
parameter corresponds to the directory where the uploads will go
(and it might be wise to make a seperate directory for HS\Link
uploads just in case) - Please note this is the directory number
as defined in Telegard, ie, if the filebase is HSLINK UPLOADS #2,
then place a 2 in the place of that variable. The PORT and BAUD
parameters are used to define what port/speed HSLK-TGI should use
after the transfer to check over everything. The <HS\Link
Commands> are whatever extra parameters you wish to pass to
HS\Link, as HSLK-TGI won't touch these.
NOTE:Do NOT include either a -U or a -P on the command line.
HSLK-TGI appends these already, using your TEMP\2 path for
uploads, and the PORT specified above as the port for HS\Link as
well. If you include either of these, hazourdous results could
occur.
- Page 2 -
Telegard Hs\Link Interface v1.00 Beta Documentation
Copyright 1991,1992 by Tim Strike. All rights reserved.
___________
OTHER NOTES
___________
STATUS LINES
HSLK-TGI provides it's own status line on line # 2 before
HS\Link is loaded. This line is colour Light Cyan on Blue, with
Ligh blue ends. It will appear on the screen, like:
▌USER: RIIM (#1) │ UL: 0/0k DL: 1/50k │ TL: 40 ▐
The TL will be the time the user had at the start of the
transfer. Since Telegard seems to write this erratically, it
won't always be up-to-date with the actual time left.
AFTER TRANSFER PROCESSING
HSLK-TGI will search the TEMP\2 directory for any received
files, and if it finds any, will prompt the user to input upload
descriptions, and then add them to the file bases.
HSLK-TGI does NOT do any of the following: Add GifSpecs,
Convert or Test Archives, or Auto-Validate the files. It's highly
suggested that you force all HS\Link uploads into their own
directory for these reasons. (If I get enough requests, I will
add the code in, but otherwise my time can be spent elsewhere...).
HSLK-TGI will also attempt to move the file into the correct
directory. It does NOT check for duplicates on any files, but
again this may be fixed come release version.
HSLK-TGI also does no time-recovery this version, so the
user won't be rewarded any time for uploading (since they
downloaded as well).
When DSZLOG is created, it contains the upload AND the
download information. HSLK-TGI removes the upload information
from this file, otherwise Telegard assumes an unauthorized
download, which isn't close to the truth.
- Page 3 -
Telegard Hs\Link Interface v1.00 Beta Documentation
Copyright 1991,1992 by Tim Strike. All rights reserved.
____________________
EXAMPLE INSTALLATION
____________________
This following section is an example configuration, as used
by me when testing out HSLK-TGI. It is in it's simplest form so
you may wish to expand on these examples in your own installation.
Since Telegard will gather the files it needs to download
from the user input (as a Batch Download) it needs to be setup as
a Batch Download protocol:
(You can also set it up as a normal protocol, in that case
just make sure you include whatever command parameters you would
normally use to stop uploads from coming through, ie single-way
mode).
Protocol #19 of 19
!. Type/protocl:Active - Batch protocol
1. Keys/descrip:"H" / "(H)S\Link Experimental"
2. ACS required: ""
3. Temp. log : "%C\dsztemp.log"
4. <U>L log : "%C\xfer.log"
<D>L log : "%C\xfer.log"
5. <U>L command: *None*
<D>L command: "HSLK-TGI D:\BBS\ 1 %P %B @%L"
6. Codes mean :Transfer bad
7. <U>L codes :(1)"" (2)"" (3)"" (4)"" (5)"" (6)""
<D>L codes :(1)"E" (2)"e" (3)"L" (4)"l" (5)"" (6)""
E. Environ. cmd: "set DSZLOG=%T"
I. DL File list: "%C\fi.lst"
C. Max DOS chrs:128 P. Log position: Filename: 51 - Status: 1
It basically matches your Zmodem protocol, except that the
upload commandline has been toggled 'Inactive' (fiddle till a
little *None* comes up) and the download command line is
different.
If you have your Protocol path defined as something other
then a null, you _must_ put HSLK-TGI.EXE in that directory,
otherwise it will not work.
I would suggest telling your users 'how' to transfer with
HS\Link on a Telegard board. I'll basically quickly run it down
for you in it's simplified way.
1. Select files you want to download as normal, except make them
a batch Download.
2. Goto the Batch Menu, and choose to transfer the files
(Download them), choose HS\Link and begin the transfer.
3. Start sending the files you wish to send while you're
downloading the files.
4. Enter descriptions afterwards.
- Page 4 -
Telegard Hs\Link Interface v1.00 Beta Documentation
Copyright 1991,1992 by Tim Strike. All rights reserved.
________
VERSIONS
________
This will contain UPDATE info for future releases, as well as
some bugs fixes and a general summary of all the new features
added. Please read this section of the documentation on every
update if you don't plan on reading any of the other inform
+:New Feature *:Updated (Fixed) Feature $:Wide Beta Feature
v1.00 Wide Beta
$ First Test Release. Since HS\Link hasn't made it out of the
Beta stages yet, I've decided neither will HSLK-TGI. I can
almost guarentee this won't work on many systems, so please take
care when installing this Wide Beta version. I will not be
responsible for your choice to install this test version of
HSLK-TGI.
Note: At this time, HS\Link has made an official release as
v1.00, and can be obtained on many boards around the country.
PLEASE NOTE THAT YOU RUN THIS WIDE BETA VERSION OF HSLK-TGI AT
YOUR OWN RISK. IT IS NOT FULLY FUNCTIONAL, SO PLEASE UNDERSTAND
THAT ANY PROBLEMS ARISING FROM THE USE OR MISUSE OF THIS PROGRAM
ARE SOLELY YOUR PROBLEM.
- Page 5 -
Telegard Hs\Link Interface v1.00 Beta Documentation
Copyright 1991,1992 by Tim Strike. All rights reserved.
__________
LEGALITIES
__________
WARRANTY
HSLK-TGI is provided as-is, without a warranty of any kind,
either expressed or implied. It is only guaranteed to occupy disk
space, nothing more. Under no circumstances shall the author be
liable to you or anyone else for any damages, including (but not
limited to) any lost profits, lost savings or other incidental or
consequential damages arising out of the use or misuse of this
program.
In other words; RUN THIS PROGRAM AT YOUR OWN RISK. You
yourself, and nobody else is responsible for the outcome of
choosing to run this program.
But NEVER the less, all care should be taken whenever you run
new programs on your system. Files opened by HSLK-TGI include
LASTON.DAT and UPLOADS.DAT, files opened and changed include any
.DIR directory listings, STATUS.DAT and USER.LST.
Make backups of these files, and continue to make backups of
all your files used with BBSs. Trust me; I've had way to many
crashes, and it's always good to have a backup.
Again, run this program at your own risk.
COPYRIGHT
The program, and all documents and files included in the
HSLK-TGI release package are copyrighted to Tim Strike and
Forbidden Knights [BBS] Software Systems. They are not to be
modified in any way, shape or form; However the distribution
archive may be changed from ARJ so long as no files are added nor
removed.
HSLK-TGI can not be included on any distribution diskettee,
nor can it be included in any distribution archive without the
proir written consent of Tim Strike.
CREDITS
All brand and product names referenced in this document are
trademarks, registered trademarks, or copyrighted works of their
respective holders.
- Page 6 -
Telegard Hs\Link Interface v1.00 Beta Documentation
Copyright 1991,1992 by Tim Strike. All rights reserved.
_____________
REGISTRATION?
_____________
[ Will be completed upon the release of the standard version of
HSLK-TGI, though for now it will remain empty, and in the future,
will likely remain free. ]
_____________________
CONTACTING THE AUTHOR
_____________________
I may be reached by sending netmail to TeleNet Canada Node
20:22/0, FidoNet Node 1:259/423 or USTGNET Node 85:896/101. You
may also choose to post a message to me through either the TeleNet
Canada Telegard Conference, or the Telegard Utilities Conference
of USTGNET.
I may also be reached via my own board, Forbidden Knights at
[416]820-7273. 2400-14,400 HST. Before 4:00am, after 6:00am.
Any changes or updates that need to be made to HSLK-TGI v1.00
will be made a new version will be released. Further suggestions,
comments and/or bug reports can be directed through one of the
above methods.
Anyways, I hope you will enjoy the use of HSLK-TGI. It has
taken a while to produce and test, and hopefully you'll be
plesantly surprised with this program.
Enjoy fully.
Sincerly,
Tim Strike, Forbidden Knights [BBS] Software Systems & Programming.
- Page 7 -
Telegard Hs\Link Interface v1.00 Beta Documentation
Copyright 1991,1992 by Tim Strike. All rights reserved.