home *** CD-ROM | disk | FTP | other *** search
/ ARM Club 3 / TheARMClub_PDCD3.iso / hensa / comms / streamer / streamerdoc / html / win_menu < prev   
Text File  |  1995-04-13  |  9KB  |  126 lines
  1. <html>
  2. <head>
  3. <title>Streamer User Guide - The Stream window menu</title>
  4. </head>
  5. <body>
  6. <h2><a name = "strwinmen">The Stream window menu</a></h2>
  7.  
  8. Each stream window has a menu attached to it. The facilities provided by the stream window menu are as 
  9. outlined below, starting with the operation of the <em>Stream ‘x’</em> submenu.<p>
  10. <ul>
  11. <li><a href = "#savestr">Saving stream data</a>
  12. <li><a href = "#spoolstr">Spooling stream data</a>
  13. <li><a href = "#savebuf">Saving to a buffer</a>
  14. <li><a href = "#clear">Clearing all data from a stream</a>
  15. <li><a href = "#client">Client submenu</a>
  16. <li><a href = "#opseltext">Operations on selected text</a>
  17. <li><a href = "#opbufs">Operations on buffers</a>
  18. <li><a href = "#miscops">Miscellaneous operations</a>
  19. <li><a href = "#hlight">Highlight...</a>
  20. <li><a href = "#fnkeys">Fn keys...</a>
  21. </ul>
  22. <h3><a name = "savestr">Saving stream data</a></h3>
  23.  
  24. You may save the text from a stream at any time. Follow the arrow off the Stream->Save submenu to reveal 
  25. a popup save box. The save icon may be dragged to a filer window in the usual manner.<p>
  26. <h4><img src = "sprites/03" align = middle>Saving from a stream</h4>
  27.  
  28. You may also drag a filer icon onto the save box to set the destination in the reverse sense. To do this 
  29. though, you must click on the save entry rather than follow the arrow to the save box, as otherwise the save 
  30. box would vanish as soon as you clicked outside it. If the filer icon you drag to the save box is a file, its full 
  31. name will be copied to the filename entry. Click on OK to save to that file. If the filer icon is a directory, the 
  32. path to the directory will be entered in the save box, replacing any previous path.<p>
  33.  
  34. If the selected destination file already existed you will be warned, and given the option to <code>overwrite</code>, <code> 
  35. append</code> or <code>cancel</code>.<p>
  36.  
  37. Three different save formats are allowed:<p>
  38.  
  39. <dl>
  40. <dt><code>Processed</code> 
  41. <dd>This saves normal ascii text, stripping control codes and using LF at the end of each line, replacing 
  42. whichever end of line sequence your tnc uses. 
  43. <dt><code>Raw</code> 
  44. <dd>Saves the raw data, as received from the tnc. 
  45. <dt><code>Streamer</code> 
  46. <dd>Saves the stream data in Streamer format, preserving TX data / RX data identification. Streamer data 
  47. files may be re-loaded into Streamer for later viewing.</dl>
  48.  
  49. With <code>Processed</code> and <code>Raw</code> formats you have the option of saving the TX data as well as the RX data. Both 
  50. TX and RX data are saved automatically (and distinctly) in Streamer format files.<p>
  51. <h3><a name = "spoolstr">Spooling stream data</a></h3>
  52.  
  53. You may save to a spool file using the <code>Stream->Spool</code> submenu, as described above for <code>Stream->Save</code>. 
  54. When a spool is started, no data will be sent to the file until new data are received from the tnc. As data are 
  55. received, they are buffered and sent to the file when appropriate. Between file operations the file is closed. 
  56. This means that even whilst still spooling you may load the spool file into a text editor, etc, for examination. 
  57. If you want to stop spooling click on the <code>cancel</code> button in the spool save box.<p>
  58. <h3><a name = "savebuf">Saving to a buffer</a></h3>
  59.  
  60. Streamer uses a system of internal buffers, held in memory, for uploading blocks of data to the tnc. It is 
  61. possible to save data to a buffer rather to a file. This is done with the <code>Stream->To buffer</code> submenu. The 
  62. Resulting dialogue box gives a choice of format similar to that for saving to a file. In this case you may 
  63. choose from either ascii or raw data, with or without the TX data.<p>
  64. <h4><img src = "sprites/02" align = middle>Saving to a buffer</h4>
  65. <h3><a name = "clear">Clearing all data from a stream</a></h3>
  66.  
  67. To delete the whole contents of a stream choose <code>Stream->Clear</code>. Be warned that this cannot be undone. If a 
  68. new view or Streamer file view window is cleared the window itself will be removed from the list of active 
  69. windows. In the case of a new view, you may create another new view; the parent stream window is 
  70. unaffected. Clearing a Streamer file view window does not affect the file on disc.<p>
  71. <h3><a name = "client">Client submenu</a></h3>
  72.  
  73. This submenu can have different functions depending of the type of window. For tnc stream windows it 
  74. governs the changing of tnc mode. You may select <code>cmd:</code>, <code>conv</code> or <code>trans</code> mode. Also there is an entry to 
  75. select / deselect automatic mode changing.<p>
  76. <h4><img src = "sprites/04" align = middle>Changing mode</h4>
  77. <h3><a name = "opseltext">Operations on selected text</a></h3>
  78.  
  79. You may select text from a stream window using the adjust key. Only complete lines may be selected. 
  80. Facilities for saving selected text to a buffer or a file are available from the <code>Select</code> submenu. The saving 
  81. procedure and available options are as for saving the whole stream. You may also clear the selection 
  82. (<code>Unselect</code>) or delete it (<code>Remove</code>). There is just one selection per stream. Selections made in a parent stream 
  83. will appear identically in new views, and vice versa.<p>
  84. <h4><img src = "sprites/06" align = middle>The Select menu</h4>
  85. <h3><a name = "opbufs">Operations on buffers</a></h3>
  86.  
  87. Text from a stream may be saved to a buffer in memory. Also, when a file other than a Streamer data file is 
  88. dropped onto Streamer it will be copied to a buffer, ready for uploading. Operations on buffers are provided 
  89. through the <code>Buffers</code> entry on any stream window. This will pop up the Buffers window, shows the name, 
  90. size and upload status of all the loaded buffers in a scrollable pane. To upload a buffer to a tnc stream first 
  91. click on its entry to select it. Choose a stream from the popup menu next to the <code>Upload</code> button. This sets the 
  92. destination for the next buffer to be uploaded. Initiate the upload by clicking on <code>Upload</code>. If Streamer is busy 
  93. uploading a buffer already your upload request will be queued. To remove the selected buffer click on <code> 
  94. Remove buffer</code>. To stop a buffer from being uploaded if it is in the queue, select it and click <code>Cancel</code>. <code>Cancel 
  95. all</code> cancels all queued uploads. To abort the current upload use <code>Abort</code>. <code>Pause</code> pauses the current upload. The 
  96. button will then change to <code>Resume</code>. Unless you want to upload a buffer more than once you should select <code> 
  97. Remove after upload</code>.<p>
  98. <h3><a name = "miscops">Miscellaneous operations</a></h3>
  99.  
  100. The <code>Misc</code> submenu provides access to two more setup areas. These are <code>Highlight...</code> and <code>Fn keys...</code>. 
  101. There is also a <code>Send break</code> entry. This sends a break signal to the tnc. The duration of the break signal is set 
  102. in the terminal setup area.<p>
  103. <h4><img src = "sprites/05" align = middle>The Misc. menu</h4>
  104. <h4><a name = "hlight">Highlight...</a></h4>
  105.  
  106. Streamer provides a mechanism by which words of interest in the output area of a stream window may be 
  107. highlighted. The highlighting colour is set in the colours setup. The <code>Misc->Highlight...</code> menu entry 
  108. reveals the highlighting control area. This has a scrolling list of names that will be highlighted. The list can 
  109. be extended by entering new words in the lower left icon and clicking on <code>Add</code>. If you select an entry from 
  110. the list by clicking on it you may choose <code>Delete</code> to remove it from the list or <code>Update entry</code> to replace it 
  111. with a new one. Clicking on <code>Save</code> stores your list in Streamers setup area on disc.<p>
  112. <h4><a name = "fnkeys">Fn keys...</a></h4>
  113.  
  114. Text may be assigned to three sets of function keys – Fn key + shift, Fn key + Ctrl and Fn key + Shift + 
  115. Ctrl. When a stream window has the caret and a function key combination is pressed, the assigned text will 
  116. be sent to the tnc, being expanded as necessary. The <code>Misc->Fn keys...</code> menu entry gives access to the 
  117. function key definition area. Choose which function key set to edit from the radio icons to the bottom of the 
  118. dialogue box.<p>
  119.  
  120. The definition may contain expressions between curly brackets. These will be expanded in the same way as 
  121. text entered in the TX area. To embed ctrl codes you may also use the ‘<code>|x</code>’ convention, e.g <code>|M</code> to send a new 
  122. line character.<p>
  123. <a href = "../Manl_html">Back to contents page</a>
  124. </body>
  125. </html>
  126.