@database 08f763e8-0
@master DH_C_Programing:StormC_V4/Projects/AutoBkup/Docs/AutoBKUP.guide
@$VER: 1.0
@width 78
@remark Created with Heddley v1.20ß © Edd Dumbill 1994-5

@node "Main" ""
                                 @{b}AutoBKUP@{ub} V 1.0
                                      by

                                   @{i}Jack York@{ui}
                                   (08.25.01)

                                << @{fg shine}FreeWare@{fg text} >>

   Contents

   @{" Introduction   " link "Introduction" 0}    What does it do?
   @{" Requirements   " link "Requirements" 0}    What does it need?
   @{" Installation   " link "Installation" 0}    Where should I put it?
   @{" Config         " link "Config" 0}    Can it be configured?
   @{" Usage          " link "Usage" 0}    How do I do it?
   @{" Layout         " link "Layout" 0}    What does it look like?
   @{" Menus          " link "Menus" 0}    How can I control it?
   @{" History        " link "History" 0}    What has it been up to?
   @{" Author         " link "Author" 0}    Who did this anyway?
   @{" Registering    " link "Register" 0}    Should I pay him for it?
   @{" Other Programs " link "Other Programs" 0}    What else has he done?
   @{" Bugs & Notes   " link "Bugs" 0}    What's wrong with it?
@endnode

@node "Introduction" "Introduction"
AutoBKUP's (Automatic Backup) sole purpose is to backup selected files at a
specified time.  Currently there are @{"five ways" link "Layout" 0} to set these times.

 1 - Do backup after computer has been turned on for a certain amount of
     time.
 2 - Do backup after the program starts.
 3 - Do backup at a specific date/time.
 4 - Do backup at regular intervals (from seconds to monthly).
 5 - Do backup if file date has changed.

AutoBKUP is ran in the background as a commodity and, once set up, requires no
further intervention from the user.  It will backup the files as specified at
the times specified.  This allows you to always have backed up data.

This came about because, even though I do full backups on a regular basis,
there are times in between when I could lose some data that would be hard to
replace should something go wrong.  With AutoBKUP running, I now know that
backups are being made while I do other things.
@endnode

@node "Requirements" "Requirements"
AutoBKUP requires OS 3.0 or later since it uses ClassAct/Reaction gadgets and
classes. The program also requires a stack size of 8 K or to have a program
such as StackAttack running.
@endnode

@node "Installation" "Installation"
AutoBKUP doesn't require any special installation.  The program will run from
any location.  However, it does look for its configuration file in the
directory it is started from.

Two versions are supplied, AutoBKUP_020 and AutoBKUP_060.  Use whichever
matches your system or, if you are not sure, just use the 020.
@endnode

@node "Config" "Config"
The configuration file contains all of the current settings of all
configurations you created.  A number of @{"ToolTypes" link "Arguments" 0} are also supported.
@endnode

@node "Usage" "Usage"
@next "Layout"
@prev "Config"
Start the program by doubleclicking on its icon or entering run >nil: AutoBKUP
in a shell. It doesn't require any @{"arguments" link "Arguments" 0} although a few are available.
However, if you are running the program from a shell and you don't have a
program such as StackAttack running, then type in stack 8000 prior to running
the program.

Add a file(s) to be copied by clicking on Add File(s) gadget.  If no file is
entered in the file requester, the whole directory will be used.  Set up the
type of copy you would like to perform, click on @{"Use" link "Layout" 0} or un-check the
@{"Stop Copying while window open " link "Layout" 0} option and and the copy will begin.
@endnode

@node "Layout" "Layout"
@next "Menus"
@prev "Usage"
Click @{"here" system "sys:utilities/multiview images/abkupmain.jpg"} to view the gui.

@{b}@{i}On the left side@{ub}@{ui} of the window is a listbrowser.  This is where you enter the
files or directories that you want copied.

 Add Files(s): Clicking on this will open a requester.  If a file is not
               selected the whole directory will be used.

 On/OFF: Will cause the files in the listbrowser to be selected/unselected.

 Delete: Delete the selected entries in the listbrowser.

