Some documentation changes.

This commit is contained in:
Andrea Mazzoleni 2011-06-26 20:40:35 +02:00
parent 9aba760012
commit 22a2c9e124
3 changed files with 28 additions and 28 deletions

View file

@ -253,24 +253,19 @@ snapraid fix \(hyf JUST_DELETED_DIR/
.PD
.RE
.SH COMMANDS
SnapRAID provides three simple commands (case sensitive) that allow to:
SnapRAID provides four simple commands that allow to:
.PD 0
.IP \(bu
See the files changed from the previous sync \(hy> \(a"diff\(a"
.IP \(bu
Make a backup/snapshot \(hy> \(a"sync\(a"
.IP \(bu
See the files changed from the previous sync \(hy> \(a"diff\(a"
.IP \(bu
Check for integrity \(hy> \(a"check\(a"
.IP \(bu
Restore the last backup/snapshot \(hy> \(a"fix\(a".
.PD
.PP
Take care that they should be written in lower case.
.TP
.B diff
Lists all the files modified from the last \(a"sync\(a" command that
needs to be backuped.
Nothing is modified.
Take care that the commands have be written in lower case.
.TP
.B sync
Updates the redundancy information. All the modified files
@ -284,6 +279,11 @@ without losing the work already done.
The \(a"content\(a", \(a"parity\(a" and \(a"q\(hyparity\(a" files are modified if necessary.
The files in the array are NOT modified.
.TP
.B diff
Lists all the files modified from the last \(a"sync\(a" command that
needs to be backuped.
Nothing is modified.
.TP
.B check
Checks all the files and the redundancy data.
All the files are hashed and compared with the snapshot saved
@ -301,7 +301,7 @@ The \(a"content\(a" file is NOT modified.
The \(a"parity\(a" and \(a"q\(hyparity\(a" files are modified if necessary.
The files in the array are modified if necessary.
.SH OPTIONS
SnapRAID provides the following options (case sensitive):
SnapRAID provides the following options:
.TP
.B \(hyc, \(hy\(hyconf CONFIG
Selects the configuration file. If not specified is assumed

View file

@ -152,19 +152,14 @@ Getting Started
:snapraid fix -f JUST_DELETED_DIR/
Commands
SnapRAID provides three simple commands (case sensitive) that allow to:
SnapRAID provides four simple commands that allow to:
* See the files changed from the previous sync -> "diff"
* Make a backup/snapshot -> "sync"
* See the files changed from the previous sync -> "diff"
* Check for integrity -> "check"
* Restore the last backup/snapshot -> "fix".
Take care that they should be written in lower case.
=diff
Lists all the files modified from the last "sync" command that
needs to be backuped.
Nothing is modified.
Take care that the commands have be written in lower case.
=sync
Updates the redundancy information. All the modified files
@ -178,6 +173,11 @@ Commands
The "content", "parity" and "q-parity" files are modified if necessary.
The files in the array are NOT modified.
=diff
Lists all the files modified from the last "sync" command that
needs to be backuped.
Nothing is modified.
=check
Checks all the files and the redundancy data.
All the files are hashed and compared with the snapshot saved
@ -196,7 +196,7 @@ Commands
The files in the array are modified if necessary.
Options
SnapRAID provides the following options (case sensitive):
SnapRAID provides the following options:
-c, --conf CONFIG
Selects the configuration file. If not specified is assumed

View file

@ -168,19 +168,14 @@ deleted directory, simply running the fix command like.
5 COMMANDS
==========
SnapRAID provides three simple commands (case sensitive) that allow to:
SnapRAID provides four simple commands that allow to:
* See the files changed from the previous sync -> "diff"
* Make a backup/snapshot -> "sync"
* See the files changed from the previous sync -> "diff"
* Check for integrity -> "check"
* Restore the last backup/snapshot -> "fix".
Take care that they should be written in lower case.
diff
Lists all the files modified from the last "sync" command that
needs to be backuped.
Nothing is modified.
Take care that the commands have be written in lower case.
sync
Updates the redundancy information. All the modified files
@ -194,6 +189,11 @@ Take care that they should be written in lower case.
The "content", "parity" and "q-parity" files are modified if necessary.
The files in the array are NOT modified.
diff
Lists all the files modified from the last "sync" command that
needs to be backuped.
Nothing is modified.
check
Checks all the files and the redundancy data.
All the files are hashed and compared with the snapshot saved
@ -215,7 +215,7 @@ Take care that they should be written in lower case.
6 OPTIONS
=========
SnapRAID provides the following options (case sensitive):
SnapRAID provides the following options:
-c, --conf CONFIG
Selects the configuration file. If not specified is assumed