home *** CD-ROM | disk | FTP | other *** search
/ HAM Radio 1 / HamRadio.cdr / misc / bpqutils / bpqterm.doc < prev    next >
Text File  |  1990-06-03  |  9KB  |  278 lines
  1.                 Terminal Controller Program for BPQ TheNode
  2.  
  3. This program is designed to provide a comprehensive terminal controller
  4. program for a BPQ node.
  5.  
  6.  There are four files supplied;
  7.  
  8. BPQTERM.EXE      The program.
  9. BPQTERM.CFG      The configuration file.
  10. BPQTERM.HLP      The help display file.
  11. BPQTERM.TXT      A list of the updates.
  12. BPQTERM.DOC      This file.
  13. T1-PIF.DVP       For DESQview version 2.24
  14.  
  15. The file T1-PIF.DVP is already set up to use BPQTERM, but may need altering to
  16. suit your system.
  17.  
  18.  
  19.          CONFIGURATION FILE
  20.  
  21. The configuration file BPQTERM.CFG holds the start up information required by
  22. BPQTERM, and must be in the current directory (under desqview in the same
  23. directory as the program). It looks something like this:
  24.  
  25.  
  26. 5           {com port. Can be overridden on the command line!}
  27. 1200        {baud rate}
  28. 8192        {memory size, in bytes (not more than 32K)}
  29. 71          {Top Bar colours}
  30. 2           {Output ink colour}
  31. 23          {Message Bar colours}
  32. 7           {Input ink colours}
  33. 4           {Help display colours}
  34. 8           {Tab Size}
  35. 1           {Clock on/off (0 = off, 1 = on)}
  36. 0           {Spool to printer on/off (0 = off, 1 = on)}
  37. 0           {Spool to file on/off (0 = off, 1 = on)}
  38. 1           {Echo to output window on/off (0 = off, 1 = on)}
  39. test.txt    {Spool to file default file name}
  40. APPL $02
  41. M ON
  42. MTX ON
  43. CONOK ON
  44. *** EOF  {end of commands sent to TNC on program start}
  45. M OF
  46. MTX OF
  47. CONOK OF
  48. *** EOF  {end of commands sent to TNC on program end}
  49.  
  50.  
  51.    Taken in order these are:
  52.  
  53. The COM port number.
  54.    This is the virtual BPQ COM port you allocate to this program.
  55.  
  56. The baud rate.
  57.    This is the rate at which the program will talk to the VIRTUAL TNC
  58.    inside the BPQ node!
  59.  
  60. Memory size.
  61.    The amount of memory to use in the screen buffer in bytes.
  62.    NOTE. Not more than 60000 bytes.
  63.  
  64. The next five parameters control the colours used.
  65.    Top bar.          For information posted along the top.
  66.    Output screen.    Information recieved in main window.
  67.    Message bar.      Information posted below the main window.
  68.    Input screen.     Information typed into input window and sent to the
  69.                      output screen.
  70.    Help Display.     For the help information.
  71.  
  72. Tab size, the spacing between tab points in the keyboard buffer.
  73.  
  74. The next four parameters are used to set the flags for functions in the program
  75. that are either on or off. Here 1 is used as on, and 0 as off.
  76.    Clock.            Time and date display on or off. When on, it can slow the
  77.                      program a little.
  78.    Spool to printer. Echo text entering the main window to a printer.
  79.    Spool to file.    Echo text entering the main window to the file specified.
  80.    Echo.             Repeat text sent in the main window.
  81.  
  82. Spool to file destination. This must be a valid file name in a valid directory
  83. (or the current one). Data is sent here as it is recived from the TNC. The
  84. spool facility is turned on and of by the spool to file key F4.
  85.  
  86. The next few lines up to the line;
  87.  
  88. *** EOF  {end of commands sent to TNC on program start}
  89.  
  90. are optional. But that the line is not!
  91.    They consist of the commands sent to the Virtual TNC on initialisation.
  92.  
  93.  
  94. The same is true of the lines up to the line;
  95.  
  96. *** EOF  {end of commands sent to TNC on program end}
  97.  
  98.    They consist of the commands sent to the Virtual TNC on close down.
  99. NOTE. It is important to quit the program properly.
  100.  
  101.  
  102. There is one optional command line parameter, an alternative COM port number.
  103. This takes precidence over the one in the configuration file, enabling you to
  104. run multiple copies (on different COM ports).
  105.  
  106.  
  107.       IN USE
  108.  
  109. ═══════════════════════════════════════════════════════════════════════════════
  110. BPQ TheNode Terminal Controller Program.  V1.04  COM 01      P.M.Hounslow G4YFE
  111. cmd:cm off
  112. md:*** DISCONNECTED
  113. MONITOR  was ON
  114. cmd:MTX      was ON
  115. cmd:CONOK    was ON
  116. cmd:APPL     was $02
  117. cmd:MONITOR  was OFF
  118. cmd:MTX      was OFF
  119. cmd:CONOK    was OFF
  120. cmd:MONITOR  was ON
  121. cmd:
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.  
  130.  
  131. Disconnected  Printer :off:  RX File :off:  Echo :on:         Scroll  Insert
  132. m off
  133.  
  134.  
  135. ═══════════════════════════════════════════════════════════════════════════════
  136.  
  137. The top line of the program, the one that starts "BPQ TheNode", is the top bar,
  138. and diplays information about the program.
  139.  
  140. The line that starts; "Disconnected Printer :off:", is the message bar. This
  141. tells up the program's status, e.g. whether connected or not. The "Scroll"
  142. message tells you that the information displayed on the main screen is from the
  143. buffer, not the current input.
  144.  
  145. Both of these lines would normally have different text attributes from the main
  146. screen window (between the top line and the message bar), and the input window.
  147. Also having the ink for the input and output texts different colours is a good
  148. idea too. However it is probably a good idea to have to background colours the
  149. same for those two. See CONFIGURATION FILE.
  150.  
  151. Text recieved comes in on the main sceen window, is displayed on screen and put
  152. into a buffer, the size of which is specified in the config file. There is full
  153. scrolling around the buffer, with single line scroll up and down, page up and
  154. down, and jump to top or bottom. Text sent from the keyboard is also put onto
  155. the main window, in the same colours as the input window.
  156.  
  157. The input window, from the message line to the bottom of the screen, is for
  158. entering and editing the text. This has a full range of editing commands. Text
  159. is not sent to the TNC or the screen until enter or ctrl-enter is hit. Unless a
  160. space is typed close to the end of the line, or the line is filled up, in which
  161. case the line will be sent.
  162.  
  163.  
  164.            KEYBOARD CONTROL
  165.  
  166.       EDITING
  167.  
  168. Ctrl Enter              Send the line and the end of over characters " >>".
  169.  
  170. Home                    Return the cursor to the left of the screen.
  171.  
  172. End                     Move the cursor to the end of the line.
  173.  
  174. Left                    Move the cursor one character to the left.
  175.  
  176. Right                   Move the cursor one character to the right.
  177.  
  178. Insert                  Toggle between insert and overwrite modes.
  179.  
  180. Delete                  Delete the character under the cursor.
  181.  
  182. Backspace               Delete the character to the left of the cursor.
  183.  
  184. Ctrl Home               Delete from the cursor to the start of the line.
  185.  
  186. Ctrl End                Delete form the cursor to the end of the line.
  187.  
  188.  
  189.       SCREEN KEYS
  190.  
  191. Up                      Scroll the screen up the buffer by one line.
  192.  
  193. Down                    Scroll the screen down the buffer by one line.
  194.  
  195. PageUp                  Scroll the screen up the buffer by one screen.
  196.  
  197. PageDown                Scroll the screen down the buffer by one page.
  198.  
  199. Ctrl PageUp             Move the screen to the top of the buffer.
  200.  
  201. Ctrl PageDown           Move the screen to the bottom of the buffer.
  202.  
  203.  
  204.       FUNCTION KEYS
  205.  
  206. F1                      Help screens.
  207.  
  208. Shift F1   (Alt H)      Display this help screen.
  209.  
  210. F2                      Turn the printer spool on or off.
  211.  
  212. Ctrl F2    (Alt P)      Dump the screen buffer to the printer.
  213.  
  214. F3                      Last line sent. Only if no text in the keyboard buffer.
  215.  
  216. Ctrl F3    (Alt E)      Toggle the echo to the output screen on or off.
  217.  
  218. F4                      Turn the file spool on and off.
  219.  
  220. Shift F4                Change the destination for the file spool.
  221.  
  222. Ctrl F4    (Alt W)      Dump the screen buffer to a file.
  223.  
  224. F5                      Send a text file.
  225.  
  226. F6                      Insert a number into the keyboard buffer.
  227.  
  228. Shift F6   (Alt N)      Select number for insertion.
  229.  
  230. F7                      Search through the screen buffer for specified text.
  231.  
  232. Shift F7   (Alt F)      Enter text for search.
  233.  
  234. F8         (Alt T)      Insert time and date at the cursor
  235.  
  236. Ctrl F8                 Toggle the clock on or off.
  237.  
  238. Ctrl F9    (Alt C)      Empty the screen buffer.
  239.  
  240. F9                      Do a screen refresh.
  241.  
  242. F10        (Alt B)      Return to command mode.
  243.  
  244. Ctrl F10   (Alt X)      Quit the program.
  245.  
  246.  
  247. NOTE.    If you just kill the program the BPQ node will still think the program
  248. there, allowing connections and still trying to send the information to the 
  249. program.
  250.  
  251. I hope that all that was not too garbled! If you have any problems, contact
  252. myself:-
  253.  
  254. Paul G4YFE @ GB7VRB
  255.  
  256. Paul Hounslow
  257. 16 West Mansion
  258. Heene Rd
  259. Worthing
  260. West Sussex
  261. BN11 3NT
  262.  
  263. 0903 212301
  264.  
  265. or
  266.  
  267. Geoff G8DHE @ GB7VRB
  268.  
  269. Geoff Mather
  270. 72 Cranleigh Rd.,
  271. Worthing
  272. West Sussex
  273. BN14 7QW
  274.  
  275. 0903 32161
  276.  
  277. 73's and good luck.
  278.