rename the config for it to be coherent with the script itself, add the license text and some comment fixesHEADmaster

2 files changed, 30 insertions, 4 deletions

diff --git a/backup.zsh b/backup.zsh
index 99c9a63..6b13d12 100755
--- a/backup.zsh
+++ b/backup.zsh
@@ -1,4 +1,28 @@
 #!/usr/bin/env zsh
+#
+# The MIT License (MIT)
+#
+# Copyright (c) 2014 Von Random
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+#
+
 self_name=$0
 
 # some hardcoded defaults
diff --git a/backup.cfg b/backup.zsh.cfg
index c852c98..b773677 100644
--- a/backup.cfg
+++ b/backup.zsh.cfg
@@ -3,12 +3,12 @@
 ## Can be ftp, sftp, ftps, ssh or local.
 protocol='ssh'
 
-## The directory store backups in, locally or remotely.
+## The directory to store backups in, locally or remotely.
 backup_dir='relative_or_full_path'
 
 ## The list of patterns to exclude from backups, for
 ## more details look into tar -X option.
-#exclude_list='/usr/local/etc/backup/excludes.list' 
+#exclude_list='/usr/local/etc/backup/excludes.list'
 
 ## The compression algorithm for backups.
 ## Can be gz, bz2, xz or empty (for non-compressed).
@@ -32,7 +32,9 @@ source_dirs=( '/home/user/source1:/var/backup/snapshot.list'
 #backup_filename='somebackup'
 
 ## GPG key to encrypt backups, uses name of the private
-## key in your keyring
+## key in your keyring. It is also entirely possible to
+## add the GNUPGHOME environment variable export here in
+## order to use the private key from a specific location.
 #gnupg_key='keyname'
 
 #### remote options ####
@@ -45,7 +47,7 @@ remote_user='username'
 ## Password, due to how openssh handles security it only
 ## works for *ftp* protocols; backups via ssh protocol
 ## work interactively. Later versions will have support
-## for ssh keys.
+## for ssh keys... If I ever decide to make it happen.
 remote_pass='PassWd'
 
 ## Port is optional, the defaults are hardcoded.