diff --git a/README.md b/README.md index e203c49..3023207 100644 --- a/README.md +++ b/README.md @@ -11,12 +11,31 @@ Requirements * Zimbra Collaboration Suite Opensource 8.6 or higher; * GNU Wget - a computer program that retrieves content from web servers; * GNU Parallel - a shell tool for executing jobs in parallel using one or more CPU; -* cURL - A command line tool and library for transferring data with URL syntax; +* cURL - a command line tool and library for transferring data with URL syntax; +* GNU grep - a command-line utility for searching plain-text data sets for lines matching a regular expression; +* date - command used to print out, or change the value of, the system's time and date information. Instalation ------------ -TO DO +First, install all the required packages in your system: + +``` +apt-get install parallel wget curl grep date +``` + +After that, download and unpack a stable release of zmbackup in "Release" section, or git clone the Master branch: + +``` +git clone https://github.com/lucascbeyeler/zmbackup.git +``` + +Enter inside the folder zmbackup and execute the script install.sh. Follow the instructions and then, to validate, execute the command "zmbackup -v" as zimbra user. The command should execute correctly: + +``` +$ zmbackup -v +zmbackup version: 1.0.0 Release Candidate +``` Documentation ------------ diff --git a/src/zmbackup b/src/zmbackup index 5534ad6..7d79af4 100755 --- a/src/zmbackup +++ b/src/zmbackup @@ -80,7 +80,8 @@ show_help (){ printf "\n -i, --incremental : Execute incremental backup for an account, a list of accounts, or all accounts." printf "\n -l, --list : List all backup sessions that still exist in your disk." printf "\n -r, --restore : Restore the backup inside the users account." - printf "\n -d, --delete : Delete a session of backup" + printf "\n -d, --delete : Delete a session of backup." + printf "\n -v, --version : Show the zmbackup version." # All the options related to Full Backups will be put here printf "\nFull Backup Options:\n" @@ -555,6 +556,9 @@ case "$1" in "-h"|"--help" ) show_help ;; + "-v"|"--version" ) + echo "zmbackup version: 1.0.0 Release Candidate" + ;; * ) echo "Error! Incorrect options" ;;