DP Tool Club 12

home *** CD-ROM | disk | FTP | other *** search

/ DP Tool Club 12 / CD_ASCQ_12_0294.iso / vrac / sfreq099.zip / SFREQ.DOC < prev next >

Wrap

Text File | 1994-02-12 | 17KB | 436 lines

SF-Request v.99a Copyright 1994 by Richard Lemaster Over The Line BBS (918)250-0542 Note ----- This is a beta version of Sf-Request. Everything seems to working fine but if you have any problems, please let me know. See the bottom of this file about how to contact me. About SF-Request ----------------- This program will let your users request files from an offline cd-rom. You can have up to 99 discs with 250 areas each. It is also a good way to keep track of what files you have on Cd-Rom because you can search for a file without having to change discs. It is made to run on a Spitfire BBS only. It comes with a program called Fill Requests which will fill the requests. Read the text file Fillreqs.doc for more information about the Fill Requests program. Installing SF-Request ---------------------- Setting the door up is very quick and easy. The first thing to do is make a dir for SF-Request and place all of the included files there. Next, copy the file listings to any dir. The listings must be the same type as the Sffiles used by Spitfire. Make a data file for each disc and place it in the dir with the SF-Request files. The data file includes: Line 1: The name of the disc. This is used when filling the requests only. Line 2: The security level needed to access this disc. Line 3: This is the number of file listings listed below. Lines 4+: These are the file area description lines. They contain the information about each area for this disc. See examples below. Example: ;40 H:\MODEM C:\SF\SFREQ\SFFILES.4 First is the security level needed to view this list. It is not required but if included, it must have a ";" before it. Next is the path to these files on the cd-rom disc. Last is the listing for this area. It can be any Sffiles type list. This is the same format that Sf-Rom uses so you can just copy that section. With the above example, a caller must have a security level of 40 to view this list. You can also place a "P" after the sec level. This will allow any sec level to preview the disc but not request from it. Example: ;40P H:\MODEM C:\SF\SFREQ\SFFILES.4 This will allow any caller to view the list but only sec 40+ can request from this area. Example: H:\MODEM C:\SF\SFREQ\SFFILES.4 This will allow any caller to request from this area. Save the file as DISC#.CFG where # is the number on the disc menu for this disc. You can have up to 250 areas in each DISC#.CFG file. After making the data file, edit the Sfreq.cfg file for your board. I've included a sample copy which you can edit for your own setup. Below are the Keywords in the config file and a description of each. NumberOfDiscs - Number of discs available Example: NumberOfDiscs 15 Default = 1 LogFile - You can put Callers.tmp here if you want activity logged to the Callers.tmp file for the node being used. (Registered version only) Example: LogFile Callers.tmp Default = Callers.tmp InActive - Inactivity Delay. Number of seconds of inactivity before caller is returned to the BBS. Default is 180. Example: Inactive 120 Default = 180 CheckSnow - May be needed for some older CGA monitors. Example: CheckSnow Off Default = Off DirectVideo - Turns On/Off direct video writes. On is faster and should work on most monitors. Example: DirectVideo On Default = On FilledDir - Directory where filled file requests are placed. Example: FilledDir F:\Fillreqs Default = C:\ KeepOldFiles - Number of days to keep files in filled request dir. Files deleted if not downloaded within this many days. Example: KeepOldFiles 7 Default = 7 MessageArea - SF Message area to place replies. Set to 0 if you don't want any messages sent. (Registered versions only) Example: MessageArea 1 Default = 1 SfPath - Spitfire home directory. Uses Sfnode.dat here to get message area information. Example: SfPath C:\SF Default = C:\SF FileExt - File extension and command to add logo to file. Must have full path and extension. File name added to end of this line. You can have up to 2 of these lines. Example: FileExt Zip C:\SF\SFUtils\Ziplogo.exe LineChar - This is the char used to determine if a line has a file name in it or is just a description. Example: LineChar 18 , Default = 18 , AddToSffiles - If this is On, then Fill Requests will add the file description to the Sffiles.bbs listing in the filled request directory or the file name used with the SffileName config keyword. Example: AddToSffiles On Default = Off SffileName - The name of the file listing Fill Request will add the descriptions to. Must include directory and file name. Example: SffileName C:\SF\Display\Sffiles.1 Default = Sffiles.bbs in filled requests directory KeepForDL - If this is On, then Fill Requests won't erase the file after it has been downloaded by the person who requested it. Use this with AddToSffiles to make requested files available to all callers. Example: KeepForDL On Default = Off Rip - If you want to use RIP displays, set this to On. See below for RIP display file names. Example: RIP On Default = Off UseControlPanels- This will only work if you have RIP On. It MUST come after RIP On in the Sfreq.cfg file. This will display a control panel on the main menu if no Menu#.Rip is found. This will allow you to use your ANSI menus with RIP because it would probably take alot of work making a new RIP menu for each disc. With this off, Sf-Request will just display the menu. Example: UseControlPanels On Default = Off ExtProt - This can be any external protocol that can use a text file listing of file names when downloading. DSZ, HS-Link, and any other that can be used with SF's Usefile option will work. The parameters passed are %1 = Baud, %2 = Port, and %3 = File name. The command line for this is: ExtProt <menu letter>,<menu name>,<batch Y or N>, <Program name and any parameters program needs> Examples: ExtProt H,Hs-Link,Y,Hs-link.exe -P%2 -@C:\SF\EXTERNAL\HSLINK.CFG %3 ExtProt Z,Zmodem,Y,C:\SF\Sfutils\DSZ.COM %2 sz -m -rr %3 You can copy this command line from your SF batch files but you MUST include the full path and extension of the protocol as in the zmodem example above. The program has zmodem built in but this was used to show how the line should look. You can only have 1 external protocol. SendOneMessage- If this is On, then only 1 message per day will be sent *NEW* to the caller. If this is Off, then 1 message can be sent for each file. Example: SendOneMessage On Default = On FlagFile - Flag file made when a file has been requested. You can use *NEW* this file to let you know when there are file requests waiting to be filled. If this file exists, then file requests need to be filled. Its quicker to check for this flag than to run Fill Requests. Leave out of Sfreq.cfg or use None if you don't a flag file made. Example: FlagFile C:\Requests.flg Default = None StatusBackground - Background color for caller status bar. *NEW* Example: StatusBackground 4 Default = 1 StatusText - Text color for status bar. *NEW* Example: StatusText 11 Default = 15 LineColors - Change color of each part of line in file listings. The *NEW* format of this line is: LineColors <Tag Color> <File Color> <Size Color> <Date Color> <Desc. Color> Example: LineColors 2 10 4 5 12 Default = LineColors 15 16 15 11 12 (Same as Spitfire) Color Codes: Black 1 DarkGray 9 Blue 2 LightBlue 10 Green 3 LightGreen 11 Cyan 4 LightCyan 12 Red 5 LightRed 13 Magenta 6 LightMagenta 14 Brown 7 Yellow 15 LightGray 8 White 16 You can also use "LineColors Random" which will choose random colors, except black, for each part of the line. SEC - Must be SEC <sec level>,<max # of requests(1-250)> Can have any number of sec levels. If callers sec level not listed, they have up to 250 requests. The below example shows a caller with sec 10 can request up to 25 files a day. Example: SEC 10,25 You now make the display files which are described below. Display Files -------------- SF-Request has built-in ANSI support and will recognize the following Spitfire display control codes: ^L , ASCII #12 - Clears the screen ^P , ASCII #16 - Displays a "More Prompt" These are the display files used by SF-Request. Not all are required. They must be placed in the SF-Request home dir. Welcome.bbs/clr/rip - The welcome screen seen when door entered. This should be used to tell callers when their requests will be ready for download. (Not required) Menu#.bbs/clr/rip - The file area menu for # disc. The # can be between 1-99. You need one of these for each disc. If a display for a disc can't be found, the door will exit. M#_<Sec>.bbs/clr/rip - This is the same as above but for the security level indicated. Example: M2_50.CLR is the file area menu for disc 2 and security level 50. Sorry for this strange file name but its the only way I could get a disc number and a security level on 1 line. Discmenu.bbs/clr/rip - This is the menu of the different discs available. You can have up to 99 different discs. If not found, the door will exit. Disc<Sec Level>.bbs/clr/rip - The same as above but for the security level indicated. Goodbye.bbs/clr/rip - The screen shown when leaving door. (Not required) There is a built in pause message after showing the display. If you have a Goodbye.Rip, you should have a text window somewhere to write the message. Running SF-Request ------------------- The command line for SF-Request is: Sfreq <sf drop file> The drop file can be Sfmain, Sffile, Sfmess, or Sfdoors.dat. You must put the complete path and file name of the drop file. To run in local mode: Sfreq local There are no other options you can use on the command line. SF-Request Files ----------------- These are the files made by running SF-Request. Request.dat - The data file containing all requested file information. Callers.dat - Keeps track of daily caller usage. This will keep track of how many files the caller has requested today. Errors.log - This is a log of any errors that occur. Filled.dat - Data file with information on filled requests. Node<#>.lst - List of files used for downloading. Message.dat - Made by Fill Requests. Tracks messages sent so caller is only sent 1 message and not 1 for each file. Features of SF-Request ----------------------- Multi-node support ------------------- SF-Request has full file sharing and locking built in using Mike Woltz's BC Share. You can use it on as many nodes as you like. You only need one copy of the SF-Request files to handle any number of nodes. Download Files --------------- Callers can download their filled requests from inside Sf-Request. It also allows batch downloads via Y or Zmodem. You must have DSZ.COM in your path somewhere. Sysop keys ----------- While running SF-Request, you can use these keys: Alt+C - Enter or exit Chat Mode. Alt+D - Drop to DOS. You don't have to change back to the SF-Request dir when returning. Alt+W - Will write the files in the request queue to disk. This will allow you to drop to DOS from within Sf-Request and fill the requests while the caller is in the door. It will also clear the requested file queue. F6 - Take 5 minutes from caller. F7 - Give 5 minutes to caller. F10 - Return caller to BBS. Alt+F1 - Drop carrier with no message. Home/End - Toggles caller info and sysop keys status bar. Activity Log (Registered version only) ------------- You can log all door activity to any file you want. Put the file name in Sfreq.cfg. This can be the Callers.tmp for the node being used or any other text file. File and Text Searching ------------------------ Will allow a caller to search for text or a file name on 1 disc or all discs. File Tagging ------------- Allows callers to tag files just like in Spitfire. Caller can tag up to 250 (2 in unregistered) files unless specified in Sfreq.cfg. Request Queue Editing ---------------------- Allows caller to remove files from their queue of requested files. Multi-Line Desc ---------------- Multi-line file descriptions are supported by reading the (ASCII #02) character used by Spitfire. Multi-Tasking ------------- Sf-Request supports the following multi-taskers and will release its time slices while idle. Windows 3.x & NT DESQview 2.xx DoubleDOS VMiX 2.xx MultiDos Plus 4.xx OS/2 2.0 DOS 5.0 Task Switcher and Compatibles TaskView, TopView, OmniView, & Compatibles Com Ports ---------- Can be used on com ports 1-8 using standard IRQ's. Note ----- If the file search cannot find a file that you know is there or if the file listings are messed up, check the LineChar option in Sfreq.cfg. Disclaimer ----------- Use this program at your own risk. There are no guarantees that SF-Request will run on your system. Richard Lemaster shall not be held responsible for any damages incurred while running Sf-request or Fill Request. The user accepts all responsibility when using these programs. Registration ------------- Registration for SF-Request and Fill Request is $15 for both, not each. The added features available to registered users are: - In unregistered version, caller can only request 2 files. When registered, caller can request up to 250 files. - Can have callers activity logged. - Removal of "Unregistered" in opening screen. - When a request is filled, a message can be left in the Spitfire message base letting the caller know if their request was filled. - Complete support for any problems you're having with SF-Request. Once registered, all future upgrades are free. You will only need the latest version. Your registration key will work with all future versions. You can call my BBS and pick up your registration key usually within 24 hours after receiving your letter. If you are not already a caller, please fill the necessary information below. Information needed for registration ---------------------------------------------------------------------- BBS Name (up to 40 chars):________________________________________ Sysop Name (up to 40 chars):________________________________________ Your Mailing Address: What password will you use when calling me: What name will you use when calling me: ---------------------------------------------------------------------- To register, simply fill out the questions above and mail it and a check, or money order for $15 to: Richard Lemaster 7332 So. 74 E Ave. Tulsa, Ok 74133 If you have any suggestions, comments, or problems with SF-Request, you can leave me a message in any of the Circuitnet confs or the Fidonet Spitfire conference. Or you call my BBS listed below. Over The Line BBS Richard Lemaster - Sysop Circuitnet 918001 Fidonet 1:170/260 Line 1:(918)250-0542 14.4 Line 2:(918)250-2462 14.4 The latest version can always be FREQ'ed with the magic name "SFREQ" from me at 1:170/260 or Chris Cook at 1:15/26. Thanks to Mike Robinson and Dave Clark for their help in writing and testing this program. File sharing and locking are from BCShare by Mike Woltz. "SPITFIRE" is Copyright (C) 1987-1994 by Mike Woltz. "SPITFIRE" is a registered trademark of Buffalo Creek Software. "BCSHARE" is Copyright (C) 1990 by Mike Woltz. "SF-Rom" is Copyright (C) 1994 by Mike Robinson.