home *** CD-ROM | disk | FTP | other *** search
- GETFILE v1.6 (91 06 03) Documentation (c) Copyright 1991 by Roy Pereira
- -------------------------------------------------------------------------------
-
- Ok, I've given in to peer pressure and written some documentation for this
- thing. GETFILE is a small door that uses the special features of PCBoard 14.5a
- to include the file descriptions along with the rest of your batch download.
- This is a feature I think, that all bbs and protocol developers should think
- about incorporating.
-
-
- THE PROBLEM:
- You download quite regularly from bulletin boards, but when you finnally
- take a look at your directory, you forget what the hell you downloaded!
-
-
- THE SOLUTION:
- You have two options: Either spend 'x' amount of time downloading the
- entire file list from the bulletin board, or use GETFILE.
-
-
- WHAT GETFILE DOES:
- GetFile loads up your pcboard.dat file and gets the location of your dir.lst
- file. It then opens it up and finds out what your directory file are. Now it
- goes through them and copies the file descriptions for the files you have
- specified. It saves these file descriptions to a plain text file. It then save
- the following to PCBSTUFF.KBD: "DB descfile.txt file1 file2 file3 ..." where
- descfile.txt is the name that you specified and file1, file2, file3... are the
- names of the files you wish to download. This has the effect of stuffing this
- string into the keyboard as if you would have typed it. Ces't tous! (That's it)
-
-
- USAGE:
- GETFILE <pcboard.dat> <descfile.txt> <file1> [file2 [file3...]]
-
- eg. GETFILE %PCBDAT% C:\PCB\BLT\FLDESC%NODE%.TXT %PCBDOOR%
-
-
- EXPLANATION OF USAGE:
- The %PCBDAT% parameter is the environmental variable set by PCBoard that
- is the path and name of your current PCBOARD.DAT file.
- Starting with v1.3, the <descfile.txt> does not need to have the node
- number in it. GetFile will automatically use the node number as a prefix
- to this filename. eg. If <descfile.txt> equals "C:\PCB\BLT\IMPORT.ME" and
- the user is on node 14, then the file "14IMPORT.ME" in the "C:\PCB\BLT"
- directory would be created.
-
- NOTE: This file HAS to reside in one of your download paths! You can later
- delete these file description files in your event.
- The %PCBDOOR% paramter is the variable set by PCBoard that has the parameters
- that were typed after the door name while the user was in PCBoard.
- Eg. GETFILE PCBFILES PKUNZIP.EXE
- PCBDOOR would be "PCBFILES PKUNZIP.EXE"
-
- NOTE: PCBFILES would be looked up as PCBFILES.ZIP if ZIP was your default
- extension as set by in PBCSETUP. If you default extension was ARC,
- then it would be PCBFILE.ARC instead.
-
-
- GetFile can handle up to 99 files. And starting with v1.5, GetFile can handle
- wildcards in its file names.
-
- eg. GETFILE PCB* BLT*.*
-
- This will find all files in the conference that are like "PCB?????.ZIP" or
- "BLT?????.???".
-
-
- SYNTAX IN PCBOARD:
- To make this door small, there is no code to ask the user for the file names.
- This would have made the door a lot bigger since I would have needed to
- incorporate communications code to access the COM ports. Instead I opted for
- a simpler method. For GETFILE to operate properly the user must type in the
- filenames on the same line as GETFILE. Just typing in GETFILE by itself will
- download an empty file description file.
-
-
- SETING UP:
- I recommend shelling to GETFILE from PCBoard by using these parameters in
- your door.lst file:
-
- File Name Sec Login USER SYS DOOR SYS Shell
- GETFILE 20 N N N Y
-
-
- DISCLAIMER:
- Offiously, I will not be responsible for damages that you may inflict on
- any computer equipment (hardware or software) just because you used my
- software. GETFILE is being distributed as freeware, but is copyrighted by me!
- Please don't sell it or include it in a package that will then be sold. The
- source code is available to anyone who wants it by contacting me.
-
-
- AUTHOR:
- I can be reached at Saltair, the PCBoard support BBS, as "CANADIAN INT.".
-
- Roy Pereira (819) 994-3857
- CIDA bbs (819) 953-8208/8207 14400 Dual HST/Ultra 96 (DataPac soon)
- Saltair bbs (801) 261-8976 9600 HST
-
-
- APPOLOGIES:
- I do appologize to anyone who was frustrated by GETFILE without any
- documentation. I hope this helps. If this document isn't clear enough though,
- I will answer your questions at the above places.
-
- HISTORY:
- 1.6 - 91 06 03 - Now also looks at the public upload DIR file.
- 1.5 - 91 05 24 - Added support for wildcards.
- 1.4 - 91 ? ? - Uses the default extension if needed.
- 1.3 - 91 ? ? - I don't remember!
-