home *** CD-ROM | disk | FTP | other *** search
/ Media Share 9 / MEDIASHARE_09.ISO / private / dskkat21.zip / DISKKAT.DOC next >
Text File  |  1993-01-28  |  50KB  |  1,388 lines
  1.  
  2.  
  3.                       Diskette Catalog System User's Manual
  4.  
  5.  
  6.  
  7.                            OVERVIEW
  8.                            --------
  9.  
  10.    The Diskette Catalog System is designed to help organize those unwieldy
  11.    floppy disks full of software.  Anyone, especially BBS Sysops, who may have
  12.    a hard time keeping track of their software will benefit greatly from this
  13.    system.  The basic philosophy of the Diskette Catalog System is to have a
  14.    number of diskettes, each containing programs archived using your favorite
  15.    compression utility.  Since many archived applications can fit onto one
  16.    floppy disk, the Diskette Catalog System facilitates easy organization of
  17.    these disks and location of programs.
  18.  
  19.    Some major features include:
  20.  
  21.         o  Quick and easy to use.  The system is designed to do as much of
  22.            the work for you as possible.
  23.  
  24.         o  Automatic creation of database files and indexes.
  25.  
  26.         o  Intuitive database layout.  The system maintains a parent/child
  27.            relationship of disks to files on each disk.
  28.  
  29.         o  Input screens and database maintenance which closely resemble
  30.            the layout of the database itself.
  31.  
  32.         o  Automatic loading of the database by reading the floppy disk
  33.            directory and automatically adding or updating entries in the
  34.            database.
  35.  
  36.         o  Various listings and reports with the ability to dynamically
  37.            create different sorts and searches.  Each report can be
  38.            printed or viewed on-screen.
  39.  
  40.         o  Printing of diskette jacking inserts listing file names, sizes
  41.            and available space on each diskette.
  42.  
  43.         o  Quick search of database by archive name.
  44.  
  45.  
  46.    INSTALLING THE DISKETTE CATALOG SYSTEM:
  47.         The Diskette Catalog System must be installed on the hard drive
  48.         in order to run.  To do this, create a directory called "DISKKAT"
  49.         off of your root directory.  Copy all of the files from the
  50.         diskette to this directory.  If you received the program in
  51.         archived format, simply extract all of the files from the archive
  52.         to the "DISKKAT" directory.
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                        -1-
  64.  
  65.  
  66.  
  67.  
  68.  
  69.                       Diskette Catalog System User's Manual
  70.  
  71.  
  72.  
  73.  
  74.    HISTORY OF THE DISKETTE CATALOG SYSTEM
  75.    --------------------------------------
  76.    The Diskette Catalog System was created basically as a personal
  77.    application to manage the software I had collected over the past few
  78.    years.  I had always used archivers and disk covers, (diskette
  79.    inserts) to manage my software but never really found a good database
  80.    product to store and retrieve all of the
  81.    information.
  82.  
  83.    Program and database files were originally generated to run under dBASE
  84.    III with the use of GENIFER, Application Generator for xBASE products.
  85.    After the database started getting large, I decided to compile the code
  86.    using Clipper, version Summer '86.  This proved to be a powerful
  87.    decision, albeit tedious because many modifications had to be made to
  88.    accommodate the differences between Clipper and dBASE.
  89.  
  90.    The various features in the program have been added through time to
  91.    facilitate my unforeseen needs and to also exploit the enhancements to
  92.    the Clipper product from Summer '86 version and Summer '87 version.  In
  93.    addition, the Funcky Library for Clipper was used to add pick lists and
  94.    browse windows, along with some system level functions which aren't seen
  95.    by the user.  For example, reading floppies is implemented through the
  96.    use of Funcky library functions.
  97.  
  98.    The Blinker Dynamic Overlay Linker was used to quickly and efficiently
  99.    link all of the object code to the executable.  Blinker provides many
  100.    features, including built-in functions for EMS/XMS management, internal
  101.    error checking and incremental linking.
  102.  
  103.    The code has been highly optimized and functions and procedures called
  104.    throughout the program have been put into a standard library.  These
  105.    functions and procedures were derived directly from the code generated
  106.    by GENIFER and enhanced as the system grew.
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                        -2-
  130.  
  131.  
  132.  
  133.  
  134.  
  135.                       Diskette Catalog System User's Manual
  136.  
  137.  
  138.  
  139.    OVERVIEW OF EDITING KEYS
  140.         During operation of the Diskette Catalog System, there are
  141.         certain keys used to input and edit the data.  The keyboard is
  142.         divided into 3 major parts.
  143.         o    Regular typewriter keys used for entering letters,
  144.              numbers and special symbols (such as !,@,#,$,%,^,& etc).
  145.  
  146.         o    Programmable Function Keys (F1, F2 F3, F4, F5, F6, F7, F8,
  147.              F9, F10).  These keys are currently not used by the
  148.              Diskette Catalog System.
  149.  
  150.         o    Data editing and entry keys (Home, End, PgUp, PgDn,
  151.              Backspace, the 4 Arrows, Ins, Del, Enter/Return).  If you
  152.              have an enhanced keyboard, there will be an additional
  153.              set of keys data entry keys.
  154.  
  155.         The following is an  explanation of each of the keys mentioned
  156.         above:
  157.  
  158.         Regular Typewriter Keys:  These are the number and letter keys
  159.         such as those on a typewriter.  The SHIFT keys are used to enter
  160.         capital letters or the top characters on the number keys (top row
  161.         of the keyboard).
  162.  
  163.         Programmable Function Keys:  These are special function keys that
  164.         some programs use to do certain tasks and are currently not used
  165.         by the Diskette Catalog System.
  166.  
  167.         Data Editing and Entry Keys:  These keys are used to enter a
  168.         screen full of information, change information in a specific data
  169.         entry block or move around the data entry screen.  These keys are
  170.         the white keys located on the right hand side of the keyboard
  171.         (the numeric keypad), or the set of keys between the numeric
  172.         keypad and regular typewrite keys if you have an enhanced
  173.         keyboard.  The following is a description of how these keys
  174.         behave in the Diskette Catalog System:
  175.  
  176.         o    Home - When this key is pressed, it will take the cursor to
  177.              the beginning of the current input field (data entry block)
  178.  
  179.         o    End - This is the same as the Home key except that it will
  180.              move the cursor to the end of the data entry block.  If
  181.              the data entry block is not full, the cursor will stop at
  182.              the space after the last non-space character in the
  183.              field.
  184.  
  185.         o    PgUp, PgDn - These keys, when pressed, will cause the
  186.              program to terminate Data Entry mode and accept the current
  187.              screen full of information.  You will then be asked if you
  188.              want to save the current information.
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                        -3-
  196.  
  197.  
  198.  
  199.  
  200.  
  201.                       Diskette Catalog System User's Manual
  202.  
  203.  
  204.  
  205.              o    BackSpace - This key is used to move the cursor one
  206.                   space to the left and delete the character that is
  207.                   there.  This used to correct any typing mistakes.
  208.  
  209.              o    Ins - This key will toggle insert mode on and off.
  210.                   When insert mode is on, all characters that are typed
  211.                   will push any existing characters to the right.
  212.                   Pressing this key again will turn off insert mode.
  213.  
  214.              o    Del - This key will delete the character that the
  215.                   cursor is currently on and move all characters ahead of
  216.                   the cursor one space to the left.
  217.  
  218.              o    Left Arrow - This will move the cursor one character to
  219.                   the left.  If the cursor is at the beginning of a
  220.                   field, it will move to the last character in the
  221.                   previous field.
  222.  
  223.              o    Right Arrow - This will move the cursor one character
  224.                   to the right.  If the cursor is at the end of a field,
  225.                   it will move to the first character in the next field.
  226.  
  227.              o    Up Arrow - This key will move the cursor to the
  228.                   beginning of the previous field.  If the cursor is at
  229.                   the first field on the screen, this key will have no
  230.                   effect.
  231.  
  232.              o    Down Arrow - This key will move the cursor to the
  233.                   beginning of the next field. If the cursor is at the
  234.                   last field on the screen, this key will have no effect.
  235.  
  236.              o    Enter/Return - This key will advance the cursor to the
  237.                   next field on the screen.  If the cursor is on the last
  238.                   field on the screen, input mode ends and you will be
  239.                   asked if you want to save the current information.
  240.  
  241.              o    Caps Lock - When this key is pressed, the "Caps Lock"
  242.                   light will come on.  This will cause all alphabetic
  243.                   characters to be typed in upper case.
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.                                        -4-
  262.  
  263.  
  264.  
  265.  
  266.  
  267.                       Diskette Catalog System User's Manual
  268.  
  269.  
  270.  
  271.    USING THE DISKETTE CATALOG SYSTEM:
  272.    To start the system, change to the diskette catalog directory and type
  273.    "diskkat" and press the ENTER key.
  274.  
  275.    The system will create any database files and index files which are
  276.    necessary for the system to run and then will produce the following
  277.    menu:
  278.  
  279.           ┌───────────────────────────────────────────────────────────┐
  280.           │                 Diskette Catalog System                   │
  281.           │    Version 2.1                                 5:35 pm    │
  282.           └───────────────────────────────────────────────────────────┘
  283.  
  284.  
  285.  
  286.                            ┌───────────────────────────┐
  287.                            │        Main Menu          │
  288.                            │                           │
  289.                            │  Maintain Disk Catalog    │
  290.                            │  Search by Archive Name   │
  291.                            │  Browse Database          │
  292.                            ├───────────────────────────┤
  293.                            │      Listings Menu        │
  294.                            │      Utilities Menu       │
  295.                            ├───────────────────────────┤
  296.                            │      Quit to DOS          │
  297.                            └───────────────────────────┘
  298.  
  299.    This is the main system menu.  The following is a description of the
  300.    available menu choices:
  301.  
  302.               Maintain Disk Catalog:  This option will bring up a data
  303.                                       entry screen used to add, delete,
  304.                                       modify and search through
  305.                                       the database.
  306.  
  307.              Search by Archive Name:  Quick search the database by
  308.                                       archive Name name. The search
  309.                                       string can be a full or partial
  310.                                       filename.
  311.  
  312.                     Browse Database:  Pops up a window to browse the
  313.                                       database sorted by archive name.
  314.  
  315.                       Listings Menu:  Brings you to a submenu where other
  316.                                       options allow you to create various
  317.                                       listings of the database.
  318.  
  319.                      Utilities Menu:  Brings you to a submenu where other
  320.                                       options allow you to perform
  321.                                       various utility functions.
  322.  
  323.                         Quit to DOS:  This option terminates the Diskette
  324.                                       Catalog System and returns to DOS.
  325.  
  326.  
  327.                                        -5-
  328.  
  329.  
  330.  
  331.  
  332.  
  333.                       Diskette Catalog System User's Manual
  334.  
  335.  
  336.  
  337.    DETAILED DESCRIPTION OF THE DISKETTE CATALOG SYSTEM
  338.    The section describes, in detail, all of the above functions.
  339.  
  340.    Maintain disk catalog
  341.    ---------------------
  342.    When you select this option, the following screen will appear:
  343.  
  344.       ┌──────────────────────────────────────────────────────────────┐
  345.       │            Diskette Catalog System V2.1                      │
  346.       ├──────────────────────────────────────────────────────────────┤
  347.       │                                                              │
  348.       │   Disk Number:                       Free Space:             │
  349.       │                                                              │
  350.       ├──────────────────────────────────────────────────────────────┤
  351.       │                                                              │
  352.       │                                                              │
  353.       │                                                              │
  354.       │                                                              │
  355.       │                                                              │
  356.       │                                                              │
  357.       │                                                              │
  358.       └──────────────────────────────────────────────────────────────┘
  359.  
  360.       This is the maintenance screen associated with the DISKS datafile.
  361.       From this initial screen there are only two fields which are
  362.       displayed:
  363.  
  364.             Disk Number:   This is the diskette number.  The value is a 4
  365.                            character numeric-only field.  For example
  366.                            "0001".  This is the key field in the "DISKS"
  367.                            file.  See Appendix B for a description
  368.                            of the files and file layouts.
  369.  
  370.              Free Space:   The amount of free space available on the
  371.                            diskette.  Valid data for this field is
  372.                            currently a numeric value ranging from 0 to
  373.                            1,457,664 (1.44m).
  374.  
  375.       NOTE: If the database is empty when you first enter this screen, the
  376.             system will automatically go into Add mode to allow you to
  377.             input new data.
  378.  
  379.  
  380.  
  381.  
  382.  
  383.  
  384.  
  385.  
  386.  
  387.  
  388.  
  389.  
  390.  
  391.  
  392.  
  393.                                        -6-
  394.  
  395.  
  396.  
  397.  
  398.  
  399.                       Diskette Catalog System User's Manual
  400.  
  401.  
  402.  
  403.    The following menu will appear on the right hand side of the screen:
  404.  
  405.                            ┌──────┐
  406.                            │ Add  │
  407.                            │ Del  │
  408.                            │ Copy │
  409.                            │ Modi │
  410.                            │ Ret  │
  411.                            │ Beg  │
  412.                            │ End  │
  413.                            │ Prev │
  414.                            │ Next │
  415.                            │ Skip │
  416.                            │ Filt │
  417.                            │ List │
  418.                            │ Tally│
  419.                            │ Zoom │
  420.                            │ Help │
  421.                            │ Quit │
  422.                            └──────┘
  423.  
  424.         This is a list of functions that can be done while within the
  425.         diskette maintenance screen.  The following is a description of
  426.         each choice and its function.
  427.  
  428.            Add:   When this option is chosen, the input blocks on the
  429.                   screen will be blanked out (the current record will
  430.                   have already be saved) and the cursor will be positioned
  431.                   on the first data entry block on the screen.  Use this
  432.                   option for new inputs.
  433.  
  434.            Del:   When this choice is made, the program will verify the
  435.                   deletion.  Answer "Y" at this point to delete the current
  436.                   record.  The current record is not actually physically
  437.                   removed from the file but is marked for later removal.
  438.                   See the "Quit" option below.
  439.  
  440.           Copy:   This option is used to copy the current record to another
  441.                   record.  All of the current information on the record is
  442.                   duplicated exactly and the program goes into Modify mode.
  443.                   One good use of this option is in the case of a similar
  444.                   archive name.  You could simply copy the record and
  445.                   change the filename.
  446.  
  447.         Modify:   This option will modify the current record displayed on the
  448.                   screen.  All that you will see happen is the cursor will
  449.                   advance to the first input block at the top of the input
  450.                   screen.  Use this option to change any or all data on the
  451.                   current input screen.
  452.  
  453.  
  454.  
  455.  
  456.  
  457.  
  458.  
  459.                                        -7-
  460.  
  461.  
  462.  
  463.  
  464.  
  465.                       Diskette Catalog System User's Manual
  466.  
  467.  
  468.  
  469.            Ret:   When this option is chosen, all of the input blocks
  470.                   within the current maintenance screen will be cleared
  471.                   except for the first input block.  The retrieval field
  472.                   will be the "Disk Number" field or "Archive Name" if
  473.                   you've previously used the Zoom option.
  474.  
  475.                   Simply enter the desired field value and the system will
  476.                   bring the first record matching the input string up on
  477.                   the screen (if the record currently exists). If no record
  478.                   matches the key field (Disk Number or Archive Name) the
  479.                   message "Not Found" will be displayed.  Press return to
  480.                   clear the message.
  481.  
  482.            Beg:   When this option is chosen, the system will display the
  483.                   first record in the database.  If you have set a filter
  484.                   (See the FILT option), the first record matching the
  485.                   filter will be displayed.
  486.  
  487.            End:   This is the same option as Beg except it displays the
  488.                   last record on file (or the last record matching the
  489.                   filter).
  490.  
  491.            Prev:  This choice will move to the record that comes just
  492.                   before the current record.  If the current record is the
  493.                   first record in the data file, the program will display
  494.                   the message "First Record" on the screen.  Press ENTER to
  495.                   go back to the list of options.
  496.  
  497.            Next:  This choice will advance to the next record in the
  498.                   database or the next record matching the filter.  If the
  499.                   current record is the last record, the program will
  500.                   display "Last Record" on the screen.  Press the ENTER
  501.                   key to clear the message.
  502.  
  503.            Skip:  This option will allow you to skip a specified number of
  504.                   records forward or backward.  When this choice is made,
  505.                   simply enter the number of records to skip at the "Recs"
  506.                   prompt.  If you wish to go back a certain number of
  507.                   records, precede the number with a minus sign "-".
  508.  
  509.            Filt:  This option will allow you to set a filter (group)
  510.                   on records in the database.  A filter is simply a
  511.                   selection of the records that match a particular
  512.                   condition.  To set the filter, choose "F" at the option
  513.                   line.  You will be asked if you want to set the filter.
  514.                   Answer "Y" at this point.  The data entry blocks will be
  515.                   cleared and it will appear as if you are entering a new
  516.                   record.  At this point, enter the information that you
  517.                   want to be "part of the condition".  If you select this
  518.                   option with a filter already set, select "C" for cancel
  519.                   to remove the filter.
  520.  
  521.  
  522.  
  523.  
  524.  
  525.                                        -8-
  526.  
  527.  
  528.  
  529.  
  530.  
  531.                       Diskette Catalog System User's Manual
  532.  
  533.  
  534.  
  535.         List:     The List option will display all records in the data
  536.                   file starting at the current record.  The program will
  537.                   display only one screen full of records at a time.  If
  538.                   there are more records to be displayed the prompt
  539.                   "More? [Y]" will be displayed at the bottom of the
  540.                   screen.  If you are done viewing the list, enter "N" to
  541.                   this prompt.  If the last record was displayed, the
  542.                   prompt "OK." will appear at the bottom of the screen.
  543.                   At this point hit any key to return to the requisition
  544.                   maintenance screen.
  545.  
  546.         Tally:    This function will simply display a count all of the
  547.                   records in the current data file.  If a filter has been
  548.                   set, the total number of records matching the current
  549.                   filter condition will be displayed.
  550.  
  551.         Zoom:     This option will "zoom" in on child records of the
  552.                   current parent database.  If you have already used this
  553.                   option, and are currently viewing child records, this
  554.                   option will not have any effect.  See "DESCRIPTION OF
  555.                   THE PARENT/CHILD RELATIONSHIP:" below.
  556.  
  557.         Help:     Display quick help screen.  Later versions of the
  558.                   Diskette Catalog System will provide context sensitive
  559.                   help.
  560.  
  561.         Quit:     Quit current operation.  If you are currently viewing
  562.                   child records in the database (filename information),
  563.                   this option will clear the bottom half of the screen
  564.                   and return to the "disks" information screen. If you
  565.                   are already at the "disks" screen, this option will
  566.                   quit back to the main menu.  If any records have been
  567.                   deleted, you will be asked if you want to pack all
  568.                   deleted records.  Packing physically discards all
  569.                   records flagged for deletion with the "Del" command.
  570.  
  571.  
  572.  
  573.  
  574.  
  575.  
  576.  
  577.  
  578.  
  579.  
  580.  
  581.  
  582.  
  583.  
  584.  
  585.  
  586.  
  587.  
  588.  
  589.  
  590.  
  591.                                        -9-
  592.  
  593.  
  594.  
  595.  
  596.  
  597.                       Diskette Catalog System User's Manual
  598.  
  599.  
  600.  
  601.    When you select "ZOOM" from the menu, the system will display file
  602.    information matching the diskette number.  The following is an example
  603.    of what the screen will look like:
  604.  
  605.    ┌──────────────────────────────────────────────────────────────┐  ┌──────┐
  606.    │            Diskette Catalog System V2.1                      │  │ Add  │
  607.    ├──────────────────────────────────────────────────────────────┤  │ Del  │
  608.    │                                                              │  │ Copy │
  609.    │   Disk Number:                       Free Space:             │  │ Modi │
  610.    │                                                              │  │ Ret  │
  611.    ├──────────────────────────────────────────────────────────────┤  │ Beg  │
  612.    │                                                              │  │ End  │
  613.    │  Archive Name:                      Archive Size:            │  │ Prev │
  614.    │                                                              │  │ Next │
  615.    │   Actual Size:                      Archive Type:            │  │ Skip │
  616.    │                                                              │  │ Filt │
  617.    │   Description:                                               │  │ List │
  618.    │                                                              │  │ Tally│
  619.    └──────────────────────────────────────────────────────────────┘  │ Zoom │
  620.                                                                      │ Help │
  621.                                                                      │ Quit │
  622.                                                                      └──────┘
  623.  
  624.         The following is a description of the fields associated with the
  625.         FILES database:
  626.  
  627.         Archive Name:  This is the name of the file on the diskette.
  628.                        Since this is a key field in the database, this
  629.                        field must be filled and must not be a duplicate
  630.                        for the current diskette.  You can, however, have
  631.                        two archive names on different diskettes.
  632.  
  633.         Archive Size:  This is the size of the archive file. This field
  634.                        can currently be from 0 to 1,457,664. (1.44M)
  635.  
  636.         Actual Size:   If you know the size of the program in its
  637.                        uncompressed form, enter that value here.  This
  638.                        field is not required.
  639.  
  640.  
  641.  
  642.  
  643.  
  644.  
  645.  
  646.  
  647.  
  648.  
  649.  
  650.  
  651.  
  652.  
  653.  
  654.  
  655.  
  656.  
  657.                                       -10-
  658.  
  659.  
  660.  
  661.  
  662.  
  663.                       Diskette Catalog System User's Manual
  664.  
  665.  
  666.  
  667.         Archive Type:  The Diskette Catalog System classifies files by
  668.                        type.  This field is very powerful and is used on
  669.                        the reports to retrieve files by category. For
  670.                        example you could generate a listing of all
  671.                        "Windows" application files in your library. If
  672.                        you do not enter a file type, the following pop-up
  673.                        screen will appear:
  674.  
  675.                             ┌───────────────────────────┐
  676.                             │ C - Communications        │
  677.                             │ E - Text Editors          │
  678.                             │ L - Languages             │
  679.                             │ S - Source Code           │
  680.                             │ D - Desktop Applications  │
  681.                             │ G - Graphics              │
  682.                             │ R - Games                 │
  683.                             │ T - Text Files            │
  684.                             │ U - Utilities             │
  685.                             │ W - Windows Applications  │
  686.                             │ X - Unclassified          │
  687.                             ├───────────────────────────┤
  688.                             │ Select File Type          │
  689.                             └───────────────────────────┘
  690.  
  691.                             Use the arrow keys to highlight the desired
  692.                             file type and press return.  The File Type
  693.                             field will be updated with the type you chose.
  694.  
  695.         Description:   This is a 30 character field used to describe the
  696.                        file.  This field is not required, but is very
  697.                        useful when used.
  698.  
  699.         After filling in the Description field (or hitting "PgDn"), the
  700.         system will ask if you want to save the record.  Select "Yes" to
  701.         save the record or "No" to discard the record.  If you select
  702.         "NO" and the record is the first record (ie the first file on the
  703.         diskette), the input screen will clear and return you to the disk
  704.         information screen (the top half of the screen).
  705.  
  706.              NOTE:  The Diskette Catalog System is designed to allow automatic
  707.                     adding.  For example, when you select "add" from the menu
  708.                     (or the record is the first one related to the current
  709.                     disk), the system will continually add records until you
  710.                     hit ESCape.
  711.  
  712.  
  713.  
  714.  
  715.  
  716.  
  717.  
  718.  
  719.  
  720.  
  721.  
  722.  
  723.                                       -11-
  724.  
  725.  
  726.  
  727.  
  728.  
  729.                       Diskette Catalog System User's Manual
  730.  
  731.  
  732.  
  733.    Search by Archive Name
  734.    ----------------------
  735.  
  736.    Selecting this option from the main menu will allow you to search the
  737.    database for a whole or partial archive name and display the
  738.    associated information for all records matching the search string.
  739.    When you select this option, the following pop-up window will appear:
  740.  
  741.                      ┌─────────────────────────┐
  742.                      │                         │
  743.                      │  Title: _____________   │
  744.                      │                         │
  745.                      └─────────────────────────┘
  746.  
  747.    At this point, enter the full or partial filename to be searched for.
  748.    For example, if you wanted to see all files beginning with "PC", enter
  749.    "PC" at this prompt.  The system will search the database and display
  750.    all records whose archive name begins with "PC".  Each record will be
  751.    displayed in the following pop-up window:
  752.  
  753.        Search Key: "PC"
  754.        ┌─────────────────────────────────────────────────────────────────┐
  755.        │                                                                 │
  756.        │    Disk Number: 0065     Archive Name: PC-ART.ZIP               │
  757.        │                                                                 │
  758.        │   Archive Size: 80,594                                          │
  759.        │                                                                 │
  760.        │    Description: PC-ART STUDIO (LIKE PC PAINT)                   │
  761.        │                    ┌───────────────┐                            │
  762.        └────────────────────┤     More?     ├────────────────────────────┘
  763.                             │               │
  764.                             │   YES   NO    │
  765.                             └───────────────┘
  766.  
  767.         Selecting "YES" will display the next record matching "Search
  768.         Key"; Selecting "NO" will return to the main menu.
  769.  
  770.    BROWSE DATABASE
  771.    ---------------
  772.    This option will allow you to browse through the entire database in a
  773.    pop-up window.  The Disk Number, Archive Name, Description and file
  774.    type will all be displayed in a scrolling window.  See appendix A for
  775.    a list of keys to use while within this window.
  776.  
  777.    LISTINGS MENU
  778.    -------------
  779.    The listings menu contains many options for displaying data within the
  780.    Diskette Catalog System database.  All reports have been standardized
  781.    to function the same way.  This section explains the available menu
  782.    choices.  The follow section describes the steps involved in
  783.    generating each of the listings.
  784.  
  785.  
  786.  
  787.  
  788.  
  789.                                       -12-
  790.  
  791.  
  792.  
  793.  
  794.  
  795.                       Diskette Catalog System User's Manual
  796.  
  797.  
  798.  
  799.    The following is the listings menu:
  800.  
  801.                            ┌───────────────────────────┐
  802.                            │      Listings Menu        │
  803.                            │                           │
  804.                            │   Archive Name Listing    │
  805.                            │   Disk Number Listing     │
  806.                            │   Summary Disk Listing    │
  807.                            ├───────────────────────────┤
  808.                            │   Quit Listings Menu      │
  809.                            └───────────────────────────┘
  810.  
  811.          ARCHIVE NAME LISTING
  812.          --------------------
  813.          This choice will list the database sorted by archive name.  The
  814.          following is a list fields, in order, which are included on this
  815.          report:
  816.  
  817.             o  Archive Name
  818.             o  File Type
  819.             o  Description
  820.             o  Archive Size
  821.             o  Diskette Number
  822.  
  823.          See the section "Running Reports" below for details of how to run
  824.          this and other report listings.
  825.  
  826.          DISK NUMBER LISTING
  827.          -------------------
  828.          This choice will list the database sorted by diskette number.  The
  829.          records will be listed first by diskette number and then by
  830.          archive names associated with each diskette number.  The following
  831.          fields are included on this report:
  832.  
  833.             o  Diskette Number
  834.             o  Archive Name
  835.             o  Description
  836.             o  Archive Size
  837.             o  File Type
  838.  
  839.          See the section "Running Reports" below for details of how to run
  840.          this and other report listings.
  841.  
  842.          SUMMARY DISK LISTING
  843.          --------------------
  844.          This choice will list the FILES database sorted by diskette
  845.          number.  The following fields are included on this report:
  846.  
  847.             o  Diskette Number
  848.             o  Bytes Free
  849.  
  850.          This report is useful when trying to fit new files into the
  851.          diskette database.  Since there are only two fields on this
  852.          report, each record on this listing is unique; therefor, there is
  853.          no option for setting a filter (See below).
  854.  
  855.                                       -13-
  856.  
  857.  
  858.  
  859.  
  860.  
  861.                       Diskette Catalog System User's Manual
  862.  
  863.  
  864.  
  865.    RUNNING REPORTS
  866.    ---------------
  867.    Although the Diskette Catalog System can generate various reports,
  868.    they all function the same way; with the exception of the Summary
  869.    Diskette Listing, which only has sorting options.  Each report has
  870.    options for specifying sort criteria, filter, and the option of
  871.    viewing the report on the screen or sending output to the printer.
  872.  
  873.    Specifying a Sort
  874.    -----------------
  875.    When each report starts, a "YES/NO" box will be displayed asking if a
  876.    special sort is required.  Selecting "YES" will display the fields in
  877.    the FILES datafile in a pick list.  Simply select the desired field.
  878.    You will then be asked if you want to add more fields to the sort.
  879.    Selecting "YES" will display a "+" on the "Sort Expression" line and the
  880.    field pick list will be displayed.  You can continue to pick field names
  881.    in this manner until the desired sort criteria is met.  The following is
  882.    an example:
  883.  
  884.         To sort the database on filenames within file type do the
  885.         following:
  886.            o  Select "YES" from the "Special Sort Required" dialog box.
  887.            o  Select "F_TYPE" from the field name pick list.  (See appendix
  888.               B for a list of field names).
  889.            o  Select "YES" at the "More?" prompt.
  890.            o  Select "ARC_NAME" from the field pick list
  891.            o  Select "NO" at the "More?" prompt.
  892.  
  893.            Notice how the "Sort Expression" line contains the fields you
  894.            chose for the special sort.  This line should look like the
  895.            following:
  896.  
  897.            Sort Expression: [ F_TYPE+ARC_NAME ]
  898.  
  899.    Specifying a Filter
  900.    -------------------
  901.    A filter is simply a way of including only those records that match a
  902.    certain condition.  After selecting the sort expression (or answering
  903.    "NO" to "Special Sort Required?"), the system will ask if you want to
  904.    set a filter.  If you specify "YES", the system will display a list of
  905.    field names.
  906.  
  907.    Simply select the field name you want to include in the filter
  908.    expression.  This pick list is the same as the sort pick list. After you
  909.    select the field name, you will be prompted for the equality operator to
  910.    use (<, >, <>, =, $).  This pick list is self explanatory.  Simply select
  911.    the operator to use.
  912.  
  913.    After selecting the operator, the system will prompt for the value of
  914.    the field you picked.  You can basically type anything you want in this
  915.    field but if it includes invalid data, you will receive an error.  Note
  916.    how the "Filter Expression" line contains the fields and values as you
  917.    build the filter.  See the example below for details.
  918.  
  919.  
  920.  
  921.                                       -14-
  922.  
  923.  
  924.  
  925.  
  926.  
  927.                       Diskette Catalog System User's Manual
  928.  
  929.  
  930.  
  931.    Next, the system will ask if you want to include more fields in the
  932.    filter expression.  If you selecting "YES", another pick list will
  933.    appear with ".and." and ".or." as choices.  Simply choose the
  934.    appropriate conjunction.  You will then be prompted with another field
  935.    name list.
  936.  
  937.    Repeat the above process until you have chosen all of the conditions
  938.    you want in the filter.
  939.  
  940.    This example will describe the steps necessary to create a listing
  941.    which includes all unclassified files (F_TYPE="X") whose description
  942.    contains the characters "PC".
  943.  
  944.    After selecting the sort criteria, the following steps will create the
  945.    proper filter expression:
  946.  
  947.            o  Select "YES" at the "Set Filter?" prompt.
  948.            o  Select "F_TYPE" from the field pick list.
  949.            o  Use the arrow keys to select "=" from the operator pick list
  950.            o  Enter "X" at the "Enter value for F_TYPE" prompt
  951.            o  Choose "YES" at the "More? prompt.
  952.            o  Select ".and." from the boolean operator pick list.
  953.            o  Select "DESCR" from the field pick list.
  954.            o  Use the arrow keys to select "$" from the operator pick list
  955.            o  Enter "PC" at the "Enter value for F_TYPE" prompt
  956.            o  Choose "NO" at the "More?" prompt.
  957.  
  958.    Notice how the "Filter Expression" line contains the filter as it's
  959.    being assembled.  The line should look like the following:
  960.        Filter expression: [ F_TYPE = "X" .and. 'PC' $ DESCR ]
  961.  
  962.    This filter expression will include all records in the database whose
  963.    file type is "X" and has the characters "PC" anywhere in the
  964.    description (the "$" operator means "is a substring of...".
  965.  
  966.    Generating the Report
  967.    ---------------------
  968.    After selecting the sort criterion and filter expressions, you will be
  969.    asked if you want the report to go to the printer, screen or if you
  970.    want to quit the report operation.
  971.  
  972.    Selecting "P" (for printer) will generate a hard copy listing of the
  973.    report.
  974.  
  975.    Selecting "S" (for screen) will display the report on the screen in a
  976.    browse box. This browse feature is the same as the main menu option
  977.    "Browse Database".
  978.  
  979.    Selecting "Q" (for Quit) will terminate the current listing operation.
  980.    Use this option if you choose the wrong report, or enter an incorrect
  981.    filter expression.
  982.  
  983.  
  984.  
  985.  
  986.  
  987.                                       -15-
  988.  
  989.  
  990.  
  991.  
  992.  
  993.                       Diskette Catalog System User's Manual
  994.  
  995.  
  996.  
  997.    UTILITIES MENU
  998.    -------------
  999.    Selecting "Utilities Menu" from the main menu will produce the
  1000.    following menu:
  1001.  
  1002.                            ┌───────────────────────────┐
  1003.                            │      Utilities Menu       │
  1004.                            │                           │
  1005.                            │  Print Diskette Inserts   │
  1006.                            │  Auto-load Database       │
  1007.                            │  Reorganize Database      │
  1008.                            ├───────────────────────────┤
  1009.                            │      Shell to DOS         │
  1010.                            ├───────────────────────────┤
  1011.                            │  Quit Utilities Menu      │
  1012.                            └───────────────────────────┘
  1013.  
  1014.    The following is a description of menu choices available:
  1015.  
  1016.    Print Diskette Inserts
  1017.    ----------------------
  1018.    This option will create diskette label inserts.  This is basically the
  1019.    same as many popular disk cover programs currently in the
  1020.    public domain.  This selection will print the contents of the
  1021.    diskette directory containing filename, file sizes, the date of
  1022.    the listing and the volume label.
  1023.  
  1024.    Auto-load Database
  1025.    ----------------------
  1026.    This is probably the most powerful feature of the Diskette Catalog
  1027.    System.  This option will read the diskette directory and
  1028.    automatically load the information into the database.  You will first
  1029.    be prompted for the desired disk drive.  Select either "A" or "B". You
  1030.    will then be prompted to insert the diskette into the drive.
  1031.  
  1032.    After inserting the disk into the desired drive, the system will read
  1033.    the volume label, available space and all of the file information on
  1034.    the diskette.
  1035.  
  1036.    NOTE:  The Diskette Catalog System expects the format of the volume
  1037.           label to be either "DISK XXXX" or "XXXX" where "XXXX" is the
  1038.           number of the diskette.
  1039.  
  1040.  
  1041.  
  1042.  
  1043.  
  1044.  
  1045.  
  1046.  
  1047.  
  1048.  
  1049.  
  1050.  
  1051.  
  1052.  
  1053.                                       -16-
  1054.  
  1055.  
  1056.  
  1057.  
  1058.  
  1059.                       Diskette Catalog System User's Manual
  1060.  
  1061.  
  1062.  
  1063.    Once the system has read the diskette information, it searches the
  1064.    database to see if the diskette is already in the database.
  1065.  
  1066.    If the disk number already exists, the Auto-Load will simply update
  1067.    the information in the database to match the information on the
  1068.    diskette. For example, if an archive size changes or a new archive has
  1069.    been added to the diskette, the information will be automatically
  1070.    updated.
  1071.  
  1072.    If the disk number doesn't exist in the database, a screen will pop-up
  1073.    allowing you to update specific information for each file.  This screen
  1074.    is similar to the archive name input section of the diskette Maintenance
  1075.    screen (see above for details).  The diskette number, filename and file
  1076.    size will be read from the diskette and you only need to input the file
  1077.    type and description.
  1078.  
  1079.    Reorganize Database
  1080.    -------------------
  1081.    This option is used to physically sort the records in the database
  1082.    according to the indexes for each file.  The FILES datafile is indexed
  1083.    on diskette number and archive name; the DISKS datafile is indexed on
  1084.    diskette number only.  If you notice searching/sorting/filtering
  1085.    performance is slow, this option can be used to re-build the database
  1086.    and possibly increase performance.
  1087.  
  1088.    Shell to DOS
  1089.    ------------
  1090.    This option simply clears the screen and gives you an MS-DOS prompt.
  1091.    The maximum amount of memory will be freed allowing you to run other
  1092.    applications.  When you are finished, typing "EXIT" followed by carriage
  1093.    return at your DOS prompt will return you to the Diskette Catalog
  1094.    System.
  1095.  
  1096.       NOTE:  DO NOT TURN OFF YOUR COMPUTER OR REBOOT WHILE IN A DOS SHELL.
  1097.              UNEXPECTED RESULTS MAY OCCUR, RESULTING IN PERMANENT DAMAGE TO
  1098.              YOU DATA.
  1099.  
  1100.    The "Quit Utilities Menu" option returns you to the main menu.
  1101.  
  1102.  
  1103.  
  1104.  
  1105.  
  1106.  
  1107.  
  1108.  
  1109.  
  1110.  
  1111.  
  1112.  
  1113.  
  1114.  
  1115.  
  1116.  
  1117.  
  1118.  
  1119.                                       -17-
  1120.  
  1121.  
  1122.  
  1123.  
  1124.  
  1125.                       Diskette Catalog System User's Manual
  1126.  
  1127.  
  1128.  
  1129.    POP-UP WINDOWS AND "YES" "NO" BOXES
  1130.    -----------------------------------
  1131.    Throughout the Diskette Catalog System there are many messages that
  1132.    appear in message windows and "YES/NO" boxes.  "YES/NO" boxes appear in
  1133.    appropriate instances to query the user.  A message is displayed along
  1134.    with choices "YES" and "NO".  You can select the appropriate choice by
  1135.    using the arrow keys and hitting return or by hitting the first letter
  1136.    of the desired choice.  Hitting escape while this window is displayed
  1137.    will often times take the negative or "NO" option.
  1138.  
  1139.    Message windows are used to let you know what the system is doing.  For
  1140.    example, counting records, searching for data, printing listings, etc.
  1141.    There are two forms of this windows; interactive and independent.  The
  1142.    interactive form will wait for the user to hit return or escape, as the
  1143.    non-interactive form will stay on the screen while the operation is
  1144.    in progress and then closes by itself when the operation completes.
  1145.  
  1146.    BUG REPORTS
  1147.    -----------------------
  1148.    I've employed extensive efforts to insure that this release of the
  1149.    Diskette Catalog System is free of any bugs.  I can confidently state
  1150.    that any fatal run-time bugs have been completely eliminated to prevent
  1151.    any possible loss of data (yours, not my own...).
  1152.  
  1153.    However, often times nasty little bugs seem to rear their ugly head
  1154.    when you least expect it. If you happen to find any fatal
  1155.    program-aborting bugs, or if the system doesn't function the way it
  1156.    should, the author can be reached at the addresses or phone numbers
  1157.    listed in LICENSE.DOC.  The first reporters of bugs will receive
  1158.    commercial versions of the system free of charge.
  1159.  
  1160.    UPDATES AND ENHANCEMENTS
  1161.    ------------------------
  1162.    This program has been updated and enhanced over the past three years
  1163.    before being released to the public.  However, there is still
  1164.    room for improvement.  There are a number of enhancements that could be
  1165.    made to make the system even better.  I currently maintain a to-do list
  1166.    of enhancements I would like to make to the system.  I decided not to
  1167.    include the list here because anyone who provides any *meaningful*
  1168.    enhancement suggestions may be eligible to receive the commercial
  1169.    version of the software, free of charge.
  1170.  
  1171.    As with any good shareware product, your input counts.  Any suggestions
  1172.    for enhancements or changes to the current features will be considered
  1173.    very seriously.
  1174.  
  1175.  
  1176.  
  1177.  
  1178.  
  1179.  
  1180.  
  1181.  
  1182.  
  1183.  
  1184.  
  1185.                                       -18-
  1186.  
  1187.  
  1188.  
  1189.  
  1190.  
  1191.                       Diskette Catalog System User's Manual
  1192.  
  1193.  
  1194.  
  1195.    APPENDIX A
  1196.    ----------
  1197.    The following table shows the keys which can be used while in a browse
  1198.    window.  A browse window is displayed when you choose "Browse
  1199.    Database" from the main menu or if you display on of the listings to
  1200.    the screen.
  1201.  
  1202.           KEY                     FUNCTION
  1203.           ---                     --------
  1204.           UP ARROW                Go to previous record (line) in the
  1205.                                   browse window.
  1206.           DOWN ARROW              Go to previous record (line) in the
  1207.                                   browse window.
  1208.           PGUP                    Go to previous page
  1209.           PGDN                    Go to next page
  1210.           HOME                    Go to first record in the browse window
  1211.           END                     Go to last record in the browse window
  1212.           CTRL/HOME               Go to first record in the database
  1213.           CTRL/END                Go to last record in the database
  1214.           LEFT ARROW              Pan one column to the left within the
  1215.                                   browse window.
  1216.           RIGHT ARROW             Pan one column to the right within the
  1217.                                   browse window.
  1218.           ESC                     Close the browse window
  1219.           RETURN                  Close the browse window
  1220.           ALPHA KEYS              Go to the record that matches the
  1221.                                   uppercase value of the key you pressed.
  1222.                                   For example, if you are displaying the
  1223.                                   Archive Name listing on the screen,
  1224.                                   pressing "A" go to the first record whose
  1225.                                   archive name begins with "A".
  1226.           ALT/S                   Search for a record.
  1227.           ALT/R                   Redraw the browse window.
  1228.           ALT/G                   Go to a specific record.
  1229.  
  1230.  
  1231.  
  1232.  
  1233.  
  1234.  
  1235.  
  1236.  
  1237.  
  1238.  
  1239.  
  1240.  
  1241.  
  1242.  
  1243.  
  1244.  
  1245.  
  1246.  
  1247.  
  1248.  
  1249.  
  1250.  
  1251.                                       -19-
  1252.  
  1253.  
  1254.  
  1255.  
  1256.  
  1257.                       Diskette Catalog System User's Manual
  1258.  
  1259.  
  1260.  
  1261.    The following keys are used to move and resize the browse window.
  1262.    NOTE:  Some browse windows have this ability disabled.
  1263.  
  1264.           Key Combination               Function
  1265.           ===============               ========
  1266.           LEFT SHIFT+LEFT ARROW         Shrink browse window by moving the
  1267.                                         right side of the window in to the
  1268.                                         left.
  1269.           LEFT SHIFT+RIGHT ARROW        Expand browse window by moving the
  1270.                                         right side of the window out to the
  1271.                                         right.
  1272.           LEFT SHIFT+UP ARROW           Shrink browse window by moving the
  1273.                                         right side of the window in to the
  1274.                                         left.
  1275.           LEFT SHIFT+DOWN ARROW         Expand browse window by moving the
  1276.                                         right side of the window out to the
  1277.                                         right.
  1278.           SCROLLOCK+UP ARROW            Move entire browse window up
  1279.           SCROLLOCK+DOWN ARROW          Move entire browse window down
  1280.           SCROLLOCK+LEFT ARROW          Move entire browse window left
  1281.           SCROLLOCK+RIGHT ARROW         Move entire browse window right
  1282.  
  1283.           NOTE:  While using the last four functions, you must press the
  1284.           scroll lock key again to resume normal operation of the browse
  1285.           window.
  1286.  
  1287.  
  1288.  
  1289.  
  1290.  
  1291.  
  1292.  
  1293.  
  1294.  
  1295.  
  1296.  
  1297.  
  1298.  
  1299.  
  1300.  
  1301.  
  1302.  
  1303.  
  1304.  
  1305.  
  1306.  
  1307.  
  1308.  
  1309.  
  1310.  
  1311.  
  1312.  
  1313.  
  1314.  
  1315.  
  1316.  
  1317.                                       -20-
  1318.  
  1319.  
  1320.  
  1321.  
  1322.  
  1323.                       Diskette Catalog System User's Manual
  1324.  
  1325.  
  1326.  
  1327.    APPENDIX B
  1328.    ----------
  1329.    The Diskette Catalog System database is comprised of two data files.
  1330.    These are standard dBASE III/Clipper database files and can be read by
  1331.    any program designed to work with dBASE files.  This appendix describes
  1332.    the datafiles, their layouts and associated index files.
  1333.  
  1334.    The first datafile is DISKS.DBF.  This file contains the information
  1335.    about each Diskette.  The following is the file layout:
  1336.  
  1337.          Field Name      Data Type   Length    Description
  1338.          BYTES_FREE      numeric       9       Free Space on each diskette
  1339.          DISK_NUM        character     4       Diskette Number
  1340.  
  1341.    The the FILES.DBF contains the information about each file on each
  1342.    diskette.  The following is the file layout:
  1343.  
  1344.          Field Name      Data Type   Length    Description
  1345.          ARC_NAME        character    12       Archive name on each disk
  1346.          ARC_SIZE        numeric       9       File size
  1347.          DESCR           character    30       File description
  1348.          DISK_NUM        character     4       Diskette number (this is
  1349.                                                linked to the DISKS datafile.
  1350.          F_TYPE          character     1       File category
  1351.          REAL_SIZE       numeric       9       Actual size of the file(s)
  1352.                                                when uncompressed.
  1353.  
  1354.    These field names appear in the field name pick lists in the listings
  1355.    options.
  1356.  
  1357.  
  1358.  
  1359.  
  1360.  
  1361.  
  1362.  
  1363.  
  1364.  
  1365.  
  1366.  
  1367.  
  1368.  
  1369.  
  1370.  
  1371.  
  1372.  
  1373.  
  1374.  
  1375.  
  1376.  
  1377.  
  1378.  
  1379.  
  1380.  
  1381.  
  1382.  
  1383.                                       -21-
  1384.  
  1385.  
  1386.  
  1387.  
  1388.