home *** CD-ROM | disk | FTP | other *** search
/ Amiga Plus Special 6 / Sonderheft_6-96.iso / pd / disktools / kan / kan.doc < prev    next >
Text File  |  1996-11-03  |  12KB  |  376 lines
  1.  
  2.  
  3.      Page 1                  The Kan System                     Page 1
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.                                The Kan System
  22.                                 Version 1.0a
  23.                   Copyright © 1992 by James Kevin Butts
  24.                             All rights reserved
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.  
  65.      Page 2                  The Kan System                     Page 2
  66.  
  67.  
  68.  
  69.   1. Introduction
  70.  
  71.        Have you ever deleted a file (or half a hard disk) and then
  72.      realized that you were in the wrong directory?  Well, of course
  73.      you have!  Enter, the Kan System.  This handy, dandy utility
  74.      allows your current DELETE command under CLI (and any other
  75.      program that deletes files) to move the file to a directory for
  76.      later removal.  Rather than instantly deleting a file, Kan will
  77.      simulate Workbench's Trashcan.  Files and whole directories are
  78.      moved to a special directory which is automatically cleared once
  79.      a day when you boot.
  80.  
  81.  
  82.   2. Contents
  83.  
  84.        This document should be accompanied by the following files :
  85.      INSTALLKAN - program to install the KAN system on your machine.
  86.      PINSTALL   - program that patches new delete logic into your system.
  87.      PDOS       - program that changes KAN option settings.
  88.      PURGE      - a script to delete the files in each KAN directory.
  89.      PURGEALL   - a script to delete files in all KAN directories.
  90.      SHIFTKAN   - a script that shifts the KAN directories around.
  91.      DEL2       - a script to allow REAL deletion of files.
  92.      SAMEDAY    - a program to determine if this is the first boot today.
  93.      KAN.DOC    - me.
  94.  
  95.  
  96.   3. How to
  97.  
  98.        To install KAN do the following :
  99.  
  100.      * Make sure your current directory contains the files listed above.
  101.      * Type "InstallKAN"
  102.  
  103.        Don't worry about InstallKAN.  It will copiously describe every
  104.      action it performs and will give you the option of aborting the
  105.      script before any action that modifies your system.  If InstallKAN
  106.      aborts because of an error you will be informed of the error and
  107.      what has been modified on your system.  After removing the cause of
  108.      the error, you can run InstallKAN again.  Also, you may run
  109.      InstallKAN at any time to reconfigure the KAN system.
  110.  
  111.        In a nutshell, InstallKAN asks you what partitions you want to
  112.      automatically PURGE daily.  Then it creates KAN directories on each
  113.      of those partitions.  Then INSTALLKAN, PINSTALL, PDOS and SAMEDAY
  114.      are placed in the directory you specify as your permanent C
  115.      directory.  Then PURGE, PURGEALL, SHIFTKAN, and DEL2 are placed in
  116.      the directory you specify as your permanent S directory.  Also the
  117.      KAN-SEQUENCE script is built and placed in that same directory.
  118.      Finally KAN informs you to add the following line to your
  119.      Startup-Sequence  :
  120.  
  121.              EXECUTE "<sdir>Kan-Sequence"
  122.  
  123.  
  124.      How to
  125.  
  126.  
  127.      Page 3                    The Kan System                   Page 3
  128.  
  129.  
  130.   4. What
  131.  
  132.      where <sdir> is your permanent S directory.  In most cases this will
  133.      be the S: directory.  Now you are installed.
  134.  
  135.        Now, here's what you've done to your system once you have
  136.      installed Kan :
  137.  
  138.        Every time you delete a file or directory it is really moved to the
  139.      "KAN" directory in the root of whatever partition said file resides
  140.      upon.  This is equivalent to dragging an icon over the Trashcan.  It
  141.      is still recoverable because it is only in the trash and has not been
  142.      carried to your local landfill yet.
  143.  
  144.        If you now realize... OOPS! I WAS IN THE WRONG DIRECTORY!!!  Your
  145.      file is safe and sound in KAN(sas).  (Sorry, I just couldn't help
  146.      myself;pun definitely intended but regretted.)  Ok, say you reboot...
  147.      It's still in your KAN directory (assuming this is still today).  Now,
  148.      say you turn off your machine and come back the next day (or next
  149.      week,etc.).  The Startup-Sequence will clear out the KAN directories
  150.      specified in Kan-Sequence which is created by InstallKAN when you tell
  151.      it which partitions to include.  Those not specified in PURGE will not
  152.      purge daily.  You will have to call "PURGE VOL:" where VOL is the name
  153.      of the partition, when you want to purge each of those volumes.
  154.  
  155.        However, things are just a little more complex than that because I
  156.      let you have more than one Kan!  If you specify one Kan then each
  157.      partition will contain one directory called KAN.  This directory will
  158.      be purged each new day you turn on your machine.  If you specify
  159.      seven Kans then each partition will contain KAN, KAN2, KAN3, ..., and
  160.      KAN7.  Each new day that you boot the directories will shift.  This
  161.      means a deleted file will move into KAN then to KAN2 then to KAN3 and
  162.      on eventually to KAN7 and finally back to KAN just before it is
  163.      purged.  This gives you seven days of computing before the file is
  164.      really deleted!
  165.  
  166.        If you are tight on space then you might want to go with only 1
  167.      KAN directory per partition.  If you decide to go housecleaning on
  168.      your harddisk then use the DEL2 script instaed to REALLY delete the
  169.      file(s).
  170.  
  171.        Finally PINSTALL, the command that installs the new KAN logic into
  172.      your system in place of the old DELETE logic, has some interesting
  173.      options.  These options are modifed by calls to PDOS.  Typing
  174.      PINSTALL will install the new logic.  This is performed in
  175.      KAN-SEQUENCE during boot up.  Typing PDOS OFF will restore the old
  176.      DELETE logic.  Generally you will never have to do this.  Please try
  177.      to remember to not un-install PDOS while another program is deleting
  178.      a file!  Typing PDOS ADD causes the shell you are typing in to always
  179.      perform REAL deletes.  PDOS ADDQ works just like PDOS ADD except no
  180.      message is printed if the shell is already marked to perform REAL
  181.      deletes.  This option is used by the DEL2 script.  PDOS REM will
  182.      mark a shell so that it will perform KAN deletes (this is the default
  183.      when a shell is created).  The script DEL2 uses the ADDQ and REM
  184.      features to perform a REAL delete and then restores the script to its
  185.  
  186.      What
  187.  
  188.  
  189.  
  190.      Page 4                    The Kan System                   Page 4
  191.  
  192.  
  193.   4. What
  194.  
  195.      previous settings.  But your system's performance isn't degraded
  196.      through calls to DEL2.  This is because PDOS is pure and
  197.      KAN-SEQUENCE adds PDOS to the resident list.  Thus bracketing Delete
  198.      with PDOS ADD and PDOS REM hardly makes a difference in speed.
  199.  
  200.        Unfortunately, with PDOS installed, ALL deleted files end up in
  201.      the Kan - some you might not have known about.  For instance, some
  202.      text editors save a file by first saving to a temporary file, then
  203.      the original file is deleted, and finally the temporary file is
  204.      renamed.  Therefore, the Kan will hold all old versions of your
  205.      files.  This is great if you have the disk space!.
  206.  
  207.        To reduce the number of temporary files that will build up on
  208.      your system, I added an exceptions table that will hold 20
  209.      exceptions for filenames.  The entries in the table can be up to 20
  210.      characters in length and they represent the FIRST characters of
  211.      the filename (no wildcards necessary).  For instance,
  212.  
  213.                PDOS ADD !LZ-RECOVERY!.
  214.  
  215.      will tell pdos to refrain from saving the temporary file (such as
  216.      !LZ-RECOVERY!.012392) from the LZ command.  The entries are
  217.      case sensitive.  However, because this feature is provided to
  218.      avoid temporary files created automatically, this should be no
  219.      problem.  Simply keep an eye on your KAN directories for the next
  220.      few weeks and add PDOS ADD filename commands to your
  221.      Startup-Sequence when you see temporary files appear.
  222.  
  223.        Note the rules under which REAL deletes will occur :
  224.  
  225.      * From any shell in which PDOS ADD has been typed.
  226.          NOTE : Any program run from this shell even if it has
  227.                 its own window or screen may or may not perform
  228.                 REAL deletes.
  229.      * Any file whose partial name is in the exceptions table.
  230.      * On any partition which does not have a ":KAN" directory.
  231.      * Any file already in a ":KAN" directory.
  232.      * Actual empty directories are deleted.
  233.  
  234.  
  235.   5. Examples
  236.  
  237.        Assume a file exists on RAM called ooga and RAM:KAN exists.
  238.      Typing "DELETE RAM:ooga" will move RAM:ooga to RAM:KAN/ooga.
  239.  
  240.        Typing "DELETE RAM:KAN/ooga" will REALLY delete ooga.
  241.  
  242.        Also, typing "DEL2 RAM:KAN/ooga" will delete it.
  243.  
  244.        NOTE: Similar results will be seen from disk utilities and
  245.              even the Workbench menu.  The Kan is not limited to
  246.              the CLI but is a system-wide program!
  247.  
  248.  
  249.      Examples
  250.  
  251.  
  252.  
  253.      Page 5                    The Kan System                   Page 5
  254.  
  255.  
  256.   5. Examples
  257.  
  258.        Assume a file exists on RAM called ooga and RAM:KAN exists
  259.      already containing a file called ooga. Typing "DELETE RAM:ooga"
  260.      will move RAM:ooga to RAM:KAN/ooga;1.  Therefore, you do not have
  261.      to worry about deleting several files with the same name
  262.      overwriting each other.  You may have up to 100 files in KAN 
  263.      coming from the same name (ooga through ooga;99).  If you try to
  264.      delete a 101th file you will be warned and the deletion will not
  265.      occur.  You can then PURGE and try again.
  266.  
  267.      NOTE : Deleting the 100th ooga will take longer than the first
  268.             since Kan must search for a free slot in the KAN directory.
  269.  
  270.        Assume you have have a directory such as FONTS with
  271.      subdirectories and a KAN directory.  Typing "DELETE FONTS ALL"
  272.      will move every file in every subdirectory into KAN.  Thus,
  273.      directory structure is not preserved.  However, this is better
  274.      than nothin'.
  275.  
  276.  
  277.   6. License
  278.  
  279.  
  280.                        Kan System version 1.0a
  281.                   © Copyright 1992 James Kevin Butts
  282.  
  283.  
  284.  DISCLAIMER
  285.  ----------------------------------------------------------------------------
  286.  The author takes no responsibility as to the suitability or accuracy of this
  287.  documentation and/or the program(s) it describes. Any damage sustained by
  288.  the use of  this documentation and/or  the program(s) it  describes is  the
  289.  sole responsibility of the user her/him self.
  290.  ----------------------------------------------------------------------------
  291.  
  292.  COPYRIGHT
  293.  ----------------------------------------------------------------------------
  294.  Kan System, © Copyright  1992  by James Kevin Butts.  All  rights  reserved.
  295.  This program may be  distributed  non-commercially  only  providing that the
  296.  documentation, copyright notice, and any other included files remain intact.
  297.  This program is FREEWARE so no financial donation is necessary (but welcome).
  298.  ----------------------------------------------------------------------------
  299.  
  300.  
  301.  
  302.  
  303.  
  304.  
  305.  
  306.  
  307.  
  308.  
  309.  
  310.  
  311.  
  312.      TroubleShooting
  313.  
  314.  
  315.  
  316.      Page 6                    The Kan System                   Page 6
  317.  
  318.  
  319.   7. Feedback
  320.  
  321.        If you have any comments, ideas what could or should be
  322.      improved, bug reports or just like to chat a bit, please feel
  323.      free to contact me at the following address.
  324.  
  325.         James Kevin Butts
  326.         2065 Sunlake BLVD #1408
  327.         Huntsville, AL 35824
  328.  
  329.  
  330.   8. Thanx
  331.  
  332.      I would like to thank the following personages for answering
  333.      my echos, sending me sample code, beta tested code, ad
  334.      infinitum.  (I always wanted to add infinity.)  :)
  335.  
  336.               Richard Rauch
  337.               Paul Kienitz
  338.               Pierre Dak Baillargeon
  339.               Tony Bybell
  340.               Jason Burley
  341.               Steven (Dragon) Johnston
  342.  
  343.      and anyone else who made any contributions.
  344.  
  345.   9. Index
  346.  
  347.         1. Introduction     ....................................    2
  348.         2. Contents   ..........................................    2
  349.         3. How to    ...........................................    2
  350.         4. What     ............................................    3
  351.         5. Examples    .........................................    4
  352.         6. License     .........................................    5
  353.         7. Feedback     ........................................    6
  354.         8. Thanx     ...........................................    6
  355.         9. Index    ............................................    6
  356.  
  357.  
  358.  
  359.  
  360.  
  361.  
  362.  
  363.  
  364.  
  365.  
  366.  
  367.  
  368.  
  369.  
  370.  
  371.  
  372.  
  373.  
  374.  
  375.      Index
  376.