Skip to content

Commit

Permalink
Updating README.md and include version function
Browse files Browse the repository at this point in the history
  • Loading branch information
lucascbeyeler committed Feb 12, 2017
1 parent 8e965ca commit 7c0cd71
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 3 deletions.
23 changes: 21 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
------------
Expand Down
6 changes: 5 additions & 1 deletion src/zmbackup
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down Expand Up @@ -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"
;;
Expand Down

0 comments on commit 7c0cd71

Please sign in to comment.