home *** CD-ROM | disk | FTP | other *** search
/ Club Amiga de Montreal - CAM / CAM_CD_1.iso / files / 074.lha / DirMastr.doc < prev    next >
Text File  |  1986-11-20  |  16KB  |  406 lines
  1.                  DIRECTORY MASTER 1.0b  DOCUMENTATION FILE
  2.  
  3.                                    OR
  4.  
  5.                  A QUICK AND DIRTY APPROXIMATION OF A MANUAL
  6.  
  7.  
  8. Directory Master is a shareware disk catalog program.  Its features include:
  9.    Menu and Mouse driven interface
  10.    Multiple display modes
  11.    Input and output filtering
  12.    printer and file support
  13.    Customizable Input output and display
  14.    Quick record searches
  15.    Duplicate records search
  16.    Compare disk to database function
  17.    ...and more
  18.  
  19. -----------------------------------------------------------------------------
  20. -----------------------------------------------------------------------------
  21.                               SOME   TERMINOLOGY
  22.  
  23. Record - a database file, directory, or disk.
  24.  
  25. DISPLAYED RECORDS - all records that are either currently visible or may be
  26.                     made visible via the arrow or slider gadgets, or
  27.                     keyboard arrows.
  28.  
  29. DISPLAY list - same as DISPLAYED RECORDS.
  30.  
  31. -----------------------------------------------------------------------------
  32. -----------------------------------------------------------------------------
  33.                                 MENU OPTIONS
  34.  
  35. Directory Master 1.0b has the following menu structure:
  36. NOTE: The items in () are currently not implemented.
  37.  
  38. PROJECT              EDIT             UTILITIES     DISPLAY     CONFIGURE
  39. About                Add Disk         Find          Records     Colors
  40.   Directory Master   Update Disk        Records     Disks       Drive
  41.   Shareware          Append Database    Duplicates  Directories   df0:
  42. New                    All            Compare       Files         df1:
  43. Open                   No Extensions  Resort        Parent        (Custom)
  44.   All                  Custom           ASCII       Custom      (Page Length)
  45.   No Extensions      Delete             Numerical               Utilities
  46.   Custom               Records                                    (Open)
  47. Save                   Extensions                                 (Save)
  48. Save As                Custom                                     (Save As)
  49. Print                Type                                         (Reset All)
  50.   to printer           (Change)
  51.   to file              (Define)
  52. Help                   (Combine Type Files)
  53. Quit                   (Assign Defaults)
  54.  
  55.  
  56.                               PROJECT MENU
  57. ABOUT
  58.    Directory Master - some general comments on current version.
  59.    Shareware - explains shareware policy.
  60.  
  61. NEW - erases current database from memory.
  62.  
  63. OPEN
  64.    All - reads in all records from a selected database.
  65.    No Extensions - reads in a subset of records from a selected database.
  66.                    The excluded records are all FILES which are in the same
  67.                    directory AND have the same name BUT different extensions.
  68.                    The first FILE is read; the others are excluded.  For
  69.                    example, if a directory has the following files:
  70.                       arc
  71.                       arc.c
  72.                       arc.o
  73.                    then the only file (of these 3) read in to the database
  74.                    would be  arc  .  The included file is the alphabetically
  75.                    first file in the list. This option allows machines
  76.                    without extended memory to access more disks without
  77.                    really losing that much information.  For the Fish0 -
  78.                    Fish90 disks, this "saves" about 2000 files.  For the
  79.                    Amicus1 - Amicus16 disks, this "saves" about 600 files.
  80.  
  81.    Custom - reads in a custom FILE subset of a selected database.  See the 
  82.             description of the custom requester in the requesters section
  83.             for more details.  Also deletes disk and directory records that
  84.             have none of the custom FILES.
  85.  
  86.    NOTE:  In order to fix a bug in version 1.0a, I had to change the database
  87.           storage format.  This makes 1.0a databases incompatible with 1.0b
  88.           databases. -- SORRY.
  89.  
  90. SAVE - saves the current database in memory to the same database that was
  91.        last accessed or to "DirMaster.dbf" if no database was previously
  92.        used.
  93.  
  94.        WARNING:  DirMaster does NOT currently check to make sure there is
  95.                  enough  room on the disk before saving.
  96.  
  97. SAVE AS - same as above except saves the current database to a specified
  98.           file.
  99.  
  100. PRINT
  101.    to printer - prints the currently DISPLAYED RECORDS with the currently
  102.                 displayed fields to the printer.
  103.    to file - same as above except to a specified file.
  104.  
  105.    WARNING:  DirMaster does NOT currently check to make sure there is enough
  106.              room on the disk before printing.
  107.  
  108. HELP - a one screen online help function.
  109.  
  110. QUIT - erases current database from memory and exits.
  111.  
  112.  
  113.                                 EDIT MENU
  114.  
  115. ADD DISK - reads the disk on the currently selected drive and adds it to the
  116.            database.
  117.  
  118. UPDATE DISK - first deletes the highlighted disk, then adds the new disk back
  119.               into the database.
  120.  
  121. APPEND DATABASE - adds an existing database file to the database in memory.
  122.  
  123.    All - see the description for the OPEN option
  124.  
  125.    No Extensions - see the description for the OPEN option.
  126.  
  127.    Custom - see the description for the OPEN option.
  128.  
  129. DELETE - deletes records from the database in memory.
  130.  
  131.    Records - deletes the highlighted record.  If the record is a Disk or a
  132.              Directory, then all sub-records are also deleted.
  133.  
  134.    Extensions - deletes FILES in the same directory that have different
  135.                 extensions.  See the OPEN section for more details.
  136.                 NOTE:  This option acts on the entire database in memory.
  137.  
  138.    Custom - deletes a custom subset of FILES.  See the description of the
  139.             Custom requester.
  140.  
  141. TYPE - NOT CURRENTLY IMPLEMENTED (Projected Version: 1.1)
  142.    Change
  143.    Define
  144.    Combine Type Files
  145.    Assign Defaults
  146.  
  147.  
  148.                                UTILITY MENU
  149.  
  150. FIND
  151.    Record - brings up a special window which is used to locate specified
  152.             records.  All of the located record's fields are showm in full.
  153.             The records which may be FOUND are ONLY those records which are
  154.             currently DISPLAYED.  This window has the following functions:
  155.  
  156.                string gadget - stores the name of the record to be found.
  157.                                Wildcards are not allowed.
  158.  
  159.                OK - begins search on the name in the string gadget.
  160.  
  161.                CANCEL - returns to the main DirMaster display and to the same
  162.                         position as before FIND was invoked.  Also clears the
  163.                         string gadget.
  164.  
  165.                QUIT - returns to the main DirMaster display, at the position
  166.                       of the last found record.
  167.  
  168.                FIRST - shows the first record in the DISPLAY list.
  169.                        Keyboard ALT-UP_ARROW does the same.
  170.  
  171.                NEXT - shows the next record in the DISPLAY list.
  172.                       Keyboard DOWN_ARROW does the same.
  173.  
  174.                PREVIOUS - shows the previous record in the DISPLAY list.
  175.                           Keyboard UP_ARROW does the same.
  176.  
  177.                LAST - shows the LAST record in the DISPLAY list.
  178.                       Keyboard ALT-DOWN_ARROW does the same.
  179.  
  180.                NOTE: Keyboard SHIFT-ARROW will move through the list by 23
  181.                      records at a time (this is the "Page Length" option).
  182.  
  183.    Duplicates - DISPLAYS all duplicate records in the current DISPLAY list.
  184.                 You may specify which fields (NAME,SIZE,DATE) are to be used
  185.                 when searching for the duplicates.
  186.  
  187. COMPARE - Compares ALL the records on a disk to ALL the records in the
  188.           current database and outputs which records are NOT in the database.
  189.           A record is output if any of the fields (NAME,SIZE,DATE) are
  190.           different.  The records are always output to the screen and may be
  191.           output to a file and or the printer as well.  Records which scroll
  192.           off the screen may not be redisplayed.
  193.  
  194. RESORT
  195.    ASCII - Resorts the currently DISPLAYED RECORDS into alphabetical order.
  196.            For example:
  197.               Fish 1
  198.               Fish 10
  199.               Fish 11
  200.               Fish 2
  201.               Fish 20
  202.               Fish 21
  203.               Fish 3
  204.               Fish 4
  205.  
  206.    NUMERICAL - resorts the currently DISPLAYED RECORDS into "numerical"
  207.                order.  For example:
  208.                   Fish 1
  209.                   Fish 2
  210.                   Fish 3
  211.                   Fish 4
  212.                   Fish 10
  213.                   Fish 11
  214.                   Fish 20
  215.                   Fish 21
  216.  
  217.     NOTES: 
  218.       1. By default DISPLAYED DISKS and RECORDS are sorted numerically, and
  219.            DISPLAYED DIRECTORIES and FILES are sorted alphabetically.
  220.  
  221.       2. Multifield sorting will probably be provided in Version 1.1.
  222.  
  223.  
  224.                                CONFIGURE MENU
  225.  
  226. COLORS - NOT IMPLEMENTED (Projected version 1.1).
  227.  
  228. DRIVE
  229.    df0: - sets df0: as the default drive.
  230.    df1: - sets df1: as the default drive.
  231.    Custom - NOT IMPLEMENTED (projected version 1.1).
  232.  
  233. PAGE LENGTH - NOT IMPLEMENTED (projected version 1.1).
  234.  
  235. UTILITIES - NOT IMPLEMENTED (projected version 1.1).
  236.  
  237.  
  238. -----------------------------------------------------------------------------
  239. -----------------------------------------------------------------------------
  240.                            GADGETS AND REQUESTERS
  241.  
  242.                                   MAIN SCREEN
  243.  
  244. UP ARROW - scrolls the DISPLAY list up as long as the arrow is selected.
  245.            Keyboard UP_ARROW does the same.
  246.  
  247. DOWN ARROW - scrolls the DISPLAY list down as long as the arrow is selected.
  248.              Keyboard DOWN_ARROW does the same.
  249.  
  250.           NOTE:  Keyboard ALT-UP_ARROW moves to the beginning of the DISPLAY
  251.                  list and keyboard ALT-DOWN_ARROW move to the end of the
  252.                  DISPLAY list.
  253.  
  254. SLIDER - moves the current DISPLAY position to anywhere within the DISPLAY
  255.          list.  The current DISPLAY limits are continually calculated and
  256.          DISPLAYED as long as the slider gadget is selected.  Clicking in
  257.          the slider box above or below the "target" will move the DISPLAY
  258.          list one screenful.
  259.  
  260.          NOTE:  Keyboard SHIFT-ARROW does the same as clicking.
  261.  
  262.  
  263.  
  264.                              CUSTOM REQUESTER
  265.  
  266. This requester is used by the following options:
  267.    Open    - Custom
  268.    Append  - Custom
  269.    Delete  - Custom
  270.    Display - Custom
  271.  
  272. The custom requester allows you to specify a subset of the database to be
  273. used in the selected option.  It has the follwing structure.
  274.  
  275.  
  276. --------  -------  -----------  ----------------------  ---------  --------- 
  277. |BEFORE|  |AFTER|  |INCLUDING|  |                    |  |INCLUDE|  |EXCLUDE|
  278. --------  -------  -----------  ----------------------  ---------  ---------
  279.  
  280. --------  -------  -----------  ----------------------  ---------  --------- 
  281. |BEFORE|  |AFTER|  |INCLUDING|  |                    |  |INCLUDE|  |EXCLUDE|
  282. --------  -------  -----------  ----------------------  ---------  ---------
  283.  
  284. --------  -------  -----------  ----------------------  ---------  --------- 
  285. |BEFORE|  |AFTER|  |INCLUDING|  |                    |  |INCLUDE|  |EXCLUDE|
  286. --------  -------  -----------  ----------------------  ---------  ---------
  287.  
  288.  
  289.                      --------                   --------
  290.                      |  OK  |                   |CANCEL|
  291.                      --------                   --------
  292.  
  293.  
  294. The 3 string gadgets (in the center) allow you to type in record names which
  295. are then parsed according to the custom options you have selected.  The 
  296. "*" and "?" wildcards are allowed for the two columns of options on the right
  297. and are parsed as follows:
  298.    "*" = 0 or more occurrences of any character.
  299.    "?" = 1 occurrence of any character.
  300.  
  301. The "*" and "?" are treated as regular characters by the options on the left.
  302.  
  303. BEFORE - Selects all records before the specified record.
  304. AFTER  - selects all records after the specified record.
  305. INCLUDING - includes the specified record.
  306.  
  307. INCLUDE - includes the specified records in the OPTION list.
  308. EXCLUDE - excludes the specified records in the OPTION list.
  309.  
  310. NOTES:
  311.    1.  When specifying more than one custom string, the order is important.
  312.        The first EXCLUDE, if selected, excludes all records that do not match
  313.        the specified record. The second and third excludes, if selected, will
  314.        exclude records from the list selected by the first row of options.
  315.  
  316.    2.  The INCLUDE gadgets are cumulative (order should not matter).
  317.  
  318.    3.  The custom Display and Delete option work only on the current DISPLAY
  319.        list.
  320.  
  321.    4.  BEFORE and AFTER are mutually exclusive. INCLUDING may be selected
  322.        with  either.
  323.  
  324.    5.  INCLUDE and EXCLUDE are mutually exclusive.
  325.  
  326.  
  327. WARNING: This does not corretly parse a combination like:
  328.                       *.c  -  INCLUDE
  329.            BEFORE  -  g
  330.  
  331.    This SHOULD mean: include ALL *.c files AND ALL records before "g".  It
  332.    is currently interpeted as: include ALL records before "g".
  333.    However, specifying
  334.            BEFORE  -  g
  335.                       *.c  -  INCLUDE
  336.    gives the expected results.
  337.  
  338.  
  339.  
  340.                             DISPLAY FIELDS REQUESTER
  341.  
  342. Double clicking on the right mouse button allows you to select which fields
  343. you want to DISPLAY.  NAME is always displayed.  You may select any
  344. combination of the other fields (SIZE, DATE, PATH).
  345.  
  346.  
  347. -----------------------------------------------------------------------------
  348. -----------------------------------------------------------------------------
  349.                                    MOUSE
  350.  
  351. The following special mouse functions are implemented:
  352. 1. Double clicking the left mouse button on a disk or directory will DISPLAY
  353.    all of the sub-records in that disk or directory.  Double clicking on a
  354.    file will bring up the FIND window.
  355.  
  356. 2. Single clicking the left mouse button on a record will highlight that
  357.    record.  Some of the menu options use highlighted records.
  358.  
  359. 3.  Double clicking the right mouse button brings up the Display Fields
  360.     requester.
  361.  
  362.  
  363. -----------------------------------------------------------------------------
  364. -----------------------------------------------------------------------------
  365.                           SOME APPROXIMATE STATISTICS
  366.  
  367.  
  368.                                 TOTAL RECORDS
  369.  
  370. MEMORY         RECORDS
  371. 512K             5000  (for partial functionality. Full functionality = 4500)
  372. 1.5M            22000
  373. 2.5M            38000
  374.    
  375.  
  376.                              SORT AND SEARCH TIMES
  377.  
  378. RECORDS      SORT TIME        SEARCH TIME (worst case)
  379. 10000        30 sec                 2 sec
  380. 38000        2min 30 sec            4 sec
  381.  
  382.  
  383. -----------------------------------------------------------------------------
  384. -----------------------------------------------------------------------------
  385.                         SUGGESTIONS ??  CRITICISMS ??
  386.  
  387. I have received many excellent suggestions, bug reports, etc.  Most of the
  388. known bugs have been fixed and many of the suggestions have been implemented
  389. or will be implemented.  I appreciate these inputs as they help make
  390. Directory Master a better product.
  391.  
  392. If you have any comments, suggestions, criticisms, etc., or would like to see
  393. other features implemented in DirMaster, please let me know.  I am hoping to
  394. make version 1.1 the final version and be finished in December 87.  So, if
  395. you have some inputs, please try to get them to me by the end of November.
  396. Thanks.
  397.  
  398.  
  399.                             Greg Peters
  400.                             1032 Middy Drive
  401.                             WPAFB, OHIO 45433
  402.  
  403.                             BIX: gpeters
  404.  
  405. -----------------------------------------------------------------------------
  406.