home *** CD-ROM | disk | FTP | other *** search
/ Boston 2 / boston-2.iso / DOS / PROGRAM / BASIC / POWBASIC / LIBRARY2 / LIST.ZIP / LIST62A.DOC < prev   
Text File  |  1987-10-04  |  35KB  |  1,019 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.          LIST Version 6.2a
  10.     (c) Copyright Vernon D. Buerg 1987
  11.         All rights reserved
  12.  
  13.            May 7, 1987
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.  
  22.          Table of Contents
  23.          -----------------
  24.  
  25.     Description of use ............... 1
  26.  
  27.     Keys and commands ................ 3
  28.      Function keys .................. 4
  29.      Alt- keys ...................... 5
  30.  
  31.     Positioning to lines ............. 6
  32.  
  33.     Displaying multiple files ........ 6
  34.  
  35.     Extracting/marking lines ......... 7
  36.  
  37.     Display format ................... 8
  38.      Status line .................... 8
  39.      Command line ................... 9
  40.  
  41.     Screen colors .................... 10
  42.  
  43.     Cloning procedure ................ 11
  44.      DEBUG information .............. 12
  45.  
  46.     Searching for text................ 13
  47.  
  48.     Filtering ........................ 14
  49.  
  50.     Exotic functions ................. 15
  51.      File sharing ................... 15
  52.      Invoking DOS commands .......... 15
  53.      Screen saving .................. 15
  54.  
  55.     Restrictions ..................... 16
  56.  
  57.  
  58.  
  59.  
  60.  
  61.                         LIST     Page 1
  62.          Description of Use
  63.          ------------------
  64.  
  65.   Command LIST
  66.   -------------
  67.  
  68.  
  69.   Purpose:
  70.   You use LIST to display files on your monitor, line by line
  71. with the aid of scrolling, positioning and filtering commands.
  72.  
  73.  
  74.   Format:
  75.      LIST [d:][path]filename[.ext]
  76.  
  77.  
  78.   Remarks:
  79.   You may rename the program file to any convenient name, such
  80. as L.COM, READ.COM, or LIST.COM.
  81.  
  82.   Using LIST is fairly straight forward. You type the command
  83. LIST at the DOS prompt, followed by the name of the file that
  84. you want to see. For example: LIST CONFIG.SYS would display the
  85. file CONFIG.SYS.
  86.  
  87.   Once the file is displayed on your screen, you may use the
  88. cursor positioning keys to move around and see different parts
  89. of the file. For example, when LIST first starts, you see the
  90. first 23 lines of the file. To see the next 23 lines, or page,
  91. press the PgDn key.  The PgUp key moves you back one page and
  92. shows you the previous 23 lines.  The up-arrow and down-arrow
  93. keys move it one line at a time. When you are finished, press
  94. the ESCape key and you are returned to the DOS prompt.
  95.  
  96.   The "filename" is optional. If omitted, you are prompted to
  97. enter a filename.  You may include drive, path, and wild
  98. cards in the file name.  The first file which matches that name
  99. is displayed. After the file is displayed, the next file which
  100. matches the "filename" may be displayed, too.
  101.  
  102.   You may also use LIST to display piped or redirected files.
  103. If you are unfamiliar with these, you may skip to the next page.
  104.  
  105. To display a redirected file, use a < (less than symbol) before
  106. the name of the file and add the /S parameter to the LIST
  107. command. For example:
  108.  
  109.     dir a: >xyz
  110.     list <xyz /s
  111.  
  112. To display a piped file, omit the filename, but supply the /S.
  113.     dir a: | list /s
  114.  
  115. Or, to LIST a file within an ARC archive:
  116.     arc /p arcname.arc filename.ext | list /s
  117.             - or -
  118.     arce arcname filename.ext /p | list /S
  119.  
  120.  
  121. LIST   Page 2
  122.  
  123.          Description of Use (cont'd)
  124.          ------------------
  125.  
  126.   Because files contain different kinds of data, there are
  127. several commands to tell LIST how to display the data.  The
  128. process that LIST uses to make the file data readable is called
  129. filtering. The filters in LIST can:
  130.  
  131.   o replace non-text and control characters with blanks
  132.   o expand TAB characters
  133.   o display line drawing characters
  134.   o change 8-bit (W*) data to readable 7-bit text
  135.   o display the hexidecimal values for each character
  136.   o remove "junk", such as control codes and backspaces
  137.  
  138.   LIST was designed to display ASCII files. That is, files
  139. which contain text, and not binary or control codes. Text
  140. characters usually range from a value of 32 to 127. To view
  141. binary files (COM, EXE, etc), the alt-H (hex dump display)
  142. command is available.
  143.  
  144.  
  145.   Characters below 32 (a blank) are replaced with a funny
  146. character to indicate that a non-displayable character has been
  147. encountered. This character is an upside-down question mark.
  148. Characters above 127 may be valid graphic characters, and may be
  149. displayed if the '8' command is in effect. To insure that
  150. characters above ASCII value 127 are not displayed, use the '7'
  151. command.
  152.  
  153.  
  154.   The top line of the display gives the file name, current
  155. right scroll offset, and the FILE's creation date and time.
  156. Optionally, a ruler may be displayed on the top line by using
  157. the alt-R keys.
  158.  
  159.   The file is displayed with one logical record on each
  160. 80-column display line.  A logical record ends in a linefeed.
  161. The maximum logical record may be 256 characters long. If the
  162. record exceeds 80 characters, you may view the portion beyond
  163. the 80 columns by using the scroll right command, or by using
  164. the Wrap feature.  The Wrap command toggles ON or OFF the
  165. wrapping of lines longer than 80 characters. With Wrap on,
  166. lines are displayed in their entirety, 80 characters per display
  167. line. The scroll -left and -right functions are disabled when
  168. Wrap is ON.
  169.  
  170.   The file may be PRINTed as it it displayed.  The P command
  171. toggles the printer on or off.  When first entered, the P
  172. command causes the current screen to be printed. As new lines
  173. are displayed, they too are printed. Printing may be stopped by
  174. entering another P command. The PrtSc key may also be used, but
  175. the title and prompt lines will be printed with the lines of the
  176. file. Empty lines cause a line to be skipped on the printer.
  177. |    The letter P is displayed on the bottom command   line while
  178. |    printing. See the section on extracting lines for other methods.
  179.  
  180.  
  181.                         LIST     Page 3
  182.  
  183.         Commands and Keys
  184.         -----------------
  185.  
  186. Control key  Function
  187. -----------  -----------------------------------------------
  188. |    left arrow  scroll left 10 columns
  189. |    right arrow  scroll right 10 columns
  190. up arrow   up one (previous) line
  191. down arrow  down one (next) line
  192.  
  193. Enter     continue to next page
  194. END      position to end of file (bottom)
  195. |    ESCape    Exit program unconditionally
  196. HOME     restart from first line (top)
  197. PgUp     scroll up one page, 23 lines
  198. PgDn     scroll down one page, 23 lines
  199.  
  200.  
  201. Letter(s)   Default  Function
  202. ---------   -------  ----------------------------------------
  203. A            find next occurance of 'text' (Again)
  204. B            skip to    end of file (Bottom)
  205. C        off   toggles Closing of files, also alt-S
  206. D            scroll Down one    page
  207. F            Find 'text' regardless of case
  208. G            Get new    filename/filespec (also    alt-F)
  209. H or ?         Help, show command list
  210. K        off   toggle Keyboard flush; if on, commands
  211.             may be queued up by holding a key down
  212. L            scroll Left 10 columns
  213. M        on   toggle test for display retrace, if on
  214.             the display is faster but may flicker;
  215.             not applicable to monochrome monitors
  216. N            down one (Next)    line
  217. P        off   toggle Printer on or off
  218. Q            Quit, display next file, or exit if only
  219.             one file is being viewed
  220. R            scroll Right 10    columns
  221. S            Scan for exact text match, case    dependent
  222. T            restart    from first line    (Top)
  223. U            scroll Up one page (23 lines)
  224. W        off   toggle Wrap of lines over 80 chars
  225. X            terminate, clear screen    and eXit to DOS
  226.  
  227. 7        off   turn off high bit (non-graphics only)
  228. 8        on   leave high bit on (graphics)
  229. *        off   toggles special * document filtering
  230.  
  231. +            position a given number    of lines forwards
  232. -            position a given number    of lines backwards
  233.  
  234. \text            Find any case 'text' going forwards
  235. /text            Scan exact case    'text' going forwards
  236.  
  237. |    `            Find any case 'text' going backwards
  238. |    '            Find exact case    'text' going backwards
  239.  
  240.  
  241. LIST   Page 4
  242.  
  243.         Commands and Keys (cont'd)
  244.         -----------------
  245.  
  246.  
  247.  
  248.   Control key   Function
  249.    -----------     ---------------------------------------------------
  250.     ctl-HOME        positions to a specific line number
  251. |   ctl-PgUp        display previous file (review)
  252. |   ctl-PgDn        display next file (or exit if only one file)
  253.     ctl-left-arrow  reset horizontal scroll position to column 1
  254.  
  255.  
  256.  
  257.     Function key     Function
  258.     ------------     ---------------------------------------------------
  259.  
  260.      F1              Help - display summary of commands
  261.  
  262.      F3              Find next occurrance of text after Scan or Find
  263.  
  264.      F9              Find previous occurrance of text after Scan or Find
  265.  
  266.      F10             Exit to DOS with clear screen and cursor last line
  267.  
  268.  
  269.      F2              change background color for Find/Scan text
  270.      F4              change foreground color for Find/Scan text
  271.  
  272.      F5              change background color for main body of display
  273.      F6              change foreground color for main body of display
  274.  
  275.      F7              change background color for top and bottom lines
  276.      F8              change foreground color for top and bottom lines
  277.  
  278.  
  279.  
  280.  
  281.  
  282.  
  283.  
  284.  
  285.  
  286.  
  287.  
  288.  
  289.  
  290.  
  291.  
  292.  
  293.  
  294.  
  295.  
  296.  
  297.  
  298.  
  299.  
  300.  
  301.                         LIST     Page 5
  302.  
  303.                 Commands and Keys (cont'd)
  304.                 -----------------
  305.  
  306.     alt- letter      Function
  307.     -----------      ---------------------------------------------------
  308.  
  309.      alt-A           toggle Apxcore(on), DesqView/DoubleDos(off-default) use
  310.  
  311.      alt-B           mark bottom line
  312.  
  313.      alt-C           clone LIST.COM, change colors or options permanently,
  314.              in a new copy of the LIST.COM program file
  315.  
  316. |    alt-D           toggle dump mode: if no lines are marked, the current
  317. |             screen only is written to the specified file; if lines
  318. |             are marked, they are written to the dump file.
  319.  
  320.      alt-E           toggle 25/43 line display (does test for EGA). If the
  321.              actual EGA lines is not 25 or 43, don't use alt-E
  322.  
  323.      alt-F           prompt for new Filespec or filename to display
  324.              entering a leading asterisk (*) may be obscured
  325.              by some console enhancers or utilities, so enter
  326.              two asterisks, e.g. **.doc
  327.      alt-G           Shell to DOS, invoke COMMAND.COM, requires 96k or more.
  328.              Use the DOS EXIT comand to return to LIST.
  329.  
  330.      alt-H           toggles hex dump formatted display
  331.  
  332.      alt-J           toggle adding line feed to lone carriage returns
  333.              and remove backspaces, overlaying previous characters
  334.  
  335.      alt-L           toggle preloading of files, default is OFF
  336.              When the file is pre-loaded, the ending line
  337.              line number becomes known.
  338.  
  339. |    alt-M           mark top line; marked lines may be printed or written
  340. |             to    the alt-D dump file.
  341.  
  342.      alt-R           toggles display of a ruler on the top line
  343.  
  344.      alt-S           toggles file Sharing option, when off
  345.              files remain open until program termination
  346.  
  347.      alt-T           toggles expansion of TAB control characters, the
  348.              tab columns are a multiple of 8, i.e. 1,9,17, etc.
  349. |             The default is to expand TABs. See    DEBUG section.
  350.  
  351. |    alt-U           unmark lines; line marks are removed
  352.  
  353.      alt-W           toggles split screen; when ON, the top half of
  354.              the screen is frozen. Further scrolling occurs
  355.              only in the bottom half of the screen (window)
  356.              until the alt-W keys are used again.
  357.  
  358.      alt-X           exits to DOS and displays the original screen
  359.              (unless screen saving has been disabled)
  360.  
  361. LIST     Page 6
  362.  
  363.                 Positioning to Lines
  364.                 --------------------
  365.  
  366.    Each displayable line of the file is assigned a line  number.
  367. The first line is assigned line number 1.  The highest allowable
  368. line  number  is  65535.   In  order  to determine the last line
  369. number, the  entire file  must be  read.  For  this reason,  the
  370. first time that the END (bottom) command is issued, it will take
  371. longer  to  process.   This  is  not  necessary  if  the file is
  372. preloaded using the alt-L installation option.
  373.  
  374.    If the  Wrap option  is in  effect, there  is one line number
  375. required for each 80 bytes of the file's records.
  376.  
  377.    If the hex dump option is in effect, there is one line number
  378. required for each 16 bytes of the file.
  379.  
  380.    You  may  position  to  a  specific  line number by using the
  381. c-Home, Ctrl key  and Home key,  or the #  key.  When c-Home  is
  382. entered, you are prompted for the line number.  Enter the 1 to 5
  383. digit line number.   The display will  now begin with  that line
  384. number at the top of the screen.
  385.  
  386.    To position forward or backward, you may use the + (plus), or
  387. - (minus) keys.  You are  prompted to enter the number  of lines
  388. to be skipped.  The display resumes at the line number shown  on
  389. the top (status)  line, plus or  minus the number  of lines that
  390. you specified.
  391.  
  392.    When  you  change  a  filter  option,  such as Wrap, the line
  393. numbering changes.  An attempt is  made to retain the same  file
  394. position.
  395.  
  396.  
  397.                 Displaying multiple files
  398.                  -------------------------
  399.  
  400.    You can display more than one file by supplying wildcards  in
  401. the file name.  For example,  LIST *.DOC will display all  files
  402. with an extension of DOC.
  403.  
  404. |          To display the next file, you use the Q or ctrl-PgDn command.
  405. When the last file has been displayed,  you  can  exit  LIST  by
  406. using the  X,  F10,  ESCape, or alt-X commands, depending on how
  407. you want the screen to look when LIST ends.
  408.  
  409.    To display the previous file, you use the ctrl-PgUp  (control
  410. |       and PgUp keys together).  LIST can keep track of up to 20  files
  411. at once.
  412.  
  413.    Another way to LIST  more than one file  is to use the  alt-F
  414. command.  Alt-F asks you for a new file name, and you may  enter
  415. a simple file name, or one that includes wild cards.  These  new
  416. file names are added to the table of filenames that LIST  keeps.
  417. Thus, you can use alt-F for several different filenames, and use
  418. |       the ctrl-PgDn and ctrl-PgUp commands to move among them.
  419.  
  420.                             LIST     Page 7
  421.  
  422.  
  423.                 Marking and Extracting Lines
  424.                 ----------------------------
  425.  
  426.    There are two ways that lines can be extracted from a file:
  427.  
  428.       o  with the P (print) command, and
  429.       o  with the alt-D (dump data) command.
  430.  
  431.    The lines to be extracted are either the current lines on the
  432. screen, or lines that you  have marked with the alt-M  and alt-B
  433. commands.
  434.  
  435.    To mark lines,  you use either  the alt-M or  alt-B commands.
  436. The alt-M command  marks the top  line on the  screen, and alt-B
  437. marks the bottom line on the screen.  You can use either or both
  438. commands to mark the starting and ending lines (in the range  of
  439. lines  to  be  extracted).   The  marked  lines are displayed in
  440. reverse video.
  441.  
  442.    After you have marked a range of lines, you use the P (print)
  443. command to print all of the  marked lines.  Or, you can use  the
  444. alt-D (dump data) command to  write those lines to a  file.  The
  445. alt-D command asks you  for a file name.   If the file does  not
  446. exist, a new one is  created.  If the files already  exists, the
  447. extracted lines are added (appended) to the file.
  448.  
  449.    For example, you  would like to  have LIST filter  out all of
  450. the junk in a file, and then write a new file.  To do this,  you
  451. might enter the following sequence of commands:
  452.  
  453.         list TESTDATA           ... display your TESTDATA file
  454.     alt-J            ... filters out    the junk
  455.     alt-M            ... marks line 1 (top line)
  456.     END            ... positions to end of    file
  457.     alt-B            ... marks the bottom line
  458.                          (last line)
  459.     alt-D            ... dumps data to a file
  460.         TESTDATE.NEW            ... you enter the new file name
  461.     alt-X            ... quit and return to DOS
  462.  
  463.  
  464. |          Once you have marked a range of lines, use of alt-M  or alt-B
  465. |       does not reset the entire line range.  The  first or last marked
  466. |       line may change, but both do not change.  Use the  alt-U command
  467. |       to unmark lines, especially after alt-D (dump) to be sure.
  468.  
  469.  
  470.  
  471.  
  472.  
  473.  
  474.  
  475.  
  476.  
  477.  
  478.  
  479.  
  480.  
  481. LIST     Page 8
  482.  
  483.  
  484.  
  485.                  Display Format
  486.                  --------------
  487.  
  488.    The monitor display is defined in terms of lines and columns.
  489. A typical monitor can display 25 lines of 80 columns each.  LIST
  490. attempts to use the number of lines and columns for the  monitor
  491. mode in use.  For example, if the monitor is in 40 column  mode,
  492. LIST displays only 40 characters per line.  And, if the  monitor
  493. is set for other than 25 lines, such as 35 or 43, LIST uses that
  494. number of lines.
  495.  
  496. |          If you use the  alt-E command  to change  EGA modes,  the EGA
  497. |       pallette,  cursor,  and other  settings are  set to  DOS default
  498. |       values.  LIST does not preserve fonts or pallettes.
  499.  
  500.    The top line of the  display is called  the Status line.  The
  501. bottom line is called the Command line.  The remaining lines are
  502. called the  primary  display  window,  and are usually lines two
  503. through 24.
  504.  
  505.  
  506.                  Status Line Format
  507.                  ------------------
  508.  
  509. The Status line has the following format:
  510.  
  511.         LIST   lllll nnnnnnn +sss mm/dd/yy hh:mm  - filename
  512.  
  513. where,
  514.  
  515. 'LIST'     is the name of this program
  516.  
  517. 'lllllll'  is the line number of the first line in the
  518.            display window (usually on line 2)
  519.  
  520. 'nnnnnnn'  is the line number of the last record, if known
  521.  
  522. '+sss'     if displayed, this is the Scroll amount, in
  523. |                  multiples of 10, corresponding to the number
  524.            of columns that the display has been shifted
  525.            to the right to view records longer than 80
  526.  
  527. 'mm/dd/yy' is the file's creation date (not today's date)
  528. 'hh:mm'    is the file's creation time (not today's time)
  529.  
  530.  
  531. Note:      The date and time  shown on the top line is  NOT  the
  532.        current date.  It is the date and time  that the file was
  533.        created.
  534.  
  535.  
  536.  
  537.  
  538.  
  539.  
  540.  
  541.                         LIST     Page 9
  542.  
  543.                  Command Line Format
  544.                  -------------------
  545.  
  546. The Command line has the following format:
  547.  
  548.       command message _________ Options: hbkmpswtalj Keys: X=exit ?=Help
  549.                   -----------
  550. where,
  551.  
  552. 'command' indicates the current process:
  553.  
  554.   'Command'   you are being asked to enter a command
  555.                enter the letter, or press the keys for
  556.                the action to perform
  557.  
  558.   'Reading '   the file data is being read
  559.   'Filter  '   the file data is being formatted for display
  560. |         'Looking '   the Scan/Find text is being searched for
  561.  
  562.   'Scan   '   you are being asked to enter text to locate
  563.   'Find   '   in the file, up to 31 characters may be entered
  564.  
  565.   '# lines?'   you are being asked to enter a 1 to 5 digit
  566.                number that is the amount of lines to skip
  567.  
  568.   'Line #? '   you are being asked to enter a 1 to 5 digit
  569.                line number to which the display is to be
  570.                positioned
  571.  
  572.  
  573. 'message' may be one of:
  574.  
  575.   '*** Text not found ***'
  576.    the Scan/Text was not found in the file
  577.  
  578.   '   *** Top of file ***'
  579.    the first line of the file is being displayed
  580.  
  581.   '   *** End-of-file ***'
  582.    the last line of the file is being displayed
  583.  
  584. St: indicate status of toggles, lower case means off:
  585.  
  586. 'H'       indicates that the hex Dump display option is in use
  587. 'b'       indicates whether the 7-bit, 8-bit, or *-option is
  588.           in use
  589. 'K'       indicates that the Keyboard flush option is in use
  590. 'M'       indicates that tests for monitor retrace are not made
  591. 'P'       indicates that Print is in use
  592. 'S'       indicates that file closing (for sharing) is in use
  593. 'W'       indicates that the Wrap mode is in effect
  594. 'T'       indicates that TAB characters are expanded
  595. 'A'       indicates APXCORE interface, 'a' for TV/DV/DD
  596. 'L'       indicates that the pre-loading option is on
  597. 'J'       indicates that line feeds are added to lone carriage
  598.           return control characters, and backspaces are handled
  599.  
  600.  
  601. LIST     Page 10
  602.  
  603.  
  604.  
  605.                  Screen Colors
  606.                  -------------
  607.  
  608.    The screen's lines may be in any of three different colors:
  609.  
  610.         o  the 'special' color for the top status line and the
  611.            bottom command line
  612.         o  the 'normal' color for the file's text windows
  613.         o  the 'bright' color for lines with Find/Scan text,
  614.            and for the upside-down question mark in 7-bit mode
  615.  
  616.    There is a pair of function keys assigned to each color.  You
  617. may  use  these  function  keys  to  change  the  background and
  618. foreground  colors  temporarily.   To  make  the  color  changes
  619. permanent, you may use the cloning command (alt-C), or use DEBUG
  620. to modify the program file.
  621.  
  622.    The colors used  for displaying the  titles and main  body of
  623. text  may  be  changed  temporarily  or  permanently.  To make a
  624. permanent  change,  the  cloning  command  alt-C  is  used.   It
  625. requires that the LIST.COM program file be on the current  drive
  626. and in the current directory.
  627.  
  628.    The border is not  changed.  The foreground color  applies to
  629. the characters displayed.
  630.  
  631.  
  632. The color attributes may be changed by using these function keys:
  633.  
  634.   For the main body of text:
  635.  
  636.         F5 - background color
  637.         F6 - foreground color
  638.  
  639.   For the top and bottom lines:
  640.  
  641.         F7 - background color
  642.         F8 - foreground color
  643.  
  644.   For the line with Find/Scan text:
  645.  
  646.         F2 - background color
  647.         F4 - foreground
  648.  
  649.    Once you  have decided  upon the  colors,  use the alt-C  key
  650. combination to change the LIST.COM program file.
  651.  
  652.  
  653.  
  654.  
  655.  
  656.  
  657.  
  658.  
  659.  
  660.  
  661.                         LIST     Page 11
  662.  
  663.  
  664.  
  665.                  Cloning Procedure
  666.                  -----------------
  667.  
  668.    The screen colors, the display retrace testing (M), the  file closing (C)
  669. and ruler (alt-R) options may be permanently set  in the program by using
  670. the alt-C cloning function.
  671.  
  672.    For  cloning  to  take  effect,  the  program  must be called LIST.COM
  673. and it must be on the current drive and in the  current directory.  There
  674. are two versions of the LIST COM file.  One is the normal  program.  The 
  675. other, which  contains an  'S' as the last letter of  the file name,  is a
  676. slightly  smaller file that excludes  the  Help  screen.   You  may  use
  677. either COM file for cloning.
  678.  
  679.    The clonable options (command toggles) are:
  680.  
  681.      M      =  Mono monitor, affects retrace testing,
  682.      C      =  file(s) are shared,
  683.      W      =  Wrap long lines
  684.      8/7/*  =  display all 256 values, or 7-bit, or special case
  685.      K      =  flush Keyboard each time a command is read
  686.  
  687.      alt-A  =  set on if using Apxcore, off if using Double Dos
  688.                or TopView, or DesqView
  689.  
  690.      alt-H  =  hex dump display, like the DEBUG format
  691.  
  692.      alt-J  =  toggle "junk" filter, add LF to CR, fix backspaces
  693.  
  694.      alt-L  =  set on to force preloading (reading) of the
  695.                entire file before any lines are displayed,
  696.                Default is OFF.
  697.  
  698.      alt-R  =  toggle columnar ruler on top line
  699.  
  700.      alt-T  =  toggle expansion of TAB characters
  701.  
  702.  
  703. Note: Be  sure you  have no  other copies  of LIST.COM which are
  704. accessible (because of a filepath type of utility).
  705.  
  706.  
  707.  
  708.  
  709.  
  710.  
  711.  
  712.  
  713.  
  714.  
  715.  
  716.  
  717.  
  718.  
  719.  
  720. LIST     Page 12
  721.  
  722.                  DEBUG Information
  723.                  -----------------
  724.  
  725.    An alternative to cloning is  to use DEBUG to make  permanent
  726. changes.  Here is a list of key items and their addresses:
  727.  
  728. |          0124 - special lines 1 and 25 colors, default is 01 (blue)
  729.           Refer to a technical reference guide for the
  730.           attribute values for the colors that you want.
  731. |          0126 - normal lines 2 thru 24 colors, default is 02 (green)
  732. |          0128 - bright color for Find/Scan, default is 0C (bright red)
  733. |          012A - clonable options;
  734. |              MRSJ WHK*  M = mono, retrace testing if off, x'01'
  735.                   R = ruler, x'02'
  736.                   S = shared, x'04'
  737. |              J = add LF to    lone CR, process backspaces,
  738. |                  if on, x'08'; default is off
  739.                   W = wrap mode, x'10'
  740.                   H = hi-bit on, x'20'
  741.                   K = kybd flush, x'40'
  742.                   * = special document filtering, x'80'
  743. |          012B - more clonable options, not all are indicated:
  744. |              .PAT DGV.  P = Preload file if on, x'02', default is off
  745.                   A = Apxcore if on, TV/DD/DV if off, x'04,
  746.               default is for Topview/Double DOS    use
  747.                   T = if on (default), expand TABs, x'08'
  748. |              D = hex display mode if on, x'10'
  749.                   G = if on, alt-G goto DOS is Disabled, x'20'
  750.                   V = if on, screen save/restore is Disabled
  751.               and 9K less memory is used/required, x'40'
  752.  
  753. By  specifying  the  bit  value,  the  option  is  enabled.  For
  754. example, to enable  Shared and Retrace,  specify a hex  value of
  755. the sum, or 01+04 = 05.
  756. |          012C - row less one at which found text is displayed,  1 byte
  757. |                 the default is 08 which displays found text on line  9
  758. |          012E - scroll offset value,  default is 10 (x'0A'),  one byte
  759. |          0130 - scroll starting value, default is 0 (x'00'), one byte
  760. |          0132 - tab increment, must be power of 2, default is 8
  761. |          0134 - tab mask, subtract tab incr from FFFFh,default is FFF8
  762.  
  763. When the Find/Scan command is used, the next line which contains that text
  764. is highlighted using the 'bright' color, and is placed in row 9 of the
  765. screen. You can change the row by altering the byte at location 12C which is
  766. normally '08', one less than the row.
  767.  
  768. The letters and command keys may also be changed. There are two tables
  769. involved: WHAT and WHERE. The WHAT table contains a list of one-byte
  770. keyboard codes. The WHERE table contains a list of two-byte matching
  771. addresses. If you really want to
  772.         change the codes, here are the DEBUG addresses:
  773.  
  774. |          035E - WHAT eye catcher
  775. |          0362 - table of key codes,  ASCII 0-127,  then extended 0-132
  776. |          0467 - WHERE eye catcher
  777. |          046C - list of two byte addresses of processing routines
  778.  
  779.                                                         LIST     Page 13
  780.  
  781.  
  782.  
  783.                          Scanning for text
  784.                          -----------------
  785.  
  786.  
  787.    You may  use Find  (\) to  search for  text regardless of the
  788. |       case, or you may use Scan (/) to find an exact match. The search
  789. |       begins  at  the  top  line  displayed  and proceeds in a forward
  790. |       direction until the end of file.  You may  start a  search  that
  791. |       goes backwards rather than  forwards by using the ` (left quote)
  792. |       key  instead of Find (\), or by using ' (right quote) instead of
  793. |       Scan (/).
  794.  
  795.    To scan for a character string, type a slash (/) followed  by
  796. one or more (up to 31)  characters.  The Scan text, but not  the
  797. slash,  is  displayed  on  the  command  line.  The Scan is case
  798. sensitive.  That is, lower case Scan text will only match  lower
  799. case file text.
  800.  
  801.    While  the  program  is  searching  for  the text, the bottom
  802. display line  is changed  to say  "Scanning".   Pressing ANY key
  803. while the search  is in progress  will terminate the  search and
  804. display the message 'Text not found' on the bottom line.
  805.  
  806.    If the text is found, the line containing it is  displayed as
  807. |       a high-intensity line (bright color) in the middle of the screen
  808. |       depending on the value of the Find Row (see cloning section).
  809.  
  810.    If the text is NOT found, the command line (25) is changed to
  811. say '*** text not found ***', and the display remains unchanged.
  812.  
  813.    To find the next occurrance of the same text, use the  A)gain
  814. command, or press the F3 key.  To find the previous occurance,
  815. press the F9 key.
  816.  
  817.    If the  PCED keyboard  enhancement program  is installed, the
  818. up/down cursor keys  may be used  to recall and  edit previously
  819. entered Scan/Find text.
  820.  
  821.    In a shared file environment, if the file changes while being
  822. listed,  the  file  position  may  become invalid.  Use the HOME
  823. command  to  insure  proper  file  synchronization, or use the C
  824. or alt-S command again.
  825.  
  826. |          If  the  display  has been scrolled right or left so that the
  827. |       "found"  text is not visible, you will see a funny symbol in the
  828. |       first  column.  This  is  the same symbol that is displayed on a
  829. |       blank line while changing the Find/Scan colors.  It is there  so
  830. |       that you can tell that the line is marked.
  831.  
  832.  
  833.  
  834.  
  835.  
  836.  
  837.  
  838.  
  839. LIST     Page 14
  840.  
  841.  
  842.                  Filtering
  843.                  ---------
  844.  
  845.    Filtering is the term used to describe the process that  LIST
  846. uses to  format file  data for  displaying on  a monitor.  After
  847. data  is  read  from  a  file,  it  is  filtered.  The method of
  848. filtering depends upon the options in effect.
  849.  
  850.    For a typical  ASCII text file,  the filter removes  carriage
  851. return and line feed characters, and expands TAB characters.
  852.  
  853.  
  854.                  Hi-bit Filter
  855.                  -------------
  856.    The  7,  8,  and  *  (asterisk)  commands  determine  whether
  857. characters above ASCII-127 are displayed.  If the hi-bit  option
  858. is off (7  command), the filter  strips the high  order bit from
  859. each character.   If the  hi-bit option  is on  (8 command), all
  860. characters, including  graphic characters  above ASCII-127,  are
  861. displayed.
  862.  
  863.                  Star Filter
  864.                  -----------
  865.  
  866.    The  star  (*  or  asterisk)  command  displays  only   ASCII
  867. characters below 128 (x'80'), but treats the special  characters
  868. x'8A'  and  x'8D'  as  line-feed  and  carriage-return   control
  869. characters.   Any  other  characters  above  127  are treated as
  870. spaces, and control codes below ASCII-26 are replaced by blanks.
  871.  
  872.    The Wrap option causes the  filtering to insure that no  line
  873. exceeds the width of the monitor, e.g. 80 characters.
  874.  
  875.                  Junk Filter
  876.                  -----------
  877.  
  878.    The alt-J  command toggles  the "junk"  filter which  insures
  879. that carriage  returns in  the file  also result  in a new line.
  880. Also, backspace characters result in "backing up" the display by
  881. one position.  This  allows more readability  of files that  use
  882. backspacing to emphasize, or over-write, characters.
  883.  
  884.  
  885.                  Hex Format Filter
  886.                  -----------------
  887.  
  888.    The hex dump option (alt-H) causes the filtering to  reformat
  889. the file  data into  a DEBUG-like  display format.   The largest
  890. file that can be displayed in Hex is 1 million bytes.
  891.  
  892.    An attempt is made to retain the file position when switching
  893. from normal to hex-dump  display, but due to  filtering changing
  894. record lengths,  the hex  display may  begin before  the current
  895. record.
  896.  
  897. NOTE:   The  EOF  control character is  ignored in this version.
  898.  
  899.                                                 LIST     Page 15
  900.  
  901.                 File Sharing
  902.                 ------------
  903.  
  904.    LIST uses two techniques for allowing you to share files with
  905. other processes.
  906.  
  907.    The first technique is called file closing and is enabled  by
  908. the C or alt-S commands.   This forces LIST to close  the viewed
  909. file unless it needs to read from the file.  If enough memory is
  910. available, the entire file may be loaded once and thus leave the
  911. file free for exclusive access by other processes.
  912.  
  913.    The  second  technique  is  called  file  sharing.   It  is a
  914. function of  DOS and  requires DOS  version 3.0  or later.  LIST
  915. opens the viewed  files with a  DENY NONE request.   This allows
  916. other processes to  read and write  to the file  if they do  not
  917. request exclusive use of the  file.  If a file is  not available
  918. to  LIST  because  it  is  locked  by  another process, you will
  919. receive the error message "File not found" or "Acccess  denied".
  920. There is  no command  to enable  or disable  this method of file
  921. sharing.  It is implicit with the use of DOS version 3.
  922.  
  923.  
  924.                 Invoking DOS Commands
  925.                 ---------------------
  926.  
  927.    If  the  "goto  DOS"  option  is  enabled, you may invoke DOS
  928. |       commands by using the alt-G command.  LIST reserves about 66k of
  929. |       memory for its own use.  This  increases LIST's  memory require-
  930. |       ments to approximately 96k when using alt-G.  The remaining mem-
  931. |       ory is available to the DOS commands.
  932.  
  933.  
  934.    After you have  finished entering DOS  commands, use the  DOS
  935. EXIT command to return to LIST.
  936.  
  937.    To disable  the "goto  DOS" function,  you must  use DEBUG to
  938. alter the option  byte described in  the section about  cloning.
  939. With it disabled, LIST requires less memory, about 66K.
  940.  
  941.  
  942.                 Screen Saving
  943.                 -------------
  944.  
  945. If the screen saving option is enabled, LIST saves the
  946. contents of the current display screen when it starts. You can
  947. restore the original screen by exiting LIST with the alt-X
  948. command.
  949.  
  950.   Screen saving requires approximately 10k more memory. This
  951. is sufficient to save 60 lines of 80 characters (EGA 8x6 mode).
  952. See the section about cloning for information about enabling and
  953. disabling the screen saving feature.
  954.  
  955.  
  956.  
  957.  
  958.  
  959. LIST   Page 16
  960.  
  961.         Restrictions
  962.         ------------
  963.  
  964.  o The program requires 66K bytes of memory. If more memory is
  965.    available, it is used to store more of the file in memory.
  966.    At least 96K is required to use the DOS shell. Add 9K if
  967.    the screen saving option is enabled (default).
  968.  
  969.  o The line number is currently limited to 65535.
  970.  
  971.  o The file size is limited to 16 million bytes for ASCII
  972. |      files, and to 1 million bytes for hex-dump files, but only
  973. |      the first 65535 records are processed.
  974.  
  975.  o PC DOS Version 2.0 or later is required. DOS version 3.0
  976.    or later is required for file sharing.
  977.  
  978.  o ANSI.SYS is NOT required.
  979.  
  980. APX Core, DesqView, TopView, and Double DOS, IBM, Sigma are all
  981. copyrighted, trademarked, and all that.
  982.  
  983. Written by Vernon Buerg for the IBM PC using DOS 2.0 or later,
  984. through DOS 3.2. Not for sale or hire.
  985.  
  986. LIST is supplied for personal, private use.  Feel free to
  987. distribute LIST given these restrictions:
  988.  
  989.  o the program shall be supplied in its original, unmodified
  990.    form, which includes this documentation;
  991.  
  992.  o no fee is charged;
  993.  
  994.  o for-profit use without a license is prohibited;
  995.  
  996.  o the program may not be included - or bundled - with other
  997.    goods or services. Exceptions may be granted upon written
  998.    request only. This applies to clubs and distributors, too.
  999.  
  1000.  
  1001. If you are using LIST and find it of value, your gift in any
  1002. amount ($15 suggested) will be greatly appreciated. Please make
  1003. checks payable in U.S. dollars to Vernon D. Buerg.
  1004.  
  1005. For use by corporations and other institutions, please contact
  1006. me for a licensing arrangement. Customizing, licensing of the
  1007. source, and other special licensing are available upon request.
  1008. Purchase orders and invoicing are acceptable.
  1009.  
  1010.  
  1011.     Vernon D. Buerg
  1012.     456 Lakeshire Drive
  1013.     Daly City, CA 94015
  1014.  
  1015.     Data:  (415) 994-2944  VOR 24-hour bulletin board
  1016.     Compuserve: 70007,1212 or 74375,500
  1017.  
  1018.  
  1019.