home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Professional / OS2PRO194.ISO / os2 / fileutil / list / list2 / list.txt < prev   
Encoding:
Text File  |  1989-09-07  |  9.7 KB  |  281 lines
  1.  
  2. List Readme
  3.  
  4. Sales Pitch:
  5. A quick & dirty listing program for protect mode OS/2.    It uses multiple
  6. threads for reading ahead in the file.    The first screen comes up after the
  7. first read!  You don't have to wait for the file to be read in.  (The read-
  8. ahead buffer is configurable from 50K on up (default is 200K)).  The colors
  9. are configurable through an INI file.  Goes straight to physical screen if
  10. possible. (otherwise the virtual is used).  Also provides search and copy
  11. features from the files being listed.
  12.  
  13. Command Line:
  14.     list [-s:string] [-g:line#] fname, ...
  15.  
  16.     -s:x    - Search for 1st occurance of string x when displaying first file.
  17.     -g:#    - Goto line # when fisplaying first file
  18.     fname   - A list of filenames to be listed
  19.  
  20. Keyboard:
  21.     ?        - Calls up quick help
  22.     PgUp    - Goes up one page. (determined by the current screen hieght)
  23.     PgDn    - Goes down one page
  24.     Home    - Move to the top of the current file
  25.     End     - Move to the end of the current file
  26.     Arrows  - Moves up, down one line. Or left, right one tabs stop.
  27.           Note: The key repeat rate determines the speed of the scrolling.
  28.  
  29.     Alt E   - Toggle EGA mode.    Goes from 80 x 43, to 80 x 25.
  30.     Alt V   - Toggle VGA mode.    Goes from 80 x 60 (or 50), to 80 x 25.
  31.           Note: EGA/VGA mode toggling will be ingored if the display
  32.           does not support that mode.
  33.  
  34.     W        - Toggles word wrap from 254 to the current screeen width
  35.     ^L        - Will refresh the display
  36.     Q,ESC   - Quit
  37.  
  38.  
  39. Searching:
  40.  
  41.     /        - Searchs for a string.
  42.     \         - Searchs for a string in any case.
  43.           Note: There is no speed difference in these searches.
  44.  
  45.     F4        - Toggles multifile search
  46.     n,F3    - Will search for the next occurance of the string
  47.     N        - Will serach for the previsous occurance of the string
  48.           Note: This is from the current marked text. If no
  49.           text is mark (it has been cleared), then the next
  50.           occurance will be from the current position of the display.
  51.  
  52.     C        - Clears the marked area.
  53.     J        - Jumps to the marked text
  54.     G        - Goto line number
  55.     M        - Marks the center line on the current display.
  56.           (This will clear the current marked location, if there
  57.           is one).
  58.  
  59.     s Up    - Pull the copy buffer up one line
  60.     s Down  - Pull the copy buffer down one line
  61.     s PgUp  - Pull copy buffer up one page
  62.     s PgDn  - Pull copy buffer down one page
  63.     s Home  - Slide the copy buffer up one line
  64.     s End   - Slide the copy buffer down one line
  65.     P        - Will paste the buffer to a file
  66.           Note: By using these keys you can mark an area. (where
  67.           the search only marks a line). Then the highlighted
  68.           lines can be copied to a file. In the file, each line
  69.           will be terminated with a CR/LF (this is the default
  70.           for OS/2).  When listing a file, list will work with
  71.           either CR's, LF's or both.
  72.  
  73.  
  74.     ^ PgUp  - Go back to the Previous file being displayed
  75.     ^ PgDn  - Go to the next file to be displayed
  76.     F        - Prompts for a new filename to list
  77.         Note: Wild cards are exapnded, and then sorted. The
  78.         new file(s) is added after the current file. (Ie, ^ PgUp
  79.         will take you back to the file you were on when you
  80.         spefied "f").
  81.  
  82.  
  83. List INI file parameters:
  84.  
  85. If you have an enviroment varible "INIT", list will look
  86. in this directory for TOOLS.INI. For the
  87. best performance you should put the list section near the
  88. top of your INI file (or use the list.ini file).  You
  89. are encouraged to at least put "[list]" in your tools.ini
  90. file; otherwise, list.exe will scan the complete tools.ini
  91. before displaying any part of the file being listed.
  92.  
  93.     Note: while the INI file is being searched for, and read,
  94.     list will go ahead and read up to the first 50K of the
  95.     first file to list... This way, once the list.INI section
  96.     has been read, the first screen will be displayed right away.
  97.  
  98.  
  99. The following keywords are allowed in the ini file:
  100. Dafault is used for any value not specifed.
  101.  
  102.     tcolor  - Color of the title line
  103.           (all colors are hex values)
  104.           Default: 07   (white)
  105.  
  106.     lcolor  - Color of the listing
  107.           Default: 03   (cyan)
  108.  
  109.     hcolor  - Color of highlighted text
  110.           Default: 70   (Black chars, on white background)
  111.  
  112.     bcolor  - Color of the scroll bar
  113.           Default: 05   (green)
  114.  
  115.     ccolor  - Color of the command line
  116.           Default: 05   (magenta)
  117.  
  118.     kcolor  - Color of keyed input
  119.           Default: 02   (green)
  120.  
  121.  
  122.     width   - Specifies the width you would like to see your listings in.
  123.     height  - Specifies the hight you would like to see your listings in.
  124.           Default: The current video mode.
  125.           Note: The current video mode is also used if these settings
  126.           are illegal for the current monitor.
  127.  
  128.     buffer  - Amount of memory (in K) to use for reading ahead.
  129.           The min amount which can be specified is: 50
  130.           Default: 200K
  131.           Note: List will automatically try to keep ahead
  132.           of the user whom is listing a file. The program will
  133.           not allocate more then the specified amount of memory
  134.           for reading ahead of the user. Also note, the read ahead
  135.           is only for the current file.
  136.  
  137.           For optimal performance, the read ahead is performed
  138.           asynchronously to the displaying.  The first screen of
  139.           the listing will occur after a small amount of the file
  140.           has been read.
  141.  
  142.           Also in the intrest of speed, list will attempt to use
  143.           the physical display addresses to perform it's updates
  144.           to the screen.  If, for some reason, addressability can
  145.           not be obtained to the physical display, it will still
  146.           work by using normal Vio calls.  (A 'v' will be displayed
  147.           on the top status line).
  148.  
  149.  
  150.     tabamt  - The tab stop amount per tab char.
  151.           Default is 8.
  152.           Note: Very rarely needs adjusted.  However, sometimes
  153.           someone changes there editor to save tabs out for an
  154.           abnormal amount.
  155.  
  156.     nobeep  - Disables list from beeping
  157.  
  158.  
  159. Status line information:
  160.  
  161.   FileName   Line WW of XX   Col YY-ZZ          [flags]      Date      Time
  162.  
  163.     FileName- The name of the file currently being displayed
  164.  
  165.     WW        - The line number of the top line on the display
  166.     XX        - The line number of the last line in the file.
  167.           Note: This will not appear until the last line is known.
  168.           (If the read ahead has read to the end of the file).
  169.  
  170.     YY - ZZ - The columns which are being displayed.
  171.           Note: This will only appear if the dispaly is not showing
  172.           column 1.
  173.  
  174.     flags:
  175.     *   - Multi file search has been selected
  176.     N   - The file is on the network
  177.     M   - The file has been totaly read into memory, and closed
  178.     R   - The file is flagged as read only
  179.     H   - The file is hidden
  180.     S   - The file is flagged as a system file
  181.     v   - List is using VioCalls
  182.  
  183.  
  184.     Date & Time
  185.         - Last modifcation Date/Time os the file.
  186.  
  187.  
  188. --------------------------------------------------------------------------
  189.  
  190.  
  191. Changes...
  192.  
  193.  
  194.     Read ahead thread dynamicly adjusts it's priority
  195.     for better performance.
  196.  
  197.     hex values are now used for colors in tools.ini
  198.     no longer supports list.ini... must be tools.ini
  199.  
  200.     searching can now be accross multiple files, toggle = f4
  201.  
  202.     changed read sizes to 4K (from 5K), for better IO performance
  203.  
  204.     Added 'G' for goto line number in listing.
  205.  
  206.     'wait' now displays more sensible
  207.  
  208.     abort is now possible wheneven 'wait' is being displayed
  209.  
  210.     Alloc read memory is faster.  Used to free it in places, and
  211.     then re-allocate it.  Now it's put into a free list, and re-used.
  212.  
  213.     Added logic to alloc_block for read caching. This is different then
  214.     read-ahead.
  215.  
  216.     Modified caching for multi-files. (although file must still be opened
  217.     before info is displayed. this is required to validate the old info)
  218.  
  219.     added hack for Doug to slime the real TOF for a file.
  220.     requires keyword HACK in ini file.    alt-o.
  221.  
  222.     Modified header to only display the root of the filename.
  223.  
  224. ---------
  225.  
  226.     Fixed bug introduce from above.  Filenames now appear with the file
  227.     being displayed.
  228.  
  229.     Fixed "/" to always search as case sensative.
  230.  
  231.     Added support for long filenames... now maps names > 20 chars, into
  232.     20 chars.
  233.  
  234.     Altered the order of trying to 'guess' at the monitor resolution
  235.     in order to get around a bug in 1.06 dealing with 2 monitors.
  236.  
  237.     Fixed GP_FAULT in multi file search
  238.  
  239.     Added logic to not call DosChgFilePtr when reading sequentially.
  240.     (Performance improvement when accessing a file over the net).
  241.  
  242.     Fixed GP_FAULT in jumping to highlighted in small file
  243.  
  244.     Added keyword NOBEEP to list ini section
  245.  
  246.     /// add nobeep into help screen ///
  247.  
  248. ---------
  249.  
  250.     Fixed bug in highlighting text when "jumping" around
  251.  
  252.     Moved filenames list (and related info) into far memory.
  253.     (list *.*, can now explode out beyond 300 files (tested
  254.     to 300 filenames)).
  255.  
  256. ----------
  257.  
  258.     Move copy buffer to shift key.  To allow shift/PgUp & PgDn.
  259.     Added compile time switch to enable or disable call to DosSetSmTitle
  260.  
  261. ----------
  262.  
  263.     Added shift & ctrl keys for copy buffer.  (fits better into alternate
  264.     keyboards).. Mapped in all combinations of shift/control arrow keys.
  265.     Fixed scroll bar for files over 15Mb in size.
  266.     Put code into to lessen "out of memory" errors.
  267.  
  268. ----------
  269.  
  270.     Changed keyboard logic to find more keys regarudless of shift/ctrl
  271.     state.
  272.  
  273. ----------
  274.  
  275.     Fixed VioSetMode to find more mode.  Noticed when trying to support
  276.     60 line mode on 1.2. (now works)
  277.  
  278. ----------
  279.  
  280.     Added 2 command line switches. (-s & -g)
  281.