eBackUp     V0.91
=================
01.04.2011, hanno



1.) Introduction
2.) Requirements
3.) Installation
4.) Usage
5.) Remarks and hints
6.) ToDo
7.) Contact/Thanks
8.) Disclaimer
9.) History




1.) Introduction:
-----------------
eBackUp is a backup and restore utility, using "Rar32 for DOS/OS2" to
compress and archive and to extract files and directories. 

eBackUp was built using "WDSibyl" (www.wdsibyl.org).




2.) Requirements:
-----------------
- OS/2 or eComStation (eCS)
- Rar for DOS version 3.93 (minimum tested is 3.90), avaliable at
   http://www.rarlab.com
  (This program is shareware - please pay for the fullversion.
  The free version has some limits, but is working ok - see "Remarks and
  Hints"). Direct download for latest version:
  http://www.rarlab.com/rar/rarx393.exe 



3.) Installation:
-----------------
- Rar32 has to be properly installed (It has just to be extracted in a
  directory of your choice - see the read me of rar32) - simply start
  eBackUp in a directory of your choice and run it
  (a INI file will be created within the program directory during operation,
  also two folders will be created to hold some user-specific files
  and the logs)

* eBackUp does not make any changes or entries in config.sys or the
  os/2-ini files.




4.) Usage:
----------
The program should be self-explanatory :-)
See also the hints for some buttons and labels ("on mouse over" for 2
seconds) and read through this file.


* Backup:
To perform a backup, you have first to create a "Set", which is a collection
of information including sources, target and other parameters.
Sets simplify the process of backing up your data. Of course you can modify
a Set anytime.
The data to backup will be stored in so called "Archives", the main thing
which rar32 is working on. After a successful backup, a catalog entry is
created. Also a log file is written and an info-line within the Actions.log
is made.

* Restore:
Each successful backup has created a entry in the backup catalog and you
can choose the desired archive to work on.
After a successful restore, log file is written and an info-line within
the Actions.log is made.

* Misc:
On  this tab page you can view archives and search for files and/or text
within files. It is also possible to repair broken archives (better chance,
if a data recovery record was added; see "Modify Set", "Target"-options),
lock or test archives and do some other actions.

* Logs:
Each backup, restore and archive view creates a log file named
corresponding to it's action.
These log files are overwritten when the next similar action is taken!
So if you like to save a log for later usage, go to the "Logs"-tab and
copy/save the log file.
The "Action.log" is a secific log file holding one short line with some
infos for each backup or restore action.


* Terms:
Set     = predefined parameters for a backup (for example: source files,
          target, compression level, ...)
Catalog = List of successfully done backups. It simplyfies the restoring
          or viewing of archives by storing some information like date/time,
          source of archive and so on.
Archive = Holds the backup data. This file is created by rar32 and always
          contains a timestamp within its name.
Volume  = If the size of an archive exceeds the predefined volume size
          (see Backup-Set/Target), multiple files are generated for an
          archive (numbered file name extentions)
SFX     = SelF eXtracting Archive; you can extact the files of an
          SFX-Archive in a simple DOS-session (no need for Rar32 or eBackUp)
Actions.log = Collection of important actions (like backup and restore)
              and the result of the action




5.) Remarks and hints:
----------------------
- The evaluation (not registered) version of Rar has the following limitations:
    * no "rar error logging" (this is mainly covered by eBackUp,
      so no real need for this feature)
    * no "Authenticy Verification" (information concerning the creator, last
      update time and archive name; not really needed)

- Default compression level is "less" and not "normal" because of
  archive_size : archive_time seems to be better - change it to any desired
  level to fit your needs


- Storing data on  multiple CDs/DVDs: As "opening media" and
  "closing session" is needed (and not yet implemented within eBackUp),
  it is suggested, to set the Volume Size (Set/Target/Volume Size)
  to the desired size. Use a disk device as target and then, after
  backup, burn the parts of the Archive (the Volumes) manually on
  CD/DVD.
  Note: If CD/DVD-size fits the size of an entire Archive, simply open
  the mediy before backup and then close the session after the backup
  has ended. (Do not use the option "Eject removable devices after backup".)


- If the link to "WDSibyl.org" or the "Look for Updates"-function do not
  work, maybe no DEFAULT browser is defined. Maybe you have to open or
  to close the browser before the desired action, depending on your
  installation - then try again.

- Open shared files: This allows to archive files which are
  opened by other applications for writing.
  This option could be dangerous, so use it carefully and
  read also the readme of Rar32!




6.) ToDo:
---------
- multi language support
- use ZIP as an alternative packer
- show estimated backup time and amount of disk space
- invisible password entry for restore and view




7.) Send bugs, tips and hints to:
---------------------------------
xeSoftx@xaonx.xatx (without x)

PLEASE DO NOT ASK FOR SUPPORT FOR Rar32!



