home *** CD-ROM | disk | FTP | other *** search
/ Between Heaven & Hell 2 / BetweenHeavenHell.cdr / 500 / 423 / list591.doc < prev    next >
Text File  |  1986-05-23  |  25KB  |  590 lines

  1.  
  2.  
  3.  
  4.  
  5.  
  6.                         LIST Version 5.91
  7.                 (c) Copyright Vernon D. Buerg 1986
  8.  
  9.                            May 19, 1986
  10.  
  11.  
  12.  
  13.                         Table of Contents
  14.                         -----------------
  15.  
  16.                 Description ....................... 1
  17.                 Display format .................... 2
  18.                  Status line .......................2
  19.                  Command line ......................3
  20.                 Keys and commands ................. 4
  21.                  Positioning to lines ............. 5
  22.                 Cloning procedure ................. 6
  23.                  DEBUG Information ................ 6
  24.                  Screen attributes ................ 7
  25.                 Searching for text................. 8
  26.                 Filtering ......................... 9
  27.                 Update history ................... 10
  28.                 Restrictions ..................... 12
  29.  
  30.  
  31.                                                         LIST     Page 1
  32.  
  33.  Command  LIST
  34.  -------------
  35.  
  36.  Purpose:  To display the contents of an ASCII text file,  line by  line
  37.         with the aid of scrolling, positioning and filtering commands.
  38.  
  39.  Format:   LIST  [d:][path]filename[.ext]
  40.  
  41.  Remarks:  An ASCII file of any size may be listed.
  42.  
  43.            The "filename" is optional.  If omitted, you are prompted  to
  44.         to enter  a filename.   You may  include drive,  path, and  wild
  45.         cards in the file name.   The first file which matches  the name
  46.         is displayed until an end-of-file character is encountered. Each
  47.         file which matches the "filename" may be displayed.
  48.  
  49.            LIST was  designed to  display ASCII  files.  That  is, files
  50.         which  contain  text  and  not  binary  or  control codes.  Text
  51.         characters  usually  range  from a  value of 32 to 127.  To view
  52.         binary files (COM, EXE, etc), the alt-H hex dump display  option
  53.         is available.
  54.  
  55.            Characters  below  32  (a  blank)  are  replaced with a funny
  56.         character to indicate that a non-displayable character has  been
  57.         encountered.  This character is an upside-down question mark.
  58.  
  59.            Characters above 127 may be valid graphic characters, and may
  60.         be displayed if  the '8' command  is in effect.   To insure that
  61.         characters above ASCII value 127 are not displayed, use the  '7'
  62.         command.
  63.  
  64.            The top line of the display gives the file name, current right
  65.         scroll offset, and the file's creation date and time. Optionally,
  66.         a ruler may be displayed on the top line by using the alt-R keys.
  67.  
  68.            The  file  is  displayed  with  one  logical  record  on each
  69.         80-column display line.   A logical record  ends in a  linefeed.
  70.         The maximum logical record may  be 256 characters long.  If  the
  71.         record exceeds 80  characters, you may  view the portion  beyond
  72.         the 80 columns  by using the  scroll right command,  or by using
  73.         the Wrap feature.
  74.  
  75.            The Wrap  command toggles  ON or  OFF the  wrapping of  lines
  76.         longer than 80 characters.  With Wrap on, lines are displayed in
  77.         their  entirety,  80  characters  per  display line.  The scroll
  78.         -left and -right functions are disabled when Wrap is ON.
  79.  
  80.            The file may  be PRINTed as  it it displayed.   The P command
  81.         toggles  the  printer  on  or  off.   When  first entered, the P
  82.         command causes the current screen  to be printed.  As new  lines
  83.         are displayed, they too are printed.  Printing may be stopped by
  84.         entering another P command.  The PrtSc key may also be used, but
  85.         the title and prompt lines will be printed with the lines of the
  86.         file. Empty lines cause a line to be skipped on the printer. The
  87.         letter P is displayed in column 80 of the top line while printing.
  88.                                                         LIST     Page 2
  89.  
  90.  Display format
  91.  --------------
  92.  
  93.            The monitor display is defined in terms of lines and columns.
  94.         A typical monitor can display 25 lines of 80 columns each.  LIST
  95.         attempts to use the number of lines and columns for the monitor
  96.         mode in use.  For example, if the monitor is in 40 column mode,
  97.         LIST displays only 40 characters per line.
  98.  
  99.            The top line of the display is called the Status line.  The
  100.         bottom line is called the Command line.  The remaining lines are
  101.         called the primary display window, and are usually lines 2
  102.         through 24.
  103.  
  104.  
  105.  Status line format
  106.  ------------------
  107.  
  108.     The Status line has the following format:
  109.  
  110.     LIST   lllll +sss mm/dd/yy hh:mm  bKMPSW  - filename
  111.  
  112.     where,
  113.  
  114.         'LIST'     is the name of this program
  115.  
  116.         'lllllll'  is the line number of the first line in the
  117.                   display window (usually on line 2)
  118.  
  119.         '+sss'     if displayed, this is the Scroll amount, in
  120.                   multiples of 20, corresponding to the number
  121.                   of columns that the display has been shifted
  122.                   to the right to view records longer than 80
  123.  
  124.         'mm/dd/yy' is the file's creation date
  125.         'hh:mm'    is the file's creation time
  126.  
  127.         'D'       indicates that the hex Dump display option is in use
  128.         'b'       indicates whether the 7-bit, 8-bit, or *-option is
  129.                   in use
  130.         'K'       indicates that the Keyboard flush option is in use
  131.         'M'       indicates that tests for monitor retrace are not made
  132.         'P'       indicates that Print is in use
  133.         'S'       indicates that the C (file sharing) is in use
  134.         'W'       indicates that the Wrap mode is in effect
  135.                                                         LIST     Page 3
  136.  
  137.  Command line format
  138.  -------------------
  139.  
  140.     The Command line has the following format:
  141.  
  142.     command message ______ Keys: <> PgUp PgDn Q=next X=exit ?=Help
  143.  
  144.     where,
  145.  
  146.       'command' indicates the current process:
  147.  
  148.           'Command'   you are being asked to enter a command
  149.                        enter the letter, or press the keys for
  150.                        the action to perform
  151.  
  152.           'Reading '   the file data is being read
  153.           'Filter  '   the file data is being formatted for display
  154.           'Scanning'   the Scan/Find text is being searched for
  155.  
  156.           'Scan   '   you are being asked to enter text to locate
  157.           'Find   '    in the file, up to 31 characters may be entered
  158.  
  159.           '# lines?'   you are being asked to enter a 1 to 5 digit
  160.                        number that is the amount of lines to skip
  161.  
  162.           'Line #? '   you are being asked to enter a 1 to 5 digit
  163.                        line number to which the display is to be
  164.                        positioned
  165.  
  166.  
  167.       'message' may be one of:
  168.  
  169.           '*** Text not found ***'
  170.            the Scan/Text was not found in the file
  171.  
  172.           '   *** Top of file ***'
  173.            the first line of the file is being displayed
  174.  
  175.           '   *** End-of-file ***'
  176.            the last line of the file is being displayed
  177.                                                         LIST     Page 4
  178.  
  179.  Key functions and Commands
  180.  --------------------------
  181.  
  182.         On the COMMAND line, enter a letter or control key:
  183.  
  184.         Letter(s)     Default   Function
  185.         ---------     -------   ------------------------
  186.         A                       find next occurance of 'text'
  187.         B                       skip to end of file (bottom)
  188.         C               off     toggles closing of (shared) files
  189.         D                       scroll down one page
  190.         F                       Find 'text' regardless of case
  191.         H or ?                  list commands (HELP)
  192.         K               off     toggle keyboard flush; if on, commands
  193.                                 may be queued up by holding a key down
  194.         L                       scroll left 20 columns
  195.         M                       toggle test for display retrace, if on
  196.                                 the display is faster but may flicker;
  197.                                 not applicable to monochrome monitors
  198.         N                       down one (next) line
  199.         P               off     toggle printer on or off
  200.         Q                       display next matching file
  201.         R                       scroll right 20 columns
  202.         S                       Scan for exact text match, case dependent
  203.         T                       restart from first line (top)
  204.         U                       scroll up one page (23 lines)
  205.         W               off     toggle wrap of lines over 80 chars
  206.         X                       terminate, clear screen and exit to DOS
  207.  
  208.         7               off     turn off high bit (non-graphics only)
  209.         8               on      leave high bit on (graphics)
  210.         *               off     toggles special * document filtering
  211.  
  212.         +                       position a given number of lines forwards
  213.         -                       position a given number of lines backwards
  214.  
  215.         \text                   Find 'text' regardless of case
  216.         /text                   Scan for exact text match
  217.  
  218.  
  219.     Control key      Function
  220.     -----------     -------------------------------------------
  221.      Enter           continue to next page
  222.      END             position to end of file (bottom)
  223.      ESCape          Display next matching file
  224.      HOME            restart from first line (top)
  225.      PgUp            scroll up one page, 23 lines
  226.      PgDn            scroll down one page, 23 lines
  227.  
  228.      left arrow      scroll left 20 columns
  229.      right arrow     scroll right 20 columns
  230.      up arrow        up one (previous) line
  231.      down arrow      down one (next) line
  232.                                                         LIST     Page 5
  233.  
  234.  Key functions and Commands (cont.)
  235.  --------------------------
  236.  
  237.  
  238.     Control key      Function
  239.     -----------     -------------------------------------------
  240.      F1              Help - display summary of commands
  241.      F3              Find next occurrance of text after Scan or Find
  242.      F10             Exit to DOS
  243.  
  244.      F5              change background color for main body of display
  245.      F6              change foreground color for main body of display
  246.      F7              change background color for top and bottom lines
  247.      F8              change foreground color for top and bottom lines
  248.  
  249.      ctl-HOME        positions to a specific line number
  250.      ctl-PgUp        restart from first line (TOP)
  251.      ctl-PgDn        skip to end of file (BOTTOM)
  252.      ctl-left-arrow  reset scroll to column 1
  253.  
  254.      alt-C           clone LIST.COM, change colors or options
  255.                      permanently in program file
  256.      alt-H           toggles hex dump formatted display
  257.      alt-R           toggles display of a ruler on the top line
  258.      alt-S           toggles file Sharing option, when off
  259.                      files remain open until program termination
  260.  
  261.  
  262.  Positioning to Lines
  263.  --------------------
  264.  
  265.            Each displayable line of the file is assigned a line number.
  266.         The first line is assigned line number 1.  The highest allowable
  267.         line number is 65535.  In order to determine the last line
  268.         number, the entire file must be read.  For this reason, the
  269.         first time that the END (bottom) command is issued, it will take
  270.         longer to process.
  271.  
  272.            If the Wrap option is in effect, there is one line number
  273.         required for each 80 bytes of the file records.
  274.  
  275.            If the hex dump option is in effect, there is one line number
  276.         required for each 16 bytes of the file.
  277.  
  278.            You may position to a specific line number by using the
  279.         c-Home, control key and Home key.  When c-Home is entered, you
  280.         are prompted for the line number.  Enter the 1 to 5 digit line
  281.         number.  The display will now begin with that line number at the
  282.         top of the screen.
  283.  
  284.            To position forward or backward, you may use the + (plus), or
  285.         - (minus) keys.  You are prompted to enter the number of lines
  286.         to be skipped.  The display resumes at the line number shown on
  287.         the top (status) line, plus or minus the number of lines that
  288.         you specified.
  289.                                                         LIST     Page 6
  290.  
  291.  Cloning procedure
  292.  -----------------
  293.  
  294.            The screen colors, the display retrace testing (M), the file
  295.         closing (C) and ruler (alt-R) options may be permanently set in
  296.         the program by using the alt-C cloning function.
  297.  
  298.            For cloning to take effect, the program must be called
  299.         LIST.COM and it must be on the current drive and in the current
  300. |       directory. There are two versions of the LIST COM file. One is
  301. |       the normal program. The other, which contains an 'S' as the last
  302. |       letter of the file name, is a slightly smaller file that excludes
  303. |       the Help screen. You may use either COM file for cloning.
  304.  
  305.            The clonable options (command toggles) are:
  306.  
  307.              M     = Mono monitor, affects retrace testing,
  308.              alt-R = use ruler on top line,
  309.              C     = file(s) are shared,
  310.              alt-H = hex dump display, like the DEBUG format
  311.              W     = Wrap long lines
  312. |            8/7/* = display all 256 values, or 7-bit, or special cases
  313.              K     = flush Keyboard each time a command is read
  314.  
  315.  
  316.  DEBUG Information
  317.  -----------------
  318.  
  319.            An alternative to cloning is to use DEBUG to make permanent
  320.         changes. Here is a list of key items and their addresses:
  321.  
  322.            0126 - special lines 1 and 25 colors, default is 01 (blue)
  323.                   Refer to a technical reference guide for the
  324.                   attribute values for the colors that you want.
  325.            0128 - normal lines 2 thru 24 colors, default is 02 (green)
  326.            012A - bright color for Find/Scan, default is 0C (bright red)
  327.            012C - options; bits 0 through 6
  328.                    MRSD WHK.  M = mono, x'01'
  329.                               R = ruler, x'02'
  330.                               S = shared, x'04'
  331.                               D = hex display, x'08'
  332.                               W = wrap mode, x'10'
  333.                               H = hi-bit on, x'20'
  334.                               K = kybd flush, x'40'
  335.  
  336.                   By specifying the bit value, the option is enabled.
  337.                   For example, to enable Shared and Retrace, specify
  338.                   a hex value of 05.
  339.  
  340.            The letters and command keys may also be changed.  There are
  341.         two tables involved:  WHAT and WHERE.  The WHAT table contains a
  342.         list of one-byte keyboard codes.  The WHERE table contains a
  343.         list of two-byte addresses.  If you really want to change the
  344.         codes, here are the DEBUG addresses:
  345.  
  346.            0358 - *WHAT* eye catcher
  347.            035E - list of one byte command letters and codes
  348.  
  349.            0394 - *WHERE* eye catcher
  350.            039B - list of two byte addresses of processing routines
  351.  
  352.         NOTE: These DEBUG addresses are version dependent.
  353.         ==================================================
  354.                                                         LIST     Page 7
  355.  
  356.  Screen attributes
  357.  -----------------
  358.  
  359.            The colors used for displaying the titles and main body of
  360.         text may be changed temporarily or permanently.  To make a
  361.         permanent change, the cloning command alt-C is used.  It
  362.         requires that the LIST.COM program file be on the current drive
  363.         and in the current directory.
  364.  
  365.            There are three classes of attributes used.  One for normal
  366.         display lines - lines 2 to 24 - another for special lines -
  367.         lines 1 and 25, and a third for the Find/Scan color.  The border
  368.         is not changed.  The foreground color applies to the characters
  369.         displayed.
  370.  
  371.         These color attributes may be changed by using these function keys:
  372.  
  373.           For the main body of text:
  374.  
  375.             F5 - background color
  376.             F6 - foreground color
  377.  
  378.           For the top and bottom lines:
  379.  
  380.             F7 - background color
  381.             F8 - foreground color
  382.  
  383.  
  384.         Once you have decided upon the colors, use the alt-C key
  385.         combination to change the LIST.COM program file.
  386.                                                         LIST     Page 8
  387.  
  388.  Scanning for text
  389.  -----------------
  390.  
  391.  
  392.            You may use  Find (\)  to search for text  regardless  of the
  393.         case, or you may use Scan (/) to find an exact match.
  394.  
  395.            To scan for a character string, type a slash (/) followed  by
  396.         one or more (up to 31)  characters.  The scan text, but not  the
  397.         slash,  is  displayed  on  the  command  line.  The scan is case
  398.         sensitive.  That is, lower case scan text will only match  lower
  399.         lower case file text.
  400.  
  401.            While  the  program  is  searching  for  the text, the bottom
  402.         display line is changed to say "Scanning".
  403.  
  404.            If the text is found, the line containing it is displayed  as
  405.         a high-intensity line (bright color).
  406.  
  407.            If the text is NOT found, the bottom line (25) is changed  to
  408.         say '*** text not found ***', and the display remains unchanged.
  409.  
  410.            To find the next occurrance of the same text,  use the A)gain
  411.         command, or press the F3 key.
  412.  
  413. |          If the PCED keyboard enhancement program is installed, the
  414. |       up/down cursor keys may be used to recall and edit previously
  415. |       entered Scan/Find text.
  416.  
  417.            In a shared file environment, if the file changes while being
  418.         listed, the file position may become invalid.  Use the HOME
  419.         command to insure proper file synchronization, or use the C
  420.         (shared) option.
  421.                                                         LIST     Page 9
  422.  
  423.  Filtering
  424.  ---------
  425.  
  426.            Filtering is the term used to describe the process that LIST
  427.         uses to format file data for displaying on a monitor. After data
  428.         is read from a file, it is filtered. The method of filtering
  429.         depends upon the options in effect.
  430.  
  431.            For a typical ASCII text file, the filter removes carriage
  432.         return and line feed characters, and expands TAB characters.
  433.  
  434.            The 7, 8, and * (asterisk) commands determine whether
  435.         characters above ASCII-127 are displayed.  If the hi-bit option
  436.         is off (7 command), the filter strips the high order bit from
  437.         each character.  If the hi-bit option is on (8 command), all
  438.         characters, including graphic characters above ASCII-127, are
  439.         displayed.
  440.  
  441. |          The * (asterisk) command displays only ASCII characters
  442. |       below 128 (x'80'), but treats the special characters x'8A' and
  443. |       x'8D' as line-feed and carriage-return control characters.  Any
  444. |       other characters above 127 are ignored.
  445.  
  446.            The Wrap option causes the filtering to insure that no line
  447.         exceeds the width of the monitor, e.g. 80 characters.
  448.  
  449.            The hex dump option (alt-H) causes the filtering to reformat
  450. |       the file data into a DEBUG-like display format. The largest
  451. |       file that can be "dumped" is 1 million bytes.
  452.  
  453.            Future versions of LIST will include filter options for:
  454.  
  455.                 o  token BASIC
  456.                 o  sQueezed files
  457.                 o  LBR library files
  458.                 o  ARC archive files
  459.                 o  specific word processor formats
  460.                 o  user written, optionally installable filters
  461.  
  462.         NOTE: The EOF control character is ignored in this version.
  463.         ===========================================================
  464.                                                         LIST     Page 10
  465.  
  466.  Update history
  467.  --------------
  468.  
  469.  Lines beginning with | denote changes to the latest version.
  470.  
  471.         Version 4.1, April 27, 1984.
  472.         Version 4.15, June 2, 1984.
  473.         Version 4.2, July 14, 1984.
  474.         Version 5.0, August 10, 1984.
  475.         Version 5.1, August 27, 1984.
  476.         Version 5.2, September 29, 1984.
  477.         Version 5.4, March 22, 1984.
  478.         Version 5.48, May 27, 1985.
  479.         Version 5.49, May 31, 1985.
  480.         Version 5.52, July 15, 1985.
  481.         Version 5.56, December 20, 1985.
  482.         Version 5.64, January 6, 1986.
  483.         Version 5.65, January 16, 1986.
  484.         Version 5.67, February 11, 1986.
  485.         Version 5.68, February 27, 1986.
  486.         Version 5.69, April 14, 1986.
  487.  
  488.         Version 5.70 through 5.82, April 16, 1986.
  489.             - Rewritten to allow implementation of new features.
  490.  
  491.                                                         LIST     Page 11
  492.  
  493.  Update history (cont'd)
  494.  --------------
  495.  
  496.         Version 5.83, May 6, 1986.
  497.           SOL, version 1, adds:
  498.             - line numbering, changes use of +, -, and ctrl-HOME
  499.             - alt-H hex dump display
  500.             - allows cloning of Wrap, Hibit, alt-R ruler, Kybd flush
  501.             - adds indication of command toggles to top line
  502.             - corrects and improves Scan and Find
  503.  
  504.         Version 5.84, May 8, 1986.
  505.             - add * command to toggle special document filter,
  506.               all characters above x'80', except 8A and 8D, are
  507.               suppressed
  508.             - correct hex dump display producing duplicate
  509.               last line
  510.             - add alt-D command (like alt-H) to toggle hex dump
  511.             - change status line H indicator to 7/8/*
  512.  
  513.         Version 5.85, May 9, 1986.
  514.             - add alt-S (like C) to toggle Shared option
  515.             - correct Scan failure when using Shared option
  516.               with several files (widcard used)
  517.             - improve speed of hex dump display
  518.  
  519.         Version 5.86, May 10, 1986
  520.             - correction to TOF and EOF status messages
  521.  
  522.         Version 5.87, May 11, 1986
  523.             - correct loop displaying short files
  524.             - use hibit (7 or 8) to suppress control chars in hex dump
  525.               for Printing
  526.  
  527.         Version 5.88, May 13, 1986
  528.             - correct Scan/Find not checking last character of records
  529.  
  530.         Version 5.89, May 14, 1986
  531.             - correct Filter loop when last byte of file block is a CR
  532.             - correct Print ignoring blank lines
  533.  
  534.         Version 5.90, May 18, 1986
  535.             - correct not displaying last record of file if file does
  536.               not end in an LF
  537.             - change hex dump to use 7/8/* options
  538.  
  539. |       Version 5.91, May 19, 1986
  540. |           - correct testing and display of M monitor retrace option
  541.  
  542.                                                         LIST     Page 12
  543.  
  544.  Restrictions
  545.  ------------
  546.  
  547. |       o  The program requires 60K bytes of memory. If more memory is
  548.            available, it is used to store more of the file in memory.
  549.  
  550.         o  The line number is currently limited to 65535.
  551.  
  552.         o  The file size is limited to 16 million bytes.
  553.  
  554.         o  PC-DOS Version 2.0 or later is required.
  555.  
  556.         o  ANSI.SYS is NOT required.
  557.  
  558.  
  559.         Written by Vernon Buerg for the  IBM PC using DOS 2.0 or
  560.         later, including DOS 3.1.
  561.  
  562.         LIST is supplied for personal, private use. Feel free to
  563.         distribute LIST given these restrictions:
  564.  
  565.           o  the program shall be supplied in its original,
  566.              unmodified form, which includes this documentation;
  567.  
  568.           o  no fee is charged.
  569.  
  570.           o  commmercial use is prohibited.
  571.  
  572.           o  the program may not be included - or bundled - with
  573.              other goods or services. Exceptions may be granted
  574.              upon written request only.
  575.  
  576.         If you are using LIST and find it of value, your gift in
  577.         any amount ($15 suggested) will be greatly appreciated.
  578.         Makes checks payable to Vernon D. Buerg. Thank you.
  579.  
  580.         For use by corporations and other institutions, please
  581.         contact me at AAI Systems for a site licensing agreement.
  582.  
  583.                 Vernon D. Buerg
  584.                 456 Lakeshire Drive
  585.                 Daly City, CA 94015-4223
  586.  
  587.                 Data: (415) 994-2944 (VOR BBS)
  588.                 Compuserve: 70007,1212
  589.  
  590.