home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 2 BBS / 02-BBS.zip / cinet119.zip / cinet.doc next >
Text File  |  1998-04-03  |  12KB  |  326 lines
  1. CitrusSoft BBS Internet Kit (c) copyright 1998 Tom Fotherby, all rights reserved
  2. --------------------------------------------------------------------------------
  3.  
  4. Disclaimer
  5. ----------
  6.  All of the files in this package become the sole responsibility of the
  7.  user.  The author of this product can not,  and will not be liable for
  8.  any use, misuse, and/or damages caused by this product.
  9.  
  10. Features
  11. --------
  12.  · 32-bit OS/2 Native programs
  13.  · Uses very little system resources
  14.  · Runs with both DOS & OS/2 BBS Software
  15.  · Easy to set up
  16.  · Fully Multi-Node Capable
  17.  · FTP, IRC and Telnet doors
  18.  · The users love them!!
  19.  
  20. Requirements
  21. ------------
  22.  · An IBM/PC Computer (486 or better) running OS/2 v3 (or newer)
  23.    with IAK or TCP/IP v2.0+
  24.  · A Connection to the internet [Slip / PPP / Lan]
  25.    *note* A 28.8k Slip/PPP line will work great! :)
  26.  · Static IP is NOT required!
  27.  · A BBS! (They can also be run in Local mode, without a BBS)
  28.  
  29. Setting up
  30. ----------
  31. A) Run the installation program (INSTALL.EXE) - it will de-archive
  32.    the doors into the specified directory, and create the necessary
  33.    configuration files.
  34.  
  35. B) You will need an OS/2 X/Y/Zmodem protocol for the FTP door to work
  36.    Properly - it is suggested that you use CE-XYZ/2 v1.01. (XYZ2_101.ZIP)
  37.    *note* The FTP Door comes pre-configured to work with CE-XYZ/2.
  38.    All you have to do is unzip XYZ2_101.ZIP.
  39.  
  40. C) Set up your BBS to run the doors.
  41.  
  42. Command Line parameters (optional) :
  43.      /L         - Run the door locally
  44.      /D<path>   - Specify the path to the drop file (ex. /Dc:\bbs\)
  45.      /N<node>   - Specify which node this door is being run from (ex. /N1)
  46.                   [This is required for Multi-Node usage!]
  47.      /H<handle> - Have the door use an open (hot) ComPort Handle
  48.      /I<idle>   - The amount of time the user can be Inactive in the door
  49.                   Before the door quits back to the BBS
  50.      /T<time>   -*Specify how much time the user can have in the door
  51.      /S<server> - Specify the IRC server to connect to
  52.                   [Use "/Sask" to prompt the user for an irc server name]
  53.      /P<port>   - Specify the Port at which to connect to
  54.      /U         - Use "Alias" on line #36 of door.sys (if available)
  55.      /A<ip>     - Specify your IP address (if having problems w/DCC or FTP)
  56.      /K         - Keep the DCC'd files when the door exits
  57.      /O         - Disable logging in the FTP/Telnet doors
  58.      /J<channel>- Auto-Join channel (IRC)
  59.  
  60. ( * = registered version only )
  61.  
  62. The /A parameter would be useful for systems that are running via
  63. Masquerading IP.
  64.  
  65. [ setting up with an OS/2 native BBS software ]
  66.  
  67. Setting the doors up with an OS/2 BBS software is rather simple!
  68. Take, for example, Synchronet BBS Software for OS/2.
  69.  
  70. (Tiny of tinys.oix.com bbs has provided information on setting up these
  71. doors with Maximus BBS software, see the included file "maxdoc.txt")
  72.  
  73. A) Add an "Online Program".
  74. B) Have it create a DOOR.SYS drop file in the NODE directory.
  75. C) For the "Startup Directory", put the same directory as you installed
  76.    the doors into via INSTALL.EXE
  77. D) For the "Command Line", put: telnet /n%# /dc:\sbbs\node%#
  78.    (in Synchronet BBS, %# is the macro for the node number)
  79. E) Add "TELNET" to the "OS/2 Programs List"
  80. F) Repeat the above steps for the IRC and FTP doors.
  81.  
  82. [ setting up with a DOS BBS software ]
  83.  
  84. If you are using a DOS BBS software, you will need to use the freeware
  85. program "HSTART".  (included in this package - hstart05.zip).
  86.  
  87. The following configuration assumes that you've unzipped the CitrusSoft
  88. BBS Internet Kit into "C:\CINET"!
  89.  
  90. Create the following files:
  91.  
  92. CINET.BAT, containing:
  93.  
  94. ----
  95. @echo off
  96. hstart.exe "%1 door" /fs /wait c:\cinet\cinet.cmd %1 %2 %3 %4 %5
  97. ----
  98.  
  99. CINET.CMD, containing:
  100.  
  101. ----
  102. c:
  103. cd\cinet
  104. %1.exe %2 %3 %4 %5
  105. hwait.exe
  106. exit
  107. ----
  108.  
  109. Now, instruct your BBS program to load cinet.bat with the parameter of
  110. telnet, ftp, or irc (depending on which one you want it to load).
  111.  
  112. example:
  113. CINET.BAT telnet <additional parameters, such as /Dc:\bbs ..etc.>
  114.  
  115. For more information on HSTART, refer to hstart.txt.
  116.  
  117. Configuration Files
  118. -------------------
  119. You may edit the following files with your favorite text editor  when
  120. changing them.  Instructions for making modifications reside  in each
  121. file.
  122.  
  123. FTP/TELNET/IRC.CFG
  124. ~~~~~~~~~~~~~~~~~~
  125. These are the main configuration files for the doors.  They are used
  126. to specify the BBS Name, Sysop Name, Drop file type, and Idle minutes.
  127. There are also special options for each door.
  128.  
  129. Line #5 in FTP.CFG allows you to configure your hostname (for anon logins)
  130. Line #5 in TELNET.CFG allows you to toggle the local screen IO (on/off)
  131. Line #5 in IRC.CFG allows you to toggle DCC file transfers (on/off)
  132.  
  133. PROTOCOL.CFG
  134. ~~~~~~~~~~~~
  135. This file allows you to customize/add/change file transfer protocols
  136. in the FTP Door.
  137.  
  138. CHANNELS.TXT
  139. ~~~~~~~~~~~~
  140. This is the file that gets presented to the user when they use  /LIST
  141. in the IRC Door.  If this file doesn't exist, the IRC Door  will  get
  142. the list of channels from the IRC Server (on the larger servers, such
  143. as EFFNet or UnderNet, this may take a long time!)
  144.  
  145. SERVERS.TXT
  146. ~~~~~~~~~~~
  147. This is the list of "default" IRC Servers that the user can connect to.
  148.  
  149. LOCKOUT.TXT
  150. ~~~~~~~~~~~
  151. You can use this file to put keywords, or partial channel names of channels
  152. that you don't want the users accessing.  (this is useful to keep the users
  153. out of channels that provide porn, or whatever)
  154.  
  155. *.SCR
  156. ~~~~~
  157. These are scripts for the Telnet door.  You can create and use these to
  158. automatically log into different servers and such..  Check out the included
  159. script, WWW.SCR, it will automatically log into the LYNX (www) program at
  160. "public.sunsite.unc.edu"!
  161.  
  162. Note, unfortunately "public.sunsite.unc.edu" seems to no longer be up,
  163. but you can find other public www/lynx hosts by web-searching for
  164. "public lynx" (www.infoseek.com, or www.webcrawler.com)
  165.  
  166. There are also script macros, which can toggle certain options or quit the
  167. telnet door itself.
  168.  
  169. List of macros:
  170.  
  171.   TOGSNOOP  - Toggle (on/off) Sysop "Snoop" mode.
  172.   TOGCRLF   - Toggle CR+LF or CR mode.  Usefull for telnetting to Maximus
  173.               BBS's, because they don't like CR+LF.
  174.               Example:
  175.                  max.scr
  176.                  ~~~~~~~
  177.                  ; search for "MAXIMUS", then toggle the CRLF mode to CR
  178.                  MAXIMUS
  179.                  TOGCRLF
  180.   TOGBINARY - Toggle the Binary mode state, once in binary mode, Scripts
  181.               and ^] will not work.  This mode is required for File Transfers
  182.               via Zmodem ..etc.
  183.   QUITDOOR  - Quits the Telnet Door.
  184.  
  185. A note about Servers
  186. --------------------
  187. A server (Also known as a Site or Host) is 2 or more words, separated by
  188. a period, and usually ends in .COM, .ORG, .EDU, .NET or .GOV.
  189. If a FTP server is preceded with a 'ftp://', it will automatically log the
  190. user in anonymously.  Also, if a directory is specified on the end, it will
  191. change to that directory once logged in.  (ex: ftp://ftp.cdrom.com/pub)
  192.  
  193. Sysop Keys
  194. ----------
  195. ALT C, Chat with the User
  196. ALT +, Give the User time
  197. ALT -, Take away time
  198.  
  199. Having problems?
  200. ----------------
  201. If OS/2 pops up a box saying that the COM Port is allready in use when a
  202. user enters the door, you'll need to add the ",-" parameter to SIO.
  203. (Refer to Appendix D. of SIOREF.TXT)
  204.  
  205. If the door says that it is unable to Initialise the COM Port, you may
  206. have to pass the COM Port handle from the BBS Software to the door.
  207. (Refer to your BBS Software's documentation for information on how to do this)
  208.  
  209. If the FTP Door returns errors such as "Connection timed out" or
  210. "Cannot build data connection" and the DCC function in the IRC Door has
  211. trouble sending files, you will need to specify "/A<your-ip-address>" on
  212. the command line.  Example: ftp /A208.212.122.150 (other parameters go here)
  213.  
  214. Contacting the Author
  215. ---------------------
  216. If you...
  217.  
  218. A) Need additional help setting up and configuring these doors
  219. B) You want to report a problem / bug
  220. C) You have suggestions
  221.  
  222. You can contact me either via E-Mail or my BBS.
  223.  
  224. E-Mail:  enigma@ees.eesc.com
  225.  
  226. BBS:     The O-Zone BBS
  227.          Telnet: ozbbs.ml.org (ip address: 208.212.122.150)
  228.          Dialup: (248) 651-6472
  229.          Logon as NEW
  230.  
  231. Mail:    Tom Fotherby
  232.          3535 Hadden
  233.          Rochester, MI 48306
  234.          USA
  235.  
  236. (for quickest response, use e-mail :)
  237.  
  238. Registration
  239. ------------
  240. You are givin a 30-day evaluation period  to  test  out the CitrusSoft
  241. Internet Kit.  After your 30-day trial period, you must decide whether
  242. or not you wish to continue using it.  If you find that these programs
  243. meet your needs, you are required to register.
  244.  
  245. Registration is a One-time  fee  of  $45  (U.S. Dollars).  All  future
  246. Upgrades will be made available to registered users at no charge.
  247.  
  248. Benefits of Registration:
  249.  · No 10-minute time limit
  250.  · All of the 'registered' features will be enabled
  251.  · The Delays will be removed.
  252.  
  253. Types of payment accepted: Check or Money Order.
  254.  
  255. ( Sorry, we do not accept Credit Cards )
  256.  
  257. Please make the Check or Money Order out to: Tom Fotherby, along with your
  258. name and BBS Name, to:
  259.  
  260.         Tom Fotherby
  261.         3535 Hadden
  262.         Rochester, MI 48306
  263.         USA
  264.  
  265. Specify where you'd like to receive the registered versions of the doors.
  266. I can send them either via E-Mail, or File Attach on my BBS.
  267. If you would like to receive it via Snail-Mail on a 3.5" floppy disk,
  268. include an additional $2.00.
  269.  
  270. Whats New in Version 1.19?
  271. --------------------------
  272. A) IRC: Auto-Join channel, /J<channel> commandline parameter added
  273. B) Several bugfixes/enhancements to the doors (especially the DCC function in
  274.    The IRC door)
  275.  
  276. Whats New in Version 1.18?
  277. --------------------------
  278. A) Several "cosmetic" bugs fixed in the IRC door.
  279. B) Chat (ALT-C) now saves the current line, and re-displays it upon chat
  280.    Exit.
  281. C) Macros added to the Telnet Door's scripting!  (See Scripting, above)
  282. D) ALT-H added, to hang up the user.
  283. E) Fixed a problem with /A being needed for FTP/DCC to work on some OS/2
  284.    Configurations.
  285. F) Worked around a bug that happened when using IBM's new TCP/IP 4.1
  286.  
  287. Whats New in Version 1.17?
  288. --------------------------
  289. A) Local Screen IO is about 10x faster! (New VIO Buffering techniques)
  290. B) IRC: Optimized the DCC Code
  291. C) IRC: If CHANNELS.TXT doesn't exist, /LIST will get the channel list from
  292.    the IRC server.
  293. D) IRC: Ability to disallow access to certain irc channels (see LOCKOUT.TXT)
  294. E) Telnet: Scripting capabilities in the Telnet door!  Refer to CINET.DOC
  295.    and WWW.SCR for more info.
  296. E) Added parameter /O.  This will disable creating the .LOG files in the
  297.    Telnet and FTP doors.
  298. F) Telnet: Fixed a bug which caused Z-Modem and other transfer protocols
  299.    to fail.
  300.  
  301. Whats New in Version 1.16?
  302. --------------------------
  303. A) The parameter /? (or -?) will bring up a list of Commandline Parameters
  304.    For each door.
  305. B) Fixed a bug where the FTP & IRC Doors wouldn't delete the temporary files.
  306. C) Added parameter /K.  Using this parameter will SAVE the files, instead
  307.    Of deleting them when the door exits.
  308. D) Added parameter /U.  This will tell the door to use the Alias on line
  309.    #36 of the DOOR.SYS file, if available.  (Useful for PCB & RA systems)
  310.  
  311. Whats New in Version 1.1
  312. ------------------------
  313. A) The doors now use 2 methods of finding the local IP address.  On some
  314.    systems gethostid() would return 255.255.255.255 for the local IP,
  315.    causing the FTP door to function improperly (Cannot Build data connection).
  316.    If it can't get the local IP by gethostid(), it will run "netstat.exe -a"
  317.    to get the correct local IP.
  318. B) BugFix: The IRC door's "/DCC LIST",  sometimes it wouldn't display
  319.    the correct SENT/RECEIVED bytes.
  320. C) The IRC & FTP doors now clean up after themselves by deleting all
  321.    temporary and received files.
  322. D) BugFix: Using ALT-C (chat) in the FTP Door would sometimes cause a
  323.    runtime error.
  324. E) The IRC Door will now be able to connect to servers that require pIdentD
  325.    to be installed.
  326.