home *** CD-ROM | disk | FTP | other *** search
/ Amiga ACS 1996 #1 / amigaacscoverdisc01.iso / hdtools / hdbackup.help < prev    next >
Text File  |  1994-07-06  |  12KB  |  498 lines
  1. @root
  2. [200,0] HDBackup Main Help Page
  3. [20,40] Menus [menus]
  4. [20,60] Configuration file options [config_root]
  5. [20,80] File list help [fl_help]
  6.  
  7. [80,120] Click Here to learn about "help"! [about_help]
  8.  
  9.  
  10. @about_help
  11. [200,0] About Help
  12.  
  13. [20,20] Text in a (normally) bright color like this may be clicked [click]
  14. to move to a page containing more details about the topic. [click]
  15.  
  16. Text in this color provides information only.  Clicking will have no
  17. effect.
  18.  
  19. The buttons near the top of the window may be clicked to return to
  20. the previous page or the main page.
  21.  
  22. You may also return to the main page by pressing the return key, or to
  23. the previous page by pressing almost any other key.
  24.  
  25. The help window may be exited by clicking the closewindow gadget or by
  26. pressing the escape key (ESC).
  27.  
  28.  
  29. @click
  30. [220,80] See!  Wasn't that easy?
  31.  
  32.  
  33.  
  34. @menus
  35. [200,0] ******* Menu items *******
  36. [20,20] Project
  37. -------
  38. Backup [menu_backup]
  39. Restore [menu_restore]
  40. No-log Restore [menu_nlrestore]
  41. Help [menu_help]
  42. About [menu_about]
  43. Info [menu_info]
  44. Quit [menu_quit]
  45.  
  46. [180,20] Display Sorting [menu_dsort]
  47. ---------------
  48. List Directories First [menu_dfirst]
  49. Sort by Name
  50. Sort by Date
  51. Sort by Size
  52. Sort by Archive Bit
  53.  
  54. [410,20] Options
  55. -------
  56. Set Archive Bits [menu_seta]
  57. Smaller Log Files [autotrim]
  58. Compression [menu_comp]
  59. Backup Dir Structure [menu_backdir]
  60.  
  61. [20,120] Devices [menu_devices]
  62. -------
  63.  
  64. ;------------------------------------------------------------------
  65.  
  66. @menu_backup
  67. [10,30] The menu item "Backup" will start the backup process.
  68. This will bring up a requester for selecting which partition or
  69. sub-directory is to be backed up.
  70.  
  71.  
  72. @menu_restore
  73. [10,30] The menu item "Restore" will start a restoration.
  74. A requester will appear asking for a logfile to be selected.  This
  75. logfile should correspond to the floppy disk (or tape etc.) set that
  76. is to be restored from.
  77. If no logfile exists, see the menu selection
  78. [382,70] "No-log Restore". [menu_nlrestore]
  79.  
  80.  
  81. @menu_nlrestore
  82. [10,30] The menu selection "No-log Restore" will allow a set of archive
  83. floppys (or tape etc.) to be restored even though no logfile exists.
  84. This mode allows a full restore only.  Consequently, all files on the backup
  85. media will be restored.  No selection of specific files can occur.
  86.  
  87.  
  88. @menu_help
  89. [10,30] The menu item "Help" will bring up this help window.
  90.  
  91.  
  92. @menu_about
  93. [10,30] The menu item "About" will display version and copyright
  94. information, as well as information about the program's authors etc.
  95.  
  96.  
  97. @menu_info
  98. [10,30] The menu item "Info" displays a window showing which colors
  99. in the file list display indicate certain attributes.
  100.  
  101.  
  102. @menu_quit
  103. [10,30] The menu item "Quit" will cause the HDBackup program to exit.
  104.  
  105.  
  106. @menu_dsort
  107. [10,30] The "Display Sorting" menu controls the order in which
  108. entries appear in the file list area.
  109.  
  110. [20,60] Sort by Name --- Alphabetical order by file name
  111.  
  112. [20,74] Sort by Date --- Files will appear in the order that they were last
  113.                  modified.  Oldest files before newer files.
  114.  
  115. [20,98] Sort by Size --- Smaller files will appear before larger files.
  116.  
  117. [20,112] Sort by Archive Bit --- Files with the archive bit set will appear
  118.                         after those without.
  119.  
  120.  
  121. @menu_dfirst
  122. [10,30] The menu item "List Directories First" when checked will
  123. cause directories to appear at the start of the file display.
  124. If this is not selected, directories will appear amongst the
  125. normal files.
  126.  
  127.  
  128. @menu_seta
  129. [10,30] The menu item "Set Archive Bits" will, when checked, cause
  130. the archive bit to be set for all files that are successfully
  131. backed-up.  This bit can later be tested as a convenient means
  132. of determining which files must be saved when doing an incremental
  133. backup.
  134.  
  135.  
  136. @menu_comp
  137. [10,30] The menu item "Compression" allows control of file compression
  138. on the backup media.  Note that if compression is selected no
  139. information will be displayed about the number of diskettes (tapes etc.)
  140. required for the backup.
  141.  
  142. [60,80] Sub-menu items:
  143.  
  144. [20,94] None --- This will cause no compression to be performed.
  145.  
  146. All  --- All files will be compressed.
  147.  
  148. Larger than ??? --- Selecting this option will bring up a requester
  149.                     allowing a file size to be entered.  All files
  150.                     whose size is greater than the size entered will
  151.                     be compressed.
  152.  
  153.  
  154. @menu_backdir
  155. [10,30] The menu item "Backup Dir Structure" controls how empty
  156. directories are dealt with when a backup is performed.  If this
  157. item is "on", empty directories will be saved to the backup media.
  158. If off, they will not be saved.
  159.  
  160.  
  161. @menu_devices
  162. [10,30] The "Devices" menu contains a list of possible devices
  163. on which a backup or restore may be performed.  If more than
  164. one of these is checked, they will be used in sequence.
  165. Devices may be added to this list with the
  166. [360,60] DEVS [opt_devs]
  167. [400,60] option.
  168.  
  169. @autotrim
  170. [10,20] The menu item "Smaller Log Files" will, when selected, cause files which
  171. were shadowed, de-selected, or which had a 'write error' to be deleted
  172. from the directory tree prior to saving the logfile.  This deletion will
  173. happen immediately after the backup is performed.
  174.  
  175.  
  176.  
  177. ;------------------------------------------------------------------
  178.  
  179.  
  180. @config_root
  181.  
  182. [10,10] CONFIGURATION OPTIONS
  183.  
  184.  
  185. [20,30] *** Case is significant for both pieces of the option spec.
  186. [20,40] *** There should also be no spaces in the option spec.
  187.  
  188. ; first column
  189. [100,70] LACE [opt_lace]
  190. SCREEN [opt_screen]
  191. FONT [opt_fontname]
  192. FONTSIZE [opt_fontsize]
  193. START [opt_start]
  194. DEVS [opt_devs]
  195. USE [opt_use]
  196.  
  197. ; second column
  198. [300,70] BRU [opt_bru]
  199. BRUPATH [opt_brupath]
  200. BRUARGS [opt_bruargs]
  201. BRUSTACK [opt_brustack]
  202. ICONS [opt_icons]
  203. LOGDIR [opt_logdir]
  204. FILEICON [opt_fileicon]
  205. DIRICON [opt_diricon]
  206. ;EMBEDLOG [opt_embedlog]
  207.  
  208. ; third column
  209. [500,70] BACKUP [opt_backup]
  210. RESTORE [opt_restore]
  211.  
  212.  
  213. [50,180] Option Default Settings [config_defaults]
  214.  
  215.  
  216. ;------------------------------------------------------------------
  217.  
  218.  
  219. @config_defaults
  220.  
  221. [10,10] Configuration Option Defaults
  222.  
  223. ; first column
  224. [50,30] DEBUG=off
  225. LACE=off
  226. SCREEN=custom
  227. FONT=topaz
  228. FONTSIZE=8
  229. START=off
  230. DEVS=df0:|df1:df2:|df3:
  231. USE=df0:
  232.  
  233. ; second column
  234. [300,30] BRU=bru
  235. BRUPATH=
  236. BRUARGS=
  237. BRUSTACK=
  238. ICONS=on
  239. LOGDIR=SYS:HDBackupLogs
  240. FILEICON=
  241. DIRICON=
  242. ;EMBEDLOG=on
  243. BACKUP=
  244. RESTORE=
  245.  
  246.  
  247.  
  248. ;-----------------------------------------------------------------
  249. ;-----            Option Pages                                ------
  250. ;-----------------------------------------------------------------
  251.  
  252.  
  253. @opt_brupath
  254.  
  255. BRUPATH=<name>
  256. example:BRUPATH=dh3:utilities/est
  257. BRU=c:
  258. BRU=HDutils:
  259.  
  260. This allows specifying an explicit path to find BRU.  Note that this path
  261. is limited to 64 characters.  It also may NOT contain spaces.  If this
  262. option is not used, HDBackup will search for BRU first in the directory
  263. containing HDBackup, and then in "c:".
  264.  
  265.  
  266.  
  267. @opt_bru
  268.  
  269. BRU=<name>
  270. example:BRU=bru
  271. BRU=bru.dbug
  272.  
  273. This allows an alternate name for the bru executable to be given.  The
  274. default is "bru".
  275.  
  276.  
  277.  
  278. @opt_bruargs
  279.  
  280. BRUARGS=<argument-list>
  281. example:BRUARGS=-#d:t:F:L:o,bru.log
  282.  
  283. This allows some user specified arguments to be passed to bru by HDBackup.
  284. Not very useful for the most part, except for debugging purposes.
  285.  
  286.  
  287.  
  288. @opt_brustack
  289.  
  290. BRUSTACK=<value>
  291. example:BRUSTACK=40000
  292.  
  293. This allows a specific stack size to be set for the bru process by HDBackup.
  294. The default is to use the same stack size as HDBackup if BRUSTACK is not
  295. given.
  296.  
  297.  
  298.  
  299. @opt_devs
  300.  
  301. DEVS=<name>|...
  302. example:DEVS=worm:|tape:
  303.  
  304. This allows adding device names to the "devices" menu in addition to
  305. to the pre-existing ones DF0: thru DF3:.  A total of 4 additional
  306. devices can be added to this menu.
  307. Note: This must come *before* a USE= option statement.
  308.  
  309.  
  310. @opt_use
  311.  
  312. USE=<name>|...
  313. example:USE=df0:|df1:|df2:
  314.  
  315. Specify the names of backup devices to use.  These devices should
  316. already exist on the device menu, either by virtue of being the
  317. default devices which are always there (i.e. DF0: DF1: DF2: DF3:),
  318. or by having been defined in a previous DEVS= option.
  319.  
  320.  
  321.  
  322. @opt_fontname
  323.  
  324. FONTNAME=<name>
  325. example:   FONTNAME=topaz
  326.  
  327. This should be the name of a constant-width font.  This font will
  328. be used wherever possible in the HDBackup screen.
  329.  
  330.  
  331. @opt_fontsize
  332.  
  333. FONTSIZE=<num>
  334. example:   FONTSIZE=8
  335.  
  336. The font can be any height from 6 to 15, but the width MUST be 8.
  337. Obviously this precludes use of proportional fonts.
  338.  
  339.  
  340.  
  341. @opt_screen
  342.  
  343. SCREEN=custom
  344. SCREEN=workbench
  345.  
  346. This will cause the workbench screen or a custom screen
  347. to be used.
  348.  
  349.  
  350.  
  351. @opt_numcolors
  352.  
  353. NUMCOLORS=4
  354. NUMCOLORS=8
  355.  
  356. Causes either 4 or 8 colors to be used for the custom
  357. screen. 
  358. Has no effect if  SCREEN=workbench
  359.  
  360.  
  361.  
  362. @opt_lace
  363.  
  364. LACE=on
  365. LACE=off
  366.  
  367. Controls whether or not the custom screen is (USA) 200 lines
  368. high or (USA) 400 lines high.  This will also affect the
  369. colors used. (Probably want different colors than for a
  370. non-interlaced screen!)
  371.  
  372.  
  373.  
  374. @opt_colors
  375.  
  376. COLORS=<num>,<num>,<num>,<num>,<num>,<num>,<num>,<num>
  377. example:   COLORS=000,458,FFF,800,7FF,AA3,8B2,111
  378.  
  379. Set the colors for the custom screen.  The number is of
  380. the format Red-Green-Blue, in hex.
  381. For example, black would be 000, white would be FFF.
  382. All colors MUST be specified if this parameter is used.
  383.  
  384.  
  385.  
  386. @opt_lacecolors
  387.  
  388. LACECOLORS=<num>,<num>,<num>,<num>,<num>,<num>,<num>,<num>
  389. example:   COLORS=000,458,FFF,800,7FF,AA3,8B2,111
  390.  
  391. Set the colors for the custom screen which will be used if
  392. LACE=on is set.  The number is of the format Red-Green-Blue,
  393. in hex.
  394. For example, black would be 000, white would be FFF.
  395. All colors MUST be specified if this parameter is used.
  396.  
  397.  
  398.  
  399. @opt_backup
  400.  
  401. BACKUP=<volume>
  402.  
  403. Causes HDBackup to automatically and immediately go into the desired
  404. mode and begin building the tree.
  405.  
  406.  
  407.  
  408. @opt_restore
  409.  
  410. RESTORE=<volume>
  411.  
  412. Causes HDBackup to automatically and immediately go into the desired
  413. mode and begin building the tree.
  414.  
  415.  
  416.  
  417. @opt_start
  418.  
  419. START=on
  420. START=off
  421.  
  422. If set to on, the operation set by specifing the BACKUP= or the
  423. RESTORE= option will commence automatically.  Otherwise the tree
  424. is merely built, then the user must start the backup.
  425.  
  426.  
  427.  
  428. @opt_icons
  429.  
  430. ICONS=on
  431. ICONS=off
  432. If on, logfiles will have icons created for them, as will any
  433. directories which need to be created to save the logfile in.
  434.  
  435.  
  436.  
  437. @opt_fileicon
  438.  
  439. FILEICON=<name>
  440. Example:FILEICON=dh3:icons/blank
  441. FILEICON=df0:my_logfile_icon
  442.  
  443. This is the name of an icon to use as the template for
  444. creating logfile icons.  The ".info" extension will be added.
  445. If this is not specified, the internal default icon will
  446. be used.  This has no effect if the "ICONS=off" option has been
  447. given.
  448.  
  449.  
  450.  
  451. @opt_diricon
  452.  
  453. DIRICON=<name>
  454. Example:DIRICON=dh3:icons/empty
  455. DIRICON=df0:my_directory_icon
  456.  
  457. This is the name of an icon to use as the template for
  458. creating logfile directory icons.
  459. The ".info" extension will be added.
  460. If this is not specified, the internal default icon will
  461. be used.  This has no effect if the "ICONS=off" option has been
  462. given.
  463.  
  464.  
  465.  
  466. @opt_embedlog
  467.  
  468. EMBEDLOG=on
  469. EMBEDLOG=off
  470.  
  471. If on, the logfile will be embedded in the BRU archive.
  472.  
  473.  
  474.  
  475. @opt_logdir
  476.  
  477. LOGDIR=<name>
  478. Example:LOGDIR=SYS:HDBackupLogs
  479. LOGDIR=DF0:
  480. LOGDIR=DF1:archive/hd/current
  481.  
  482. The directory in which to start the Logfile storage tree.  If this is
  483. set to "nothing", no logfile will be saved!
  484.  
  485.  
  486. ;-------------------------------------------------------------------
  487.  
  488. @fl_help
  489.  
  490. [60,20] General information about the file list:
  491. [20,40] The file list is the area on the right half of the screen
  492. which displays the list of files to be either backed-up or restored
  493. (depending on the mode).
  494.  
  495. Double-clicking on a file entry will bring up a window showing
  496. detailed information about the file, as well as a hexadecimal display
  497. of the first 64 bytes in the file.
  498.