home *** CD-ROM | disk | FTP | other *** search
/ ftp.wwiv.com / ftp.wwiv.com.zip / ftp.wwiv.com / pub / BBS / TCHOLI47.ZIP / TCHOLI.DOC < prev    next >
Text File  |  1995-05-07  |  8KB  |  223 lines
  1.  
  2. Date: 05-07-95     Prgm: TcSoft's Holiday/Personal Reminder Door       Page 1
  3.  
  4.  
  5. Author:
  6.  
  7. Tom Cunha of FidoNet # 1:387/310.2 of San Antonio, Texas
  8.  
  9.  
  10. Disclaimer:
  11.  
  12.              This software is provided AS IS.
  13.  
  14.         YOUR  USE  of this  software is an agreement
  15.         that you will NOT hold Tom Cunha responsible
  16.         in any way, due to the  use of, or  inablity
  17.         to use, this software.
  18.  
  19. Short Description:
  20.  
  21. This is a `Multinode smart' door which will inform your users
  22. of upcoming holidays.  It will also keep a personal date database
  23. for the users and remind them of upcoming personal dates as well.
  24.  
  25. Requirements:
  26.  
  27. * ANSI/AVATAR (if you want color)
  28. * 180K Memory PLUS the size of the data (tcuser.hol) file
  29. * DOS version 3.1 or newer (supports file locking for Multi-Nodes)
  30.  
  31. Features:
  32.  
  33. * Non Standard Interrupts (1-15)  (HELLO??   digiboard??)
  34. * Fossil is NOT required
  35. * unlimited baud rate
  36. * AVATAR/0+
  37. * ANSI color graphics and ASCII monochrome mode
  38. * Automatic time left verification
  39. * Automatic carrier detection
  40. * Updated status bar with users' data
  41. * Fast modem input/output for those fast modems
  42. * Inactivity timeout verification
  43. * Sysop keys while door is active;
  44.         Alt H         Hangs up
  45.         Alt R or X    Returns to BBS without hanging up
  46.         Alt C         Chat [disabled]
  47.         Alt J         Jump to DOS
  48.         Alt =         Add one minute to time in door
  49.         Alt -         Subtract one minute from time in door
  50.  
  51. Please note that time changes made in the door do not affect the users
  52. time inside the BBS.  This means, if you increase a users time in the
  53. door then they will still be dropped by the BBS when they return if
  54. the original time limit has been exceeded.
  55.  
  56.  
  57.  
  58.  
  59. Date: 05-07-95     Prgm: TcSoft's Holiday/Personal Reminder Door       Page 2
  60.  
  61. Compatibility:
  62.  
  63. SuperBBS, QuickBBS, Remote Access, RBBS, Telegard, WildCat 3, Force!,
  64. PCBoard (latest), GAP, WildCat BBS, Genesis, Spitfire, WWIV, Osiris
  65. and other BBS software that uses a compatible format.
  66.  
  67. Use:
  68.  
  69. In order to run the door you only need provide the location and name
  70. of the `bbs drop file' for the door to read.
  71.  
  72. For instance, if your bbs was located in c:\bbs and the drop file name
  73. is dorinfo1.def then your command line would be;
  74.  
  75. TC-HOLI C:\BBS\DORINFO1.DEF
  76.  
  77. and you will be off and running.
  78.  
  79. The Holiday door will keep a data file named:  TCUSER.HOL
  80.  
  81. This file contains all the holiday dates as well as all the personal
  82. dates a user may enter.
  83.  
  84. If you wish to add more holiday dates, then you may.  Read on.
  85. If you wish to lengthen or reduce the period of displayed entries...
  86. ie: by default the door will show any entries which fall within
  87. a 90 day period of the actual date.  You can lengthen or shorten this
  88. time period.
  89.  
  90. Example:  using the default, a user would not see a reminder unless it
  91.           is going to occur within the next 90 days.
  92.  
  93. There are four Sysop configurable variables in two seperate files.
  94.  
  95. You need to create a plain text file (named: PWORD.HOL) with a text editor.
  96. The first line is a Password and the second line is the day limitation.
  97. If you use this option you must put in both lines.
  98. It might look something like:
  99.  
  100. 234567890
  101. 120
  102.  
  103. meaning the password for entering holiday entries would be 1234567890
  104. and all entries would be shown if they are going to occur within 120 days.
  105.  
  106. The trick on entering Holiday entries is;
  107.  
  108. Proceed as if you were going to make a regular entry, BUT when you get
  109. to the description part put in your Password.  The program will prompt
  110. you again for a  Holiday description.
  111.  
  112. REMEMBER, if PWORD.HOL is not found then the user will not be asked for
  113. personal dates.  This option was added for sysops who may not want users
  114. entering dates.
  115.  
  116.  
  117. Date: 05-07-95     Prgm: TcSoft's Holiday/Personal Reminder Door       Page 3
  118.  
  119. The other Sysop configuration file is called  EDITPWRD.HOL. If this file
  120. is found in the directory. It enables the online editor.  You will want 
  121. this if you plan on editing, removing, etc. data records.  The file contains
  122. only one line.  And that is the password you will use to enter the editor.
  123. To access the editor you simply press  *  at the prompt after the dates are
  124. done displaying.  Remember the * will act as a bad keystroke if you don't
  125. have  EDITPWRD.HOL  in the door directory or path.
  126.  
  127. Command Line Parameters
  128. -----------------------
  129. In order to implement the non standard interrupts we had to complicate the
  130. command line (sorry).  :(
  131. If you are using a registered version and want to use the  alternate path
  132. feature which allows you multiple Match Maker  databases, you need to
  133. read this section.
  134.  
  135. If you want to use non standard interrupts you need to read this section.
  136. If the above two situations don't apply, you can skip this section.
  137.  
  138. /HSK    is representive of the  Handshake method used
  139.                 0 = No Handshaking
  140.                 1 = Use XON/XOFF (software) handshaking
  141.       (default) 2 = Use CTS/RTS (hardware) handshaking
  142.                 3 = Use both 1 and 2
  143.  
  144. /IRQ    is representive of the IRQ (Interrupt)
  145.                 a number between 1 and 15
  146.  
  147. /PTH    is representive of the path to the drop file
  148.         if you use   /HSK   or   /IRQ   or  you  MUST
  149.         use this command (/PTH).                 ----
  150.  
  151. examples:
  152.  
  153.         TC-HOLI D:\BBS\DORINFO1.DEF
  154.                 this is a standard usage example..
  155.                 TC-HOLI will autodetect if a fossil is present
  156.                 if the fossil is found, it is used... if it 
  157.                 is not found TC-HOLI will automatically fall back
  158.                 to the internal communications routines (built in).
  159.                 Default interrupt/com port, etc.. settings are
  160.                 used when the door is called in this manner.
  161.  
  162.         TC-HOLI D:\BBS\LINE%1\DORINFO%1.DEF
  163.                 this would be an example of a multinode system
  164.                 running with standard interrupts/com ports, etc.
  165.                 The %1 would be, in most cases, the node number
  166.                 and is passed to the .BAT file by the BBS.
  167.                 Autodetect fossil is used.....
  168.                 Default interrupt/com port, etc.. settings are
  169.                 used when the door is called in this manner.
  170.  
  171.  
  172. Date: 05-07-95     Prgm: TcSoft's Holiday/Personal Reminder Door       Page 4
  173.  
  174.  
  175.         TC-HOLI /PTHD:\BBS\LINE%1\DORINFO%1.DEF /HSK3 /IRQ9
  176.                 each command is seperated by a space and begins
  177.                 with the  /      notice  ALL  of the command line
  178.                 arguements have a   /   in use.  
  179.                 %1 is one way that multi-node systems pass the node
  180.                 number to the batch file.
  181.                 for this example, we will say it is node 2
  182.                 the command translates to:
  183.                 TC-HOLI will look in   d:\bbs\line2  for dorinfo2.def
  184.                 the handshake will be both XON/XOFF  and  CTR/RTS
  185.                 we will run the internal comm routines on interrupt 9
  186.                 ***************************************************
  187.                 If you use  /    anywhere on the command line, then 
  188.                 ALL command line variables must be preceeded by the   
  189.                 /  and the associated variable identifier 
  190.                 (/HSK, /IRQ, PTH)
  191.                 ***************************************************
  192.                 ie:  TC-HOLI /HSK3 D:\BBS\DORINFO1.DEF 
  193.                      is not a legal command line:
  194.                      corrected it would read;
  195.                         TC-HOLI /HSK3 /PTH/D:\BBS\DORINFO1.DEF
  196.  
  197.  
  198. Registration:
  199.  
  200.         It is an unfortunate fact that a lot of people feel shareware
  201.         is freeware.  TC-HOLI.EXE is not freeware.
  202.  
  203.         It is suggested you register this software after a reasonable
  204.         evaluation period.
  205.  
  206.         I am only asking $ 25.00 for registration.
  207.         If you register more than one of my software packages I
  208.         will reduce the cost of  each  package by $5.00.
  209.  
  210. By        Tom Cunha
  211.        6443 Jenny Drive
  212.     San Antonio, Tx  78239-2723
  213.      Fidonet # 1:387/310.2
  214.  
  215. TcSoft support sites:
  216.  
  217.  
  218.   Al Thorley of FidoNet # 1:3634/48 @ (910) 867-5521   14.4 V32b, V42b
  219.   
  220.  
  221.  
  222.  
  223.