Shareware Overload/ShartewareOverload.cdr/busi/clubplan.zip/CLUBCAT.DOC

Text File | 1987-03-24 | 15KB | 461 lines

                                 CLUBCAT!

                               Version  2.0

              (c) COPYRIGHT  1984,85,86 - All Rights Reserved

                                    by

                             MUSTANG  SOFTWARE
                        3125 19th Street, Suite 162
                        Bakersfield, CA  93301-3118
                              (805)  395-0223











CLUBCAT Documentation                                               Page...2



                       --- CLUBCAT! Version 2.0 ---


CLUBCAT! is distributed under the Shareware concept which means that you do
not have to pay for it.  You may make as may copies as you wish, give the
program to anyone or do anything else you wish except sell it.  If you find
the program useful, you are asked to make a donation of $45.00 to the
author.  This is to help in recovering some of the cost of development and
any further  enhancements of this program and to encourage the development
of additional  programs.



                    --- REQUIREMENTS ---

                 IBM or compatible computer
                 128K of memory
                 1 diskette drive of any kind
                 and a Fixed disk OR
                 2 diskette drives.
                 Mono or color display
                 Printer if hard copy desired


                         --- LIMITED WARRANTY ---


THIS    PROGRAM  IS  PROVIDED  "AS  IS" WITHOUT WARRANTY OF ANY KIND, EITHER
EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE WITH RESPECT TO DEFECTS
IN THE PROGRAM OR  DOCUMENTATION.   MUSTANG SOFTWARE  ASSUMES NO  RISK AS TO
QUALITY AND PERFORMANCE OF THE PROGRAM.  SHOULD THE PROGRAM PROVE DEFECTIVE,
YOU ASSUME THE ENTIRE COST OF  ANY LOSS  OF PROFIT  OR ANY  OTHER COMMERCIAL
DAMAGE.  SOME STATES DO NOT ALLOW THE EXCLUSION OF IMPLIED WARRANTIES SO THE
ABOVE EXCLUSION MAY NOT APPLY TO  YOU.   THIS STATEMENT  SHALL BE CONSTRUED,
INTERPRETED, AND GOVERNED BY THE LAWS OF THE STATE OF CALIFORNIA.






CLUBCAT Documentation                                               Page...3






                      --- COPYRIGHT ---

Regardless of the  method of  marketing used, CLUBCAT! is NOT in the
"Public Domain". It is copyrighted by Mustang Software.  However, we
grant you the right, in fact ENCOURAGE you to make and distribute as
many copies  as you wish,  using any  acceptable medium of exchange,
with the following restrictions:





                              - DO NOT -

                1.  Distribute the Program without this
                    documentation;
                2.  Accept remuneration for the program;
                3.  Alter the program in any manner.






CLUBCAT Documentation                                               Page...4




                              --- OVERVIEW ---



CLUBCAT is a database program to organize and catalog your diskette file
collection.  It was written for a California User Group to allow their
public domain library to be organized by file type, disk label, etc.,
hence the name CLUB CATalog.  It reads diskettes and the volume label and
then allows a 4 line description for each file.  A flexible search and
print functions allows formatted output sorted in a number of ways.


The program is  menu driven  for ease of use.   To select one of the
functions from the menu, enter the number of the desired funtion. It
is  NOT  required that you press the  enter key  so the program will
automatically take you to your selection.



                          --- DATA ENTRY KEYS ---


The computer will put the cursor in the proper position for entering
information in each field. The length of each field is marked by the
[ and ].  You  must  enter information into  each field except those
labeled as optional. You will not be allowed to move beyond the left
and right boundaries of each field.   The following keys can be used
for inputing data:


    The  LEFT and RIGHT cursor control keys  move the cursor
    anywhere within the boundary of the field.

    The BACKSPACE, INS and DEL keys move the same as in DOS.
    If you attempt to  insert more characters than the field
    will allow, the computer will beep and INS is cancelled.

    The TAB and Shift TAB will move you from one field to
    another, much the same as the up/down arrows.

    The  HOME key  will move the cursor the beginning of the
    current input field.

    The END key will move the cursor to the last position of
    the current input field.

    The  UP and DOWN  cursor control keys move the cursor to
    the  next field in the  appropriate direction.







