home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 4 / DATAFILE_PDCD4.iso / utilities / utilsm / ramstore / !RAMstore / Docs / Manual next >
Encoding:
Text File  |  1996-04-04  |  12.5 KB  |  280 lines

  1.  
  2.  ABOUT THIS PROGRAM
  3.  ---------------------------------------------------------------------------
  4.  Name    : RAMstore
  5.  Version : 1.02 (04 Apr 1996)
  6.  Purpose : Semi-permanent RAM disc
  7.  Author  : © Andrew Berry, 1996
  8.  Licence : Freeware. Please see conditions at the end of this file.
  9.  
  10.  RAMstore supports Interactive Help.
  11.  
  12.  
  13.  PURPOSE
  14.  ---------------------------------------------------------------------------
  15.  The idea of this program is to provide a 'semi-permanent' RAM disc, the
  16.  idea being that it is loaded in your boot sequence each time you use your
  17.  computer. When loaded it will copy a specified directory from a permanent
  18.  storage media (for instance hard disc) onto the RAM disc. This directory
  19.  can then be accessed from the icon bar and used in the same way as the RAM
  20.  disc. When the program is quit or you shutdown the computer the directory
  21.  will be copied back onto the hard disc ready for re-loading next time you
  22.  start up.
  23.  
  24.  In other words, it allows you to make use of the fast access time of the
  25.  RAM disc, but with the advantage that your data will be automatically
  26.  stored so your don't need to bother about transferring it when you've
  27.  finished working.
  28.  
  29.       
  30.  CREATING A STORAGE DIRECTORY
  31.  ---------------------------------------------------------------------------
  32.  When you first use RAMstore you will need to specify a storage directory.
  33.  This is a directory on a permanent disc (ie hard disc) which is used to
  34.  store the data which will be copied to RAM each time the program is run.
  35.  
  36.  Selecting 'Create...' from the 'Storage' submenu brings up a window with a
  37.  blue folder on the left hand side. Enter a filename in the box below this
  38.  icon and drag the folder to a directory viewer where you want the storage
  39.  directory to be created. The filename will appear in the long white box
  40.  but the directory will be created ONLY when your click on 'Create'.
  41.  Selecting 'Cancel' will close the window without creating the storage
  42.  directory.
  43.  
  44.  Once you have clicked on 'Create' the storage directory will be created
  45.  and copied to RAM. The program is then ready for use as described in the
  46.  later section, 'Once the storage directory has been set'.
  47.  
  48.  
  49.  ALTERING THE STORAGE DIRECTORY
  50.  ---------------------------------------------------------------------------
  51.  If you decide to alter the position of the storage directory this must be
  52.  done using the 'Alter...' option of the 'Storage' submenu.
  53.  
  54.  The pathname of the current storage directory is shown in the top left.
  55.  Dragging the blue folder will specify the position of the new storage
  56.  directory, as for creating a new one, and the pathname will appear in the
  57.  lower long white box. Clicking on 'Alter' will cause the new storage
  58.  directory to be created according to the two options which can be set from
  59.  the top right of the window.
  60.  
  61.  'Transfer contents' is used to copy the complete contents of the current
  62.  storage directory to the new storage directory. This is turned on by
  63.  default as you will usually want to copy the contents of the directory
  64.  otherwise your data won't be available next time you use the program!
  65.  
  66.  'Delete old' only applies when 'Transfer contents' is selected, and is used
  67.  to remove the old storage directory after copying the contents to the new
  68.  position. This is also on by default.
  69.  
  70.  
  71.  DELETING THE STORAGE DIRECTORY
  72.  ---------------------------------------------------------------------------
  73.  The final option on the 'Storage' directory is 'Delete...'. This opens a
  74.  window which shows the pathname of the current storage directory. Clicking
  75.  on 'Delete' will remove the storage directory from the PERMANENT media, but
  76.  will leave the RAM version alone.
  77.  
  78.  
  79.  USING THE 'STORAGE' OPTIONS
  80.  ---------------------------------------------------------------------------  There is some flexibility when using the options on the 'Storage' menu. For
  81.  instance, deleting the current storage directory will not delete the data
  82.  which is on the RAM disc. If a new storage directory is then created, the
  83.  RAM data will be copied to the new storage directory when the program
  84.  is quit.
  85.  
  86.  If no storage directory is selected then clicking with either Select or
  87.  Adjust on the icon bar will open the 'Create...' window to save you using
  88.  the menu. Otherwise they behave as described below.
  89.  
  90.  
  91.  ONCE THE STORAGE DIRECTORY HAS BEEN SET
  92.  ---------------------------------------------------------------------------
  93.  After a storage directory has been created the program is ready for general
  94.  use. To be of any real use it should be loaded in the desktop boot file. A
  95.  line such as the following should be inserted:
  96.  
  97.      Filer_Run ADFS::IDEDisc4.$.Utilities.!RAMstore
  98.      
  99.  Filer_Run should be replaced by Run on pre-RISC OS 3 machines.
  100.  
  101.  The program will not function correctly unless a RAM disc has been
  102.  configured. This can be done by typing
  103.         
  104.         Configure RamFsSize 64K
  105.         
  106.  at the command line, replacing 64 with a size suitable for your expected
  107.  use. If you attempt to start RAMstore when no RAM disc is present, the data
  108.  will not be copied from the storage directory. However, the program will
  109.  still load and the data can be transferred after a RAM disc has been
  110.  created. See the section 'Backing up and Restoring' for details.
  111.  
  112.  
  113.  USING THE PROGRAM
  114.  ---------------------------------------------------------------------------
  115.  Once the storage directory has been selected and the appropriate line
  116.  inserted in your boot file, the program will start up ready for use each
  117.  time you use the computer.
  118.  
  119.  The RAMstore directory on the RAM disc can be accessed in two ways.
  120.  
  121.      1)   By opening the root directory of the RAM disc as usual and
  122.           opening the RAMstore directory
  123.           
  124.      2)   By clicking on the RAMstore icon on the icon bar.
  125.      
  126.  The second method is recommended, as only the RAMstore directory is stored
  127.  on permanent disc and data could be saved elsewhere on the RAM disc by
  128.  accident if the first method is used.
  129.  
  130.  Although the RAMstore directory is opened using the RAMstore program,
  131.  please remember that it is in fact just the RAM disc you are using. This
  132.  program only provides a method of copying the data at the end of each
  133.  session. Therefore, using this program is just as fast as using the RAM
  134.  disc and the RAMstore directory can be used in the same way as any other.
  135.  Data is only copied to disc at the end of each session, therefore providing
  136.  a very fast and virtually transparent system.
  137.  
  138.  
  139.  STORING THE DATA
  140.  --------------------------------------------------------------------------
  141.  The data which is on the RAM disc is automatically transferred to disc
  142.  when the user does any of the following:
  143.  
  144.      -   Selects 'Quit' from the main menu
  145.      -   Quits from the task manager
  146.      -   Selects 'Exit' from the task manager menu
  147.      -   Shuts down using either the task manager menu or with
  148.          Ctrl-Shift-F12
  149.          
  150.  The first method is recommended because there is no possibility of data
  151.  loss this way. Even if the data cannot be transferred to disc by the
  152.  program it will still be available to copy manually - the program doesn't
  153.  delete data in the RAM disc at any stage. If the user shuts down then the
  154.  data is transferred OK unless a problem is encountered, in which case it
  155.  will be lost. This is only a temporary problem and should be fixed for a
  156.  future version.
  157.  
  158.  
  159.  BACKING UP AND RESTORING
  160.  ---------------------------------------------------------------------------
  161.  The two remaining items on the main menu are as follows:
  162.  
  163.  Backup : Selecting this will cause the data in the RAMstore directory on
  164.           the RAM disc to be copied to the storage dirctory. This is to
  165.           enable a backup of the RAMstore directory to be made without
  166.           quitting the program.
  167.           
  168.  Restore: This will only be available if a problem was encountered when
  169.           the program started up. An obvious example is attempting to start
  170.           the program when no RAM disc is present. The program will still
  171.           start, and the data can be copied later after a RAM disc has been
  172.           created by selecting 'Restore'.
  173.  
  174.  
  175.  AUTOMATIC BACKUP
  176.  ---------------------------------------------------------------------------
  177.  This feature can be used as protection, just in case the computer crashes
  178.  losing any data in the RAM disc. Selecting 'Options...' from the icon bar
  179.  menu opens an options window, which currently has only one section.
  180.  
  181.  The automatic backup time is shown in the display icon and can be altered
  182.  in 5 minute increments using the up and down arrows. Provided 'Backup
  183.  every...' is selected, the data from the RAMstore directory on the RAM disc
  184.  will be copied to permanent disc, in exactly the same way as if you had
  185.  selected 'Backup' from the menu. This feature ensures that you don't forget
  186.  to back up the data. If 'Confirm' is selected then you will be queried
  187.  before backing up takes place.
  188.  
  189.  Clicking on 'OK' closes the window and implements the new options.
  190.  Selecting 'Save' saves the options, which will be used next time the
  191.  program is loaded.
  192.  
  193.  
  194.  QUITTING THE PROGRAM
  195.  ---------------------------------------------------------------------------
  196.  The 'Quit' option on the icon bar menu has a submenu containing two items.
  197.  Selecting 'Backup' will backup the data and quit, and is equivalent to
  198.  selecting 'Quit' in version 1.00. Selecting 'Discard' will quit without
  199.  saving the data. This will rarely be needed, and confirmation is requested
  200.  before the program will quit.
  201.  
  202.  Selecting 'Quit' from the icon bar menu has the same effect as selecting
  203.  'Backup' from it's submenu, and so the submenu need not be used unless the
  204.  'Discard' option is needed.
  205.  
  206.  
  207.  HISTORY
  208.  ---------------------------------------------------------------------------
  209.  1.00 (09 Apr 1995) : • The first version, fully working.
  210.  ---------------------------------------------------------------------------
  211.  1.01 (13 Aug 1995) : • Added options window
  212.                       • Automatic backup facility added
  213.                       • Can now quit without saving data, using the new
  214.                         Quit submenu
  215.                       • Clicking on 'Storage' on the icon bar menu now
  216.                         selects 'Create...' if selectable
  217.                       • Short filenames now displayed correctly in the
  218.                         windows
  219.  ---------------------------------------------------------------------------
  220.  1.02 (04 Apr 1996) : • Quit.Backup on menu is now greyed out at the same
  221.                         time as Backup.
  222.                       • Updated templates
  223.                       • Added interactive help
  224.  
  225.    
  226.  THINGS TO DO
  227.  ---------------------------------------------------------------------------
  228.  • Improve shutdown procedure so that the shutdown is halted if the data
  229.    can't be saved.
  230.  
  231.  
  232.  BUGS
  233.  ---------------------------------------------------------------------------
  234.  In case of any serious bugs which I am unaware of, you are advised to quit
  235.  using the option on the main menu, as this eliminates ANY possibilty of
  236.  data loss. If the program crashes at any stage you will be able to access
  237.  the data manually from the directory on the RAM disc.
  238.  
  239.  
  240.  DISTRIBUTION NOTES
  241.  ---------------------------------------------------------------------------
  242.  This program is Freeware, NOT public domain. This means that I retain the
  243.  copyright but give everyone the right to distribute it by any means, as
  244.  long as all files are supplied and I am fully credited.
  245.  
  246.  If you would like to include this program on a magazine cover disc then
  247.  please contact me first to obtain the latest version. If you run a PD
  248.  library and did not obtain this program from me, then you may like to write
  249.  and I'll send you the latest versions of all my programs followed by
  250.  regular updates as they become available.
  251.  
  252.  
  253.  PLEASE NOTE
  254.  ---------------------------------------------------------------------------
  255.  Although this program has been fully tested, I (the author) cannot be held
  256.  responsible for any loss or damage caused by the use or misuse of this
  257.  program. It is used entirely at your own risk.
  258.  
  259.  
  260.  CONTACT
  261.  ---------------------------------------------------------------------------
  262.  Please write to me at the address below. I would be interested to hear if
  263.  you have ideas for improving the program or have found any bugs.
  264.  
  265.  New versions of all my programs are always sent first to APDL and
  266.  The Datafile or can be obtained by writing to the below address, enclosing
  267.  either a cheque for £1.00 or a disc and return postage.
  268.  
  269.  The file !RAMstore.Docs.Others contains details of my other programs.
  270.        
  271.  Please write to:
  272.  
  273.     Andrew Berry
  274.     39 Lancaster Avenue
  275.     Sandiacre
  276.     Nottingham
  277.     NG10 5GW
  278.     
  279.  ---------------------------------------------------------------------------
  280.