home *** CD-ROM | disk | FTP | other *** search
/ GEMini Atari / GEMini_Atari_CD-ROM_Walnut_Creek_December_1993.iso / files / diskutil / backupst / bfront.txt < prev    next >
Text File  |  1990-11-01  |  17KB  |  381 lines
  1.                     BFRONT --- A BackupST frontend
  2.  
  3.                         F.J.R. Appelman,
  4.                       University of Utrecht,
  5.                     3D Computer Vision Research Group,
  6.                          The Netherlands. 
  7.                        email: fred@cv.ruu.nl
  8.  
  9.     
  10. 1. Info
  11.     Bfront is a frontend for the BackupST program. This program makes 
  12.     is possible for novice users to use the powerfull posibilities of 
  13.     the BackupST program. This document will not give a description 
  14.     and/or explanation of the BackupST program. A separate document 
  15.     describes the BackupST program.
  16.     
  17. 2. Starting the program
  18.  
  19.     Start the application (Bfront) by double clicking from the 
  20.     desktop. The resource file resource.rsc must be present in the 
  21.     same folder as the Bfront program. If present the default settings 
  22.     of the program will be read form the file bfront.dat. If the file 
  23.     is not present, this will be silently ignored. 
  24.  
  25.     A welcom box will be presented for the period of 1.5 seconds. 
  26.     During this time the mouse is disabled. After the welcom box, a 
  27.     permanent box is drawn on the desktop. The program is always 
  28.     started in List mode.
  29.  
  30.     Bfront is a frontend to the BackupST program. The BackupST program 
  31.     will have its own screen memory during execution. You can toggle 
  32.     between the Bfront screen and the BackupST screen by using the 
  33.     ESC.
  34.  
  35.     The BackupST program has both a mouse and a keyboard interface.
  36.     The keyboard commands (keycommand) are an equivalent to the mouse 
  37.     commands. The ESC is the only keycommand which does not have a 
  38.     mouse equivalent.
  39.  
  40. 3. DESK
  41.  
  42.     +-------------------------------------------------------+
  43.     | Desk                File  Mode General Backup Restore |
  44.     +-------------------------------------------------------+
  45.     | About Bfront ... |
  46.     +------------------+
  47.  
  48.     In the DESK-menu you can get information about the Bfront. It will 
  49.     inform you that Bfront is free of charge. I don't believe in the 
  50.     share-ware concept. 
  51.     
  52. 4. FILE
  53. +-----------------------------------------------------------------------+
  54. Desk  File                                  Mode General Backup Restore |
  55. +-----------------------------------------------------------------------+
  56.       | Start Selected mode          | ❎S |
  57.       |-----------------------------------|
  58.       | Save default configuration   | ^D |
  59.       | Read configuration           | ^R |
  60.       | Save configuration           | ^S |
  61.       |-----------------------------------|
  62.       | Quit                         | ^Q |
  63.       +-----------------------------------+
  64.  
  65. 4.1 Start selected mode
  66.     This will start the BackupST program. The first time Bfront is 
  67.     started, this entry of the menu will not be enabled. If the 
  68.     current mode (See Section 5) is List or Restore this menu entry is 
  69.     enabled if the location of the BackupST program is defined (See 
  70.     Subsection 6.4). If the mode is Backup both the location of the 
  71.     BackupST program and the data to be stored (See Subsection 7.5) 
  72.     have to be specified before this menu entry is enabled. This 
  73.     action can also be started by the keycommand ALT-S.
  74.         
  75. 4.2 Save default configuration
  76.     This will store the current configuration under the name 
  77.     bfront.dat. This configuration will automatically be read (See 
  78.     Section 2) the next time Bfront is started. In the configuration 
  79.     file the following items are stored:
  80.         -x- Verbosity (See 6.1)
  81.         -x- Sectors per track (See 6.2)
  82.         -x- Tracks per side (See 6.3)
  83.         -x- The path to BackupST (See 6.4)
  84.         -x- The used drive (See 6.5)
  85.         -x- The used floppy type (See 6.6)
  86.         -x- Archive bit mode (See 7.1)
  87.         -x- Verify mode (See 7.2)
  88.         -x- Backup mode (See 7.3)
  89.         -x- Format mode (See 7.4)
  90.         -x- The backup path (See 7.5)
  91.         -x- The restore date mode (See 8.1)
  92.         -x- The overwrite mode (See 8.2)
  93.         -x- The interactive mode (See 8.3)
  94.         -x- The create directories mode (See 8.4)
  95.         -x- The restore path (See 8.6)
  96.  
  97.     The mode is always set to List if the program is started. Error 
  98.     recovery mode is always turned off.
  99.     This action can also be started by the keycommand CTRL-D.
  100.  
  101. 4.3 Read configuration ...
  102.     This will read a user specified configuration file from disk. This 
  103.     new configuration will take effect immediatly. This action can 
  104.     also be started by the keycommand CTRL-R.
  105.  
  106. 4.4 Save configuration ...
  107.     This will save the current configuration under a user specified 
  108.     name. This action can also be started by the keycommand CTRL-S.
  109.  
  110. 4.5 Quit
  111.     This will quit Bfront. No confirmation is asked. This action can 
  112.     also be started by the keycommand CTRL-Q.
  113.  
  114. 5. Mode
  115.  
  116. +-----------------------------------------------------+
  117. | Desk  File  Mode             General Backup Restore |
  118. +-----------------------------------------------------+
  119.             | List    | ❎L |
  120.             | Restore | ❎R |
  121.             | Backup  | ❎B |
  122.             +--------------+
  123.  
  124.     The BackupST has 3 modes in which it works.
  125.     
  126. 5.1 List
  127.     This will set BackupST in List mode. In this mode you can list the 
  128.     contents of an existing archive. This selection will disable the 
  129.     Backup (See Section 7) and Restore (See Section 8) menu. This 
  130.     action can also be started by the keycommand ALT-L.
  131.  
  132. 5.2 Restore
  133.     This will set BackupST in Restore mode. In Restore mode you can 
  134.     extract files from an existing archive. This selection will 
  135.     disable the Backup (See Section 7) and enable the Restore (See 
  136.     Section 8) menu. This action can also be started by the keycommand 
  137.     ALT-R.
  138.  
  139. 5.3 Backup
  140.     This will set BackupST in Backup mode. In this mode you can create 
  141.     a new archive. This selection will enable the Backup (See Section 
  142.     7) and disable the Restore (See Section 8) menu. This action can 
  143.     also be started by the keycommand ALT-B.
  144.  
  145. 6. General
  146. +----------------------------------------------------------+
  147. | Desk File Mode   General                  Backup Restore |
  148. +----------------------------------------------------------+
  149.                  | Verbosity ...         |
  150.                  | No. Sectors/Track ... |
  151.                  | No. Tracks/Side...    |
  152.                  | Backupst path...      |
  153.                  |-----------------------|
  154.                  | Drive A               |
  155.                  | Drive B               |
  156.                  |-----------------------|
  157.                  | Single Sided          |
  158.                  | Double Sided          |
  159.                  +-----------------------+
  160.  
  161. 6.1 Verbosity ...
  162.     The verbosity controls the amount of noise the BackupST program 
  163.     creates. This is more a debug feature than a normal feature. 
  164.     Normal users should keep it at a value of '0' which is the default 
  165.     value. The verbosity value ranges from ``0'' to ``9''.
  166.     
  167. 6.2 No. Sectors/Track ...
  168.     This controls the number of sector on a track. The only valid 
  169.     values are '9' and '10' sectors per track. If you restore or list 
  170.     an archive this value is overruled by information stored in the 
  171.     archive. 
  172.     
  173. 6.3 No. Tracks/Side ...
  174.     This controls the number of tracks on a side. The only valid 
  175.     values are 80--84 tracks per side. If you restore or list an 
  176.     archive this value is overruled by information stored in the 
  177.     archive. 
  178.     
  179. 6.4 BackupST path ...
  180.     The backupst path is the path to the BackupST program. This option 
  181.     has to be selected before the BackupST program can be started. 
  182.     Once you've selected the program you should store the path in the 
  183.     default configuration file (See Section 4.2).
  184.  
  185. 6.5 Drive selection
  186.     You can either select Drive A or Drive B. A checkmark is set 
  187.     before the selection. 
  188.     
  189. 6.6 Floppy type selection
  190.     You can either select Single sided or Double sided floppies. A 
  191.     checkmark is set before the selection.
  192.     
  193. 7.0 Backup
  194.  
  195. +------------------------------------------------------------+
  196. | Desk File Mode General    Backup                   Restore |
  197. ---------------------------+-----------------------+---------+
  198.                            | Set archived bit      |
  199.                            | Verify on             |
  200.                            | Full backup           |
  201.                            |-----------------------+
  202.                            | Always                |
  203.                            | On error              |
  204.                            | Never                 |
  205.                            |-----------------------+
  206.                            | Backup path ... | ❎ P |
  207.                            +-----------------------+
  208.  
  209. 7.1 Set archived bit
  210.     If this menu entry has a checkmark, the archived bit will be set 
  211.     during the backup process. This bit indicates that a file has been 
  212.     archived. The incremental (See Subsection 7.3) backup relies on 
  213.     this feature. Turning off the process of setting the archived bit 
  214.     will make it possible to make multiple incremental backups. 
  215.  
  216.     ``Setting'' the archived bit is a little bit symbolic since TOS 
  217.     1.4 is introduced. The introduction of TOS 1.4 inverted the 
  218.     meaning of the archived bit. Before TOS 1.4 the bit was set to 
  219.     ``1'' to indicate the file was archived. Before TOS 1.4 this bit 
  220.     was automatically cleared by the OS once the file was changed. 
  221.     Since the introduction of TOS 1.4 this bit is set to ``0'' to 
  222.     indicate the file is archived. In TOS 1.4 this bit is set to ``1'' 
  223.     by the OS if the file is changed. BackupST will automatically 
  224.     adjust its behavior to the present TOS version.
  225.         
  226. 7.2 Verify on
  227.     If this menu entry has a checkmark, every tracks that is written 
  228.     will be verified. This option will slow down the backup-process, 
  229.     but will increase the reliability. 
  230.     
  231. 7.3 Full backup
  232.     If this menu entry has a checkmark, BackupST will make a full 
  233.     backup. A full backup means that every file will be stored in the 
  234.     archive, without checking the archived bit.
  235.  
  236.     If the menu entry does not have a checkmark, this means that an 
  237.     incremental backup will be made. During an incremental backup only 
  238.     files from which the archived bit is cleared (See Subsection 7.1) 
  239.     will be stored in the archive.
  240.     
  241. 7.4 Format mode
  242.     Three different formats are supported. 
  243.  
  244.          -x- Never
  245.                 Never format a track. If a disk I/O error occurs, 
  246.                 BackupST is aborted with an error message.
  247.         -x- Always
  248.             Format every track before trying to write on the track. 
  249.             After formatting of the track the behavior of BackupST is 
  250.             as if format On error was selected.
  251.         -x- On error
  252.             Format a track if an I/O error occurs. After formatting of 
  253.             this track, writing to the track is tried again. Up to 5 
  254.             retries will take place. If the retries have no effect, 
  255.             BackupST is aborted. When every track needs reformatting, 
  256.             it turns out to be a time consuming proces. If more than 3 
  257.             tracks need formatting on a particular side of a disk the 
  258.             remaining tracks on that side will be formatted before 
  259.             trying to write on that side. 
  260.     
  261. 7.5 Backup path ...
  262.     Enter a space seperated list of the ``files'' to be archived. 
  263.     Files can be:
  264.             1. Plain files. 
  265.             2. directories
  266.             3. disks
  267.             4. regular expressions
  268.     Slashes (/) are automatically converted to backslashes (\). 
  269.     Relative addressing is supported. Regular expressions are full 
  270.     regular expressions, not the GEMDOS regular expressions.
  271.     This action can also be started by the keycommand ALT-P. 
  272.  
  273. 8. Restore
  274. +---------------------------------------------------+
  275. Desk File Mode General Backup    Restore            |
  276. +---------------------------------------------------+
  277.                                | Restore file dates |
  278.                                | Overwrite silently |
  279.                                | Interactive mode   |
  280.                                | Create Directories |
  281.                                | Error recovery ... |
  282.                                | Restore Path | ❎ P |
  283.                                +--------------------+
  284.  
  285. 8.1 Restore file dates
  286.     If the menu entry has a checkmark, the original creation date will 
  287.     be restored. After writing to the file to harddisk, the creation 
  288.     date is set to ``today''. With this option enabled the creation 
  289.     date is restored to the original date. 
  290.     
  291. 8.2 Overwrite silently
  292.     Overwrite existent files silently. Normally BackupST will not 
  293.     overwrite an existing file without asking permission to do so. If 
  294.     you enable this option, BackupST will overwrite all files without 
  295.     asking. 
  296.     
  297. 8.3 Interactive mode
  298.     If this option is enabled, BackupST will go into interative mode. 
  299.     It will first read the archive index, and then enter a little 
  300.     subshell. The following command are available:
  301.         -x- ls [directory]
  302.         -x- dir [directory]
  303.             This command will list the contents of a directory. If you 
  304.             don't specify a directory, the current directory is listed 
  305.             by instead. By default, no files are extracted in 
  306.             interactive mode. Only the files specifically 'added' (see 
  307.             command add) by the user are extracted. Files to be 
  308.             extracted are marked by a '+'. Directories are marked by a 
  309.             '\'. Directories are never marked by a '+', only the 
  310.             contents of a directory is. If you list the contents of a 
  311.             directory, you see the contents of a fictive disk. There 
  312.             is absolute no relation with the current contents of the 
  313.             hard disk. This so fictive disk has a root directory under 
  314.             which all disks are mounted. If you type 'ls' at the root 
  315.             level you probably only see the volume label(s) of the 
  316.             disks you have stored in this archive. If only one 'disk' 
  317.             is available, an automatic 'cd disk' will be done when the 
  318.             program is started.
  319.         -x- ll [directory]
  320.             The 'll' command will make a long directory listing. (see 
  321.             ls)
  322.         -x- quit
  323.         -x- stop
  324.         -x- exit
  325.             This will abort the program without extracting the marked 
  326.             files.
  327.         -x- help [command]
  328.         -x- h [command]
  329.             This command gives a list of all commands available. If an 
  330.             argument is given, an explanation of this command is 
  331.             given.
  332.         -x- cd [directory]
  333.         -x- chdir [directory]
  334.             Change directory to 'directory'. If no argument is given, 
  335.             the new directory is the root directory of the 
  336.             ramdirectory.
  337.         -x- add [files]
  338.             Add files to the list of files to be extracted. If the 
  339.             argument is a directory, all files in this directory are 
  340.             added to the list.  Regular expressions are also valid. 
  341.             Added files are marked by a '+' in front of the filename 
  342.             in a 'ls' command. (see 'ls')
  343.         -x- rm [files]
  344.             Opposite of add command. Same syntax.
  345.         -x- extract
  346.         -x- retrieve
  347.         -x- go
  348.             Retrieve all marked files from the archive.
  349.     
  350. 8.4 Create directories
  351.     If this option is enabled, the files restored from the archive 
  352.     will retain their directory hierarchy by creating directories as 
  353.     needed. This is the normal behavior. If you don't create 
  354.     subdirectories the files wwhich are restored will be stored at the 
  355.     root disk of the ``original'' disk the files were located on. 
  356.  
  357.     This command is usually used in conjuction with the restore path 
  358.     (See Subsection 8.6) option. Suppose you set the restore path to 
  359.     d:/tmp. If you now restore a single directory (e.g. c:/bin/mwc) 
  360.     from the archive (You will need interactive mode for this 
  361.     feature), and you don't create subdirectories, you can restore the 
  362.     files in this directory in d:/tmp.
  363.     Within the directory d:/tmp no new directories will be created.
  364.     If needed the directory d:/tmp will be created. 
  365.     
  366. 8.5 Error recovery ...
  367.     This wil set BackupST in Error recovery mode. In this mode you can 
  368.     try to restore an existing archive if the main archive index is 
  369.     damaged. In this mode an attempt is made to read the backup 
  370.     archive index. 
  371.  
  372. 8.6 Restore path ...
  373.     Set an alternate root for the restore action. If this option is 
  374.     used, BackupST will not write back the data at the position it was 
  375.     originally stored. Suppose you have stored a directory named 
  376.     'c:/bin'. If you restore the data with a restore path of d:/tmp, 
  377.     the data will be restored at d:/tmp/bin. The directory structure 
  378.     will be maintained.
  379.     This action can also be started by the keycommand ALT-P. 
  380.  
  381.