CLUBCAT Documentation                                               Page...5



                          --- CLUBCAT!  FILES ---

The following files are a part of the  CLUBCAT!  package.  The first
two files are the only required ones.  The remaining ones are created
by the program as data is added to the database.

CLUBCAT.COM  - This is the compiled version of the program.
CLUBCAT.CHN  - This is the chain file needed to run the program.
CLUBCAT.DOC  - This is the documentation file you are reading now.
CLUBCAT.DAT  - Complete database of recorded information.
CLUBCAT.PRT  - The printer attributes which are saved for later use.
xxxxxxxx.IDX - Various index pointer files for data.




                         --- STARTING CLUBCAT! ---

The first time CLUBCAT! is run, it looks for the file CLUBCAT.DAT on the
default drive.  If not found, it assumes that you either have it on another
disk, or need to create a new database.  You are presented with a  choice
and should respond accordingly.





                                 --- MAIN MENU ---


CLUBCAT!'s Main Menu offers many choices, each of which will be covered  in
the following discussion.  We will proceed through the explanation as  if a
user is just starting up a new database, and cover all menu choices in order
of use.


C - CHANGE SOURCE DRIVE:  The source is the drive that CLUBCAT! will use
    when READING files into the database.  It is different from the default
    drive, which is where CLUBCAT! was started from.  You should first set
    the Source drive to the floppy drive that will contain the files to be
    cataloged.


D - DIRECTORY LISTING OF SOURCE:  Use this to get a screen listing of the
    files on the source drive, of desired, prior to using the LOAD command
    which follows.


V - CHANGE VOLUME LABEL:  If the label listed by the DIRECTORY command above
    is not what you want, change it with this command.







CLUBCAT Documentation                                               Page...6

L - LOAD FILES TO MASTERFILE:  This command is the heart of the program.  It
    reads the floppy disk in the source drive and places the file names,
    sizes and dates in the Masterfile.  By placing one disk after another in
    the source drive and pressing L, you will load the names, etc. of all
    the files in your diskette collection to the CLUBCAT! Masterfile.


U - UPDATE MASTERFILE:  After you have completed LOADing as much diskette
    file information as you want, you should use this command to enter the 4
    line descriptions.  It is also used to change any information about any
    file after it has been entered.

    Selecting UPDATE will bring up a SEARCH WINDOW which allows you to look
    for  a record (file) in several different ways.  You may search using
    the FULL VOLUME LABEL, PARTIAL VOLUME LABEL, FULL PROGRAM NAME, PARTIAL
    PROGRAM NAME, or NO CURRENT DESCRIPTION.  The FULL choices require a
    complete and exact match on either Volume Label or Program Name.  The
    PARTIAL choices will scan the entire field of Volume or Name and find
    any matches.  For example, a partial search for CAT will find a files
    named CLUBCAT!.EXE, CATBIRD.DOC and FATCAT02.COM.  The No  Current
    Description search will locate any file without any description entered.

    Once you have selected the Search criteria, CLUBCAT! presents the record
    on screen and positions the cursor in the first field, Volume Label. Use
    the editing keys as described above to move around the screen and make
    changes as required.  When finished, you are prompted to use the F10 key
    to exit the update editor.  ESC will return you to the Main Menu without
    making any changes.  Press F10 when done with the update and  the record
    stays on the screen, but the prompt area at the screen bottom changes.
    You then have a number of choices.  You can F2 Delete the Record, F3
    Change your searching criteria, F6 Select the Previous Record, F7 Select
    the Next Record, or F10 Update the Current Record.  Esc will exit to the
    Main Menu.


A - ADD NEW RECORD:  This selection allows the user to add individual file
    or program names without using the LOAD command from a floppy diskette.
    It uses the same editing screen as the UPDATE Masterfile cammand, and
    functions in a similar manner.


M - MERGE FILES TOGETHER:  If two CLUBCAT! database files are created on
    separate disks, the information from one can be added to the other using
    this command.  The Masterfile on the Source drive will be updated to
    reflect the additional information contained in the second Masterfile,
    located on some other drive.  This option is handy if more than one
    person is responsible for addition to the database.


