home *** CD-ROM | disk | FTP | other *** search
/ Scene Xplorer 1 / Scene_Xplorer_1.iso / Tools / TextView / TextView_eng.doc < prev    next >
Text File  |  1978-01-11  |  30KB  |  899 lines
  1. $VER: TextView.doc 1.6 (31.5.96)
  2.  
  3.  
  4.  
  5.  
  6.  
  7. °°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°
  8.                         May 31, 1996
  9.  
  10.                      Torbjörn Andersson
  11.                           presents
  12.                         TextView 1.6
  13.  
  14.                          Shareware
  15.  
  16. °°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°
  17.  
  18.  
  19.  
  20.  
  21.  
  22. 1. Contents
  23. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  24. Contents ................................................. 1
  25. Introduction ............................................. 2
  26. Requirements ............................................. 3
  27. Usage .................................................... 4
  28. Load ..................................................... 5
  29. Save ..................................................... 6
  30. Crunch ................................................... 7
  31. Keys ..................................................... 8
  32. Mouse .................................................... 9
  33. Search .................................................. 10
  34. Goto .................................................... 11
  35. Iconify ................................................. 12
  36. Settings ................................................ 13
  37. Comments ................................................ 14
  38. Bugs .................................................... 15
  39. History ................................................. 16
  40. Credits ................................................. 17
  41. Distribution ............................................ 18
  42. Shareware ............................................... 19
  43. Author .................................................. 20
  44.  
  45.  
  46.  
  47.  
  48.  
  49. 2. Introduction
  50. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  51. TextView is one of the programs I use most. I made it
  52. because I wanted a good and fast textviewer. And TextView is
  53. fast. It loads files in a twinkling of an eye, it has custom
  54. routines for text output and scrolling, and searching for a
  55. string is very fast. I have tried to make it configurable
  56. and userfriendly, so I hope it can be used by anybody.
  57.  
  58. Features:
  59. · Written entirely in assembler.
  60. · Has custom routines for text output and scrolling.
  61. · Scrollbar with soft realtime scrolling.
  62. · Can show different fontstyles and colors.
  63. · Doesn't show commands in AmigaGuide files.
  64. · Files can be shown in binary and hexadecimal form.
  65. · Pipe support.
  66. · Xpk support.
  67. · Reads files crunched with PowerPacker.
  68. · Can crunch and save files.
  69. · Multiple files.
  70. · Font sensitive.
  71. · Random palette.
  72. · Window on own screen or any public screen.
  73. · Configure font, screen depth, placement of scrollbar, etc.
  74. · Very fast searchroutine.
  75. · Bookmarks.
  76. · Iconify.
  77. · Can be made Resident.
  78. · AmigaOS 1.2/1.3 compatible, AmigaOS 2.0/3.0 aware.
  79.  
  80.  
  81.  
  82.  
  83.  
  84. 3. Requirements
  85. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  86. A few features require AmigaOS 2.0 or higher, otherwise
  87. AmigaOS 1.2 is enough.
  88.  
  89. Reqtools.library is required if you want to:
  90. Choose file (loading and saving), choose font, choose screen
  91. mode, search for a string, set tab size, set priority, change
  92. palette.
  93.  
  94. Alternatively asl.library can be used for the file-, font-
  95. and screen mode selecting.
  96.  
  97. Powerpacker.library is required if you want to:
  98. View a file that is both crunched and encrypted with
  99. PowerPacker, or crunch and save a file.
  100.  
  101. Xpk libraries are required if you want to view a file
  102. compressed with Xpk.
  103.  
  104. Asl.library is a part of AmigaOS 2.0+.
  105.  
  106. Reqtools.library and powerpacker.library are popular
  107. libraries by Nico François. You should not have any big
  108. trouble finding these if you don't already have them.
  109.  
  110.  
  111.  
  112.  
  113.  
  114. 4. Usage
  115. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  116. TextView can be started from both CLI and Workbench, and can
  117. be made resident. It doesn't take any arguments from
  118. Workbench, except the file if you use TextView as default
  119. tool. From CLI the usage is:
  120. TextView [file|dir] [TABS <n>] [BIN|HEX|ASCII] [ICON]
  121.  
  122. Explanation of options:
  123.  
  124. TABS <n>
  125. Use tabsize n.
  126.  
  127. BIN|HEX|ASCII
  128. View file in bin/hex mode, or force normal viewing. If none
  129. of these options is given, hex mode will automatically be
  130. used if the file is executable, an icon, an iff file or has
  131. (many) exceptional characters.
  132.  
  133. ICON
  134. Start iconified.
  135. (KS 2.0+)
  136.  
  137.  
  138.  
  139.  
  140.  
  141. 5. Load
  142. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  143. If you start TextView with no arguments, it will open a file
  144. requester. You can specify a filename on the commandline to
  145. load directly, or a directory to position the file requester
  146. in.
  147.  
  148. If you want to load a new file, use "Open..." in the Project
  149. menu, or "Open New..." if you want to keep the first file.
  150. The first free buffer will be used when selecting Open New,
  151. and if none is free the screen will flash.
  152.  
  153. TextView will load the whole file in one turn. It has some
  154. disadvantages. It requires that there is a free continuous
  155. block of memory as large as the file. The loading cannot be
  156. interrupted. You can't start reading until the whole file
  157. is loaded. But it is fast.
  158.  
  159. If the file was crunched with PowerPacker or Xpk, it will
  160. automatically be decrunched before it is shown.  If it is
  161. encrypted you will be asked for a password first. A
  162. progress bar will be used when loading and decompressing
  163. xpk-files.
  164.  
  165. When the file is loaded, TextView will count the number of
  166. lines in it, and at the same time create a small speed up
  167. table used when scrolling through the file.
  168.  
  169. If a file is loaded from a pipe device, TextView will first
  170. pull the whole file from it in small blocks. Then it will
  171. allocate a block of memory as large as the whole file and
  172. copy the smaller parts to it. Thus the memory required for
  173. this is twice the size of the file, and it will lead to
  174. memory fragmentation. But I hope it is better than no pipe
  175. support at all.
  176.  
  177.  
  178.  
  179.  
  180.  
  181. 6. Save
  182. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  183. Sometimes I load a huge file of a floppy disk with TextView,
  184. and then discover that I want a copy of it on the HD. Since
  185. the file is in memory, it would be a waste of time to have
  186. to access the slow floppy disk once again. I think it is
  187. natural to have a save function in a textviewer, even if it
  188. is not possible to edit the text.
  189.  
  190. Use Save As in the Project menu to save the current file.
  191. TextView will warn you if the file already exists.
  192.  
  193.  
  194.  
  195.  
  196.  
  197. 7. Crunch
  198. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  199. Save PP in the Project menu can be used to crunch a file
  200. using the powerpacker.library and then save it.
  201.  
  202. You can't use this function to encrypt or crunch executable
  203. files, it only handles "data" files. The efficiency used is
  204. always "best". Speedup buffer is automatically adjusted to
  205. available memory. One or two "*" will be shown in the
  206. titlebar while crunching if the largest buffer couldn't be
  207. allocated; and crunching is then slower. You can abort
  208. crunching at any time by selecting Save PP again.
  209.  
  210.  
  211.  
  212.  
  213.  
  214. 8. Keys
  215. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  216. Use About in the Project menu, or "?", to see the key
  217. commands.
  218.  
  219. The Help key will show some system info and information
  220. about all files loaded. A "*" marks which one of the buffers
  221. that is currently shown.
  222.  
  223. Keys 1,2,... switches between file buffers.
  224.  
  225. Use shift and an F-key to set a bookmark the same F-key to
  226. go to that bookmark.
  227.  
  228. Use B/H keys to toggle between bin/hex/normal view mode.
  229.  
  230. TextView will quit if you press Esc, Q, Ctrl-C or Ctrl-D.
  231. Ctrl-D will set a returncode of 20, which can be used to
  232. break scripts.
  233.  
  234. You can use the arrow keys to view lines that are too long,
  235. or use Word Wrap by pressing W. TextView will then format
  236. the text by putting line feeds where appropriate. Word Wrap
  237. cannot be undone.
  238.  
  239. Shift-E will start and pass the filename to the editor set
  240. in ENV:EDITOR.
  241.  
  242.  
  243.  
  244.  
  245.  
  246. 9. Mouse
  247. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  248. You can use the mouse to move through the file.
  249.  
  250. When the select (left) button is pressed, TextView will
  251. start to examine the mouse position. When it is moved a
  252. little bit away from the middle of the window, the text will
  253. start scrolling up or down. The further the mouse is moved
  254. from the middle, the faster the text will scroll.
  255.  
  256. You do not have to keep the button pressed, clicking is
  257. enough for TextView to