@{b}@{i}On the right side@{ub}@{ui} there are four sections.

 @{u}File Locations@{uu}: (Specific to each config file)

  Destination: Select where you would like the files copied to.  A separate
               location can be entered for each config created.

  WorkFiles:   Select the location for the programs workfiles to be stored.
               One location is used for all workfiles.

 @{u}Run Options@{uu}:  (Specific to each config file)

  Clone file attributes: When set, the date, comment and protection bits of
                         the file to be copied will be copied to the
                         destination file.

  Skip files with same dates: If the destination file already exists and has
                              the same datestamp as the original, the copy
                              will not occur if this option is set.

  Warn on file Over Write: Display a requester warning that a file will be
                           overwritten.

 @{u}Global Options@{uu}: (Applies to ALL config files)

  Always Show GUI on startup: When set, the GUI will be displayed each time
                              the program is started.  This can be
                              overridden by the @{"tooltype" link "Arguments" 0} showgui.

  Delete History file at program start: The history file showing all copies
                                        will be deleted each time the
                                        program is started.

  Exit program when done: When the selected configs have ran successfully
                          the program will exit.  Note that this option
                          may cause the program to behave differently than
                          expected if the interval copy option is chosen.

  Keep record of all copies: Create a file that contains a list of all the
                             files that were copied.  Will also list files
                             that failed to copy.

  Run all config settings: If set, all defined config files will be ran.

  Stop copying when window is open: If the GUI is being displayed, copies
                                    will cease if this option is set.  Un-
                                    setting it will cause copies to start.

  New: Create a new config file.

  Edit: Edit the name of a config file.

  Delete: Delete a config file.

  Chooser: Select a config file.

  Hotkey: The keyboard key press needed to show the GUI.

 @{u}Time Settings@{uu}: (Specif to each config file except for the Timer Interval)

  After Power On: Perform a copy after the computer has been powered on for
                  a certain amount of time as set in the time gadgets.

  At Program Start: Perform a copy as soon as the program begins.

  At Specified Date/Time: Perform a copy at an exact time as indicated in the
                          date/time gadgets.

  At Regular Intervals: Perform copy at regular intervals as indicated by the
                        date/time gadgets.

  If File date has changed: Perform a copy if the file date has changed since
                            the date/time indicated.

  Date/Hours/Minutes/Chooser - Select the date/time for the type of copy.
                               Note that only applicable gadgets will be
                               available for each type of copy.

  Timer Interval: How often all of the above settings will checked.

@{b}@{i}At the bottom@{ub}@{ui} are the control gadgets:

 Quit - quit the program.  Any changes are NOT saved.

 Use  - close the window after getting any changes made.  The program
        will still be active.

 Save - close the window after getting any changed made AND save all the
        changes.

 Cancel - close the window.  Will attempt to undo the changes made to the
          last config file although any list nodes added will remain.
@endnode

@node "Menus" "Menus          "
Menus

Project:

 
 Save Config     - Saves the current settings.

 Quit            - Quit the program.
@endnode

@node "History" "History"
Release History:

 VERSION              RELEASE DATE             COMMENTS


   1.0                  08.25.01           Initial release
@endnode

@node "Author" "Author"
If you have any comments or questions you can reach me at

 jyork@twmi.rr.com

 or

 jyork@voyager.net

 The most recent version of the program can be download from my
 webpage at http://my.voyager.net/~jyork
@endnode

@node "Register" "Register"
The program is free (although gifts will not be refused :) ) and fully
functional so registering is not required.  However I do make frequent changes
that are not always uploaded to Aminet right away. If you would like to be
notified of these updates then you should register (just send @{"me" link "Author" 0} an email
saying you want to hear about the changes).  Also, I would appreciate hearing
from anyone that uses it; suggestions and good or bad opinions are welcome.
@endnode

@node "Other Programs" "Other Programs"
Here are some other programs I have written.  If you can't find them just drop
@{"me" link "Author" 0} an email.

 FindChanges - Find any changes made to the files on your hard drive for a
               specified period.

 Payroll     - Complete system to handle the payroll of any business, large
               or small.

 PhoneSpell  - Converts a phone number into a phase.
@endnode

@node "Bugs" "Bugs"
Bugs:

 None that I know of.
@endnode

@node "Arguments" "arguments"
AutoBKUP does not currently support command line arguments but it does use
several ToolTypes.


 - CX_PRIORITY - set the priority the program runs at.

 - CX_POPUP    - enable the hotkey option.

 - HOTKEY      - enter the keyboard keys to show the gui.

 - DONOTWAIT   - don't wait for the program to finish.
                 This should be set else it may cause
                 other programs to wait for it to finish,
                 which it won't usually.

 - SHOWGUI     - This is used as an override switch.  If the
                 option @{"Exit Program when done" link "Layout" 0} is selected
                 along with @{"Always show gui" link "Layout" 0} being NOT
                 selected, the program may start and stop
                 before the user can activate the gui.
                 This will force the window to be displayed
                 so options can be changed.
@endnode

