Return to list.txt CVS log

Up to [OS/2 SDKs] / pmsdk / pbin

Microsoft OS/2 SDK PM 02-24-1989

Documentation for the LIST tool

Sales Pitch:
A quick & dirty listing program for protect mode OS/2.	It uses multiple
threads for reading ahead in the file.	The first screen comes up after the
first read!  You don't have to wait for the file to be read in.  (The read-
ahead buffer is configurable from 50K on up (default is 200K)).  The colors
are configurable through an INI file.  Goes straight to physical screen if
possible (otherwise the virtual one is used).  Also provides search and copy
features from the files being listed.


Keyboard:
    ?	    - Calls up the help menu
    PgUp    - Goes up one page (determined by the current screen height)
    PgDn    - Goes down one page
    Home    - Move to the top of the current file
    End     - Move to the end of the current file
    Arrows  - Moves up, down one line. Or left, right one tab stop.
	      Note: The key repeat rate determines the speed of the scrolling.

    Alt E   - Toggle EGA mode.	Goes from 80 x 43, to 80 x 25.
    Alt V   - Toggle VGA mode.	Goes from 80 x 50, to 80 x 25.
	      Note: EGA/VGA mode toggling will be ignored if the display
	      does not support that mode.

    W	    - Toggles word wrap from 254 to the current screen width
    ^L	    - Will refresh the display
    Q,ESC   - Quit


Searching:

    /	    - Searches for a string
    \ 	    - Searches for a string in any case
	      Note: There is no speed difference in these searches.

    F4	    - Toggles multifile search
    n,F3    - Will search for the next occurence of the string
    N	    - Will search for the previous occurence of the string
	      Note: This is from the current marked text. If no
	      text is marked (it has been cleared), then the next
	      occurence will be from the current position of the display.

    C	    - Clears the marked area
    J	    - Jumps to the marked text
    G	    - Goto line number
    M	    - Marks the center line on the current display.
	      (This will clear the current marked location, if there
	      is one)

Shift-Up    - Pull the copy buffer up one line
Shift-Down  - Pull the copy buffer down one line
Shift-PgUp  - Pull copy buffer up one page
Shift-PgDn  - Pull copy buffer down one page
Shift-Home  - Slide the copy buffer up one line
Shift-End   - Slide the copy buffer down one line

    P	    - Will paste the buffer to a file
	      Note: By using these keys you can mark an area. (where
	      the search only marks a line). Then the highlighted
	      lines can be copied to a file. In the file, each line
	      will be terminated with a CR/LF (this is the default
	      for OS/2).  When listing a file, list will work with
	      either CR's, LF's or both.


    ^ PgUp  - Go back to the Previous file being displayed
    ^ PgDn  - Go to the next file to be displayed
    F	    - Prompts for a new filename to list
	    Note: Wild cards are expanded, and then sorted. The
	    new file(s) are added after the current file. (Ie, ^ PgUp
	    will take you back to the file you were on when you
	    specified "f").


List INI file parameters:

If you have an enviroment variable "INIT", list will look in this
directory for TOOLS.INI. For the best performance you should put the
list section near the top of your initialization file.  You
are encouraged to at least put "[list]" in your tools.ini
file; otherwise, list.exe will scan the complete tools.ini
before displaying any part of the file being listed.

    Note: while the INI file is being searched for, and read,
    list will go ahead and read up to the first 50K of the
    first file to list... This way, once the TOOLS.INI section
    has been read, the first screen will be displayed right away.


The following keywords are allowed in the ini file:
Dafault is used for any value not specifed.

    tcolor  - Color of the title line
	      (all colors are hex values)
	      Default: 07   (white)

    lcolor  - Color of the listing
	      Default: 03   (cyan)

    hcolor  - Color of highlighted text
	      Default: 70   (Black chars, on white background)

    bcolor  - Color of the scroll bar
	      Default: 05   (green)

    ccolor  - Color of the command line
	      Default: 05   (magenta)

    kcolor  - Color of keyed input
	      Default: 02   (green)


    width   - Specifies the width you would like to see your listings in.
    height  - Specifies the height you would like to see your listings in.
	      Default: The current video mode.
	      Note: The current video mode is also used if these settings
	      are illegal for the current monitor.

    buffer  - Amount of memory (in K) to use for reading ahead.
	      The min amount which can be specified is: 50
	      Default: 200K
	      Note: List will automatically try to keep ahead
	      of the user whom is listing a file. The program will
	      not allocate more then the specified amount of memory
	      for reading ahead of the user. Also note, the read ahead
	      is only for the current file.

	      For optimal performance, the read ahead is performed
	      asynchronously to the displaying.  The first screen of
	      the listing will occur after a small amount of the file
	      has been read.

	      Also in the intrest of speed, list will attempt to use
	      the physical display addresses to perform its updates
	      to the screen.  If, for some reason, addressability can
	      not be obtained to the physical display, it will still
	      work by using normal Vio calls.  (A 'v' will be displayed
	      on the top status line).


    tabamt  - The tab stop amount per tab char.
	      Default is 8.
	      Note: Very rarely needs adjusting.  However, sometimes
	      someone changes their editor to tab by a different amount.

    nobeep  - Disables beeping


Status line information:

  FileName   Line WW of XX   Col YY-ZZ	      [flags]	  Date	  Time

    FileName- The name of the file currently being displayed

    WW	    - The line number of the top line on the display
    XX	    - The line number of the last line in the file.
	      Note: This will not appear until the last line is known.
	      (If the read ahead has read to the end of the file).

    YY - ZZ - The columns which are being displayed.
	      Note: This will only appear if the display is not showing
	      column 1.

    flags:
	*   - Multi file search has been selected
	N   - The file is on the network
	M   - The file has been totally read into memory, and closed
	R   - The file is flagged as read only
	H   - The file is hidden
	S   - The file is flagged as a system file
	v   - List is using VioCalls


    Date & Time
	    - Last modification Date/Time on the file

This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.