home *** CD-ROM | disk | FTP | other *** search
/ Oakland CPM Archive / oakcpm.iso / cpm / dirutl / dirr5.lbr / DIRR.DQC / DIRR.DOC
Text File  |  1986-01-19  |  9KB  |  202 lines
  1.             DIRR, A CP/M DIRETORY PROGRAM
  2.               notes by Irv Hoff
  3.                   01/07/86
  4.  
  5.  
  6.  
  7.          NOTE:    MAY BE USED WITH 8080, 8085
  8.             OR Z80 PROCESSORS.  SUPPORTS
  9.             CP/M V2.2 AND CP/M V3.0 BOTH.
  10.  
  11.  
  12.     HISTORY:
  13.     -------
  14.     The history of DIRR is quite clouded.  It was likely called D.COM
  15.     originally and probably written in 'C'.  Jim King disassembled it
  16.     and obviously spent a considerable amount of time in documenting
  17.     and altering it for his terminal, printer and time-date board.  It
  18.     was limited for use with Z80 processors.  He called his version
  19.     DI214.COM.    His work was mostly done around December 1983.
  20.  
  21.     I had independently modified the original D.COM program for a dis-
  22.     play I liked a lot more, but renamed my version DIRR.COM.  This
  23.     was done so it would not interfere with any changes the original
  24.     author might wish to make in future releases of D.COM, and would
  25.     minimize any animosity to my making such extensive changes to his
  26.     program, then using his original name.
  27.  
  28.     In early December 1985, I found Jim King had the source code for
  29.     his Z80 version, and he graciously made that available.  I made a
  30.     large number of changes and again thought I should call my version
  31.     something different from either D.COM or his DI214.COM.  This ver-
  32.     sion is again called DIRR.COM as the display is almost identical to
  33.     the version I have been using for some time, and distributed under
  34.     the name DIRR2.COM.
  35.  
  36.     The most important thing I did was to rewrite it in normal 8080 code
  37.     and eliminate the macro libraries that were required.  It may now be
  38.     used on any CP/M-80 v2.2 computer with 8080, 8085 or Z80 processor.
  39.     It may now be assembled with any normal assembler.    Numerous other
  40.     changes were made, which include making the reverse video optional.
  41.     Several new options were added, and all were changed to be similar
  42.     to those offered for the 'SD' directory program, where possible.
  43.     This should make it easier for people to move between the two pro-
  44.     grams - note there is no "D" option with this program, at present.
  45.     In early January, I updated the pragram to work with CP/M 3.0, as I
  46.     found a large number of people with CP/M 3.0 (especially Commodore
  47.     C128 owners) were trying to use the program but getting incorrect
  48.     "space remaining" displays.
  49.  
  50.  
  51.     PURPOSE:
  52.     -------
  53.     DIRR makes an alphabetical list of the CP/M directory files and in-
  54.     cludes the file length.  A number of options are available to make
  55.     the program quite useful.  These are listed below.    Several of them
  56.     are likely unique to this program.    Most can be set to be activated
  57.     by default, if preferred.
  58.  
  59.     The program is for CP/M-80 v2.2 or v3.0 and can run with 8080, 8085
  60.     or Z80 processors.
  61.  
  62.  
  63.     EXAMPLES OF USE:
  64.     ---------------
  65.     DIRR ?     help guide that shows all the options
  66.     DIRR     lists all non-"SYSTEM" files in the current user area
  67.     DIRR *.COM     lists all the ".COM" files in the current user area
  68.     DIRR B:*.*"  lists all files on drive B: in the current user area
  69.     DIRR *.* $A  lists all programs in all user areas on current disk
  70.     DIRR *.* $E  gives an extended display of user area and attributes
  71.     DIRR *.* $S  lists all files including .SYS system files.
  72.     DIRR $AES"     extended listing of all files this disk
  73.  
  74.  
  75.     OPTIONS, QUICK REFERENCE:
  76.     ------------------------
  77. 103H    A - shows files from all user area on current disk
  78. 104H    C - compressed display, 5 rows, no file size included
  79. 105H    E - extended display, shows user areas and attributes
  80. 106H    F - Makes a disk file after the CRT display is done
  81. 107H    N - Does not stop at full screen, else shows [more] when full
  82. 108H    P - Printer output, does not display on CRT
  83. 109H    S - Includes any systems files (most useful with $AES)
  84. 10AH    V - Version number and date
  85.  
  86.  
  87.     OPTIONS, DETAILED:
  88.     -----------------
  89.     DIRR $A     Shows all the files on the disk, alphabetized, no user
  90.          areas shown (use the 'E' option to include user area.)
  91.  
  92.     DIRR $C     Compressed listing - 5 rows instead of 4, leaves off
  93.          the file length to get the extra row for users with
  94.          very large disk systems.  Overrides 'E' option request.
  95.  
  96.     DIRR $E     Extended display, easily the most unique feature of
  97.          this program.    Shows one row less than normal, but
  98.          to the right of each row it shows the user area of
  99.          the file just listed and then has a separate area for
  100.          each of the attributes:
  101.  
  102.                 archive bit
  103.                 read/only file
  104.                 system file
  105.  
  106.     DIRR $F     After displaying the directory, will then make a disk
  107.          file of the same information, called ~DIR.  Using this
  108.          special character will insure the file is listed at the
  109.          very end of a normal display where it is easily found.
  110.  
  111.     DIRR $N     When the CRT display fills, DIRR stops with a [more]
  112.          message on the bottom line.  Touching any character on
  113.          the keyboard restarts the display.  The 'N' option will
  114.          keep the display running until finished with no stops.
  115.  
  116.     DIRR $P     Prints the output for a hard copy.  Option offered for
  117.          sending control strings to the printer for the print
  118.          font preferred, etc.  Another option returns it to the
  119.          normal print size, etc. when done printing.
  120.  
  121.     DIRR $S     Includes any systems files that meet the original re-
  122.          quest - the ideal display for these files would be to
  123.          use options '$AES'.
  124.  
  125.     DIRR $V     Shows the version number and date.
  126.  
  127.     DIRR $ACEFNPSV  -  causes ALL of the above options to be used.
  128.  
  129.          NOTE:    A few options cannot work well at the same time.
  130.             For instance, 'C' overrides the 'E' option as it
  131.             not possible to compress to 5 rows and also
  132.             expand to just 3 rows showing user areas and
  133.             attributes.  Keeping this in mind, the options
  134.             may be entered in any order.
  135.  
  136.  
  137.  
  138.                  SUMMARY:
  139.  
  140.     Special Note:  DIRR alphabetizes vertically, but in a quite unique
  141.     manner that has established its popularity.  If the file names can
  142.     all be shown at one time, then the DIRR display is similar to that
  143.     of some other programs.  When they can't be all shown at one time,
  144.     DIRR has two different types of displays available.
  145.  
  146.     To help simplify the explanation, assume a normal display of 24x80.
  147.     the bottom line will display [more] after the screen fills, leaving
  148.     23 lines of 4 rows, or 92 total files displayed.
  149.  
  150.     The normal display alphabetizes the first 92 files into four rows
  151.     and displays those, saying [more] on the bottom line to indicate the
  152.     user should tap any key to continue.  It then alphabetizes the next
  153.     92 files and displays those, etc. until finished.  DIRR is perhaps
  154.     the only directory program available that works in this manner.
  155.  
  156.     If the 'N' option (nonstop) is selected, the entire directory is
  157.     first alphabetized and placed into four rows, the top 23 lines
  158.     shown on the first screen, then the next 23 lines, etc.  This is
  159.     very similar to other programs such as SD, where the same method is
  160.     used whether you operate the 'N' option or not.
  161.  
  162.     When sending to the printer where 56 lines are typed between form
  163.     feeds, the first 220 files are alphabetized, etc.  This makes each
  164.     hard copy page somewhat independent of any others.
  165.  
  166.     These special features are difficult to describe.  They are quite
  167.     quite unique in performance and unlike other programs, such as "SD"
  168.     which originally offered only horizontal alphabetization.  This is
  169.     pretty difficult to scan rapidly for content, and much harder to de-
  170.     termine if a specific file exists on this system while looking at a
  171.     general listing.  DIRR alphabetizes vertically, which is more common
  172.     to general index listings and may be rapidly scanned for content.
  173.  
  174.     The header at the bottom has some very interesting information.
  175.     Here is one from a system using a 1 megabyte floppy disk drive:
  176.  
  177.         B: 984k   Used: 31/412k   Free:  97/572k
  178.  
  179.     This says the disk has 984k available to the user, 31 files and ex-
  180.     tents have been used totaling 412k leaving 572k and room for 97 more
  181.     file names.  Few other directory programs give all this information.
  182.     Some users frequently run out of room for new file names before they
  183.     exhaust all the disk space, so this information is very useful.
  184.  
  185.     Try DIRR, you may like it better than what you have been using.  In
  186.     any case, it has some quite unique features you are certain to like.
  187.     (Suggest you rename it to D.COM on your working disk as you can then
  188.     just type "D <ret>" to activate the program.  This is a lot easier
  189.     than typing "DIR <ret>" for the normal display - and display lots of
  190.     additional information as well.)
  191.  
  192.     It does have some modest drawbacks - it can only be used on one disk
  193.     drive at a time, has no provision for use with RCPM systems using a
  194.     wheel byte, and no means of limiting outside users to certain drives
  195.     or maximum user areas.  It is excellent however for local use on any
  196.     size disk system.
  197.  
  198.                     - Irv Hoff
  199.                       Los Altos Hills, CA
  200.                       (415) 948-2166 - voice
  201.  
  202.