home *** CD-ROM | disk | FTP | other *** search
/ Shareware Overload / ShartewareOverload.cdr / comm / subway21.zip / SUBWAY.DOC < prev   
Text File  |  1988-02-24  |  9KB  |  244 lines
  1.  
  2. *** SUBWAY 2.1 Documentation File ***
  3.  
  4. (1) INTRODUCTION
  5.  
  6. What is SUBWAY ?
  7.  
  8. A simple communications program featuring :
  9.  
  10. * TTY emulation
  11. * ASCII file capture
  12.  
  13. Is that all ?  Yes that's all *but* what makes it special is its ability to :
  14.  
  15. * stay resident
  16. * run as a background task
  17.  
  18. Staying resident means that you can, from inside any application, pop up the
  19. terminal and communicate at will with your favorite BBS, and flip back and
  20. forth between your application screen and the terminal screen.
  21.  
  22. Running as a background task means that, once the ASCII file capture is
  23. underway, you can leave the terminal and come back to your application : the
  24. capture will go on, whatever you're doing as a foreground task.  Think of it
  25. as something like the PRINT utility, except that here the data flow is from
  26. the outside world to your disk.  Furthermore, if this data flow comes to a
  27. stop while in background capture mode, SUBWAY will detect it and beep the
  28. speaker to warn you, urging you to pop up the terminal and check what's going
  29. on.
  30.  
  31.  
  32. (2) INSTALLING SUBWAY
  33.  
  34. This program is made of two parts :
  35.  
  36. * a general purpose interrupt driven async communications driver (CDRV)
  37. * a pop-up terminal emulator featuring background file capture (SUBWAY)
  38.  
  39. To install them, type CDRV [Enter], then SUBWAY [Enter].  If you want to
  40. use SideKick (tm) too, load it *after* SUBWAY.  This way you can call SK
  41. from inside SUBWAY or SUBWAY from inside SK (more about this later).
  42.  
  43. (3) USING SUBWAY
  44.  
  45. To activate SUBWAY, just press the [Alt]-[Esc] key combination.  The screen
  46. is blanked and the cursor is homed.
  47.  
  48. The first thing to do is to "open" the com port (the default is COM1:, but
  49. this can be changed).  To do this, use the Alt-T combination (T stands for
  50. "take").  If CDRV succeeds in initializing the port, it will say so, and you
  51. can start to communicate (presumably by sending an ATZ string to your modem).
  52.  
  53. To "close" the com port, just press Alt-R (R stands for "release").  This will
  54. stop the IRQ driven mode, and drop RTS and DTR (forcing most modems to drop
  55. the line as well).
  56.  
  57. The baud rate and data format can be changed anytime using the following key
  58. combinations :
  59.  
  60. Alt-1 to set 1200 bps
  61. Alt-2 to set 2400 bps
  62. Alt-3 to set  300 bps
  63.  
  64. Alt-N to set NO parity, 8 data bits, 1 stop bit
  65. Alt-O to set ODD parity, 7 data bits, 1 stop bit
  66. Alt-E to set EVEN parity, 7 data bits, 1 stop bit
  67.  
  68. To send a BREAK signal, just type Alt-B.
  69.  
  70. Now for the best : background ASCII file capture.
  71.  
  72. To activate it, just type Alt-C.  To stop it, type Alt-C again, since this is
  73. a toggle.
  74.  
  75. When you start it, you'll be prompted for a file pathname.  If the file does
  76. not exist, it is created.  If it already exists, captured data will be
  77. appended to the end of the file.  You should *always* specify a drive and full
  78. pathname.  This is because, if you change your working directory while the
  79. file capture is running in background mode, SUBWAY won't find the capture file
  80. any longer, and many characters will be lost.
  81.  
  82. To exit terminal mode, just press Alt-X.  This will not drop the communication
  83. or stop the capture : SUBWAY will keep on receiving characters, and write them
  84. to disk if requested to do so.  Notice that the original screen contents are
  85. restored.  To recall SUBWAY, just Alt-Esc again.
  86.  
  87.  
  88. (4) WORKING WITH SIDEKICK (tm)
  89.  
  90. Loading SK after SUBWAY brings some interesting features : with the notepad,
  91. you can upload small text files using the PASTE function (you might wish to
  92. adjust the paste delay factor to a non-zero value).
  93.  
  94. A typical working session might be :
  95.  
  96. * load CDRV, then SUBWAY, then SIDEKICK
  97. * activate SUBWAY (Alt-Esc)
  98. * open com port (Alt-T)
  99. * set speed to 2400 bps (Alt-2)
  100. * connect to BIX (ATD...etc...)
  101. * join your favorite conference... Gosh ! 100 new messages !
  102. * turn capture on (Alt-C, enter pathname)
  103. * type "all" to read all messages
  104. * exit SUBWAY (Alt-X)
  105. * play around with your favorite program (word processor, spreadsheet,
  106.   compiler, CAD, etc...)
  107. * a moment later, a gentle beep warns you
  108. * activate SUBWAY again (Alt-Esc) : "no more unread messages, etc..."
  109. * stop capture mode (Alt-C)
  110. * disconnect from BIX (Alt-R)
  111. * browse thru the messages
  112. * find an interesting question
  113. * pop up SK's notepad
  114. * write the answer
  115. * assign the whole text to a key
  116. * exit SK's notepad
  117. * reconnect to BIX (Alt-T, ATD..., join...)
  118. * "comment" the question, and automatically paste the answer using the
  119.   key you just assigned
  120.  
  121.  
  122. (5) PATCHING SUBWAY
  123.  
  124. Several default parameters can be changed using DEBUG.  First, load SUBWAY,
  125. using the command : DEBUG SUBWAY.COM [Enter]
  126.  
  127. * hot key combination : the scan code for the key is at offset 0103, the
  128.   default value is 01 (Esc) - the shift status is at offset 0104, the
  129.   default value is 08 (Alt) - both values can be changed, provided you
  130.   avoid to interfere with otherwise used key combinations.
  131.  
  132. * com port used : the port number is a WORD at offset 0105, the default
  133.   value is 0 (COM1:)
  134.  
  135. * initial settings : the control byte is at offset 0107, the default value
  136.   is 83H, standing for 1200 bps, 8 data bits, no parity, 1 stop bit - the
  137.   meaning of each bit in this byte adheres to the BIOS (INT 14H) convention.
  138.  
  139. * the "no more incoming data" alarm comes when a timer (reset at each capture
  140.   file write) has elapsed.  The default value is a WORD at offset 0108.  This
  141.   value is 550 decimal (226H).  Units are clock ticks, so 550 is about 30
  142.   seconds.  This is well suited for a 1200 bps communication, but might be a
  143.   bit short at 300 bps, or a bit long at 2400 bps.
  144.  
  145. When the required values are patched, just write the file back (using the "W"
  146. debug command) to disk.
  147.  
  148. Changes will be effective the next time you load SUBWAY (don't load it twice
  149. in a row, please reboot if it is already loaded).
  150.  
  151.  
  152. (6) TECHNICAL ISSUES
  153.  
  154. How does SUBWAY work ?
  155.  
  156. * staying resident : nothing magic about it - INT 27H is used to install the
  157.   program - INT 09H is hooked to detect the hot key combination.
  158.  
  159. * screen swapping : BIOS calls are used to read and write the screen - this
  160.   may be somewhat slower than direct memory access, but this is much more
  161.   portable.
  162.  
  163. * IRQ driven com port : this is CDRV's job - it just has to take care of the
  164.   8250 (async chip) and 8259 (IRQ controller chip) and manage an 8 K-byte
  165.   ring buffer.
  166.  
  167. * background file capture : a TSR is allowed to issue DOS calls as long as it
  168.   doesn't interfere with foreground applications - fortunately the DOS opens
  169.   two windows even though it looks as if it closed the door : it manages an
  170.   internal "DOS busy flag" to tell us when it doesn't want to be disturbed,
  171.   and it calls INT 28H whenever it has nothing special to do and agrees to be
  172.   called.
  173.  
  174. * memory requirements : CDRV uses about 9800 bytes, including the 8192-byte
  175.   ring buffer - SUBWAY uses about 8500 bytes, including the 4000-byte screen
  176.   buffer and a 2048-byte capture buffer - this capture buffer is flushed to
  177.   disk whenever it is full.
  178.  
  179. * flushing capture buffer to disk : the DOS calls sequence is as follows :
  180.  
  181.    - hide file
  182.    - open file
  183.    - go to end of file
  184.    - write buffer to file
  185.    - close file
  186.    - unhide file
  187.  
  188.   the file is hidden to prevent another TSR coming up at the very same moment
  189.   from finding the file and maybe open and modify it - it has to be closed and
  190.   reopened at each call, because exiting a foreground application closes ALL
  191.   files.
  192.  
  193. * critical errors : whenever a critical error occurs in this sequence, the DOS
  194.   call is failed (this requires DOS 3.0 or later to work) - whenever a DOS
  195.   call fails in this sequence, a low pitched sound comes out of the speaker,
  196.   the infamous "Abort, Retry, Ignore ?" message won't appear on your screen,
  197.   and the disk write is canceled (not retried).
  198.  
  199.  
  200. (7) IN CASE OF PROBLEM
  201.  
  202. SUBWAY has been tested for a while, and it seems to work rather well.  It
  203. works even with WINDOWS running in foreground (you can't pop up the terminal
  204. while in WINDOWS, but the background file capture is still running).
  205.  
  206. In the event you meet any problem :
  207.  
  208. * FIRST try to find out by yourself where it comes from - it is good for the
  209.   brain and might be very rewarding to your ego.
  210.  
  211. * THEN ask for help - my BIX emailbox is : lanc.
  212.  
  213.  
  214. (8) FUTURE FEATURES
  215.  
  216. I'm working on the next version of SUBWAY.  Guess what it will do ?
  217.  
  218. * background Xmodem/Ymodem up- and down-loading (for sure !)
  219.  
  220. * sophisticated terminal emulation (maybe...)
  221.  
  222. * anything else you might suggest (why not ?)
  223.  
  224.  
  225. (9) ENCLOSED FILES
  226.  
  227. * CDRV.COM : communications driver
  228. * CDRV.DOC : technical documentation about CDRV
  229.  
  230. * SUBWAY.COM : the communications program the world has been waiting for
  231. * SUBWAY.DOC : this file
  232.  
  233.  
  234. (10) ????WARE
  235.  
  236. Freeware or shareware ?  Well, I might as well consider this program to be
  237. nothing more than freeware.  I just wrote it for my personal use, and assumed
  238. that it could, after all, be useful to someone else as well.  But, if you like
  239. it so much that you feel a compulsive need to pay for it... just let me know.
  240.  
  241. BIX : lanc
  242. CALVACOM : LA21 (this is a Frrrrrench BBS)
  243.  
  244.