# ME-Backup documentation

## Reference

## Launch

- Bundle types

  ME-Backup is distributed in two modes: platform independent and platform dependent. The platform dependent package contains the JRE on that platform whereas independent package can be executed on any platform as long as JRE/JDK 8 is installed.

- For platform dependent package, unzip it and execute corresponding launcher

  On Windows, launch backup.exe or backup.bat

  On Linux or Mac, launch backup.sh. Likely you need to invoke chmod +x backup.sh.

- For platform independent package, an extra step of setting up java command into PATH is required

  On Windows, set PATH=<your java path>;%PATH%

  On Linux or Mac, export PATH=<your java path>:$PATH. You may need to invoke chmod +x -R <jre folder>.

## Configuration

- Setup path on first use

## Basic Operations

- Create a group

  Menu File ‣ New Group

- Create a task

  Menu File ‣ New Task, select Category in the combo box and then fill in corresponding parameters.

- Modify an existing task

  Select and double click an existing task to trigger task window. Any modification will be saved to config file once backup is closed normally.

- Rearrange task orders

  Drag and drop a task onto other task or group. Note a group task can only be dragged and dropped onto another group task.

  Press `[` to reorder task one level up and `]` one level down

- Delete a task

  Menu File ‣ Delete Task

- Launch backup jobs.

  Menu File ‣ Execute

## Task: Sync Folder

- This task synchornizes destination folder with source folder
- Name, Source and Source fields are required
- MD5 controls file comparison policy. When selected, file comparison computes source and destination file MD5 and only overwrite destination file in case their MD5 differ. This policy is strict in terms of time consumption but guarantees only overwrite when file content is changed . When MD5 not selected, the default comparison policy takes effective. In this policy, destination file is overwritten in case source file is newer (by file modification date) or their file size differ
- Confirm Update Existing option gives user a way to confirm each overwrite of existing destination file. But it only takes effective when global mute option is disabled.

## Task: Copy Folder

- This task copies source folder to destination folder. For example, if source folder is C:/Myfolder and destination folder is C:/Backup, after running the task, C:/Backup/Myfolder is copied from C:/Myfolder.
- Name, Source and Source fields are required
- Append Timestamp to Name controls whether append a timestamp to the destination directory name. The timestamp is in format yyyy-mm-dd-hh-mm-ss.

## Task: Zip and Copy Folder

- This task first creates a zip file compressing the source folder and then copies the zip file to destination folder. For example, if source folder is C:/Myfolder and destination folder is C:/Backup, after running the task, C:/Backup/Myfolder.zip is created from C:/Myfolder.
- Name, Source and Source fields are required
- Append Timestamp to Name controls whether append a timestamp to the destination file name. The timestamp is in format yyyy-mm-dd-hh-mm-ss.

## Task: Execute Command

- This task performs a command and outputs its stderr and stdout.
- Name, Parameter fields are required
- In Parameter field, use space to seperate parameters. For example, cp -r path1 path2. Use single quote to surround space if necessary. For example, cp -r ‘C:/p 1’ ‘C:/p 2’

## Options