home *** CD-ROM | disk | FTP | other *** search
/ Crawly Crypt Collection 1 / crawlyvol1.bin / bbs / pqwk101 / phidoqwk.doc < prev    next >
Text File  |  1993-08-22  |  13KB  |  345 lines
  1.  
  2.  
  3.                            PhidoQWK Docs
  4.                            August 2,1993
  5.  
  6. Introduction
  7.  
  8. What is PhidoQWK? This is a doors program for FIDODOOR users that 
  9. will allow your users to log in, download new messages from the bases
  10. that they have selected (and you have validated them for) in a
  11. compressed format. They can then take this packet and through
  12. MaxiMiser (for ST's) or any IBM QWK compatible program (Deluxe2,SLMR,
  13. Ezreader all have been tested) enter their replies to be uploaded and
  14. posted in the correct message bases.
  15.  
  16. PhidoQWK maintains complete BBS security:
  17.  
  18.        Checks for Message Read flags
  19.        Checks for Message Enter Flags
  20.        Checks User Time limits (Can't enter without enough time)
  21.        Checks free disk space so it will not crash or overfill HD
  22.        Checks Ram available to ensure safe execution of ARC/LZH/ZIP
  23.        Validates packets to ensure correct Compression program used
  24.        Updates Messages Entered Counter
  25.        Updates Messages Read Counters
  26.  
  27. Allows you to configure:
  28.  
  29.        Which commands to pass to ARC/ZIP/LZH
  30.        Which commands to pass to external protocols
  31.        Online help text.
  32.        How Many messages a user can get from a Base by baud rate
  33.        How many messages a user can get from a Session by baud rate
  34.        Do you wish to delete extra included lines
  35.        Logging
  36.        
  37. Allows user to configure:
  38.  
  39.        Which Compression they want to use
  40.        Which protocol they want to use
  41.        How many messages they will receive (<= you global choice)
  42.        Maintains Users High Message read counters
  43.  
  44.  
  45.  
  46. What does running PhidoQWK mean to you the Sysop?
  47.  
  48. Your BBS will become more available to other users. I can log onto the
  49. a BBS, grab 700 messages and download the packet and be off in 9 mins
  50. instead of the usual 90 (and even in 90 I didn't get to read everything).
  51.  
  52. If you have a second system you to will be able to take advantage of
  53. offline entry of messages. PhidoQWK in local mode copies files to disk
  54. so that you may take you packet to your other system and stay current.
  55. Again you BBS will be available to your users even though you are "on it"
  56.  
  57. The message content will be more accurate and precise. People will be able
  58. to take their time in composing responses so typo's will be reduced and 
  59. the message will be more coherent and to the point.
  60. (With the added time maybe even FLAMES will be toned down)
  61.  
  62. Without Toll charges hindering some of your long distance callers, they
  63. to will become more involved in the BBS.
  64.  
  65. Setting up
  66.  
  67. First you should have in this LZH the following files:
  68.  
  69.         PhidoQWK.PRG  - This is the main program
  70.         MAXICFG2.PRG  - The configuration program
  71.         MAXIHELP.DAT - The online HELP file
  72.         MAXIHELP.IDX - The index file for the help
  73.          MAXIIDX.PRG   - Creates the IDX file if  you  change  the 
  74. MAXIHELP.DAT
  75.         PROTOCOL.DEF - External Protocol Definitions
  76.         MAXBAUD.DAT  - Sample Messages/Baud dat file
  77.         PhidoQWK.TXT  - You are reading it
  78.  
  79. You will need to supply from your own collection:
  80.  
  81.             ARC.TTP   -
  82.      This is the default compression used in PhidoQWK
  83.      For speed I recommend ARC 6.02 but any will work.
  84.             
  85.             LHARC.TTP -
  86.       This is Optional but it provides an alternative
  87.       Compression. I have used LZH201i successfully.
  88.  
  89.             STZIP.PRG -
  90.       This is also optional. This will provide your 
  91.       IBM Users with a alternative as many of their
  92.       readers default to ZIP. I have used STZIP2 with 
  93.       success.
  94.  
  95.              XYZ.TTP   -
  96.      This is the file protocols I use to send and
  97.      receive the packets. Please get version 2.01. 
  98.      Remember that XYZ is shareware and Mr. Hamilton deserves his money.
  99.  
  100. Now with all of these gathered together in one place (the main 
  101. BBS folder where FIDODOOR.CFG is) you should run MAXICFG.PRG. It 
  102. will ask you to fill in a few pertinent details that PhidoQWK 
  103. needs to know. Here is an overview of each configuration option:
  104.  
  105. 1) BBS Name - The is the full name of your BBS
  106.  
  107. 2) Location -
  108.  There is the City and State/Province in which you are
  109.               located.
  110.  
  111. 3) Logoff   -
  112.  This is where you enter a text file that will be displayed
  113.               to the user when they terminate their offline session.
  114.  
  115. 4) Sysop    - Your Name/Alias
  116.  
  117. 5) Welcome  -
  118.  An intro screen shown to the user when they begin to
  119.               read a packet generated from your BBS.
  120.  
  121. 6) Shortname-
  122.  This is a name (less then 8 characters) that will be
  123.               applied to the packets outgoing and incoming from
  124.               your BBS. Please note that no spaces or none ascii
  125.               characters are allowed. LEFTOVER is valid but LEFT OVER
  126.               is not.
  127.  
  128. 7) Bulletin - This is a file shown to the user directly after the
  129.               intro screen. This may contain any news or bulletins
  130.               you feel the user should see.
  131.  
  132. 8) Phone #  - The Phone # for the BBS
  133.  
  134. 9) ARC Location -
  135.  This is where you tell PhidoQWK where to find ARC.TTP
  136.  
  137. 10) ARC Extract -
  138.  These are the commands you pass to ARC to extract a
  139.                   file.
  140.  
  141. 11) ARC Move - These are the command you pass to ARC to MOVE a
  142.                group of files into a compressed format.
  143.  
  144. 12,13,14) - Same as 9,10,11 except this is for ZIP
  145.  
  146. 15,16,17) - Same as 9,10,11 except this is for LHARC
  147.  
  148. **Note leaving 9,12 or 15 blank will disable the availability of those
  149.   compressions to the users.
  150.  
  151. 18) Protocol Def. - This is where you will supply the Name of  the 
  152.                     protocol (as the users will see it),  the path 
  153.                     to the executable and the command line parame-
  154.                     ters.  This is needed to send and receive the files.
  155.  
  156. 19) Max Messages/baud -
  157.       This will take you to a submenu when you can
  158.     define BY BAUD RATE, how many messages will be sent both per
  159.     conference and per session. This will allow you to fairly decide which
  160.     baud rates can receive more or less. I support only bauds
  161.     300,1200,2400,9600 & 19200 at this time. IF the bbs reports any other
  162.     baud rates please let me know and I will make the adjustments.
  163.  
  164. 20) BBS Type - This is where you enter FOREM/TURBO or TURBO2 (for
  165.     turbo 2 owners I will add the necessary offsets for  the expanded
  166.     pas.dat file and adjust for the different file directory structure).
  167.     If you are using PHIDOQWK you can also enter OTHER in this line and
  168.     you will be prompted for the Drives online for your BBS and the name
  169.     of you main BBS folder. These are store in an ASCII file called PHIDOQWK.OPT.
  170.  
  171. 21) Allow MaxiMiser Quotes -
  172.       A YES will allow the initials in quote lines to be left in. A NO will strip the initials
  173.       out and leave the > symbol only.
  174.  
  175.  
  176. 23) Location of LOG file - This is the name of the PhidoQWK log file.
  177.      If you do not wish to have one then enter NOLOG on this line.
  178.  
  179. 25) Censor Taglines -
  180.      There are 3 possible options here, ALL, NONE or
  181.      a base list. If you enter ALL or a base list then taglines will be
  182.      removed from messages entered offline into those bases select or ALL
  183.      bases. NONE would be the preferred choice here as all the programmers
  184.      use their taglines as a method of tracking their programs and
  185.      potential theft of their products.
  186.  
  187. 26) Delete >8 includes - This is PhidoQWKs' IMS routine. If you enable
  188.      this routine then PhidoQWK will strip excess quoted lines from the
  189.      uploaded messages. This will work in blocks of 8 so that an offline
  190.      reader can intelligently quote upto 8 lines, generate a response then
  191.      quote 8 more for the next section of their reply.
  192.  
  193. 27) Chars to be treated as quote chars - Different offline readers use
  194.      different characters to define a quote. What you enter here is a
  195.      string of characters that you want treated as potential quote
  196.      characters. If PhidoQWK finds these characters in the position used by
  197.      the quote characters it will recognize them and have the IMS routine
  198.      treat them accordingly.
  199.  
  200. 28) Base user is forced to read - This is a base that will be sent to
  201. the user regardless of whether it is flagged or not. This could be
  202. used for a base where you keep your users posted on the current
  203. happens with the BBS. Entering 0 disables this feature.
  204.  
  205. Hints for using MAXICFG.PRG...
  206.  
  207. -
  208.  When MAXICFG asks for path names you must supply full path names
  209.    eg. C:\FOREM\XYZ.TTP
  210. - To save you some typing you may hit return and select the
  211.    programs/Paths via a file selector by hitting return
  212.  
  213. The Extract and Move Commands are left in the case you type them and are 
  214. passed to the program unmodified. I have supplied suggested parameters as 
  215. defaults but you are free to modify them as you wish. I HEARTILY RECOMMEND 
  216. THAT YOU DO A SEND QWK AND RECEIVE REP WITH EACH COMPRESSOR YOU HAVE ONLINE 
  217. BEFORE YOU LEAVE THEM UNATTENDED.
  218.  
  219.  
  220. Once you have finished, press return to save the file.
  221.  
  222. MAXICFG6 will now save your CFG file and it will examine your Pas.Dat (or 
  223. TPAS.DAT for turbo 2 owners) and create a file called MXUSPREF.DAT. This is 
  224. the file that contains your users preferences when they use the door.
  225.  
  226. Now create a PhidoQWK folder on EVERY drive the BBS knows about.
  227. When I create the packets I use the drive with the most free space.
  228. PhidoQWK will create them if needed but in the interest of time please do 
  229. it yourself.
  230.  
  231. Now, edit your LOGOFF.BAT file to pass the parameter LOGOFF to PhidoQWK.
  232. Eg. C:\FOREM\PhidoQWK.PRG LOGOFF
  233. If you fail to do this step properly, your users hi message counters
  234. and messages sent counters will not be updated.
  235. The Logoff routine is NOT needed for PHIDOQWK
  236.  
  237. Now edit your FDOORS.DAT file to add PhidoQWK.PRG in as per the 
  238. BBS instruction manual:
  239.  
  240. PhidoQWK
  241. 0
  242. C:\forem\txt\maxi.in
  243. C:\forem\PhidoQWK.prg
  244. C:\forem\PhidoQWK.prg
  245. C:\forem\txt\maxi.out
  246.  
  247. You have now successfully set up PhidoQWK.
  248.  
  249.  Extra Features
  250.  --------------          REDIRECTION
  251.  
  252.  The program automatically attempts to redirect the text output from
  253. ARC/ZIP/LZH to the user, but in case you start having problems from 
  254. this feature, you can pass the command REDIRECT OFF to the program,
  255. and it will refrain from doing this action. So, your line in your
  256. FDOORS.DAT would be more like.
  257.  
  258. C:\FOREM\PhidoQWK.PRG REDIRECT OFF
  259.  
  260.  
  261.  
  262.       PhidoQWK Deluxe Enhancements  
  263.  
  264.                     PRE-PREPARED PACKETS
  265.  
  266.  Create a text file with all of the user names you wish to pre-pr-
  267. epare
  268. mail packets for, called PACKING.LST. These must contain names of users
  269. who have already used the door, and saved their preferences. In a BAT 
  270. file of your choice, preferably, DAILY.BAT or FMAINT.BAT, enter a line
  271. to tell PhidoQWK to pre-prepare a packet. Eg.
  272.  
  273. C:\FOREM\PhidoQWK.PRG PACK
  274.  
  275.  
  276.                      General Comments
  277.  
  278.  I love user feedback on new features and ideas please 
  279. encourage your users to try PhidoQWK and let their imagination 
  280. run wild about what they would LIKE it to do in the future.
  281.  
  282. This program is playing with your config.dat and message bases. 
  283. While I have made every effort to ensure their safety something 
  284. may go wrong. Please while testing make regular backups and I do 
  285. recommend running Don Liscombes' Message Manager to ensure your 
  286. message bases continued health.
  287.  
  288. This version of PhidoQWK is released as FREEWARE. You are expected to
  289. pay NOTHING for using it. I (Shawn Smith) do retain all rights to the
  290. program and it is provided strictly on an "AS IS" bases. I take
  291. absolutely no responsibility for the programs performance (or lack
  292. thereof).
  293.  
  294. If you should desire to send me a "thanks" my address is:
  295.  
  296. 27 Carr Dr
  297. Ajax, Ontario
  298. L1T 3E2
  299.  
  300. Enjoy and I hope to hear from you soon, I can be reached at node 68
  301. and I do run a MaxiMiser/PhidoQWK support conference (Code 10068) if
  302. you would like to join drop me a line there.
  303.  
  304.  
  305.  
  306. ADDENDUM
  307.  
  308.  
  309. Description of MXUSPREF.DAT
  310. This file at present contains the users Rec # in the pas.dat,
  311. User name (for comparison in case the user got deleted and a new user
  312. was assigned to the rec #. There is all the various options the user
  313. selects like ARC/LZH/ZIP, # of messages/base, # of messages/conference.
  314. I have left some expansion as I do have future plans.
  315.  
  316. The structure is as follows:
  317.  
  318. struct userpref {
  319.             int rec;         /* Record # in pas.dat */
  320.            char uname[31];   /* User name */
  321.            char Mxflags;     /* User flags */
  322.             int Messperconf; /* Messages per conference */
  323.             int Messperpack; /* Messages per packet */
  324.            char mxflags2;    /* User flags 2*/ 
  325.            char Expand[212]; /* Expansion, Seems like a lot but I have 
  326.                                                               plans  */
  327.                  };
  328.  
  329. /* User flags definition
  330.             bit 0 = ARC
  331.             bit 1 = ZIP
  332.             bit 2 = LZH
  333.             bit 3 = Confmail allowed
  334.             bit 4 = Xmodem
  335.             bit 5 = 1K Xmodem
  336.             bit 6 = Ymodem
  337.             bit 7 = Zmodem
  338.  
  339.    User Flags 2 definition
  340.             Bit 0 = Confmail Messages shown
  341.             bit 1 = Do not Clear lines
  342.             bit 3-7 = Future Expansion
  343. */
  344.  
  345.