home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 5 / DATAFILE_PDCD5.iso / utilities / d / discbase / !DiskBase / !Help / ReadMe < prev    next >
Encoding:
Text File  |  1996-10-14  |  25.3 KB  |  498 lines
  1. |              Copyright Jan Ganzevles, Dec. 1990 - Oct. 1996
  2.  
  3.  
  4. |                        !DiskBase version 0.75
  5.                          ======================
  6.  
  7.       (lines marked with '|' are updated since the previous release)
  8.  
  9.  Why !DiskBase ?
  10.  ---------------
  11.  
  12.  The programs you use a lot, are often easy to find. But how about the rest,
  13.  especially if they are stored on floppies? A diskette label is too small to
  14.  print a complete directory on and having separate printouts it can still be
  15.  time consuming to find just the one file you're looking for.
  16.  
  17.  But now there is ............ !DiskBase
  18.  
  19.  
  20.  What !DiskBase does.
  21.  --------------------
  22.  
  23.  It gives you the possibility to:
  24.  
  25.   - ADD directory info of disks (floppies and harddisks) to the datafile.
  26.     !DiskBase makes a distinction between applications, directories and
  27.     files. For each type of entry some relevant information is stored.
  28.  
  29.   - DELETE a diskname (and of course the entries of that disk).
  30.  
  31.   - SHOW disk names and optional their contents.
  32.     - If 'Show contents' is deselected, only disknames, date, free-space and
  33.       number of files/directories/applications are given.
  34.     - If 'Show contents' is selected, you have five suboptions to specify
  35.       the level of contents you want to see.
  36.       - If none of the five suboptions is selected, only files/dirs/apps
  37.         in the root-directory of the disk are shown.
  38.       - Otherwise you will be shown the contents of one or more of the
  39.         following items:
  40.         - Directories
  41.         - Applications
  42.         - Archives
  43.         - PackdDir
  44.         - DOSdisc partitions
  45.     It's possible to give a (wildcarded) diskname to do the SHOW on
  46.     (e.g. "*PROG*" will SHOW all disks with 'PROG' in the name) and it's also
  47.     possible to exclude (wildcarded) disknames by using a ~ as the first
  48.     character of the name (e.g. "~*BU" will SHOW all disks, except the ones
  49.     ending in 'BU').
  50.     Allowable wildcard characters are '*' matching any 0 or more characters
  51.     and '#' matching exactly any 1 character. Any combination of wildcard
  52.     and normal characters is allowed.
  53.  
  54.   - SEARCH for (wildcarded) entry names. You can limit the SEARCH for one or
  55.     more particular types of entry (files/directories/applications). If type
  56.     "Files" is selected, an extra limitation can be made for a filetype. The
  57.     filetype may be entered in its textual form ("Basic") or in its hex
  58.     numerical form ("&FFB"). Since version 0.56 there is also the possibility
  59.     to limit the SEARCH to include or exclude disks using a (wildcarded)
  60.     diskname and optionally the exclude character (see also SHOW)
  61.  
  62.   - DUPLICATES. This option now has several sub-options.
  63.     You can search files and/or applications having no duplicates, or
  64.     one or more duplicates, or two or more duplicates.
  65.     So you can find files/applications on your disks having no backup, or for
  66.     instance a scan of only your harddisk to report all files/applications
  67.     with two or more copies on that disk (one or more duplicates), or scan
  68.     all disk directories to see if there are files/applications with more
  69.     than one backup (so more than two copies somewhere).
  70.     Duplicates are files and/or applications (not directories!) with the same
  71.     name and optionally the same size and timestamp.
  72.     Same rules for wildcards and include/exclude disks as with SHOW are
  73.     applicable.
  74.  
  75.   - RESULTS If the RESULTS window is open, you can save the RESULTS as a file
  76.     on disk, or drag it to an application (e.g. printerdriver, !Edit, !DTP).
  77.     Since version 0.56 you have the option to double click a line of the
  78.     RESULTS window. The effects are:
  79.       -  If it's a directory name:
  80.          You can open the directory viewer
  81.       -  If it's an application name:
  82.          The application can be started, or if SHIFT is pressed, the
  83.          application's directory viewer is opened.
  84.       -  If it's a file:
  85.          The file is run or started. Be aware that as a side-effect this can
  86.          result in an application being started. E.g. if you double click a
  87.          line showing a file of type Sprite the application !Paint is started
  88.          and the file loaded, if the application has been seen before,
  89.          otherwise the sprite is shown on your screen.
  90.          (For safety, your confirmation is asked, before an action is taken.
  91.           If the disk has not been inserted ADFS will ask you to do so.)
  92.       -  If it's an archive file, or a file inside an archive file:
  93.          The archive file is run, in order to start an application like
  94.          !ArcFS or !SparkFS to open the archive file for you. Because !ArcFS,
  95.          !Spark and !SparkFS share the same filetype for archive files (&DDC)
  96.          the application seen last by RISCOS will be started, even if it's an
  97.          !ArcFS archive, which can't be read by !Spark.
  98.          Unless the new ArcFSArc (&3FB) filetype is used, in which case of
  99.          course !ArcFS is started, if seen before by RISCOS.
  100. |     -  If the RESULTS window shows results of a DUPLICATES, clicking on the
  101. |     filename doesn't start any action, but clicking on the pathname will
  102. |        start the appropriate action for the file located in this directory.
  103.       -  If it's a diskname, a window will open showing a printpage. If a
  104.          printerdriver is loaded, the selected papersize is used, otherwise a
  105.          size just sufficient for the number of labels specified is assumed.
  106.          The label of the selected diskname is added to the page, and when
  107.          Menu is pressed over one of the labels, a menu is shown with the
  108.          following options:
  109.            SHOW LABEL   -  Gives a preview of the label the pointer was over
  110.                            when Menu was pressed.
  111.                            Clicking Select on the open preview will increase
  112.                            the shown depth level of the entrynames, Adjust
  113.                            will decrease it.
  114.            DELETE LABEL -  Deletes the label at the position the pointer was
  115.                            over when Menu was pressed. The other labels are
  116.                            re-arranged. If pressed with Adjust the next label
  117.                            at the same position can be deleted.
  118.            INVERT LABEL -  This option will change the layout of the printed
  119.                            labels (see the preview).
  120.            LABEL SIZE   -  A dialogue window will be shown, where labelsizes
  121.                            and number of labels can be specified. All sizes
  122.                            are in millimetres.
  123.                            From version 0.72 onwards, there is an option to
  124.                            configure the depth of the entrynames printed on
  125.                            the labels. If Menu is pressed on top of a label
  126.                            you can specify if you want to set the depth of
  127.                            just that label, or of all labels. Otherwise if
  128.                            Menu is pressed on the empty background only all
  129.                            labels at once can de set.
  130.                            If the depth is set to '1' only entries in the
  131.                            root-directory are shown (as in pre-0.72 versions)
  132.                            '2' will also show the entries inside directories
  133.                            and applications shown in the root and so on.
  134.                            The maximum number selectable is the maximum depth
  135.                            in the loaded datafile. The value selected for all
  136.                            labels will be stored in the datafile when saved.
  137.            OWNER'S NAME -  Here you can specify the name of the owner that
  138.                            will be printed on the label.
  139.            FONT         -  This leads to a submenu where you can select the
  140.                            font used for printing. Changing the Font$Path
  141.                            will directly affect the selectable fonts, without
  142.                            need for a restart of !DiskBase.
  143.            PRINT        -  will start printing of all the labels queued.
  144.  
  145.          Information about font, owner's name, label sizes and invert label
  146.          will be saved in the database. If an older database (pre 0.57) is
  147.          used, the extra info will be added and the version number of the
  148.          datafile updated. If for any reason you want to use an older version
  149.          of !DiskBase afterwards, this information will be lost, but the file
  150.          will still be compatible with the older program version.
  151.  
  152.   - SAVE the datafile (which is completely kept in memory) to a disk.
  153.  
  154.   - STATUS toggles on/off display of a status window. This window displays
  155.     the number of disks, files, directories and applications stored, and the
  156.     time/date of the last update of the !DiskBase datafile.
  157.  
  158.   - LABELS this will display the window with the labels queued for printing.
  159.  
  160.  
  161.  What you should know.
  162.  ---------------------
  163.  
  164.   - Since version 0.52 nearly all actions are multitasking.
  165.     This increases the time an individual action needs, but it prevents your
  166.     processor being used for only a single task.. During the action a window
  167.     is shown displaying the activity type, options and a progress status.
  168.     Also a STOP button is provided, but be aware that this cancels the
  169.     ongoing action, even if it is an ADD. In this case the part of the disk
  170.     already added to the datafile is removed, so an incomplete addition is
  171.     impossible.
  172.     Although DELETE is multitasking as well, an activity window is NOT shown,
  173.     merely because it's not preferable to do a partial delete, so a STOP
  174.     button is not needed.
  175.  
  176.   - In places where wildcards are allowed, the following rules apply:
  177.      - The (only) wildcard character is "*".
  178.      - You may start and/or end a name with a wildcard. No wildcards are
  179.        allowed in the middle of a name.
  180.      - All names are case insensitive.
  181.  
  182.              e.g.    "TEST*" :   finds all names starting with "Test"
  183.                     "*TEST"  :   finds all names ending with "Test"
  184.                     "*TEST*" :   finds all names with "Test" somewhere in it.
  185.                      "TE*ST" :   not allowed!
  186.  
  187.   - !DiskBase automatically restricts its memory usage to a minimum. This is
  188.     done by using a heapmanager as described in the Dec/90 issue of
  189.     "RISC User". If more room is needed while adding disks, !DiskBase tries
  190.     to expand the block of memory it uses by asking the window manager for an
  191.     extra 4K if it runs out of space for storing disknames, or 8K for entries
  192.     (where entries are files/directories/applications). While doing a SHOW,
  193.     SEARCH or DUPLICATES an extra block of memory is needed to set up a table
  194.     of pointers. This extra block is returned to the wimp as soon as the
  195.     window displaying the results is closed. This window is also closed when
  196.     the datafile is being updated because the displayed results may not be
  197.     valid anymore.
  198.  
  199.   - ADD of a disk is done by selecting the number of the drive the disk is
  200.     in. This will take some seconds (depending on the number of directories).
  201.     Optional a warning will be given if a diskname already exists, or a scan
  202.     of the contents of an archive file fails.
  203.     From version 0.69 upwards the contents of DOS- and Atari-formatted
  204.     floppies and DOSDisc partitions can be added to the datafile.
  205.     One drawback is that the datafile has only a field of ten characters for
  206.     entrynames, and DOS- and Atari-filenames can have a length up to twelve
  207.     characters. So these names will be truncated in the datafile, conform
  208.     copying these files to Acorn formatted disks.
  209.     Of course a prerequisite for this is that you are using RISCOS 3.
  210.     On the 'Add disk' window an option is provided to decide if you want to
  211.     include DOSDisc partitions.
  212.     The setting of this option doesn't affect the ability to include DOS-
  213.     or Atari-formatted diskettes.
  214.  
  215.   - DELETE a disk asks for a diskname to delete (no wildcards allowed).
  216.  
  217.   - Displaying results of a SHOW or SEARCH:
  218.  
  219.      - Info for disknames:
  220.         - Time/date of the last addition of this disk in the datafile.
  221.         - Floppy or harddisk (Winnie).
  222.         - Total of free space on the disk. If two values are shown, the
  223.           second is the size of the largest file you can save (without
  224.           compaction, only for "L" and "D" formatted disks).
  225.         - Number of files/directories/applications on the disk.
  226.  
  227.      - Info for entries:
  228.          "File":
  229.             - If timestamped: filetype and creation/update date/time.
  230.                         else: load and execution addresses.
  231.             - size of the file (in bytes if less than 10.000 else in Kbytes).
  232.          "Directory":
  233.             - Creation date of the directory.
  234.             - Size of all its entries (in (K)bytes, as with "Count").
  235.          "Application":
  236.             - Time/date of the file "!RunImage" if it has a file with this
  237.               name in it, otherwise the creation date of the application
  238.               directory (ADFS uses the same rule).
  239.             - Size of all the entries it contains (again in (K)bytes).
  240.  
  241.      - Displays are in the following format:
  242.  
  243.         Diskname     Time/date     Disktype    Free: .../... K   (red)
  244.         $            Dirs: ...  Appl: ....     File: ....        (green)
  245.         .  File1        Filetype  Time/date  Size: .... K        (black)
  246.         .  File2        Load: &....  Exec: &....  Size: ....     (black)
  247.         .  Directory    Time/date  Size: ....                    (green)
  248.         .  .  File3        Filetype  Time/date  Size: ....       (black)
  249.         .  .  Archive    S Filetype  Time/date  Size:   .. K     (light blue)
  250.         .  .  .  App2         Time/date  Size: ....              (dark blue)
  251.         .  .  .  .  File7        Filetype  Size: ....            (black)
  252.         .  .  .  .  File8        Filetype  Size: ....            (black)
  253.         .  .  File4        Filetype  Time/date  Size: .... K     (black)
  254.         .  .  Application  Time/date  Size: ....                 (dark blue)
  255.         .  .  .  File5      C Filetype  Time/date  Size: .... K  (black)
  256.         .  App3         Time/date  Size: ....                    (dark blue)
  257.         .  .  Data         Time/date  Size: ....                 (green)
  258.         .  .  .  File10     D Filetype  Size: ....               (black)
  259.         .  File6        Filetype  Time/date  Size: .... K        (black)
  260.         .  File9      P Filetype  Time/date  Size: .... K        (light blue)
  261.         .  File11     Q Filetype  Time/date  Size: .... K        (black)
  262.  
  263.        where the pathname for:
  264.           File1/File2/Directory/File6 is: ":Diskname.$"
  265.           File3/File4/Application is:     ":Diskname.$.Directory"
  266.           File5 is:                       ":Diskname.$.Directory.Application"
  267.           Archive is:                     ":Diskname.$.Directory"
  268.  
  269.        App2/File7/File8:                entries inside archive file.
  270.                                         sizes shown are uncompressed sizes!!
  271.  
  272.        Disktype:  Floppy/ADFS/SCSI/IDE/CD-Rom
  273.  
  274.        A:         ArcFS archive
  275.        C:         CFSlzw
  276.        D:         SparkFS-datafile (created by using SparkDir option)
  277.        O:         DOSDisc
  278.        P:         PackDir
  279.        Q:         Squash
  280.        S:         Spark archive
  281.        Z:         ZIP archive
  282.  
  283.   - When displaying results of a SEARCH, all relevant info to find the
  284.     matching entry is shown (parent directory/application and disk names).
  285.  
  286.   - Displaying results of a DUPLICATES:
  287.     From 0.74 onwards, the full pathname in which the reported file resides
  288.     is shown, and not only the name of the disk which holds this file.
  289.     So what you'll see is:
  290.      - Entryname. (and if 'Compare timestamp/size' selected, also entry info)
  291.      - If the option 'No dups' is selected you'll see the full pathname of
  292.        the reported file, else a list of pathnames, one for each duplicated
  293.        entry.
  294.  
  295.       Note:  - For DUPLICATES entries are sorted as follows:
  296.                  1. Names in alphabetical order
  297.                  2. If names are equal then on increasing entrysize.
  298.                  3. If names and sizes are equal, then oldest entry first.
  299.                So if 'Compare timestamp/size' is not selected, this is the
  300.                order of the shown DUPLICATES.
  301.  
  302.   Tips
  303.   -----
  304.   - 1. About printing disklabels.
  305.  
  306.     !DiskBase stores labelsizes, number of labels per row and column, and
  307.     gaps between the labels. You can change the dimensions of the printed
  308.     disklabel and its position on paper.
  309.  
  310.     As an example how to use this I'll explain the way I do it:
  311.  
  312.              My (DeskJet) printer driver is setup as follows:
  313.              paper height:    297.0 mm       width:  210.0 mm
  314.              margin   top:      2.2 mm      bottom:   10.3 mm
  315.                      left:      3.3 mm       right:    3.9 mm
  316.  
  317.              !DiskBase is setup this way:
  318.              label width:      66.9 mm      height:   69.8 mm
  319.              labels horizontal  3         vertical:    4
  320.              gap horizontal     1.0 mm    vertical:    1.0 mm
  321.  
  322.     This way I can print 12 labels onto one A4-size sheet.
  323.     (I couldn't find labels of approx. 70x70 mm, instead I use A4 size
  324.     labels, and cut them after printing).
  325.     !DiskBase prints labels one at the time, but it would be nicer to be able
  326.     to queue the labels until one sheet of paper is filled (in the example
  327.     mentioned above 12 labels) and then print them all together.
  328.     I'm thinking of implementing this, but I'm not quite sure how to do it.
  329.  
  330.  - 2. About CFS files
  331.  
  332.     When you double-clicked on a CFS file of a pre-0.67 version !DiskBase
  333.     gave a warning that it couldn't start/run a file compressed by CFS. This
  334.     warning is no longer needed. It is possible to start/run a CFS file, by
  335.     altering the 'Alias$@RunType_D96'. The best places to do this is in the
  336.     !Boot and !Run files of !CFS itself.
  337.     If you change the line:   Set Alias$@RunType_D96 "Set Dummy$Variable "
  338.                         to:   Set Alias$@RunType_D96 Filer_Run CFS#%0
  339.     you will always be able to run/start a CFS-file by double-clicking (from
  340.     the RESULTS window as well as from an ADFS filer-window, without having
  341.     to open the CFS filer window).
  342.  
  343.   - 3. About changing the !RunImage file
  344.  
  345.     After loading the !RunImage file a CRC-check is done on the !RunImage
  346.     file. If this check fails, !DiskBase will NOT run anymore!!!
  347.     This I have added because it I get bugreports about !DiskBase versions in
  348.     which !RunImage files aren't the original ones anymore (so someone has
  349.     changed the file, even though it is a crunched one, so very hard to read)
  350.     and I don't want to spend any more hours locating bugs that didn't exist
  351.     in the original version.
  352.     So to all of you that want to try to change it, first make a backup of
  353.     !DiskBase.
  354.  
  355.  #           Even loading the !Runimage file in a Basic Editor and
  356.  #           saving it again, without changing anything can corrupt
  357.  #           a Basic file when it is crunched.
  358.  #           Also renumbering the file will result in a CRC-error.
  359.  
  360.     This will probably not stop a very determined person to try to mess
  361.     around in the program, but it will keep the average user from trying to.
  362.  
  363.  
  364. =============================================================================
  365.  
  366.   - I've tried to make the program as error free and foolproof as possible
  367.     but I'm nearly sure that it is NOT error free (which program is?).
  368.     Please let me know what errors you've got and, if possible, if it's a
  369.     program bug or an operator error that I should have checked for.
  370.     I've included a textfile called BugReport, which I hope everyone will use
  371.     to report bugs with (or send New Feature Suggestions on).
  372.     If you answer all the questions in it as good as possible, I probably can
  373.     trace errors more quickly.
  374.  
  375.  
  376.     You can reach me:     Jan Ganzevles
  377.                   at:     van Deyssellaan 22
  378.                           1422 KB Uithoorn
  379.                           Netherlands
  380.                           (+31) 297 569065 (speech).
  381.               or via:     Acorn BBS       (modem up to 14400 bps)
  382.                           (+31) 20 6631849
  383.          or Email to:     JanGanzevles@unn.unisys.com
  384.  
  385.   - Also any suggestions to improve this program are welcome.
  386.  
  387.  
  388.  Copyright
  389.  ---------
  390.  
  391.   - Any statement in this application is as I wrote it. Any similarity or
  392.     likeness of the statements used in this application with statements
  393.     of any other program or otherwise is purely coincidental and not
  394.     intentional.
  395.  
  396.   - Much care has been taken to create this application. However, no
  397.     responsibility, financial or otherwise, is accepted for any consequences
  398.     arising out of the use of this application. If for any reason the layout
  399.     of the datafile is to be changed in future releases, I shall try to
  400.     supply a convert program, if possible!
  401.  
  402.   - This application is meant to be public domain and may not be used for any
  403.     commercial use what so ever, without my written permission. You may use
  404.     and distribute the application as much as possible, as long as you leave
  405.     this application as it is, without changes and/or removal of one or more
  406.     of its files. If any error is discovered in it, please let me know and
  407.     I shall try fo fix it. This to make sure that compatibility with future
  408.     releases is guaranteed as much as possible.
  409.  
  410.   - Many thanks to "RISC User" and Christopher Wilmot for publishing the Heap
  411.     Manager. The utility HeapCode in this application is a result of that
  412.     publication. (Risc User, Volume 4, Issue 2, December 1990, pg. 55-59)
  413. |   In version 0.75 I changed the heap used earlier to the one described by
  414. |   Alan Wrigley in "RISC User" volume 9 issue 1 (November 1995).
  415. |   This gives the benefits of a sliding heap and also uses Dynamic Areas
  416. |   if run on a Risc PC.
  417. |   (See also the small modification in "Risc User" 1996 May issue, pg.43)
  418.     I also thank Joris RÖling for the !Help application. I'm not sure if it's
  419.     Public Domain but I found it in several programs and it's so useful,
  420.     that I decided to adopt it for this Help instruction.
  421.  
  422.   - This application consists of the following files:
  423.  
  424.        - !DiskBase    Application
  425.            - !Boot        Obey
  426.            - !DBaseChk    Application
  427.                -  !Boot       Obey
  428.                -  !Help       Text
  429.                -  !Run        Obey
  430.                -  !RunImage   Basic
  431.                -  !Sprites    Sprite
  432.                -  Messages    Text
  433.                -  Templates   Template
  434.            - !Help        Application
  435.                -  !Boot       Obey
  436.                -  !Run        Obey
  437.                -  !RunImage   Absolute
  438.                -  !Sprites    Sprite
  439.                -  Readme      Text       (this document)
  440.                -  Templates   Template
  441.            - !Run         Obey
  442.            - !RunImage    Basic
  443.            - !Sprites     Sprite
  444.            - BugReport    Text
  445.            - CodeFile     Data
  446.            - FntMenuDoc   Text
  447.            - FontMenu     Module
  448.            - History      Text
  449.            - Messages     Text
  450.            - MsgTrans     Module
  451.            - Templates    Template    uses 3D icons (RISCOS 3 only)
  452.            - Template2D   Template    uses normal icons (RISCOS 2 and 3)
  453.  
  454.   - Also an application to check the integrity of !DiskBase-datafiles (and to
  455.     convert older datafiles to the new format) is supplied. This !DBaseChk is
  456.     placed inside !DiskBase, to prevent one beeing distributed without the
  457.     other accidently.
  458.  
  459. |                                          Jan Ganzevles, 14 October 1996.
  460.  
  461. -----------------------------------------------------------------------------
  462.  
  463. |    Version 0.75 (14 October 1996)
  464. |
  465. |  - The first problem in !DiskBase I encountered after upgrading from an
  466. |    A340 to a RiscPC, was that if a user has two different filing systems
  467. |    both having equal drive numbers, !Diskbase had no way of adding both
  468. |    disks. (e.g. I couldn't add my SCSI::4 as icon 4 pointed to ADFS::4
  469. |    and although icon 5 in the 'Add Disk' window was also enabled, it did
  470. |    not point to SCSI::4).
  471. |    So I added some icons and logic to let the user select a filing system,
  472. |    after which !DiskBase will check the drives present for that particular
  473. |    filing system.
  474. |  - The static heap I used to use is changed to a sliding heap, which also
  475. |    makes use of Dynamic Areas if the program is run on a Risc PC.
  476. |    For the source and an explanation of this heap written by Alan Wrigley
  477. |    see "Risc User" volume 9, issue 1 (November 1995), and the modification
  478. |    in volume 9 issue 6 (May 1996), pg. 43.
  479. |  - As a result of a change in version 0.74, an explicit DELETE of a disk
  480. |    could cause an infinite loop, but deleting a disk by adding one with the
  481. |    same name didn't suffer from this. This is now fixed.
  482. |  - Clicking on lines of the RESULTS window when results of a DUPLICATES
  483. |    were shown, gave incorrect actions. This has been fixed now.
  484. |  - Several minor changed both cosmetic and functional were implemented as
  485. |    well.
  486. |  - One of the issues to be taken care of in a next release will be the use
  487. |    of the Wimp-font as configured on Risc OS 3.50 and above in the RESULTS
  488. |    window, without loosing the alignment of the column layout. This will
  489. |    probably need quite some change of the redraw code, but that was not
  490. |    feasible at the moment.
  491. |  - One more point is that I've always done my best to stay compatible with
  492. |    Risc OS 2.00, but as I've no way of testing this anymore, I will no
  493. |    longer try to be compatible with this Risc OS version.
  494. |    Even testing all code on Risc OS 3.10 myself will be quite hard to
  495. |    accomplish, but I will do all I can, or try to find some beta-testers
  496. |    for this.
  497.  
  498.