home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 2 BBS / 02-BBS.zip / maxcgis.zip / maxcgis.doc < prev    next >
Text File  |  1998-09-12  |  5KB  |  108 lines
  1.                         -----------------------------
  2.                           Maximus CGI Pack for OS/2
  3.                         -----------------------------
  4.  
  5. What it is:
  6. ~~~~~~~~~~~
  7.     A package of three CGI programs which allow visitors on the World
  8. Wide Wait to view your user listing, your last few callers and who's
  9. currently online.
  10.  
  11. Requirements:
  12. ~~~~~~~~~~~~~
  13.     - OS/2 Warp 3.0 or higher
  14.     - 386DX or better with atleast 8 megs of RAM
  15.     - Maximus BBS software
  16.     - Connection to the internet
  17.     - Web server
  18.  
  19. Legal Stuff:
  20. ~~~~~~~~~~~~
  21.     This collection of programs should only take up room on your hard
  22. drive, and should (hopefully :> ) do what they were meant to do. Nothing
  23. more, nothing less. If they do cause any damage to your system, I take
  24. no responsibility, but ask that you report the damage(s) to myself as
  25. soon as possible so that I may look into/fix the problem immediately.
  26.  
  27. Installation:
  28. ~~~~~~~~~~~~~
  29.     Unzip all the files in the distribution archive to a temp directory.
  30. Place the file USERINFO.MEX in Maximus' MEX directory, the three
  31. executables (and their corresponding config files) into your web
  32. server's CGI-BIN directory, and the DOC file wherever you store your
  33. junk :>
  34.  
  35.     Next, edit the three config files to suit your needs. They're all
  36. commented, and should be pretty self-explanatory.
  37.  
  38.     You may need to edit the USERINFO.MEX file to suit the paricular
  39. needs of your BBS. If you don't know MEX, don't worry, I don't either,
  40. but I've commented it enough that we should both be able to understand
  41. it :>
  42.  
  43.     When you load the USERINFO.MEX file in your text editor, you'll
  44. notice two #define's near the top, those are the only real things you'll
  45. need to worry about. They should look like this by default;
  46.  
  47. #define telnet_node  2                  // Telnet node number
  48. #define local_node   3                  // Local node number
  49.  
  50.     The numbers in the third column are the node numbers, for the telnet
  51. node and the local node, respectively. (Sorry, at the moment I only have
  52. support for one of each, as I'm not a MEX expert. If you know how to
  53. easily add support for more than one of each, please see the "Contacting Me"
  54. section and let me know).
  55.  
  56.     Once you've edited this file to suit your needs, compile it with
  57. MEX(p). Now you'll need to call it somewhere within the regular login
  58. procedure. I reccommend adding a link to it at the beginning of your
  59. WELCOME.MEC file, (IE: [MEX]M\Userinfo).
  60.  
  61.     When a user logs off of your BBS, you should have some method of
  62. automagically deleting the file UONLINE.# (in the main Maximus
  63. directory), where # is the task number. There are several ways of doing
  64. this;
  65.  
  66. 1 - Add a line to the batch file that calls your BBS immediately after
  67.     the call to MAX(p).EXE that deletes the file (if you run a single-
  68.     node system, you should be able to just have the batch file delete
  69.     UONLINE.1, but if you run a multi-node system, you should have an
  70.     environment variable (IE: %TASK%) or a parameter (IE: %1) that you
  71.     would use to delete the file, IE: "del c:\max\uonline.%1").
  72.  
  73. 2 - Within the file BYEBYE.MEC (in the \MAX\MISC dir) add a line like
  74.     the following for each of your nodes (replacing the node number
  75.     where appropriate);
  76.  
  77.     [iftask]1 [delete]C:\Max\Uonline.1
  78.  
  79. 3 - Put the included DELFLAG.MEX file into Maximus' MEX directory and
  80.     compile it, and call it before each logoff in your MENUS.CTL file
  81.     like the following;
  82.  
  83.   NoDsp MEX             M\Delflag             Transient "Goodbye (log off)"
  84.         Goodbye                               Transient "Goodbye (log off)"
  85.  
  86.     Now, you're finally ready to add a link to the CGI's in some HTML
  87. code! The three programs can be called as follows;
  88.  
  89. LASTTEN.EXE - If called with no parameters, it will display the last ten
  90.               callers to the BBS. If you add a parameter to it's command
  91.               line (IE: lastten.exe?20) it will display that number of
  92.               callers.
  93.  
  94. MAXLIST.EXE - This CGI has no parameters, so it should be called with
  95.               the executable name only.
  96.  
  97. WHOONNOW.EXE - If called with no parameters, this will display the users
  98.                online on nodes 1 through 3, if you specify a number on
  99.                the command line (IE: whoonnow.exe?8) it will display the
  100.                users online on nodes 1 through the number specified.
  101.  
  102. Contacting Me:
  103. ~~~~~~~~~~~~~~
  104.     If you feel the need to contact me, I can be reached on the World
  105. Wide Wait at http://tinys.oix.com/blackdeath or by E-Mail at
  106. s_honsberger@usa.net. I've included my PGP public key if you wish to
  107. encrypt your message to me.
  108.