Thanks to Wolfgang Draxler, Andreas Rderer and Oliver Cremer for
supporting and testing!




8.) Disclaimer:
---------------
You are using this program at your own risk. The author gives no
warranty for the function or any others things affected by this program.
Under no circumstances the author is liable for any loss or damage
supposed to derive from the use of the program.




9.) History:
------------

v0.91	01.04.2011  (released on WDSibyl.org)
  *Add backup statistic to end of log (see "Settings")
  *Option to create unique logfiles for backups (not restore or archiveview)
  *minor: changed some variable names (no YN)
  *Settings: button for "Reset to defaults" added (moved some values to
   section "Div" within INI file)
  *possibility to add a descripition to manually added catalogs
  *additional files to exclude from compression added (this speeds up
   backup time in some cases)

V0.90	29.03.2011
  *Form "Selective Restore": borderstyle changed from bsSizeable to bsDialog
  *Form "Status" is now sizeable (mimimum size defined; this also resets
   form size on application start)
  *Form "Status": font for listbox changed to "System VIO" (monospaced)
  *Logs-listbox: font size changed from 8 to 6
  *New version always resets Ini-Form-Section (no possibility to skip)
  *Show a note concerning registration on "First Start" and "New version"
  *RegCode: also space characters are filtered
  *Restore to different location: always add pathseparator to target directory
  *Restore: Possibility to restore without preserving drive and
   directory structure
  *further reduction of pipe sleep time: 150,80,40,20,5,0 (200,100,60,40,20,5)
  *PipeUnit: SleepSys only applied as long as ExecThread is running
  *Form "Status":improved time-display (prevent from flickering)
  *param "-x@" has to be placed before the "stop_param_reading"-switch
   ('--'), otherwise exclude_dirs_files will be ignored (error corrected)
  *Listbox "Backup-Sets": double-clicking opens the "Modify selected Set"
   dialog
  *improved drive- and directory selection for backup-set sources
  *WPI-script: no replace for eBackUp folder and eBackUp executeable
  *bugfix: password input (<xyz.tmp) suppressed for backup
  *clear password entry field after successful backup
  *disable checkbox "Keep drive and folder structure" (if neccessary) after
   "Form1_enabled" commands

V0.89	20.03.2011
  *Code for registration implemented - now registration is needed
   (license is free), otherwise just demo-version
  *Settings: possibility to write the used Rar32 parameters to the log file
  *Settings: default for 'Authenticy verification check' changed to 'false'
  *Versions handling now under control of Application.ProgramVersion
   (instead of Form_Label), each new version asks for ini-reset
  *PipeUnit: 'Invalid argument' added to Warnings (error occurs for example
   in conjunction with loss of network connectivity)
  *code concerning "test-version" and "update-reminder" removed (now
   registration is needed)
  *all commands 'Form1.TabbedNotebook1.Enabled' changed to 'Form1.Enabled'
  *MiscTab: delete display of remark line when an archive is choosen manually
  *PipeUnit: Stop scrolling also added for "misc" operations

V0.55T  (Ini-V 0.55T)	09.03.2011
  *Returnvalues of checks changed from integer to boolean
  *short information about "No errors"/"Warnings"/"File Open Errors" is
   written to the remark field (Catalog)
  *PipeUnit: if exec has ended and bytesread=0 and no chr13+10 at end:
   add chr13+10 to initiate processing of remaining-string
  *'Invalid argument' added to warnings-group
  *Settings: log-level "Directory and File Names" as default   *Settings: as
   "Open shared" is now enabled, there is no need to re-disable it after
   each "form-visible" (all corresponding commands removed)
  *password input revised
  *WPI-script: removed the "REPLACE" option for WPFolder (to take an
   eventually movement of EBACKUP_FOLDER into account), see also 0.90

V0.50T (Ini-V 0.50T)	06.03.2011
  *functionality for "Selective Restore" implemented
  *const/var for "incl.tmp", "excl.tmp" and "temp.tmp" files instead of fixed
   names
  *Actions.log sorting changed to "descending"
  *Close/Minimize/Move for Set_Form (sep. proc for OnCloseQuery)
  *Status_Information scrolls to last line. Checkbox to stop integrated.
   (ListBox instead of Memo)
  *added "signal on errors/warnings" (additional checkbox on Settings-Tab)
  *Form_Sets: button to remove all entries from "Dir/files to exclude"-field
   added
  *Restore to diff. target: corrected an error when changing directory by
   menue (ChDir to CurDir)
  *show explaining text for the priority settings of backup and restore
   trackbar
  *eliminated code trying to write to ini file on read error during program start
  *Start time/elapsed time on Status_Information_Window
  *possibility to go to log or editor directly from Status_Information_Window
  *added: remarks for backup
  *added: encrypt archive (password); SetType is marked to indicate
   encrypted archives
  *Settings: option "Open shared files" enabled (and added remarks with
   warnings)



