home *** CD-ROM | disk | FTP | other *** search
/ Hall of Fame / HallofFameCDROM.cdr / util4 / cat.lzh / CAT.DOC < prev   
Text File  |  1985-06-15  |  15KB  |  372 lines

  1.     
  2.     
  3.     
  4.      
  5.     
  6.     
  7.     
  8.         CAT.COM- DIRECTORY MAINTENANCE FACILITIES
  9.     
  10.     
  11.     CONTENTS
  12.     
  13.     Overview . . . . . . . . . . . . . . . . . . . . . . . .  1
  14.     
  15.     Background . . . . . . . . . . . . . . . . . . . . . . .  2
  16.     
  17.     Screen Format  . . . . . . . . . . . . . . . . . . . . .  3
  18.     
  19.     Manipulating the Display . . . . . . . . . . . . . . . .  4
  20.     
  21.     Program Function Keys  . . . . . . . . . . . . . . . . .  6
  22.     
  23.     Using the Command area . . . . . . . . . . . . . . . . .  7
  24.     
  25.     î    CAT.COM- DIRECTORY MAINTENANCE FACILITIES
  26.     Page 1
  27.     
  28.     OVERVIEW:
  29.     
  30.     This document provides information about CAT for use on the
  31.     IBM Personal Computer.  We hope the program fills as  many
  32.     of your needs as it did ours.
  33.     
  34.     It provides a full screen list of a file set specified by
  35.     the user.  These may be presented in an unsorted, name,
  36.     extension, date, or size order, and the sorted order of
  37.     presentation may be changed dynamically.  Within each entry
  38.     is displayed an area to allow the entry of commands.  This
  39.     command area may be used to issue commands which pertain to
  40.     the files displayed.  These commands are entered in the
  41.     command areas adjacent to the files they are to affect.  
  42.     Helpful facilities are provided to reduce the typing
  43.     required.  One example is the use of the "=" internal
  44.     command to repeat the last command.  To provide additional
  45.     ease of use, the editing keys and function keys may be used
  46.     to page through the list and add or delete commands.
  47.     
  48.     When all desired commands have been entered, the user
  49.     enters execution mode [by pressing CTRL-ENTER] to pass the
  50.     commands entered in display mode to the PC-DOS command
  51.     environment.  The commands are passed to the command
  52.     environment for execution, one after the other, beginning
  53.     with the command closest to the top of the list and
  54.     continuing toward the end of the list until all commands
  55.     have been returned or an internal function is encountered.
  56.     
  57.     After execution, the program returns you to DOS to allow
  58.     you to view any messages or output which result from the
  59.     executed commands.  The DOS prompt appears, with a full
  60.     block cursor to remind you that CAT.COM is still active. 
  61.     To return to the CAT.COM display, simply press ENTER all by
  62.     itself.  Any other entry will be immediately executed by
  63.     DOS, without returning to the CAT.COM display until you
  64.     press ENTER all by itself.
  65.     
  66.     The program becomes a resident extension of DOS in memory. 
  67.     This means the program loads into an area of memory that is
  68.     protected from change by any other programs you run.  Once
  69.     loaded, you can start LOTUS, MultiMate, or most any other
  70.     program without interference.  When you return to PC-DOS,
  71.     CAT.COM IS STILL OPERATING:  PRESS RETURN WITH NO COMMAND
  72.     TO RESUME OPERATION OF CAT.COM.  It picks up right where
  73.     you left off.  CAT.COM will remain active in memory until
  74.     the system is rebooted.
  75.     
  76.     Because it stays resident, CAT.COM always occupies
  77.     approximately 7000 bytes of memory.  This storage includes
  78.     the necessary resident code and table space for an
  79.     unlimited amount of entries.  
  80.     
  81.     î    CAT.COM- DIRECTORY MAINTENANCE FACILITIES
  82.     Page 2
  83.     
  84.     BACKGROUND:
  85.     
  86.     CAT is invoked from the DOS command environment by issuing
  87.     the commands shown below:
  88.     
  89.     +==========================================================+
  90.     |                               |
  91.     |                               |
  92.     | CAT < fspec > < /sn | /se | /sd | /ss>           |
  93.     |                                |
  94.     | CAT is the minimum command.                    |
  95.     | If no parameter is specified, files will sort by date.   |
  96.     | The | symbol separates alternative commands.             |
  97.     |                                |
  98.     +==========================================================+
  99.     
  100.     If the filespec is omitted, all files on the current
  101.     default disk will be listed.  This is almost always the way
  102.     you invoke CAT.COM.  If CAT is used on the IBM PC/XT, only
  103.     those files within the current directory on drive C: are
  104.     listed.  Options include:
  105.     
  106.     /sn: files will be listed in alphabetical order by filename.
  107.     /se: files will be listed in alphabetical order by extension.
  108.     /sd: files will be listed in date sequence,newest first.
  109.     /ss: files will be listedbysize, largest first.
  110.      
  111.     EXAMPLES:
  112.     CAT        list all files on default drive by date.
  113.     CAT /SN        list all files on default drive by name.
  114.     CAT B:/SS    list B: drive by largest file size.  
  115.     
  116.     î    CAT.COM- DIRECTORY MAINTENANCE FACILITIES
  117.     Page 3
  118.     
  119.     SCREEN FORMAT:
  120.     
  121.     The displayed format consists of three distinct areas.  The
  122.     first line is a status line.  The first two (blinking)
  123.     characters show the current default drive in DOS.
  124.     
  125.     The balance of the line gives the size of the allocation
  126.     unit, the allocation units used and the allocation units
  127.     free (as well as the percentage of free allocation units)
  128.     on the listed diskette plus the number of the first
  129.     displayed entry as well as the count of active (displayed)
  130.     entries.  (Allocation unit information is of little
  131.     interest to most people.  See your DOS manual if you're
  132.     curious.  JSS]
  133.     
  134.     The next 23 lines contain displayed entries for listed
  135.     files.  The first portion gives the filespec for the listed
  136.     file.  The next 25 postions are a command area.  The
  137.     balance of the line contains the attribute indicators, the
  138.     size of the file in decimal bytes, the number of allocation
  139.     units occupied by the file, followed by the date and time
  140.     the file was last updated.
  141.     
  142.     The last line of the screen displays the function key
  143.     settings.
  144.     
  145.     î    CAT.COM- DIRECTORY MAINTENANCE FACILITIES
  146.     Page 4
  147.     
  148.     MANIPULATING THE DISPLAY:
  149.     
  150.     Once the list is displayed, the editing keys on the
  151.     keyboard may be used to manipulate the screen.  The
  152.     semantics for the key usage follow those used for the BASIC
  153.     editor.  They are:
  154.     
  155.     PgUp         move the display to show entries nearer the
  156.     beginning of the entry sequence.
  157.     
  158.     Ctrl-PgUp    move the display to show the first screen
  159.     of entries in the entry sequence.
  160.     
  161.     PgDn        move the display to show entries nearer the
  162.     end of the entry sequence.
  163.     
  164.     Ctrl-PgDn     move the display to show the last screen of
  165.     entries in the entry sequence.
  166.     
  167.     Home        position the cursor to the first postion of
  168.     the command area on the first entry displayed on the
  169.     screen.
  170.     
  171.     End        position the cursor at the last character
  172.     in the command field on the line containing the cursor.
  173.     
  174.     Ctrl-End     erase the command area from the cursor to
  175.     the end of the field.
  176.      
  177.     Ins        toggle insert mode.  When in insert mode, a
  178.     full block cursor is displayed.
  179.      
  180.     Del        delete the character at the cursor.
  181.     
  182.     
  183.     Cursor keys     move the cursor in the direction depicted
  184.     by the arrows on the keys.  The screen will scroll up or
  185.     down if needed and if possible.
  186.     
  187.     Enter         positions the cursor to the beginning of
  188.     the next command area.  It functions like the RETURN key on
  189.     a 3270, not the 3270's ENTER key.  If appropriate, the
  190.     screen will be scrolled as described below in the entry
  191.     for Tab.
  192.     
  193.     Backspace     deletes the character to the left of the
  194.     cursor.
  195.     
  196.     î    CAT.COM- DIRECTORY MAINTENANCE FACILITIES
  197.     Page 5
  198.     
  199.     Tab         skips to the first position of the next
  200.     command area if not the last entry displayed.  In this
  201.     case,  scrolling occurs as for down cursor unless
  202.     prohibited by file position.  In this case, wrap to first
  203.     displayed command area occurs.
  204.     
  205.     Shift-Tab     skips backward to the beginning of the
  206.     previous command field.  If the cursor is not in the first
  207.     position of the command area, this key will position to the
  208.     first position of the current command area.  If the skip is
  209.     off the first entry displayed, scrolling occurs as for up
  210.     cursor unless prohibited by file position.  In this case,
  211.     wrap to last displayed command area occurs.  
  212.      
  213.     ESC        clear the command area to blanks and
  214.     position the cursor to the first position of the command
  215.     area on the current entry.
  216.     
  217.     Ctrl-Return     EXECUTE ALL COMMANDS.  While in execution
  218.     mode, a block cursor will be displayed along with the DOS
  219.     prompt, CAT remains active in core and can be recalled
  220.     simply by depressing [CR].  CAT will display the previous
  221.     entries from your previous display.  To refresh and update
  222.     the current display, simply depress [F1].
  223.     
  224.     î    CAT.COM- DIRECTORY MAINTENANCE FACILITIES
  225.     Page 6
  226.     
  227.     PROGRAM FUNCTION KEYS:
  228.     
  229.     The functions provided on the PF keys are displayed on the
  230.     25th line of the display.  The assignment is similar to the
  231.     BASIC softkeys, with the function key placing the assigned
  232.     character string on the command line at the first position,
  233.     then entering execution mode.  The function key assignments
  234.     are as follows:
  235.     
  236.     [F1] FRESH    refresh display and clear old entries.
  237.     [F2] DIR A:    read and display all entries from drive A:
  238.     [F3] DIR B:    read and display all entries from drive B:
  239.     [F4] DIR C:    read and display all entries from drive C:
  240.     [F5] Sort/N    sort (ascending) by name and refresh.
  241.     [F6] Sort/T    sort (ascending) by extension and refresh.
  242.     [F7] Sort/E    sort on date (descending) and refresh.
  243.     [F8] Sort/S    sort on size (descending) and refresh.
  244.     [F9] EDIX    Executes EDIX file editor IF YOU HAVE IT.*
  245.     [F0] EXECUTE    Executes the filename shown all by itself.
  246.     
  247.     
  248.     *-Send us your copy of CAT along with a check for $10.00 to
  249.     cover postage and handling and we will change the PF key
  250.     settings to execute your preferred editor (e.g., Wordstar,
  251.     Volkswriter, EDLIN  or another of your choice).  Make sure
  252.     to include a note stating your requirements.  [I'll do it 
  253.     for free for Searle PC User Group participants.  You should 
  254.     be aware that I reassigned these function keys so they 
  255.     would make more sense to most users./jss.]
  256.     
  257.     î    CAT.COM- DIRECTORY MAINTENANCE FACILITIES
  258.     Page 7
  259.     
  260.     Using the Command area:
  261.     
  262.     The input areas on each line (following the file ids) may
  263.     be used to enter any REASONABLE command as in the normal
  264.     DOS environment.  If not otherwise directed, CAT will
  265.     append the complete filespec associated with the command
  266.     area AT THE END OF THE COMMAND LINE.  For example, "TYPE"
  267.     on the line containing A:CAT.DOC (a text file) is passed to
  268.     DOS as TYPE A:CAT.DOC.  This is where "reasonable" comes
  269.     in.  It isn't reasonable to TYPE CAT.COM, since it isn't
  270.     reasonable to TYPE a binary file.  CAT.COM will do it, but
  271.     it's just as ugly as if you did it in DOS.
  272.     
  273.     If the command is preceded by the /O internal command, no
  274.     appending will occur and the command will be passed to the
  275.     command environment without further processing.  For
  276.     example, /O CHKDSK B: will pass the command CHKDSK B: to
  277.     DOS without appending the filename shown on that line.  
  278.     This means you can issue this type of command from any
  279.     line.  The command you pass obviously has to make sense to
  280.     DOS.
  281.     
  282.     To copy a particular file to the A: drive, use the
  283.     following format on the command line: COPY / A:  This
  284.     command will copy the filename shown to drive A.  THE "/"
  285.     CAUSES CAT TO INSERT THE FILESPEC LOCATED ON THAT LINE IN
  286.     PLACE OF THE "/" CHARACTER WHEN THE COMMAND IS EXECUTED.  
  287.     
  288.     The substitution of the filespec in the command passed to
  289.     DOS is a key concept for CAT.COM that gives the program
  290.     much of its power.  The general rule is:  UNLESS OTHERWISE
  291.     DIRECTED, CAT.COM WILL APPEND THE FILESPEC AT THE END OF
  292.     YOUR COMMAND.  THE TWO EXCEPTIONS ARE THE /O COMMMAND,
  293.     WHICH EXECUTES ONLY WHAT IS ENTERED, AND THE SLASH COMMAND,
  294.     WHICH CAUSES INSERTION OF THE FILESPEC AT ANOTHER POINT.
  295.     
  296.     
  297.     The /n internal command will allow you to directly  execute
  298.     the current filespec, if possible.  This option is useful
  299.     for  executing batch files, and other executable filetypes,
  300.     such as .COM and .EXE files.  It won't work if you can't
  301.     issue the same command in DOS, so don't try to execute a
  302.     text file -- DOS can't do it.  This is the same command
  303.     that is issued by f10.  The difference between the /n
  304.     command as entered on the command line and f10 is that you
  305.     can supply your own arguments -- /n b: typed on line that
  306.     contains CHKDSK.COM will pass CHKDSK B: to DOS.  /n tells
  307.     the program to take the filename (only) and append any
  308.     supplied arguments before passing the combined commands to
  309.     DOS.  CTRL-ENTER is used to invoke your commands all at
  310.     once.  
  311.     
  312.     î    CAT.COM- DIRECTORY MAINTENANCE FACILITIES
  313.     Page 8
  314.     
  315.     As noted earlier, "=" will allow you to repeat a previously
  316.     entered command without having to retype it.  It simply
  317.     means USE THE SAME COMMAND AS SHOWN ABOVE ON THIS LINE TOO.
  318.     There must be a reasonble command shown above.  
  319.     
  320.     CAT.COM will also display a subset of the files shown for a
  321.     particular drive.  The /r command will refresh your display
  322.     and show only the files included by a search string
  323.     (same rules as for the DOS DIR command).  If you want to
  324.     sort on particular filenames then enter the following: /r
  325.     *.mem.  CAT.COM will select only the filenames on that disk
  326.     that have a filetype of .mem for the resulting display.
  327.     
  328.     After all of your commands are entered on the display,
  329.     press  [Ctrl] and [CR] simultaneously.  The block cursor
  330.     will show along with the DOS prompt, just press [CR] for
  331.     your requested list.
  332.     
  333.     î    CAT.COM- DIRECTORY MAINTENANCE FACILITIES
  334.     Page 9
  335.     
  336.     
  337.     
  338.     PROGRAM WRITTEN BY:
  339.     
  340.     
  341.         STEVE O'KANE              RON SIMMONS
  342.         4306 DIEHL WAY             4303 ALCOSTA PLACE
  343.         PITTSBURG, CA.  94565        PITTSBURG, CA 94565
  344.         415-544-6204            415-427-4381
  345.     
  346.     
  347.     EDITORIAL COMMENT:
  348.     
  349.     O'Kane and Simmons distribute this program under the
  350.     FREEWARE concept.  They welcome sharing of the program with
  351.     others and ask for a VOLUNTARY contribution of $35.00 if
  352.     you feel the program is worthwhile.  
  353.     
  354.     Whether you contribute to O'Kane and Simmons or another
  355.     writer, FREEWARE deserves your financial encouragement to
  356.     make the concept grow and attract competent programmers.  
  357.     
  358.     Documentation cleaned up 4/7/84 
  359.     
  360.     ===========================================================
  361.     Program errors noted:
  362.     Hard disk users should note that CAT.COM will apparently 
  363.     deal with only 64 files at a time.  If you have more, be
  364.     aware that the program's authors didn't anticipate the XT's
  365.     hard disk.  This problem shouldn't impact floppy disk users.
  366.     
  367.     If you exit the program IMMEDIATELY after entering it, the
  368.     screen won't clear.  Issue CLS to clear the screen.
  369.     6/4/84
  370.  
  371.                     Jon Simsî
  372.