home *** CD-ROM | disk | FTP | other *** search
/ DP Tool Club 17 / CD_ASCQ_17_101194.iso / dos / util / rpr15 / rpr.doc < prev    next >
Text File  |  1994-09-13  |  16KB  |  346 lines
  1.                            USERS GUIDE
  2.                          RPR Version 1.0
  3.                       A File Viewing Utility
  4.  
  5.                     Red Paint Read (C) Copyright 1994
  6.                     RPR (C) Copyright 1994
  7.                     All Rights Reserved by Bruce Henry
  8.  
  9.  
  10. INTRODUCTION
  11. This program is a file viewer for ASCII text files. It's features
  12. are similar to other file viewing utilities available, with the
  13. hope that the best features of the others have been included and
  14. the worst features discarded. The interface is intended to be
  15. easy to use and understand. Full mouse support is provided as
  16. well as hot keys and drop-down menus.
  17.  
  18. GENERAL FEATURES
  19. Rpr will read any file either named as a command line parameter
  20. or chosen via the scrollable directory display. It has both
  21. Hexadecimal and ASCII display modes as well as 25x80, 43x80(EGA)
  22. and 50x80(VGA) options. Blocks of text can be marked and sent to
  23. the printer or a file. Searches can be done for strings of text
  24. or the viewer can jump to any byte or line in the file. Screen
  25. colours can be customized to the user's preference. Piping is
  26. also supported.
  27.  
  28.  
  29. FAST START
  30. ==========
  31. RPR can be started without any parameters in which case a
  32. scrollable directory listing will be presented from which a file
  33. can be selected.
  34.  
  35. RPR COMMAND LINE OPTIONS
  36. The command line supports 3 parameters described with examples as
  37. follows:
  38.  
  39. rpr [[path]filename] - where [path][filename] is the path and/or  
  40.                        name of the file to be viewed.
  41.  
  42.                        eg. rpr rpr.doc
  43.  
  44. rpr /?               - where /? will display a description of     
  45.                        these parameters.
  46.  
  47. rpr /s               - where /s enables piping and could be used
  48.                        like this:
  49.  
  50.                        dir|rpr /s
  51.  
  52.                        which would display the current
  53.                        directory inside rpr.
  54.  
  55. Use the Home, End, PgUp, PgDown, and Up-Down cursor keys to move
  56. within the file. Full Mouse support is also provided and also
  57. menu hot keys for drop-down menus. A Help screen is displayed by
  58. pressing F1 or "h". Menu options are selected by pressing the
  59. highlighted menu letter in the name on the top line or by
  60. positioning the mouse cursor anywhere on the menu name and
  61. pressing the left mouse button.
  62.  
  63.  
  64. SYSTEM REQUIREMENTS:
  65. RPR will run in about 60K of memory with any version of DOS above
  66. Version 3.0.
  67.  
  68. LIMITATIONS:
  69. RPR will now handle files of any length. Lines over 80 characters
  70. are wrapped into the next line.
  71.  
  72. MOUSE USAGE
  73. ===========
  74. Items selected by the mouse must be clicked on once with the left
  75. mouse button. If a menu is being used, clicking the mouse
  76. anywhere outside of the menu box is equivalent to pressing the
  77. escape key.
  78.  
  79. COMMAND KEYS
  80. ============
  81. PgUp - Moves display up one screen in the file.
  82. PgDn - Moves display down one screen in the file.
  83.  Up  - Moves the cursor up one line in the file.
  84. Down - Moves the cursor down one line in the file.
  85.  ->  - Moves the cursor to the right in Mark Block mode. 
  86.  <-  - Moves the cursor to the left in Mark Block mode. 
  87. Home - Moves the cursor to the beginning of the file. 
  88. End  - Moves the cursor to the end of the file. 
  89. Esc  - Remove the menu or quit the program.
  90. Space Bar - Moves the display down one screen in the file. 
  91. Enter - Selects the highlighted menu choice or accepts user input 
  92.         for the Goto Line or Byte and Ascii Search functions.
  93.  
  94. F1   - Pops up the Help Screen. 
  95. F2   - Prompts user for anycase text search string. 
  96. F3   - Prompts user for exact case text search string. 
  97. F4   - Repeats last search. 
  98. F5   - Switches to Hexadecimal mode or back to Text mode. 
  99. F6   - Prompts user for a byte number to go to. 
  100. F7   - Prompts user for a line number to go to. 
  101. F8   - Set start and end points for marking a block of text.
  102. F9   - Unmarks highlighted block. 
  103. F10  - Sends current marked block to the printer. 
  104. F11  - Requests for a file name to write a marked block to.
  105.        Block will be APPENDED to the file if it exists.
  106. F12  - Switches display between 43/50 and 25 line mode.
  107.  
  108.  
  109. CONVENIENCE KEYS
  110. ----------------
  111. The space bar acts like the pagedown key, moving the display down
  112. one screen at a time.
  113. The left mouse button, when held down on a key name (PageUp,
  114. Home,CursorDn, etc.), will repeat the key until the mouse button
  115. is released.
  116. The right mouse button will scroll the screen down through the
  117. file a line at a time at high speed.
  118.  
  119. MENUS AND HOT KEYS
  120. ==================
  121. There are five menu items available on the Menu line (top line),
  122. all of which can be accessed either by a hot key (the highlighted
  123. letter in the menu name) or by selecting it with the mouse. If
  124. the menu is an action menu, the file movement and cursor keys
  125. will move a scrollbar through the menu until an action is
  126. selected. If the menu is a passive one (the Help menu), the file
  127. movement and cursor keys move through the menu the same as they
  128. do while reading a file. If the menu has more information or
  129. display lines than can be shown on the screen at one time, an
  130. arrow will appear on the top line of the menu to indicate the
  131. direction to move in the file to see the rest of the selections
  132. or information. These arrow blocks (an up and down arrow can be
  133. present at the same time) are also used as mouse keys by
  134. positioning the mouse cursor on the arrow block and clicking the
  135. left mouse button.
  136.  
  137. Files Menu
  138. ---------- 
  139. Another file can be selected to read by using the files menu.
  140. Press the "f" key or click anywhere on the "Files" name to access
  141. a sorted directory listing for the current working directory.
  142. Files or other directories can be selected with the scrollbar or
  143. the mouse. The parent directory can be selected by choosing the
  144. ".." entry which will be the first entry shown unless the current
  145. working directory is the root directory.
  146.  
  147. Drives Menu
  148. -----------
  149. As the program is loaded, a survey is made of available drives
  150. which then appear in the drives menu. Selecting a different drive
  151. letter will switch the Files menu to the new drive's current
  152. working directory. In the case of floppies or CD Rom drives, be
  153. sure that the drive is loaded and that the media contains Dos
  154. compatible files.
  155.  
  156. Colours Menu
  157. ------------
  158. The colours menu allows customization of the screens colours.
  159. These will be saved in a small configuration file that is read
  160. each time the program is loaded. This insures that colour changes
  161. made in one session will still be in effect in subsequent
  162. sessions. To restore the default colours, just erase the file
  163. named "rpr.cfg" in the root directory of C: drive.
  164.  
  165.  
  166. Options Menu
  167. ------------
  168. The Options menu provides another way to access the commands that
  169. are tied to the function keys (F1 to F12).
  170.  
  171. Help
  172. ----
  173. A short description of the keys, menus and available features are
  174. found in the "Help" menu.
  175.  
  176. Esc
  177. ---
  178. The Escape function allows the user to remove the current menu or
  179. to quit the program. It duplicates the action of the "Esc" key.
  180.  
  181.  
  182.  
  183. DETAILED PROGRAM DESCRIPTION
  184. ============================
  185. When RPR gets a filename from the command line or the Files menu
  186. it opens the file and begins to read it into a buffer. This
  187. buffer is of a constant size and so RPR never grows in memory
  188. regardless of the size of the file being read. As it is read, the
  189. file is scanned for linefeeds and carriage returns as well as tab
  190. symbols so that RPR can count the lines that pass through the
  191. buffer. During this scanning, a "loading" message will be seen on
  192. the second line (status line) of the screen. Indices are also
  193. set up at this time to allow for easy movement within the file
  194. later. This process continues until the entire file has passed
  195. through the buffer. When this process is complete, the "loading"
  196. message stops flashing and the file is ready for viewing. With
  197. files under 100Kb in size this processing occurs very fast,
  198. however the larger the file, the longer this can be expected to
  199. take.
  200.      RPR can also accept piping with the use of the '/s'
  201. parameter. Piping enables RPR to view text that is output from
  202. another program by use of temporary files and is normally
  203. channelled through Dos with the use of the piping symbol "|". For
  204. more information on piping consult your DOS manual.
  205.      Searches for text are allowed for up to 30 characters which
  206. can include spaces or punctuation. These searches always begin at
  207. the top of the current screen and proceed forward through the
  208. file. A search can be for an exact match of the text (case
  209. sensitive), or it can be for any occurrence of the text
  210. regardless of case. Each search can be repeated with the F4 key
  211. until the end of the file is reached. Search can be used in both
  212. ASCII and hex modes.
  213.      The Hexadecimal display is presented in three fields. The
  214. first field is a six character hex byte index on the left of the
  215. screen. The middle part of the screen is a display of the hex
  216. value of the bytes in a sixteen byte range starting at the
  217. index in the first column. The values are separated by spaces
  218. and a double space divides the sixteen bytes into two eight byte
  219. areas. Finally, a column on the right of the screen displays an
  220. ASCII representation of the sixteen bytes for that line.
  221. Both text and hex modes can display in 43/50 line mode unless a
  222. Hercules type display is being used.
  223.      The Goto Byte command can also be used in either hex or text
  224. modes and can move the display to any position in the file or
  225. locate a previously displayed area of the file.
  226.      The Goto Line command, however, is only available in text
  227. mode since in hex mode the lines are all sixteen bytes long and
  228. do not correspond to the line count in text mode.
  229. These commands allow movement through the file as well as the
  230. more common means provided by Page Up, Page Down, Home (moves to
  231. the start of the file), End (moves to the end of the file), and
  232. Cursor Up, Cursor Down (move the display up and down a line,
  233. respectively). The Space Bar also can be used as a Page Down key
  234. for fast and easy progress through the file. Full mouse support
  235. is also provided with movement through the file accomplished by
  236. clicking on the movement labels highlighted on the top line, with
  237. the left mouse button. If the button is held down, the operation
  238. repeats until the button is released. Holding down the right
  239. mouse button provides a continuous forward scrolling action
  240. through the file. When the end of a file is reached, an "End of
  241. File" message will overwrite the copyright string in the top
  242. right corner.
  243.      Marking blocks of text to be sent to the printer or saved as
  244. a file is done much like moving around the file. However, when
  245. the Mark Block command is given, a visible cursor appears and
  246. will remain on the screen until the process is finished. The
  247. ENTER key will anchor one end of the block by highlighting the
  248. character under the cursor in reverse video and then allow
  249. movement of the cursor to the ending position of the block which
  250. may be either forward or backward in the file. Again, the ending
  251. position is anchored with the ENTER key and the block marking is
  252. complete. The visible cursor now disappears and the block will
  253. remain highlighted until the block is unmarked with the F9 key or
  254. the block has been written to a file. If the block is sent to a
  255. printer with the F10 key, the highlight will remain in place
  256. until the block is in the printer buffer and a key is pressed.
  257. Marking blocks is available only in text mode. Marking blocks may
  258. also be done with the mouse by moving the mouse cursor to the
  259. desired beginning and ending points and clicking the left mouse
  260. button.
  261.      If a block is being written to a file, a file name is
  262. entered at the prompt and the file will be APPENDED to the named
  263. file if it exists, or the file will be created. This filename
  264. will be remembered for following Block Write operations. All
  265. editing keys (insert, delete, home, end etc.) are available when
  266. input is required from the keyboard.
  267.      All of the screen colours can be set with a scrollable drop-
  268. down menu that has a line for every area of the screen that has a
  269. separate color attribute. All areas of the screen can be set and
  270. both the background and the foreground colours can be set.
  271. The first line of the screen and the second line are separately
  272. addressable as are the text display portion of the screen and the 
  273. help screen and other menu boxes. The colours will change each
  274. time an area is selected and the colours will rotate through in a
  275. continuous loop. After these colours are set to new values, a
  276. small configuration file named "rpr.cfg" is written to the root
  277. directory of the hard drive when the program is exited.
  278. The colours stored in this file will then be reloaded each time
  279. the program is executed. If the configuration file is removed,
  280. the colours will revert to the start-up defaults. 
  281.      Monochrome displays can also be adjusted to a much more
  282. limited extent.
  283.  
  284.  
  285.                                          | Text | Hex  |
  286.                                          | Mode | Mode |
  287.                        ------------------|------|------|-
  288.                        Search for Text   |  X   |  X   |
  289.                        ------------------|------|------|-
  290.                        Goto Byte         |  X   |  X   | 
  291.    FEATURE             ------------------|------|------|-
  292.    SUMMARY             Goto Line         |  X   |      |
  293.                        ------------------|------|------|-
  294.                        Mark Block        |  X   |      |
  295.                        ------------------|------|------|-
  296.                        43/50 Lines       |  X   |  X   |
  297.                        ------------------|------|------|-
  298.  
  299. DISCLAIMER
  300. ----------
  301. All warranties and liabilities are disclaimed except those
  302. described in the Guarantee conditional upon registration of this
  303. program.
  304.  
  305. GUARANTEE
  306. ---------
  307. Upon registration of this program the registered user receives a
  308. money-back guarantee of the registration fee should this program
  309. not perform in the manner indicated in the documentation.
  310.  
  311. LICENCE
  312. -------
  313. Red Paint Read is distributed as a Shareware program with the
  314. understanding that it may be evaluated on a trial basis 10 times
  315. without fee. After the trial period, the user is required to
  316. register the program for the fee indicated on the order form.
  317. The licence will provide the user with a registration number and
  318. exclusive rights to the use of or transfer of that licensed copy.
  319.  
  320. TO ORDER
  321. --------
  322. Simply print out the order form in the file "rprorder.frm" and
  323. mail it along with the registration fee.
  324. The registration fee is US $5.00 or CAN $6.00. See the order form
  325. "rprorder.frm" for more details.
  326.  
  327. ABOUT RPR
  328. ---------
  329. Red Paint Read was written and compiled using Borland C++ 3.1
  330. under the compact memory model. It follows most of the C++
  331. conventions of data hiding and encapsulation and the use of
  332. objects.
  333. Separate versions of RPR compiled for 80286 machines
  334. (RPR286.COM) and 80386 machines (RPR.COM) are included.
  335. This zip should contain these files:
  336.  
  337. rpr.exe      - Red Paint Read executable
  338. rpr286.exe   - executable version for 80286 machines
  339. rpr.doc      - this file
  340. rprorder.frm - RPR order form
  341. rprhelp.bat  - a batch file to display this file
  342. file_id.diz  - program description file
  343.  
  344. Bruce Henry,
  345. Red Paint Software
  346. Internet: bruce.henry@canrem.com