home *** CD-ROM | disk | FTP | other *** search
/ Amiga Format 50 / af050sub.adf / ABackup / ABackupEnglish.doc < prev    next >
Text File  |  1993-06-25  |  39KB  |  791 lines

  1.  
  2.  
  3.                 ABackup - User's Manual
  4.  
  5.  
  6.  
  7.  
  8.  
  9. AboutThisDoc
  10.  
  11.       This manual describes release 2.00  of  the  utility    ABackup.  This
  12.   program is (c)1992 by  Denis  GOUNELLE,  any  commercial  usage  or  selling
  13.   without author's written authorization is strictly forbidden. You  can  copy
  14.   and spread this program at the following conditions:
  15.  
  16.     - all the files must be provided
  17.     - none of the file must have been modified
  18.     - you don't charge more than $6 for copy fee
  19.  
  20.       In spite of several tests, no warranty is made that there's no error
  21.   in ABackup. YOU USE THIS PROGRAM AT YOUR OWN RISKS. In no event  will  I  be
  22.   liable for any damage, direct or indirect, resulting of the use of  ABackup.
  23.  
  24. Introduction
  25.  
  26.       ABackup is a backup program written for the Amiga. It  can  be  used
  27.   both to make a backup of your hard disk or to  archive  files,  has  a  full
  28.   Intuition interface, and can use XPK    library.  Under  2.0  system  release,
  29.   ABackup is able to recognize links and to manage high density disks.
  30.  
  31.       This program is SHAREWARE. If you find it useful, I  invite  you  to
  32.   send me $10 at the address listed below in  order  to  become  a  registered
  33.   user. Please use only :
  34.  
  35.       - checks from a French bank
  36.       - cash (French Francs prefered, otherwise any currency of the E.E.C.  is
  37.     accepted, as well as US dollars and Swiss  Francs  ;  in  either  case
  38.     please add a little more for change fee)
  39.       - checks from an European bank
  40.  
  41.   If you send me a check, it must be in French Francs and the beneficiary must
  42.   be "M. GOUNELLE Denis". In either case,  as  a  registered  user,  you  will
  43.   receive the next version of ABackup as soon as it  will  be  available.  You
  44.   should be aware that this contribution fee only gives right to  one  update.
  45.   If you want to receive the next updates regularly,  a  $20  contribution  is
  46.   required.
  47.  
  48.       Suggestions  and/or  criticisms  will  be  always  welcomed.     Don't
  49.   hesitate to write at the following address :
  50.  
  51.                    M. GOUNELLE Denis
  52.                     Boite 71
  53.                   6, rue des cailloux
  54.                  92110 CLICHY - FRANCE
  55.  
  56.       You can also send a message to  the  following  Internet  address  :
  57.   gounelle@alphanet.ch. Note that this mailbox is not  mine,  so  please  send
  58.   only short messages. As I don't have direct access to  the  messages,  don't
  59.   expect an answer before a dozen of days.
  60.  
  61.       Thanks to Michel SCHINZ (without him, this program  would  be  still
  62.   only at the planning stage)  and  Jean-Yves  PROUX  for  their  suggestions.
  63.   Special thanks to  Jean-Philippe  RAPP  for  his  numerous  suggestions  and
  64.   constant supporting. Last, thanks to XPK library authors for their wonderful
  65.   work.
  66.  
  67. Getting_started
  68.  
  69.       ABackup can be run as well from CLI as from Workbench. From the CLI,
  70.   you can invoke ABackup by a syntax as follows :
  71.  
  72.      ABackup [FROM directory] [BUFSIZE size] [NOCOMP ext,ext,...] [NOTASK]
  73.  
  74.       The BUFSIZE option allows to change the size of the read buffer (for
  75.   example "BUFSIZE 64" asks for a 64 Kb buffer). By default, the  buffer  size
  76.   is 4 Kb large. You can specify a directory name for backup (with the  "FROM"
  77.   option); by default, this one will be  the  current  directory.  The    NOCOMP
  78.   option allows to specify extensions of file names to don't compress. You can
  79.   specify  up  to  10  extensions,  separated  by  a  comma   (e.g.:   "NOCOMP
  80.   .info,.run").
  81.       Usually, ABackup tries to create a child task that will perform  all
  82.   write operations (this speedup backup between 10-20%). If the task  creation
  83.   fails, ABackup will do write    operations  itself,  just  like  the  previous
  84.   versions of the program. If the creation of the child task is a problem  (no
  85.   memory etc...) you can prevent  ABackup  to  create  it  with  the  "NOTASK"
  86.   argument.
  87.  
  88.       From the Workbench, you can change the size of the  read  buffer  by
  89.   adding a line of the form "BUFSIZE=<size in Kb>" in the "TOOL  TYPES"  field
  90.   of ABackup icon. You can also specify extensions  of    file  names  to  don't
  91.   compress by adding a line  of  the  form  "NOCOMP=ext,ext,...",  or  prevent
  92.   ABackup to create a child task by adding a line "NOTASK".  Finaly,  you  can
  93.   set ABackup as "DEFAULT TOOL" of an archive file.
  94.  
  95.       When the program starts, a screen is displayed with several  gadgets
  96.   in it : "Backup an AmigaDOS partition", "Restore", "Rebuild catalogue",  and
  97.   "Quit". Click on the gadget that matches the wanted action.
  98.       The startup screen has also a menu with the "Config...",  "About..."
  99.   and "Quit" options. The first one allows  to  modify  ABackup  configuration
  100.   (see "Configuration" section), the second one  displays  informations  about
  101.   the program, and the last one allows to quit ABackup.
  102.  
  103. Configuration
  104.  
  105.       A window appears in the middle of the screen,  with  eight  gadgets.
  106.   The first three gadgets show the names of the viewer programs  corresponding
  107.   to the type of a file (ASCII file, IFF picture or other, see  the  "Viewing"
  108.   section)   and   the      two     next     the    names     of    the    external
  109.   compression/decompression program (see the "Compression" section).
  110.       At the bottom of the window, three gadgets enable  to  validate  the
  111.   changes, to validate and save the changes, or to  cancel  the  changes.  The
  112.   configuration is saved to the "S:ABackup.config" file, which is loaded  each
  113.   time the program start.
  114.  
  115. Requesters
  116.  
  117.       When using ABackup, often you'll see requesters with one message and
  118.   one or two gadgets ("Ok", "Continue/Abort", "Yes/No").
  119.  
  120.       In any case, you can reply to a request by clicking on one of  these
  121.   gadgets, or by pressing the key corresponding to the first letter of a reply
  122.   (for example, the "c" or  "C"  key  for  "Continue").  You  can  also  press
  123.   <RETURN> for a positive reply ("Ok",  "Continue",  "Yes")  or  <ESC>  for  a
  124.   negative reply ("Abort", "No").
  125.  
  126.       Finally, when a requester message asks for inserting a disk  in  one
  127.   drive, inserting a disk in this drive will be  detected  and    this  will  be
  128.   equivalent to clicking on the "Continue" gadget.
  129.  
  130. Backup_an_AmigaDOS_partition
  131.  
  132.       A requester is displayed that allows    to  choose  the  directory  to
  133.   backup. By clicking on the "Cancel" gadget, ABackup will return to the  main
  134.   screen. By clicking on the "OK" gadget,  ABackup  will  load  the  directory
  135.   contents. For breaking this loading, click on the "Abort"  gadget  or  press
  136.   one of the following keys : "a", "A", <ESC>.
  137.  
  138.       As directory contents is loaded, the selection screen is  displayed.
  139.   This screen consists of a gadgets set and a bottom area where are  displayed
  140.   files and subdirectories of the current directory. At the start, no file and
  141.   no directory are selected. Files are displayed in black on grey  background,
  142.   and directories in white on grey. Directories with at least  one  descendant
  143.   selected are displayed on a  black  background.  You    can  scroll  the  list
  144.   display by means of the vertical scroll bar on the right. The  name  of  the
  145.   current directory is displayed in the area named "Directory". The number and
  146.   size of the selected files are displayed in the area named "Selection".
  147.  
  148.       For selecting a file in a list, click on the name of this file :  it
  149.   is displayed in black on a blue  background  and  the  "Selection"  area  is
  150.   updated. If you click on a selected file, this one will be  unselected.  For
  151.   selecting or unselecting a set of files, click on the first  file  and  keep
  152.   down the left button while moving your mouse. Last, to  view    a  file,  just
  153.   double-click on its name (see "Viewing" section).
  154.       When you click on a directory name, two actions can happen. If  this
  155.   directory is empty, it will be selected or unselected as a file.  Otherwise,
  156.   the list display will be modified in order to make visible the  contents  of
  157.   this directory. The "Directory" area will be updated.  To  go  back  to  the
  158.   previous directory, you can either click on the "Parent" gadget (at the  top
  159.   of the scroll bar), either click on  the  hidden  gadget  between  the  left
  160.   border of the screen and the left border of the display area.  If  you  went
  161.   very down in the tree structure, you can go back  straight  at  the  initial
  162.   directory by clicking on the "Root" gadget (at the top of the scroll bar).
  163.  
  164.       At the top of the screen, there are two rows of  identical  gadgets.
  165.   These ones allow to select (first row) or to  unselect  (second  row)  files
  166.   and/or subdirectories in a global way according to various criterions :
  167.  
  168.   All
  169.       Selects or unselects all files and subdirectories from  the  current
  170.       directory.
  171.  
  172.   By name
  173.       Selects or unselects files and subdirectories according to a name or
  174.       a pattern. A pattern is a name with  one    of  the  special  AmigaDOS
  175.       characters: '#' or '?' under 1.3 system release, '#', '?', '|', '~',
  176.       '%', parenthesis, or brackets under 2.0  system  release.  For  more
  177.       informations, refer to your AmigaDOS User's manual.
  178.       A window is displayed with a string gadget. Type in it a name  or  a
  179.       pattern and validate your choice by pressing  <RETURN>.  Now,  click
  180.       either on the "==" gadget, if you want files or subdirectories whose
  181.       name matches the name or the pattern you typed, either on  the  "!="
  182.       gadget, if you want files or subdirectories whose name doesn't match
  183.       the name or pattern you typed. You  can  cancel  this  operation    by
  184.       clicking on the window close gadget.
  185.  
  186.   By date
  187.       Selects or unselects files and subdirectories according to the  date
  188.       of the last change. A window is brought up  with    a  string  gadget.
  189.       Type in a  date  and/or  time  respecting  the  following  syntax  :
  190.       DD-MM-YY or DD-MMM-YY for  the  date  (for  example,  "01-03-92"  or
  191.       "01-Mar-92"),  and  HH:MM:SS  for  time.  Validate  your  choice  by
  192.       pressing the <RETURN> key, then click over the "<="  gadget  or  the
  193.       ">=" gagdet,  according  as  you  want  to  get  earlier  files  and
  194.       subdirectories or later ones in relation to the typed date.
  195.       If you typed only time, the date will be the day date. If you  typed
  196.       only a date, time will be "23:59:59", when you click over  "<=",  or
  197.       "00:00:00", when you click over ">=". You can cancel this  operation
  198.       by clicking on the window close gadget.
  199.  
  200.   By bits
  201.       Selects or unselects files and  subdirectories  according  to  their
  202.       protection bit. A window is brought up with  a  string  gadget.  For
  203.       testing one or several bits (see the  AmigaDOS  command  "Protect"),
  204.       type them in this gadget and validate your choice  by  pressing  the
  205.       <RETURN> key. Click now over the "= 1" or "= 0" gadget according  as
  206.       you want files and subdirectories with their bits set or unset.  You
  207.       can cancel this operation by clicking on the window close gadget.
  208.  
  209.       The "Reverse" gadget allows to invert a  selection  :  all  selected
  210.   files become unselected  and    all  unselected  files    become    selected.  The
  211.   "Recursive" gadget controls the action of the "Reverse" gadget, just  as  it
  212.   controls the "All", "By name", "By date" and "By bits" gadgets : it shows if
  213.   selecting or unselecting will or will not concern  files  that  are  in  the
  214.   subdirectories of the current directory.
  215.       Last, the "OPTIONS" and "START"  gadgets  allows  to  modify  backup
  216.   options and to start backup (see just below).
  217.  
  218.       The selection screen has three menus too. The "Size" menu allows  to
  219.   change unit ABackup is using to display the size of selected files. You  can
  220.   choose beetween Bytes (the default unit), Kilobytes and  Megabytes.  If  you
  221.   select the "Automatic" item, ABackup  will  automatically  change  of  unit,
  222.   depending  of  the  size  of    selected  files.  Later,  we'll  describe  the
  223.   "Selection" menu. The "Backup" menu has the following options :
  224.  
  225.   Start
  226.       Allows to start backup. If you selected no file and no subdirectory,
  227.       an error message will be displayed. The backup progression  will    be
  228.       explained below.
  229.  
  230.   Options
  231.       Allows to change the backup options. These options are as follows  :
  232.  
  233.       Compress
  234.       Tells what kind of compression will be done :  none  (NO),  with
  235.       the functions integrated to ABackup (Internal), with an external
  236.       program (External) or with XPK library. For  more  informations,
  237.       see "Compression" section.
  238.       Note that ABackup will not try to compress files with a  ".lha",
  239.       ".lzh", ".zoo", ".arc", ".pp" or ".z" file  name  extension,  as
  240.       well as any file less than 512 bytes long. You can specify other
  241.       extensions to don't compress,  with  the  NOCOMP  argument  (see
  242.       "Getting_started" section).
  243.  
  244.       Verify
  245.       Reread and compares every track  after  writing  it.    Meaningful
  246.       only for backup to disks.
  247.  
  248.       Backup links
  249.       Backup selected links. Meaningful only under 2.0 system release.
  250.       An archive which contains links can of course be  restored  even
  251.       under 1.3 system release (links will simply be not restored).
  252.  
  253.       Set archive bit
  254.       Once backup is over, sets the  archive  bit  (see  the  AmigaDOS
  255.       command "Protect") of all files and subdirectories  successfully
  256.       backed up.
  257.  
  258.       Backup report
  259.       Indicates if ABackup has to create a backup report. This one can
  260.       be printed or written to a file.
  261.  
  262.       Backup to
  263.       Selects an archive. If a given name is of the form "df?:"  (e.g.
  264.       df0:, df1:, etc....), ABackup will use the specified    disk  unit
  265.       by writing on disks in a special format. In this case, you  need
  266.       not to format your backup disks. Otherwise, ABackup will  create
  267.       an archive file with the name you specified.    Note  ABackup  has
  268.       the capability of creating this file on any device that  accepts
  269.       the AmigaDOS "Seek" function.
  270.       You can use several disk drives for backup : specify    the  names
  271.       of the drives separated by a coma. For exemple, if  you  specify
  272.       "df0:,df1:" ABackup will start with disk in df0:, then  continue
  273.       with the disk in df1:, go back to df0:, etc... The program  will
  274.       automatically (without requester) toggle from one drive  to  the
  275.       next, if the disk in the new drive has been changed.
  276.  
  277.       At the bottom  of  the  window,  three  gadgets  allow  to  validate
  278.       changes, to validate and save your new options or to clear  changes.
  279.       Options are saved in the "S:ABackup.config" file, that is loaded  at
  280.       every program starting.
  281.  
  282.   Estimations
  283.       Gives an estimation of backup  time  and    of  the  number  of  disks
  284.       needed. The result depends of the size of  the  selected    files,    of
  285.       backup options, and of the processor inside your Amiga. It  may  not
  286.       be accurate if other tasks are running during  the  backup.  ABackup
  287.       always suppose that you backup a hard disk to floppies.
  288.  
  289.   About...
  290.       Displays some informations  on  this  program.  To  continue,  click
  291.       within the window, over the window close gadget or press any key.
  292.  
  293.   Abort
  294.       Allows to abort whole operation. After it asked to confirm,  ABackup
  295.       returns to the main screen.
  296.  
  297.       For starting a backup, you have to select the  "Start"  item  in
  298.   "Backup" menu or the "START" gadget. If you asked for backup  report  to
  299.   be written to a file, a requester will be brought up    so  that  you  can
  300.   specify a name for this file. If you click over the  "Abort"  button  in
  301.   this requester, no report will be generated.
  302.  
  303.       At this time, a new screen is brought up with different infos on
  304.   the backup progression. In the bottom area,  the  file  names  pass  by,
  305.   followed by an info on  the  current    operation  (compression,  writing,
  306.   etc....). If you asked for a disk backup, you can remove the    last  disk
  307.   from your drive  as  soon  as  the  "Archive  closed"  message  will  be
  308.   displayed.
  309.       If an error occurs (and  if  this  is  possible),  ABackup  will
  310.   display a message to ask if you want    to  continue  in  spite  of  that.
  311.   Obviously, ABackup will not make  a  backup  for  the  file  that  maked
  312.   problem.
  313.       At the top and on  the  right  of  this  screen  there  are  two
  314.   gadgets. The "* ABORT *" gadget allows to abort a backup. After it asked
  315.   to confirm, ABackup returns to the  selection  screen.  The  "* PAUSE *"
  316.   gadget allows to pause a backup for a while. Note that  it  can  happens
  317.   ABackup doesn't react immediatly  when  you  click  over  one  of  these
  318.   gadgets but, in all cases, your request will be  registered  before  the
  319.   next write operation in the archive.
  320.  
  321.       Once a backup ended (a message will inform you of that), ABackup
  322.   returns to its main screen.
  323.  
  324. Error_recovering
  325.  
  326.       When an error occurs while writing on a disk, you will  see  the
  327.   following message "Write error on DFx:, should I try to recover  ?".  If
  328.   you answer "NO", the backup will be aborted.
  329.       If you answer "YES", ABackup will copy all data already  written
  330.   on the bad disk to a new disk, so backup will be able to  continue.  So,
  331.   you will have to provide a new disk, of the same type than the bad one :
  332.   you can't use (for example) a High Density disk (1.76 Mb) to  replace  a
  333.   normal density disk (880 Kb).
  334.       The copy will be processed using a single disk drive.  In  order
  335.   to limit disks swap, ABackup will allocate a buffer in memory. The  size
  336.   of this buffer will not be greater than half of the largest CHIP  memory
  337.   block still available, *OR* than the    size  of  three  tracks.  If  this
  338.   buffer can't be allocated, the backup will be aborted.
  339.  
  340.                  CAUTION :
  341.  
  342.       If you made an  error  recovering  during  a    backup,  I
  343.       strongly advise you to verify the archive so    you'll  be
  344.       sure that all went well. 
  345.  
  346. Viewing
  347.  
  348.       From the selection  screen,  you  can  view  any  file  just    by
  349.   double-clicking on its name. A window appears, with several gadgets.
  350.       The "Execute" gadget shows the name of the viewer to use for the
  351.   selected file. The file's name and type (from  which  the  name  of  the
  352.   viewer is set) are displayed above  (in  white).  You  can,  of  course,
  353.   modify the name of the program to use. The two lower gadgets    allow  you
  354.   to start viewing ("OK" gadget), or to abort operation ("CANCEL" gadget).
  355.       If you try to view a link, ABackup will just display the name of
  356.   the file or directory the link points to.
  357.  
  358. Compression
  359.  
  360.       ABackup is able to compress files to backup, in order to  reduce
  361.   archive size.  By  default,  the  algorithm  is  the    same  as  for  the
  362.   "compress" UNIX command : you can hope for a space-saving  from  30%  to
  363.   50%, but the backup is seriously slowed down with a "normal" 68000 based
  364.   Amiga.
  365.  
  366.       You can use external    compression  and  decompression  programs,
  367.   which may be faster and/or better. All you have  to  do  is  the  modify
  368.   ABackup configuration (see "Configuration" section) : enter the  command
  369.   to execute both for compression and decompression, specifying "%s" as  a
  370.   source file and "%d" as a destination file. For exemple, in order to use
  371.   the commands provided with PowerPacker  (copyright  by  Nico  François),
  372.   enter :
  373.  
  374.       Crunch %s %d NOLED NOPER NOSUFFIX EFFICIENCY 1
  375.  
  376.   as compression program, and :
  377.  
  378.       Decrunch %s %d QUIET
  379.  
  380.   as  decompression  program.  You  won't  be  able  to  select   external
  381.   compression as long as no command name has been given. When  backing    up
  382.   and restoring, ABackup automatically runs the  specified  commands,  and
  383.   redirect their output to the "T:ABackup.log" file. You can look at  this
  384.   file if an error occurs.
  385.  
  386.       This version of ABackup can also use the XPK    library  (on  Fish
  387.   disk 754). This library will    be  automatically  recognized  if  already
  388.   installed in your "LIBS:" directory. You will then be able to select one
  389.   of the available compression method, in the options window. The name    of
  390.   the methods are prefixed with a "x" character, like "x BLZW".
  391.  
  392.       Take care that it  won't  be  possible  to  restore  an  archive
  393.   compressed with an external program, or with XPK library, if    you  don't
  394.   have the corresponding decompression program. Though, you  should  avoid
  395.   to use external compression if you plan to give the archive to  somebody
  396.   else.
  397.  
  398. Restore
  399.  
  400.       A menu is brought up allowing to specify the archive    that  must
  401.   be used. If you click on the "Abort" gadget, ABackup will return to  the
  402.   main screen. The gadgets corresponding to your drives are  automatically
  403.   enabled or disabled according to your  hardware  configuration.  If  you
  404.   click on one of these enabled gadgets, ABackup will ask  you    to  insert
  405.   the last disk in the backup set, for loading the catalogue. If you click
  406.   on the "File" gadget, a requester will be brought up so that you specify
  407.   your archive file. If you click on  the  "Abort"  gadget,  ABackup  will
  408.   return to the main screen.
  409.  
  410.       Once you  have  selected  an    archive,  ABackup  will  load  the
  411.   catalogue of files backed up    in  this  archive  and    will  display  the
  412.   selection screen. This screen is almost the same as that  one  used  for
  413.   backup. The only difference is that the "Directory"  field  shows  where
  414.   the files will be restored, and that options are as follows :
  415.  
  416.   Restore dir. tree
  417.       Indicates if selected files will be all  restored  in  the  same
  418.       directory (NO) or if the tree structure  will  be  restored  too
  419.       (YES).
  420.  
  421.   Restore date
  422.       Indicates if ABackup will set the date of restored file  to  the
  423.       date they had at backup time.
  424.  
  425.   Restore links
  426.       Restore  selected  links.  Meaningful  only  under  2.0    system
  427.       release.
  428.  
  429.   Restoration report
  430.       Indicates if ABackup has to generate a restoration report.  This
  431.       one can be printed or written to a file.
  432.  
  433.   Restore empty dirs
  434.       Indicates if ABackup has to create empty backed up  directories.
  435.  
  436.   Replace files
  437.       Indicates what ABackup has to do if a file  it  has  to  restore
  438.       already exists. Choices are : "No" (file is not replaced), "Yes"
  439.       (file is replaced), "Ask for" (ABackup will ask to  confirm  for
  440.       every existing file), "Older" (ABackup replaces this  file  only
  441.       if this one is older than the backed up file).
  442.  
  443.   Restore to
  444.       Usually, files are restored in the directory where they were  at
  445.       the time of the backup, but you can specify another directory by
  446.       this gadget.
  447.  
  448.       For starting a restoration, you have to select the "Start"  item
  449.   in "Restore" menu or the "START" gadget. If you  asked  for  restoration
  450.   report to be written to a file, a requester will be brought up  so  that
  451.   you can specify a name for this file. If  you  click    over  the  "Abort"
  452.   button in this requester, no report will be generated.
  453.       At this time, a new screen is brought up with different infos on
  454.   the restore progression. In the bottom area, the names of restored files
  455.   pass by,  followed  by  an  info  on    the  current  opération  (reading,
  456.   etc....). If an error occurs (and if this  is  possible),  ABackup  will
  457.   display a message to ask if you want    to  continue  in  spite  of  that.
  458.   Obviously, ABackup will not restore the file that maked problem. If some
  459.   links are to be restored, ABackup will  restore  them  after    all  other
  460.   files and directories are restored.
  461.       At the top and on  the  right  of  this  screen  there  are  two
  462.   gadgets. The "* ABORT *" gadget allows to abort a restoration. After  it
  463.   asked  to  confirm,  ABackup    returns  to  the  selection  screen.   The
  464.   "* PAUSE *" gadget allows to pause restoration for a while. Note that it
  465.   can happens ABackup doesn't react immediatly when you click over one  of
  466.   these gadgets but, in all cases, your request will be registered  before
  467.   the next read operation in the archive.
  468.       Once a restoration ended (a message will inform  you  of  that),
  469.   ABackup returns to its main screen.
  470.  
  471. Rebuild_catalogue
  472.  
  473.       This function is not very useful unless an archive file has been
  474.   damaged, or you have loose the last  disk  of  a  backup  set.  It  will
  475.   rebuild the archive catalogue, which is required to restore. You  should
  476.   be aware that this function can't handle all  errors,  and  may  not  be
  477.   usuable by unexperienced users.
  478.  
  479.       If the archive is a file, you should make a copy of it in  order
  480.   to avoid to destroy it if operation fails. You will also have  to  check
  481.   that the first header is at a sector boundary, that is,  at  an  address
  482.   multiple of 512 (you can use the "TYPE archive HEX" command,  the  first
  483.   and the third long word of a header are always set to the "ABCK" value).
  484.   If the archive is on disks, you must give the disks in  the  same  order
  485.   they were written to. This function works even if disks are missing.
  486.  
  487.       The archive selection screen appears    (see  "Restore"  section).
  488.   When you have selected the archive,  ABackup    loads  its  content,  file
  489.   after file : a new screen  appears  with  some  informations    about  the
  490.   processing. Once the content    is  loaded,  the  new  catalogue  will    be
  491.   created. If the archive is on disks, ABackup will ask you for a new disk
  492.   to write the catalogue. Use this disk a the last disk of the backup set,
  493.   when restoring.
  494.  
  495. The_Selection_menu
  496.  
  497.       ABackup has the capability of recording a file selection so that
  498.   you can recall it later : this can be useful if you use  frequently  the
  499.   same selections. These ones are kept as text files containing a  set    of
  500.   commands : these files are in the "ABCK:" directory.
  501.       In order to record a selection, choose the "Record" item in  the
  502.   "Selection" menu; then, do your selection as you do usually. Note  that,
  503.   during this recording, the "Backup" menu disappear (for the time being).
  504.   Once you have ended, select the item "Save" in the "Selection"  menu  to
  505.   save your selection. If you want to abort a recording, choose  the  item
  506.   "Abort" in the "Selection" menu.
  507.       To recall a selection, choose the "Load" item in the "Selection"
  508.   menu. A file requester will be displayed allowing  you  to  specify  the
  509.   selection file you want use. If you click on the  "OK"  gadget  in  this
  510.   file requester, that file will be loaded and selection it contains  will
  511.   be executed.
  512.  
  513.       This is description of the selection language used  by  ABackup.
  514.   This allows to create or modify a selection file as you like,  by  means
  515.   of your usual text editor.
  516.  
  517.       CD :                  go back to root directory
  518.       CD /                  go back to parent directory
  519.       CD "dir"                        go down in given directory
  520.       INVERT                  reverse selection
  521.       RECURS {YES|NO}              set recursivity flag
  522.       INCLUDE ALL              include all files
  523.       INCLUDE "name"                  include given file
  524.       INCLUDE NAME "name" {==|!=}     select by name
  525.       INCLUDE DATE "date" {<=|>=}     select by date
  526.       INCLUDE BITS "bits" {=0|=1}     select by protection bits
  527.       EXCLUDE ALL              exclude all files
  528.       EXCLUDE "name"                  exclude given file
  529.       EXCLUDE NAME "name" {==|!=}     exclude by name
  530.       EXCLUDE DATE "date" {<=|>=}     exclude by date
  531.       EXCLUDE BITS "bits" {=0|=1}     exclude by protection bits
  532.  
  533.   Here is an exemple of selection file:
  534.  
  535.       RECURS YES
  536.       ; go back to root
  537.       CD :
  538.       ; clear any selection
  539.       EXCLUDE ALL
  540.       ; include all files with archive bit cleared
  541.       INCLUDE BITS "a" =0
  542.       ; exclude all ".o" files
  543.       EXCLUDE NAME "#?.o" ==
  544.  
  545.       Note that empty lines and lines starting by a ";" character  are
  546.   ignored. Also note that ABackup  stores  automatically  the  recursivity
  547.   indicator state at the beginning of your selection record : if you  take
  548.   a look at the created files you'll see they all  beging  by  a  "RECURS"
  549.   command. If you want to be sure to  clear  a    previous  selection,  it's
  550.   recommended to start all your  selections  by  clicking  on  the  "ROOT"
  551.   gadget and then on "EXCLUDE ALL".
  552.  
  553. Usage_without_interface
  554.  
  555.       ABackup can be used from CLI, without  it's  graphic  interface.
  556.   This may be useful for doing    automatical  backup,  with  programs  like
  557.   "cron". Four operations are allowed from this  level:  backup,  restore,
  558.   rebuild catalogue, archive listing.
  559.  
  560.       Backup is started with a command like:
  561.  
  562.       ABackup BACKUP FROM dir TO arc  SELECT  {ALL|ARC|file}  [OPTIONS
  563.       {C|V|A|L}] [NOCOMP ext,ext,...] [VERBOSE] [REPORT file] [BUFSIZE
  564.       size] [NOTASK]
  565.  
  566.   where "dir" is the directory to backup and "arc" the name of the archive
  567.   to create. The "SELECT" argument allows to select files  to  backup:  it
  568.   must    be  followed  by  the  name  of  a  selection  file  (for  exemple
  569.   "ABCK:FullBackup"), by the keyword  "ALL"  which  allow  to  select  all
  570.   files, or by the keyword "ARC" which allow  to  select  all  files  with
  571.   archive bit cleared.
  572.       The "OPTIONS" optional argument allow to change  backup  options
  573.   (CAUTION: by default, ALL options are reset) : "C" for compression,  "V"
  574.   for verifying, "A" to set archive bit, "L"  to  backup  links.  You  can
  575.   specify several options (for exemple "OPTIONS CV").
  576.       The "REPORT" optional argument allow to have  a  backup  report.
  577.   Specify "PRT:" as a file name in order to have this report printed.  The
  578.   "VERBOSE" optional argument allow to have more messages  during  backup.
  579.   The other arguments are described at the "Getting_started" section.
  580.  
  581.       Restore is started with a command like:
  582.  
  583.       ABackup RESTORE FROM arc [TO    dir]  SELECT  {ALL|file}  [OPTIONS
  584.       {F|D|E|L}] [REPLACE  {YES|ASK|OLDER}]  [VERBOSE]  [REPORT  file]
  585.       [BUFSIZE size] [NOTASK]
  586.  
  587.   where "arc" is the name of the archive. The "SELECT" argument allows  to
  588.   select files to restore: it must be followed by the name of a  selection
  589.   file (for exemple "ABCK:SourcesFiles") or by the  keyword  "ALL",  which
  590.   allow to select all files without having to create a selection file.
  591.       The "TO dir" optional argument allow to  restore  files  in  the
  592.   specified directory, rather than the directory they were at backup time.
  593.       The "OPTIONS" optional argument allow to change restore  options
  594.   (CAUTION: by default, ALL options are reset) : "F" to restore all  files
  595.   in the same directory,  "D"  to  restore  date,  "E"  to  restore  empty
  596.   directories, "L" to restore links. You can specify several options  (for
  597.   exemple "OPTIONS FE").
  598.       The "REPLACE" optional argument allow to  specify  what  ABackup
  599.   has to do if a file to restore already exists. It must  be  followed    by
  600.   "YES" (or "Y", the file is replaced), by "ASK"  (or  "A",  you  will  be
  601.   asked for confirmation), or by "OLDER" (or "O",  the  file  is  replaced
  602.   only if it's older than the one in the archive). By default,  files  are
  603.   not replaced.
  604.       The "REPORT" optional  argument  allow  to  have  a  restoration
  605.   report. Specify "PRT:" as a file name  in  order  to  have  this  report
  606.   printed. The "VERBOSE" optional argument allow  to  have  more  messages
  607.   during   restore.   The   other   arguments    are   described   at   the
  608.   "Getting_started" section.
  609.  
  610.       Rebuilding catalogue is started with a command like:
  611.  
  612.       ABackup REBUILD FROM arc [VERBOSE] [BUFSIZE size] [NOTASK]
  613.  
  614.   where "arc" is the name of the archive. The "VERBOSE" optional  argument
  615.   allow to have more messages during processing. The other  arguments  are
  616.   described at the "Getting_started" section.
  617.  
  618.       Archive listing is started with a command like:
  619.  
  620.       ABackup LIST FROM arc [TO file] [NOTASK]
  621.  
  622.   where "arc" is the name of the archive. The "TO file" optional  argument
  623.   allow to write the listing into the  specified  file,  rather  than  the
  624.   console window. Specify "PRT:" as a file name in order to have the  list
  625.   printed. The other arguments    are  described    at  the  "Getting_started"
  626.   section.
  627.  
  628. Program_history
  629.  
  630.       This program was developped on an Amiga 3000 UNIX-1 (6  Mb  RAM,
  631.   internal HD disk drive, internal hard disk of 100 Mb,  external  SyQuest
  632.   drive of 88 Mb, external  floppy  disk  drive,  1960    monitor  and  Star
  633.   LC24-10 printer) connected by a null-modem cable to an A500  with  1    Mb
  634.   RAM.
  635.       ABackup was written almost in  C  language,  and  compiled  with
  636.   SAS/C 5.10b. DPaint IV (from Electronic Arts), SID2 (by Tim Martin), and
  637.   DME (by Matt Dillon) were very useful too.
  638.  
  639.   12-Mar-92   development beginnning
  640.   08-Jun-92   v1.00, 58036 bytes
  641.  
  642.   20-Jun-92   v1.10, 59404 bytes
  643.           o Handles High Density floppy disks (1.76 Mb).
  644.           o When run from the Workbench, you can change  the  size    of
  645.         the read buffer with "BUFSIZE=<size in Kb>" in  the  "TOOL
  646.         TYPES" field of ABackup icon.
  647.           o Several changes in backup :
  648.         - when there is any problem at initialization  time,  goes
  649.           back to the selection screen
  650.         - when an archive file exists, or there is already a  disk
  651.           in drive, asks to confirm before starting writing
  652.         - tests if files to back up are protected against  a  read
  653.           (opening a file works in any case, but under 2.0  system
  654.           release you  will  be  kicked  out  at  the  first  read
  655.           operation)
  656.         - displays the compression  rate  for  every  file  (after
  657.           "OK")
  658.           o Several changes in the interface :
  659.         - added  the  "Size"  menu   in   the   selection   screen
  660.           (Bytes/Kb/Mb)
  661.         - displays backed-up/restored percentage and remaining one
  662.         - the "monitor" window (in blue) is larger when screen  is
  663.           in PAL mode
  664.           o Time valuation more accurate (uses the "timer.device").
  665.  
  666.   28-Jun-92   v1.20, 62616 bytes
  667.           o Added the "Selection" menu in the selection screen  :  you
  668.         can record a selection and recall it later.
  669.           o Fixed several bugs :
  670.         - as a result of an error in the  computing  of  remaining
  671.           place in the last disk, sometimes it wrote  a  catalogue
  672.           overlapping two different floppies
  673.         - when you swapped a disk during a file header writing, it
  674.           forgot to  set  up  the  disk  position  at  0  (in  the
  675.           catalogue)
  676.         - during a read, at the end of a  disk,  it  detected  one
  677.           byte earlier it had to ask for the next disk.
  678.           o For a by date selection, you can give the month name (e.g.
  679.         "01-Jan-92")
  680.           o When run from the Workbench, it does not  open    the  small
  681.         "console" window.
  682.  
  683.   01-Jul-92   v1.30, 67640 bytes
  684.           o Double-click upon a name starts a "view" operation
  685.           o Under  2.0  system  release,  uses  "dos.library"  pattern
  686.         matching functions (more powerful than SAS/C ones)
  687.           o Added "Estimation" option in "Backup" menu
  688.           o Displays error messages rather than error codes
  689.           o  Bug  fixed  in   "draggin   select":   didn't   displayed
  690.         directories when scrolling list
  691.           o Restore screen's title when "Abort" is selected on archive
  692.         selection menu (Restore)
  693.  
  694.   04-Jul-92   v1.31, 68316 bytes (Fish #706)
  695.           o Added "Restore date" option
  696.           o Added auditive beep in alert/wait functions
  697.           o No more need for "arp.library" to make drives "BUSY" under
  698.         1.3 system release
  699.           o Estimations more accurate (don't suppose that last disk is
  700.         full)
  701.  
  702.   22-Aug-92   v1.40, 78328 bytes
  703.           o Can use several disk drives for backup
  704.           o Full access from CLI ("batch" mode)
  705.           o Bug fixed: always tried to  decompress    archive  catalogue
  706.         (even if it was not)
  707.           o Bug fixed: when loading archive  file  catalogue,  scanned
  708.         all archive beginning (instead of going  straight  to  the
  709.         good location)
  710.           o Preparation of non-dos    partitions  backup  (most  of  the
  711.         required code written)
  712.           o Added visual beep to each auditive beep
  713.  
  714.   09-Sep-92   v1.50, 81068 bytes
  715.           o Added support for links under  2.0  system  release  (both
  716.         hard and soft links are handled)
  717.           o Added "Backup links" and "Restore links" options
  718.           o Added "Automatic" item to "Size" menu
  719.           o Added "NOCOMP ext,ext,..." argument
  720.           o When requesting a disk for writing, verifies that the disk
  721.         has really been changed before continuing
  722.           o If an error occurs while writing on a disk, make one retry
  723.           o Error in percentage computation corrected
  724.           o On selection screen, directories with at  list    one  child
  725.         selected are displayed on a black background
  726.           o No more overflow from "monitor" window if file name is too
  727.         long
  728.           o Bug fixed in SendPacket() function
  729.           o Bug fixed in time computation (00:29:59 + 1 gave  01:00:00
  730.         ... whoops !)
  731.           o Forgotten trace message removed
  732.  
  733.   07-Oct-92   v1.51, 81048 bytes
  734.           o Any file or directory whose comment begins  with  "SKIPME"
  735.         is ignored when loading directory tree
  736.           o Bug fixed : no more problems if the size of a file  change
  737.         between the time we load directory tree and time  we  save
  738.         the file
  739.           o Bug fixed : didn't  clear  destination  name  between  two
  740.         restore (so the second was made is the same directory than
  741.         the first)
  742.           o Update status display when disk is changed
  743.  
  744.   15-Oct-92   v1.60, 84312 bytes (Fish #759)
  745.           o Added function to rebuild catalogue
  746.           o Selection screen modified  (added  "OPTIONS"  and  "START"
  747.         gadgets, etc...)
  748.           o Estimations for 68000 Amigas corrected (thanks to JYP !)
  749.           o If a file is read protected (under 2.0 system release) ask
  750.         for retry
  751.           o When restoring, display  the  name  of    the  file  created
  752.         instead of the name in the archive
  753.           o Restore option "At the same level" renamed  "Restore  dir.
  754.         tree"
  755.  
  756.   21-Oct-92   v1.61, 84472 bytes
  757.           o From WB may be set as "DEFAULT TOOL" of an archive file
  758.           o File type (for visualisation) : no longer binary  when  an
  759.         <ESC> character is found
  760.           o Window are now centered on the screen
  761.           o Menus are no longer present during backup or restore
  762.  
  763.   29-Oct-92   v1.70, 87016 bytes
  764.           o Can use external programs for compression/decompression
  765.           o Added a menu for the startup screen (Config, About,  Quit)
  766.           o Screen's title show what is the current operation
  767.           o On selection screen, when restoring, the "Directory" field
  768.         shows the destination directory
  769.           o By default, compression is disabled
  770.           o Documentation modified so it can be read with ADoc
  771.  
  772.   11-Nov-92   v1.80, 88528 bytes
  773.           o Creates a child task for disk  write  operations  (speedup
  774.         backup between 10-20%)
  775.           o Sets archive bit only on  files/dirs  which  have  not    it
  776.         already set
  777.           o Filenames are truncated to the left instead of    the  right
  778.         ("Directory" field, "monitor" window, e.g.  ".../foo/bar")
  779.  
  780.   22-Nov-92   v2.00, 90492 bytes
  781.           o Can use XPK library
  782.           o Added the error recovering function
  783.  
  784.   Planned improvements :
  785.           o Support for non-AmigaDOS partitions (AMAX, etc...)
  786.  
  787.  
  788.  
  789.  
  790.  
  791.