T - TRANSFER TO THE REPORTS MENU:  The reports menu is the heart of the
    program.  Here you may select the method of reporting the information in
    the database, and to what device the report is sent.







CLUBCAT Documentation                                               Page...7

R - REBUILD INDEX FILES:  This option simply reads all the data and updates
    the indexes that locate files and volume labels.  It does not have to be
    used on a regular basis.  It is included in case tha database structure
    gets contaminated, in which case a quick re-index will usually fix the
    problem.


T - TRANSFER TO REPORT MENU:  This is the second major part of the program,
    and is used to print the files list.  It will be covered in detail in
    the following pages.

E - EXIT TO DOS:  This option seems self explanatory.





                           --- REPORTS MENU ---



Selecting T from the Main Menu brings up the REPORTS MENU.  Reports in
CLUBCAT can be directed either to the printer or to a file of your choice.


P - CATALOG SENT TO PRINTER:  Since the report can be sent to a printer or a
    file, you must select the proper choice.  If a file is selected, also
    enter the filename, with full path support.  See selection below.


F - CATALOG SENT TO FILE:  As indicated, a filename is necessary, and
    pathnames are supported.


U - UPDATE TITLE DESCRIPTIONS:  From within the report menu you have the
    ability to update the volume label descriptions (titles).  Selecting
    this option brings up a sub-menu which prompts for the change desired.


A - SET PRINTER ATTRIBUTES:  Since CLUBCAT has the ability to use double
    wide printing in headers, etc, this selection allows you to set up the
    specific codes required by your printer.  A sub-menu appears and you are
    prompted to enter the correcct  3 digit ascii code.  If you printer does
    not support enhanced mode printing, set the values to 000.








CLUBCAT Documentation                                               Page...8


                          --- REPORT FORMATS ---


The remaining REPORT MENU choices deal with specific report formats.


C - CATALOG:  The main format is the full catalog report.  It prints the
    Volume Label at the top of the page in double wide print in both
    corners.  Immediately below are the title line(s) for that volume,
    followed by the individual files.  Each filename is printed with the
    description lines indented.  Only description lines with text are
    printed, blank lines are not includes to save space.  The bottom right
    corner of each page has a double wide entry of the first and last volume
    appearing on the page.


V - LISTING BY VOLUME LABEL:  This report is very similar to the CATALOG
    report.  The differences are twofold:  It does NOT include the title
    lines (volume label descriptors) and it adds a complete header which has
    date, time, page number and report title.  The Catalog report was
    designed to prepare for a typset report to be sent to printers where the
    header information was not desired.


N - LISTING BY PROGRAM NAME:  Name listing has full header information, and
    presents the files alphabetically.


B - LISTING OF BLANK DESCRIPTIONS:  This prints a full header with page
    numbers that lists all files which have NO descriptive lines entered.
    Each filename is printed with 4 blank lines to be used to enter
    descriptive information away from the program, perhaps by other club
    members.

T - LISTING OF TITLES:  This report has a full header and simply lists each
    volume label and the descriptive titles associated with it.


S - LISTING OF SPACE ON DISKETTES:  A full header report listing each volume
    name with the space used and space available to add new files.


All of the above reports are available at both 6 and 8 lines per inch
printing.  The best way to visualize the effects is to print one of each
report.






CLUBCAT Documentation                                               Page...9


                         --- TECHNICAL SUPPORT ---

Customer satisfaction is very important to Mustang Software. We have tried
to anticipate and respond to potential questions in this documentation.
However, we realize  that, from time to time, unexpected situations may
occur.  Therefore, if you need  additional assistance or information, you
may do so via the following methods:

                     1.  CompuServe (75236,3312)
                     2.  Mustang Software [phone]
                         (9 am to 4 pm PST please)








CLUBCAT Documentation                                              Page...10




                    --- CLUBCAT! REGISTRATION FORM ---


        Name: ___________________________________________

        Company: ________________________________________

        Address: ________________________________________

        City: ________________  State: __  Zip: _________

        Telephone: (____) ____-_______

        Version: _______

        Comments:










        Mail to:                MUSTANG Software
                                3125 19th Street, Suite 162
                                Bakersfield, CA  93301-3118