home *** CD-ROM | disk | FTP | other *** search
/ The World of Computer Software / World_Of_Computer_Software-02-386-Vol-2of3.iso / l / l2_21.zip / L2.DOC next >
Text File  |  1993-01-23  |  14KB  |  296 lines
  1.  
  2. ==============================================================================
  3.  
  4.                                L2 Version 2.1
  5.                              A. Donnie Hale, Jr.
  6.                           Copyright (c) 1992, 1993
  7.  
  8.                        An OS/2 2.0 file-viewer utility
  9.  
  10.                              SANSoft Development
  11.                               4971 Pegasus Ct.
  12.                              Hilliard, OH  43026
  13.                          Voice-mail: (614) 898-2675
  14.  
  15. ==============================================================================
  16.  
  17.  
  18. Description
  19. -----------
  20. L2 is a text file-viewer utility created for OS/2 2.0 developers and users.
  21. It is developed entirely as a 32-bit application (save the text-mode
  22. interface, which IBM left as 16-bit). Multiple files may be specified on the
  23. command line (now including wildcards!!), and there is no restriction as to
  24. the maximum line length of a file. In addition to the standard features of a
  25. file-viewer utility, L2 incorporates intelligent tab expansion, multiple text
  26. modes, jumping to a specific line number, setting and retrieving of
  27. bookmarks, and regular expression searches.  Also, because L2 loads the file
  28. to be viewed entirely into memory, scrolling, jumping to specific or saved
  29. locations, and text searches are extremely fast.
  30.  
  31.  
  32. Release 2.1 Notes
  33. -----------------
  34. To improve ease of use, L2 can now be started without any command-line 
  35. parameters. When this is done, L2 will prompt for a file name or names. Any 
  36. number of file names (with or without wildcards) may be entered at this 
  37. prompt, separated by spaces (up to 60 characters total). L2 will treat this 
  38. list exactly as if it had been entered on the command line. If <Escape> is 
  39. pressed at this point, L2 will exit.
  40.  
  41. Along with this, while a file is being viewed, the 'N' key will bring up this 
  42. same prompt to allow viewing a new file while within L2. The same rules for 
  43. entering file names given above apply here. The expanded list of files will 
  44. be appended to any current list of files, and the first file found out of the 
  45. additional files will be displayed.
  46.  
  47. If L2 gets through its entire list of files without being able to load any of 
  48. them, it will bring up the file prompt. Hitting <Escape> will exit at this 
  49. point.
  50.  
  51. The number of files that may be contained in the file list has been increased 
  52. to 256 files.
  53.  
  54.  
  55. Release 2.0 Notes
  56. -----------------
  57. Release 2.0 of L2 incorporates several new features, including wildcard 
  58. filename expansion and a file-selection list. Command-line arguments passed 
  59. to L2 which have wildcards ('*' and '?') are expanded into full file names.  
  60. Arguments without wildcards are left as-is. The F6 and Shift-F6 keys move 
  61. forward and backward through the expanded list of files. The Ctrl-F6 key 
  62. brings up a list of all of the expanded file names, with the currently listed 
  63. file hilited. The desired file may be hilited, and when <Enter> is pressed, 
  64. that file will be loaded. Up to 50 files may be contained in this expanded 
  65. file list.
  66.  
  67. If there is a problem loading the next/previous/selected file, a message is 
  68. displayed, there is a short pause, and the next file in the list is loaded. 
  69. If L2 gets through the entire list of files without being able to load any of 
  70. them, it will exit.
  71.  
  72. To work with this capability, the file-search criterion remain across files.  
  73. Thus, if a search is performed on one file and then a new file is selected, 
  74. only the 'A' key needs pressed to repeat that search from the top of the new 
  75. file. The <Esc> key exits L2 altogether.
  76.  
  77. Also, bookmarks maintain the file in which they are set. Thus, if 5 files are 
  78. in the file list and bookmark 2 is set in file 3, the specified location in 
  79. file 3 will be returned to when bookmark 2 is retrieved while viewing file 1.
  80.  
  81.  
  82. Features of L2
  83. --------------
  84. L2 uses "intelligent tab expansion": most text editors allow a tab width to
  85. be set. When <Tab> is pressed, the cursor goes to the next multiple of that
  86. tab stop on the current line. For example, if the tab width is 4, tab stops
  87. would be at columns 1, 5, 9, 13, etc. If the cursor is in column 10 and <Tab>
  88. is pressed, the cursor goes to column 13, where the next character will be
  89. placed.  Editors operate this way so that source code will have correct
  90. indentation.  Assuming that the tabs are saved in the file, most file-viewers
  91. simply display the character after a tab after moving the tab-width number of
  92. places to the right. In the previous example, with a tab-width of 4 and a tab
  93. at column 10, the standard file-viewer would display the next character at
  94. column 14 rather than 13. Thus columns are not aligned correctly, and the
  95. file doesn't look the same in the file-viewer as in the editor. L2 corrects
  96. this problem by using the tab width for locating tab stops the same way that
  97. an editor does.
  98.  
  99. L2 supports up to 15 video modes, depending on hardware. Its default mode is
  100. 80x30 (720x480). When cycling through video modes, L2 stops at the next valid
  101. mode. Also, L2 supports up to 16 BACKGROUND colors, as well as the standard
  102. 16 foreground colors, again, depending on hardware.
  103.  
  104. Specific line numbers may be jumped to. Also, bookmarks may be set and
  105. retrieved. This is useful when examining source code and jumping from one
  106. function to another and back, etc.
  107.  
  108. L2 supports regular expression searches, so that complex search expressions
  109. may be entered and acted on. This goes beyond the capabilities of most file
  110. viewers.
  111.  
  112. L2 is strictly for viewing text (ASCII) files, with lines delimited by CR/LF 
  113. combinations. Attempting to view non-text files with L2 will yield 
  114. unpredictable results.
  115.  
  116.  
  117. Using L2
  118. --------
  119. First, copy L2.EXE to a directory that is in your PATH statement. Then, to
  120. run L2, simply type L2 at an OS/2 2.0 full-screen or windowed prompt (L2 runs
  121. much better in full-screen mode), followed by 1 or more file names, and then
  122. press <Enter>:
  123.  
  124.   L2 filenam1.ext [filenam2.ext [filenam3.ext...]] <Enter>
  125.  
  126. If you run L2 with no file names, L2 will prompt you for the file(s) to view.
  127.  
  128. L2 will be started in its currently configured state. Initially, that is 80
  129. column by 30 row (720x480 pixels), with default colors, tab expansion on, and
  130. a tab width of 3. There is a means to change these, described later.
  131.  
  132. L2 comes up with the top of the file displayed starting on the second row,
  133. continuing to the next to the bottom row. The top row is an informational /
  134. status line as shown below:
  135.  
  136.  FILENAME.EXT  9,999,999 9,999,999  +999,999   999,999      MM/DD/YY  HH:MM:SS
  137.       │            │         │          │         │            │         │
  138.   file name      line #   # lines    column   file size    file date file time
  139.  
  140. The column offset area is only displayed when not in the leftmost column.
  141. Also, if the file size exceeds 1,000,000 bytes, it will be displayed in terms
  142. of the number of kilobytes (e.g. 1,354K).
  143.  
  144. The bottom line on the display is for messages and text input. "Top of file"
  145. and "End of file" are examples of the messages displayed there. Text to be
  146. input includes the text for searches and line numbers for jumping.
  147.  
  148. Pressing <F1> brings up a simple help screen describing available keys and
  149. their functionality.  Pressing the Escape key (<Esc>) exits L2.
  150.  
  151.  
  152. Navigating L2
  153. -------------
  154. The standard navigation keys are used to move throughout the file. These
  155. include:
  156.  
  157.   Cursor keys ()    - line/column at a time scrolling,
  158.   Ctrl-Left, Ctrl-Right - tab-width at a time horizontal scrolling
  159.   PgUp, PgDn            - page up and page down scrolling
  160.   Home                  - top of file, stay in current column
  161.   Ctrl-Home             - top of file, column 1
  162.   Backspace             - go to column 1
  163.   End                   - end of file, column 1
  164.  
  165. Other navigation keys include:
  166.  
  167.   'G' key               - prompted for a line number; go to that line
  168.   '0' - '9' keys        - set bookmarks 0 through 9
  169.   Shift '0' - '9' keys  - retrieve bookmarks 0 through 9
  170.  
  171.  
  172. Searching in L2
  173. ---------------
  174. There are three types of searches in L2: case-sensitive text search,
  175. case-insensitive text search, and regular expression search. To perform a
  176. search, press:
  177.  
  178.   'F' key               - perform a case-insensitive search; enter up to 60
  179.                           characters to search for; escape or 0 length search
  180.                           text cancels the search
  181.   'S' key               - case-sensitive search, up to 60 characters
  182.   'R' key               - regular expression search, up to 60 characters in
  183.                           the expression (although the found text may be
  184.                           longer)
  185.   'A' key               - repeat the last search from the last found text
  186.  
  187. All new searches (i.e., those begun with the 'F', 'S', or 'R' keys) begin at
  188. the top of the file. If the text is found, L2 will move to the line
  189. containing the text and hilite the text.  If the text is not found, a message
  190. will be displayed at the bottom of the screen.  Pressing 'A' after getting a
  191. "Text not found..." message will begin the search again at the top of the
  192. file.
  193.  
  194. A repeated text search will begin at the first character after the previously
  195. found text. Regular expressions, however, are line-at-a-time searches;
  196. therefore, a repeated regular expression search will begin on the line after
  197. the line containing the previously found text.
  198.  
  199. The characters available for regular expression searches are:
  200.  
  201.   ^      - matches beginning of line
  202.   $      - matches end of line
  203.   .      - matches any character
  204.   \      - followed by a single character matches that character, except:
  205.   \b     - backspace
  206.   \s     - space
  207.   \t     - tab
  208.   \\     - backslash
  209.   []     - character class
  210.   [^...] - negative character class
  211.   *      - match 0 or more occurences of the preceding regular expression
  212.   |      - match expression before | or expression after |
  213.  
  214. Ranges of ASCII characters may be specified in character classes. For
  215. instance, [a-zA-Z0-9] matches any alphanumeric character. The characters * .
  216. ^ $ are not special characters within a character class.
  217.  
  218.  
  219. Configuring L2
  220. --------------
  221. There are several configurable items in L2, including tab expansion (on/off),
  222. tab width (2-8), screen colors (text, border, hilite, and help), and video
  223. mode. To modify these items, press:
  224.  
  225.   'T' key               - toggle tab expansion on/off
  226.   'W' key               - cycle the tab width from 2-8 spaces
  227.   'M' key               - cycle the video mode; there are 15 potential video
  228.                           modes, depending on the support your hardware
  229.                           provides
  230.   F2, Shift-F2          - background, foreground text colors
  231.   F3, Shift-F3          - background, foreground border colors
  232.   F4, Shift-F4          - background, foreground hilite colors (found text)
  233.   F5, Shift-F5          - background, foreground help colors
  234.  
  235.   Note: There are 16 available foreground AND background colors, assuming the
  236.         hardware supports it.
  237.  
  238. If any of the configurable items are changed, the changes WILL BE LOST if the
  239. configuration is not saved. To save L2's configuration, press the <F10> key.
  240. L2 maintains its configuration information in the L2.EXE file (this is done
  241. to make loading L2 as fast as possible). Since OS/2 keeps the .EXE file open
  242. in DENYWRITE mode while L2.EXE is running, L2 cannot save its configuration
  243. to itelf; therefore L2 saves its configuration in a file called L2CLONE.EXE.
  244. This file can then be renamed to L2.EXE after exiting L2 (to use the RENAME
  245. command, L2.EXE must be deleted or renamed first). One advantage of this
  246. approach is that you can create multiple copies of L2 for viewing different
  247. file types, such as L2C.EXE for C files; L2ASM.EXE for assembler files; etc.
  248. The configuration for each version could be appropriate to that file type.
  249.  
  250.  
  251. Registering L2
  252. --------------
  253. L2 was developed to support the author's responsibility of evaluating and
  254. documenting a system with 400+ modules for which the source code was acquired
  255. from a third-party company. It is distributed as shareware with the
  256. confidence that it can help others as well. Your comments, suggestions, and
  257. constructive criticisms are welcome. Please enclose them, along with the
  258. $25.00 registration fee, addressed to:
  259.  
  260.     SANSoft Development
  261.     4971 Pegasus Ct.
  262.     Hilliard, OH  43026
  263.     Voice-mail: (614) 898-2675
  264.  
  265. Contact SANSoft Development for site licenses or volume purchases of L2.
  266.  
  267. Thank you in advance for your support.
  268.  
  269.  
  270. Distributing L2
  271. ---------------
  272. SANSoft Development retains the sole right to sell L2; however, it may be
  273. distributed, provided:
  274.  
  275.   A. It is only distributed in its unmodified, archived form (L2.ZIP)
  276.   B. No attempt is made to profit from the distribution of L2 (a duplication
  277.      fee not to exceed $5.00 may be charge by recognized users' groups)
  278.  
  279.  
  280. Warranty/Disclaimer
  281. -------------------
  282. SANSoft Development makes no representations or warranties as to the
  283. merchantibility or fitness of this product to a particular purpose. There is
  284. no other warrenty, expressed or implied. SANSoft Development  will not be
  285. liable for any special, incidental, consequential, indirect or similar
  286. damages due to loss of data or any other reason, even if SANSoft or an agent
  287. of SANSoft has been advised of the possibility of such damages. In no event
  288. shall SANSoft Development's liability for any damages ever exceed the price
  289. paid for the license to use the software, regardless of the form of the
  290. claim. The person using the software bears all risk as to the quality and
  291. performance of the software. Use of this package constitutes agreement on the
  292. part of the user to this disclaimer.
  293.  
  294. ============================ E N D  O F  F I L E =============================
  295.  
  296.