From e17b505c90357e55b2c1c502ba6656ae5baa6c8d Mon Sep 17 00:00:00 2001 From: Andrea Mazzoleni Date: Mon, 28 Mar 2011 20:50:30 +0200 Subject: [PATCH] Some documentation changes. --- INSTALL | 15 +++++++++------ README | 3 ++- snapraid.1 | 3 ++- snapraid.d | 3 ++- snapraid.txt | 3 ++- 5 files changed, 17 insertions(+), 10 deletions(-) diff --git a/INSTALL b/INSTALL index 5c9af39d..876fc5cd 100644 --- a/INSTALL +++ b/INSTALL @@ -6,15 +6,18 @@ As root or user type: ./configure make -and as root to install the programs and the documentation -type: +When you have to check for correctness the application simply typing: + + make check + +If if terminates with "Success", you can install the application and +the documentation running as root : make install -then change the example configuration file snapraid.conf.example -to fit your needs and copy it in /etc/snapraid.conf +To start using SnapRAID you have to change the example configuration +file snapraid.conf.example to fit your needs and copy it in /etc/snapraid.conf -The documentation is in the man page: +You can have more details in the manpage documentation available with: man snapraid - diff --git a/README b/README index 940c6a31..d871746c 100644 --- a/README +++ b/README @@ -9,7 +9,8 @@ and it allows to recover from a complete disk failure. SnapRAID is mainly targeted for a home media server, where you have a lot of big files that rarely change. -The main features of SnapRAID are: +Beside the ability to recover from a disk failure, the other +features of SnapRAID are: * You can start using SnapRAID with already filled disks. * The disks of the array can have different sizes. diff --git a/snapraid.1 b/snapraid.1 index d7376643..12ac6220 100644 --- a/snapraid.1 +++ b/snapraid.1 @@ -36,7 +36,8 @@ and it allows to recover from a disk failure. SnapRAID is mainly targeted for a home media center, where you have a lot of big files that rarely change. .PP -The main features of SnapRAID are: +Beside the ability to recover from a disk failure, the other +features of SnapRAID are: .PD 0 .IP \(bu You can start using SnapRAID with already filled disks. diff --git a/snapraid.d b/snapraid.d index 9dae833d..4621600d 100644 --- a/snapraid.d +++ b/snapraid.d @@ -19,7 +19,8 @@ Description SnapRAID is mainly targeted for a home media center, where you have a lot of big files that rarely change. - The main features of SnapRAID are: + Beside the ability to recover from a disk failure, the other + features of SnapRAID are: * You can start using SnapRAID with already filled disks. * The disks of the array can have different sizes. diff --git a/snapraid.txt b/snapraid.txt index a2eb5b0d..34d55a6d 100644 --- a/snapraid.txt +++ b/snapraid.txt @@ -26,7 +26,8 @@ and it allows to recover from a disk failure. SnapRAID is mainly targeted for a home media center, where you have a lot of big files that rarely change. -The main features of SnapRAID are: +Beside the ability to recover from a disk failure, the other +features of SnapRAID are: * You can start using SnapRAID with already filled disks. * The disks of the array can have different sizes.