Permalink
Browse files

added help to readme and change spaces/tab indentation

  • Loading branch information...
1 parent 0783381 commit d5851c62db167e7c964fd8f491e30bae39b08978 sshAdm.in committed Mar 18, 2012
Showing with 39 additions and 11 deletions.
  1. +28 −0 README.md
  2. +11 −11 snapback.pl
View
@@ -18,6 +18,34 @@ script would make a new snapshot of a single volume with option __-m__.
If CRT and PK files are not provided respectively as 'cert.pem' and 'pk.pem'
under directory '/etc/aws' you should specify them both with __-C__ and __-K__
+## Help
+
+ Usage:
+ ./snapback.pl [-a|-h]
+ Additional options :
+ [-m <days>] [-x <count>] [-C <file>] [-K <file>]
+ Debug & Help options :
+ [-d]
+
+ Description:
+
+ Options Legend :
+ *M* - Mandatory
+ *O* - Optional
+
+ Options :
+ -a, --automagic *O* Enables Automagic(R) mode.. at
+ the moment this is the only choice
+ -m, --mindays <days> *O* Specify minimum amount of days that
+ have to be passed since last backup
+ to create a new snapshot
+ -x, --maxcount <number> *O* Specify the maximum amount of
+ snapshots for a single EBS volume
+ -C, --crtfile <file> *O* Specify the AWS certificate file
+ -K, --pkfile <file> *O* Specify the AWS private key file
+ -d, --debug *O* Prints LOTS of debug info on stdout
+ -h, --help *O* Prints this help screen
+
## Installation details
* create dedicated user
View
@@ -134,7 +134,7 @@
sub help {
print "
Usage:
- $script_name [-a|-h]
+ ./snapback.pl [-a|-h]
Additional options :
[-m <days>] [-x <count>] [-C <file>] [-K <file>]
Debug & Help options :
@@ -147,17 +147,17 @@ sub help {
*O* - Optional
Options :
- -a, --automagic *O* Enables Automagic(R) mode.. at
- the moment this is the only choice
- -m, --mindays <days> *O* Specify minimum amount of days that
- have to be passed since last backup
+ -a, --automagic *O* Enables Automagic(R) mode.. at
+ the moment this is the only choice
+ -m, --mindays <days> *O* Specify minimum amount of days that
+ have to be passed since last backup
to create a new snapshot
- -x, --maxcount <number> *O* Specify the maximum amount of
- snapshots for a single EBS volume
- -C, --crtfile <file> *O* Specify the AWS certificate file
- -K, --pkfile <file> *O* Specify the AWS private key file
- -d, --debug *O* Prints LOTS of debug info on stdout
- -h, --help *O* Prints this help screen"."\n";
+ -x, --maxcount <number> *O* Specify the maximum amount of
+ snapshots for a single EBS volume
+ -C, --crtfile <file> *O* Specify the AWS certificate file
+ -K, --pkfile <file> *O* Specify the AWS private key file
+ -d, --debug *O* Prints LOTS of debug info on stdout
+ -h, --help *O* Prints this help screen\n";
}
sub cleanExit {

0 comments on commit d5851c6

Please sign in to comment.