V0.41T (Ini-V 0.40T)	19.02.2011 (released on WDSibyl.org)
  *literal error within message for new ini-file-version corrected
  *minor layout changes and changes to this readme
  *new ini-version: reset of form parameters not just in case of
   "StartFromIDE"

V0.40T (Ini-V 0.40T)	18.02.2011
  *eBackUp is now available as WPI file! (special thanks to Oliver)
  *Set: adjustment of width/height to OpenDialog for SourceFiles
  *good progress with handling of errors/warnings (StdErr to pipe)
  *new ini-version only resets form settings (no need to delete the ini-file
   itself)

V0.31T (Ini-V 0.20T)	15.02.2011
  *minor change: text arrangement within eCenterWidget
  *PipeReadUnit: operand changed from > to <> for '[A]bort' and '[Q]uit'
  *volume size of "700M" correctly implemented
  *volume size of "4090M" removed - this is not supported by Rar32
   (max. 2GB), same with "auto"!
  *added hints and information to buttons and entry fields (if it makes sense)
  *Settings: Checkbox added to enable/disable hints
  *after closing the Set Form, the last selected Set is selected again (not
   always the 1st one)
  *further reduction of pipe sleep time: 200,100,60,40,20,5 (250,120,80,50,30,10)
  *added: functionality for "Add an Archive to the catalog"
  *check of length of ExecParam improved
  *Hints for tab-pages removed ("TPageAccess")



V0.30T (Ini-V 0.20T)	13.02.2011 (released on WDSibyl.org)
  *possibility to search for an update of eBackUp after testperiod has ended
  *program exits improved (halt instead of appl.terminate)
  *main form during operations minimizeable (now anyway hidden when
   an operation starts)
  *improved handling of rar32 error- and warning-messages
  *cmd thread set to "hide" (instead of "minimized")

V0.23T (Ini-V 0.20T)	11.02.2011
  *progress displayed within eCenter widget
  *SetName limited to 12 characters
  *moved StatusForm_Close etc from StatusUnit to MainUnit to enable
   pipe-/MLE-writting till end
  *ActionCode for DosStopSession changed (back) from 0 to 1 (compiled
   progr. version did not stop)
  *Misc: result of button "Alternatively choose an Archive from Disk ..." was
   based on Label instead of variable
  *the priority trackbars also influence the SysSleep-time in the PipeUnit
   (less cpu usage)
  *improved infos within action.log
  *disabling of all relevant buttons if Set- or Cat-files exist but are empty
  *minimize button for StatusForm added

V0.22T (Ini-V 0.20T)	10.02.2011
  *Checking for rar32 for each relevant operation before operation-start
   (not when RarExec starts)
  *ActionCode for DosStopSession changed from 1 to 0 (now cmd-thread is
   stopped/canceled correctly)
  *root-directory is now also allowed as a backup-target (Target check
   changed)



V0.21T (Ini-V 0.20T)	08.02.2011 (released on WDSibyl.org)
  *filters for OpenFilesDialog (Rar32-path, Misc/Choose_Archive)
  *Backup: abort backup if missing target path could not be created
  *"Recurse Subdirs"=yes set as default for new Sets
  *PipeUnit: progress bar infos adapted
  *SetUnit: errors creating first new set solved (append/rewrite file)
  *MainUnit: default compression level changed to "less" instead of "normal"
   (seems to be more accurate)
  *Misc-tab: relevant buttons disabled if no cat entries are available
  *behavior of "Cancel Operation" improved
  *no log entries if rar32.exe was not found



V0.20T (Ini-V 0.20T)	06.02.2011 (released on WDSibyl.org)
  *misc tab: functionality for Lock/SFX/Repair/Test archive implemented
  *added: functionality for backup- and restore priority (REM :-( I cannot
   see any differences in speed ...)
  *version check (ini-version) on programm start added
  *ChDir back to CurDir after each File-OpenDialog etc.

V0.12T (Ini-V 0.10T)	04.02.2011
  *layout changes
  *possibility to delete archive files added
  *Set: back to current drive after changing the target drive (by menue)
   to prevent from error
  *used "-vn" to get archiv names like "xxx.r00" (advantage: first archive
   is always "xxx.rar"; easy cataloging and deleting etc.)
  *added: functionality to delete archives and/or catalog-entries

V0.11T (Ini-V 0.10T)	02.02.2011  (released on WDSibyl.org)
  *Multicolumnlist on Misc-tab instead of
  *Action log for ArchiveView blocked
  *"adding directories to a set": problem solved
  *more functionalities for "misc"

V0.10T (Ini-V 0.10T)	23.09.2010-31.01.2011 (with many interruptions ... :-( )
  *first "test"-version, useable until 31.04.2011