home *** CD-ROM | disk | FTP | other *** search
- FileGate document for filegate v2.00 and higher
-
- FileGate v2.00 (c)Copyright 1996 by Tdd /Dementia '96
- Released under the label of DMA (Dementia)
- First official public release at 14/03/1996
-
-
- What's filegate?
- ----------------
- FileGate v2.00 is a fileslister, downloader and uploader
- for RemoteAccess compatible bulletinboardsoftware running
- files.bbs or RA internal filedatabase. FileGate will take care
- of download-counters and will start the needed protocols.
- BiDirectional protocols are supported as well!
- The wareztag alike lister is HIGH-speed and easy to use for
- both sysop and user. Lightbars, internal (and external)
- fileviewing, tagging, backscroll, all features are available to
- make life and bbs'ing very relaxed.
- FileGate has multinode support aswell so more than one
- line should be no problem at all.
-
-
- Minimal requirements for installation:
- --------------------------------------
- . MS-DOS 3.30 or higher
- . About 530kb of FREE conventional memory
- . Vga or compatible video-card (for setup)
- . 80286 or better
- . About 1mb of FREE harddisk space for FULL
- installation of ALL features
- . Remote access 2.50 or higher compatible
- bulletinboard-software using files.bbs or
- ra-internal filedatabase
- . You must set the environment variables:
- set dszlog=<path+filename>
- set temp=<path>
- set ra=<path>
-
-
- Included files:
- ---------------
- The following files are needed by filegate
- and are therefore included in the package (if not,
- then contact the nearest support-bbs and get a
- complete package!)
-
- FLG_LST.EXE . The lister
- FLG_DU.EXE . Downloader and uploader
- FLG_STP.EXE . Setup utility
- FLG.CFG . Sample configuration file
- FLGPROT.CFG . Sample protocol-configuration
- File. Includes samples for
- Gsz,BiModem and CeXYZ
- FLG_LST.ANS . The lister ansi
- PROTOCOL.ANS . Ansi used for protocol-selection
- TAGLIST.ANS . Background ansi for TAGLIST-edit
- FLG_UP.ANS . Uploadprocessor ansi
- FLGTHANX.ANS . Ansi shown after a user uploaded
- Some files (optional)
- INTRO.ANS . Background ansi for down- and
- Uploadmenu.
- FLG_AREA.ANS . Background ansi for areaselector
- FLG_GRP.ANS . Background ansi for group-selector
- SEARCH.ANS . Ansi for keyword and newfiles-search
- FLGMAIN.ANS . Ansi for filegate internal lightbar-
- Menu (not tested though...)
-
- Included protocols in the package are Zmodem(gsz),
- BiModem(pampa). They are included in their original package
- so you have to unpack them yourselfes.
-
-
- Installation and configuration:
- -------------------------------
- UnZip the package in any directory you want, run
- the FLG_STP.EXE and change colors, directories (non-existing
- directories are generated) and switch between remote-access
- or files.bbs.
-
- When you select COLOR-CONFIG:
- - LIGHTBAR FOREGROUND
- Foreground color of the lightbar
- - LIGHTBAR BACKGROUND
- Background color of the lightbar
- - GLOBAL TEXTS
- Color of the texts like (areaname or
- Search on keyword'
- - FILENAME COLOR
- Color of the filename in lister
- - FILESIZE
- Color of the size(length) of the file
- In lister
- - DOWNLOAD-COUNTER
- Color used for the downloadcounter
-
- - FILENAME/SIZE
- Color used for the uploaded-filename and
- Size of that file
- - PROTOCOL
- Color of the protocol-name showed in the
- Download/upload-menu
- - BYTES FREE
- Color used for bytes free on uploaddisk'
- And transfertime'
-
- Explanation of directory-entries etc:
- - PROTOCOL DIRECTORY
- All protocols must be located in this
- directory!
- - UPLOAD DIRECTORY
- The public upload-directory, uploads
- that are public will be put here
- - PRIVATE DIRECTORY
- The private files (to sysop) will be
- put here
- - COMMANDLINE FOR VIRUSCHECK *
- This commandline will be used while
- checking the uploads for virusses.
- (Tested with tbav)
- Example: C:\TBAV\TBSCAN @ KI BA
- - BANNERFILE *
- The TEXTfile mentioned here will be
- Stamped on all uploads
- - COMMERCIAL FILE *
- This file will be added to all uploads
- - UPLOAD PROCESSOR COMMANDLINE
- This commandline will be used to activate
- An external uploadprocessor, use the @' char
- For passing filenames (@ will be replaced
- By the file to be processed)
- * FILLING THIS LINE WILL DEACTIVATE THE
- INTERNAL FILEPROCESSOR !
- (Tested with skullcheck)
- Example: C:\SKULL\SKULLCHK.EXE @ /N*N /P*P
- - EXTERNAL FILEVIEWER
- FileGate will start this program as the
- Fileviewer, instead of the internal one
- (Tested with x-view)
- Example: C:\XVIEW\XVIEW.EXE @
-
- When you select TOGGLES (use space to toggle)
- - DATESWAPPING
- While developing filegate, we encountered
- Some bug with ra2.50, it returned the
- Last-logon-date incorrectly, it returned
- It like this: MM/DD/YY, it must be DD/MM/YY
- So this option will swap DD and MM
- - USE UPLOADED BY STRING
- If switched, filegate will add an uploaded
- By string to the files.bbs when processing
- The upload (does not work with ra internal
- filedatabase)
- - ADD TAGDUDE.HUH TO DOWNLOADLIST
- FileGate will add a textfile containing
- Descriptions of all tagged files to
- Downloadlist if switched ON'
- - USE FILEGATE.LOG INSTEAD OF RA.LOG
- Turn this ON' if you do not want filegate
- To add the log-entries to the RA.LOG
- But add it to a special FILEGATE.LOG
- (This file is located in the ra-dir)
- - CONVERT TO NEW ARCHIVES (IN UPLOAD-SCAN)
- Select the archive-format to convert uploaded
- Files to here (does not work if you use an
- External uploadprocessor)
- - WHICH TYPE OF FILEDATABASE DO U USE
- This option lets you select FILES.BBS or
- Ra internal filedatabase (faster!). Now you
- don't need to use the slow FILES.BBS and will have
- Cool descriptions as well
-
-
- Multinode:
- ----------
- Multinode should work, however, it is not fully
- tested so it might give some problems.
- All files that are needed are located in the following
- directories.
-
- %RA%\NODE<nodenumber>\DORINFO1.DEF
- %RA%\NODE<nodenumber>\EXITINFO.BBS
- %RA%\FILES.RA (and all other related files)
-
- These directories are only activated when you start filegate
- with the '#' char for multinode support (must be first parameter!)
-
- (In this example RA is located in C:\RA)
- Example: FLG_LST.EXE #3 L
- this will choose node3, reads the following files
- C:\RA\NODE3\DORINFO1.DEF
- C:\RA\NODE3\EXITINFO.BBS
- and lists the current area
-
-
- The Lister:
- -----------
- Start without parameters for explanation of the commandline
-
- Available functions:
- . File- and message- Group/Area selection
- . Taglist editing
- . Keyword search (searches on filenames as well!)
- . Area listing
- . Newfiles search from last date user logged on
-
- Executable: FLG_LST.EXE
- Parameters: [!|#<nodenr>] [SG|SF|SC|SM|N|NA|K|L|E]
-
- Commandline options:
-
- ! . Force into local-test-mode (do not
- read dorinfo and exitinfo)
- * MUST BE FIRST OPTION *
- # . Go for multi-node support, (eg.
- FLG_LST #2 for node2)
- See for multinode for more info
- * MUST BE FIRST OPTION *
- SG . Select filegroup and filearea
- SF . Select filearea
- SC . Select mailgroup and mailarea
- SM . Select mailarea
- L . List current filearea
- K . Search on keyword
- N . Scan for newfiles since last call
- NA . Ask if user wants to scan for newfiles
- E . Edit current taglist
-
-
- Sub. NEWFILES
- --------
- The newfiles checker will scan for all newfiles
- since the last logon of the user. It will take
- the lastdate variable out of the userrecord.
-
-
- Sub. KEYWORD
- -------
- This feature lets the user search on keyword
- through the entire bbs. (Also on filenames!)
-
-
- Sub. INTERNAL FILEVIEWING
- --------------------
- FileGate has an internal fileviewer aswell, this one
- should work on all systems, however, it is not yet
- fully developed (still busy on viewing music-files and
- other formatted files). So if this one gives you any
- bugs, just use an external one (tested with X-VIEW 1.81)
-
-
- The downloader and uploader:
- ----------------------------
- Available functions:
- . Downloading all tagged files
- . Making a textfile containing descriptions of all
- tagged files that are to be downloaded (tagdude)
- . Uploading and processing uploaded files
- . Importing file_id.diz files into files.bbs or
- ra filedatabase
-
- Executable: FLG_DU.EXE
- Parameters: [!|#<nodenr>] [D|U]
-
- Commandline options:
- D . Download all tagged files
- U . Start receiving files, private or public
- and process them afterwards
- D[path+filename]
- . Will force (one) file to be downloaded from
- commandline (handy for allfiles etc..)
- U[path]
- . Will force the upload-directory to the specified
- one
-
-
- Sub. UPLOADPROCESSOR
- ---------------
- FileGate has an internal file-uploadprocessor, it
- worked just fine at my board, however, I cannot
- say it will work on ALL boards. You can therefore
- use an external processor, this processor should
- add the file-description to the filebase because
- filegate does not do that (when using external one).
- Installing an external processor is recommended
- (If you want full and good upload-processing).
- It was tested with SKULLCHECK 3.80a and it went well!
-
- The internal processor checks the uploaded files
- for virusses, stamps a banner, adds a commercial file
- and imports the file_id.diz into the filebase.
-
-
- Sub. TAGDUDE.HUH
- -----------
- This file is generated while scanning for tagged files
- it contains all descriptions of the tagged files and has
- both header and footer. These header and footer can be
- configured to your own needs, the filenames of these
- files are: TAGHDR.HUH (for the header) and
- TAGFTR.HUH (for the footer)
- Both files are added to the TAGDUDE.HUH file.
- !!! These files must be located in the RA directory!
-
-
- Sub. PROTOCOLS
- ---------
- All protocols MUST be DSZ-log compatible for filegate
- to recognize the down- and uploads. For filegate to find
- the DSZ.LOG file, the DSZLOG variable has to be set!
- Set this variable in you autoexec.bat or the batchfile
- you use to start your bbs-software!
- SET DSZLOG=C:\LOGS\DSZ.LOG (for example that is...)
- See for the protocol-installation part in this document
- for more information about installing protocols!
-
- !!! Further, filegate changes the current directory to
- the TEMP directory (set in autoexec.bat) this directory
- MUST exist, filegate will report a runtime error if
- I could not change the directory!
- (This temp-variable is also used for other features
- so it's wise to set it!)
-
-
- Sub. TODAYS DOWNLOADS
- ----------------
- FileGate also generates two files named FLGTODAY.UP and
- FLGTODAY.DWN, these files contain all files that have
- been downloaded (or uploaded) today, files that are
- more then once downloaded get a higher number (they are
- not added twice!). There is no util that converts these
- files to an ansi-file so you have to wait for an util
- that does so (sorry for that...).
- These files have to erased by you every night (filegate
- wont erase them if a day goes by..) Or else you'll get
- very long lists containing files that have been downloaded
- weeks ago (or files that have been downloaded about 100x).
- The record-format is listed at the end of this document
- (This is for util-coders).
-
-
- Protocol-installation and supported protocols:
- ----------------------------------------------
- FileGate supports one-way as well as bi-directional
- protcols. You can install these protocols with the
- setup-utility (flg_stp.exe). Up to 10 protocols are allowed.
- All available macros are listed in the protocol-editor, however,
- here's a list:
- *B . Current bpsrate, not comport but modemspeed!
- *L . Logfile position (dsz compatible) this is
- The same as the DSZLOG variable.
- *F . Fileslist, this file contains a list of all
- Files that are tagged and to be downloaded!
- (Including path)
- *U . Upload directory (where files are received into)
- *P . Current comport (1=com1 etc..)
- * IMPORTANT * This will be set to 1 in local
- Testmode! (So don't go crazy while testing it)
- *K . Kilobyte limit (this variable holds the users
- Kb-limit that is yet available for download
-
- Some protocols like GSZ and BIMODEM are already configured in
- the example protocol-configuration. So you don't need to enter
- your own commandline.
-
-
- Known bugs:
- -----------
- There are still bugs to be fixed, and features
- of remote access that are not yet supported. Here's a
- list containing all we know about them:
- . Area flags not supported (still working on it though)
- Use levels instead!
- . Remoteaccess internal filebase
- Files flagged FREE within an area that is NOT free at all
- (not supported yet!)
- . Pressing escape while testing locally might lead to
- a strange hang of your computer (we think it's already
- fixed but, just in case it goes wrong, wont happen
- with a user online)
- . Remote access 2.50 saves its LASTDATE differently then
- You config it, we therefore implemented a date-swapping
- Routine that will swap the date to the one wanted!
- . The timer does NOT work under DESQVIEW, the usertime will
- not be updated (not decreased), RA will update it correctly!
-
-
- Final message:
- --------------
- That's it for now, more weird options for filegate are
- coming very very soon. If you are a coder of weird utils
- (like todays downloads, a record-structure in PASCAL can
- be found at the end of this document).
- Support can be found at the following bbs's
-
- Digital Underworld: Final Chase
- +31-(0)23-5240160
- 2k4 - 14k4
- Syzo Tdd
-
- Lounge Act
- +31-(0)71-5790411
- 2k4 - 14k4
- Syzo Vertigo
-
- You can also e-mail me (the coder:Tdd) at
- v952481@si.hhs.nl
- or check the filegate-homepage (not really
- up to date.. But who carez)
- http://www.hhs.nl/~v952481/home.html
-
-
- Thanx fly to:
- . The Free Debugger (for his intensive beta-testing)
- . Vertigo, for his high phonebills :)
-
-
- Greetz to:
- . Members of DMA, Brainrave, Mad Max, Scsi2, Highlite,
- Thunderbass
- . Member of BLACKTRON, Armadon
-
-
- !!! AND KNOW, THE STRUCTURE (IN PASCAL)
-
- This structure is used in the following files:
- FLGTODAY.UP and FLGTODAY.DWN
-
- These files contain the information about files that
- are downloaded/uploaded today (well, you have to erase these
- files yourselves in an daily event)
- The uploaded files do not use the TIMES variable!
-
- TODAYUPDWN = RECORD
- FN : STRING[12];
- TIMES : BYTE; { not used in FLGTODAY.UP }
- END;
-
- <end of doc>