Small doc updates, clarify references to "snapraid touch". (#19)

Co-authored-by: Andrea Mazzoleni <[email protected]>

INSTALL

@@ -7,25 +7,27 @@ code from http://www.snapraid.it and unpack it with:
     tar xf snapraid-*.tar.gz
     cd snapraid-*
 
-To configure and build run:
+To configure and build, run:
 
     ./configure
     make
 
-To check for correctness of the application run:
+To run the correctness tests for the application:
 
     make check
 
-If it terminates with "Success", you can install the application and
-the documentation running as root:
+If this terminates with "Success", you can install the application and
+the documentation by running:
 
     sudo make install
 
-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 snapraid application itself does not require root privileges.)
+
+To start using SnapRAID, change the example configuration
+file snapraid.conf.example to fit your needs and copy it to /etc/snapraid.conf
 
 To get more help, see the "Getting Started" section in the snapraid manpage
-typing:
+by typing:
 
     man snapraid
 

cmdline/snapraid.c

@@ -38,7 +38,7 @@ void usage(void)
 {
 	version();
 
-	printf("Usage: " PACKAGE " status|diff|sync|scrub|list|dup|up|down|smart|pool|check|fix [options]\n");
+	printf("Usage: " PACKAGE " status|diff|sync|scrub|list|dup|up|down|touch|smart|pool|check|fix [options]\n");
 	printf("\n");
 	printf("Commands:\n");
 	printf("  status Print the status of the array\n");
@@ -49,6 +49,7 @@ void usage(void)
 	printf("  dup    Find duplicate files\n");
 	printf("  up     Spin-up the array\n");
 	printf("  down   Spin-down the array\n");
+	printf("  touch  Add non-zero ns timestamps to files\n");
 	printf("  smart  SMART attributes of the array\n");
 	printf("  pool   Create or update the virtual view of the array\n");
 	printf("  check  Check the array\n");

cmdline/status.c

@@ -466,14 +466,14 @@ int state_status(struct snapraid_state* state)
 	}
 
 	if (unscrubbed_blocks) {
-		printf("The %u%% of the array is not scrubbed.\n", muldiv_upper(unscrubbed_blocks, 100, blockmax));
+		printf("%u%% of the array is not scrubbed.\n", muldiv_upper(unscrubbed_blocks, 100, blockmax));
 	} else {
 		printf("The full array was scrubbed at least one time.\n");
 	}
 
 	if (file_zerosubsecond) {
-		printf("You have %u files with zero sub-second timestamp.\n", file_zerosubsecond);
-		printf("Run the 'touch' command to set it to a not zero value.\n");
+		printf("You have %u files with a zero sub-second timestamp.\n", file_zerosubsecond);
+		printf("Run 'snapraid touch' to set their sub-second timestamps to a non-zero value.\n");
 	} else {
 		printf("No file has a zero sub-second timestamp.\n");
 	}

snapraid.1

@@ -116,29 +116,29 @@ consider before using it.
 The main one is that if a disk fails, and you haven\'t recently synced,
 you may be unable to do a complete recover.
 More specifically, you may be unable to recover up to the size of the
-amount of the changed or deleted files from the last sync operation.
+changed or deleted files from the last sync operation.
 This happens even if the files changed or deleted are not in the
-failed disk. This is the reason because SnapRAID is better suited for
+failed disk. This is why SnapRAID is better suited for
 data that rarely change.
 .PP
-Instead the new added files don\'t prevent the recovering of the already
-existing files. You may only lose the just added files, if they are on
+On the other hand, newly added files don\'t prevent recovering already
+existing files. You may only lose the recently added files, if they are on
 the failed disk.
 .PP
 Other limitations are:
 .PD 0
 .IP \(bu
-You have different file\-systems for each disk.
-Using a RAID you have only a big file\-system.
+With Snapraid, you still have separate file-systems for each disk.
+With RAID you get a single large file\-system.
 .IP \(bu
-It doesn\'t stripe data.
+Snapraid doesn\'t stripe data.
 With RAID you get a speed boost with striping.
 .IP \(bu
-It doesn\'t support real\-time recovery.
+Snapraid doesn\'t support real\-time recovery.
 With RAID you do not have to stop working when a disk fails.
 .IP \(bu
-It\'s able to recover damages only from a limited number of disks.
-With a Backup you are able to recover from a complete
+Snapraid can recover damages only from a limited number of disks.
+With a Backup you can recover from a complete
 failure of the whole disk array.
 .IP \(bu
 Only file, time\-stamps, symlinks and hardlinks are saved.

snapraid.d

@@ -55,26 +55,26 @@ Limitations
 
 	The main one is that if a disk fails, and you haven't recently synced,
 	you may be unable to do a complete recover.
-	More specifically, you may be unable to recover up to the size of the
-	amount of the changed or deleted files from the last sync operation.
+	More specifically, you may be unable to recover up to the size of
+	the changed or deleted files from the last sync operation.
 	This happens even if the files changed or deleted are not in the
-	failed disk. This is the reason because SnapRAID is better suited for
+	failed disk. This is why SnapRAID is better suited for
 	data that rarely change.
 
-	Instead the new added files don't prevent the recovering of the already
-	existing files. You may only lose the just added files, if they are on
+	On the other hand, newly added files don't prevent recovering already
+	existing files. You may only lose the recently added files, if they are on
 	the failed disk.
 
-	Other limitations are:
+	Other Snapraid limitations are:
 
-	* You have different file-systems for each disk.
-		Using a RAID you have only a big file-system.
-	* It doesn't stripe data.
+	* With Snapraid, you still have separate file-systems for each disk.
+		With RAID you get a single large file-system.
+	* Snapraid doesn't stripe data.
 		With RAID you get a speed boost with striping.
-	* It doesn't support real-time recovery.
+	* Snapraid doesn't support real-time recovery.
 		With RAID you do not have to stop working when a disk fails.
-	* It's able to recover damages only from a limited number of disks.
-		With a Backup you are able to recover from a complete
+	* Snapraid is able to recover damages only from a limited number of disks.
+		With a Backup you can recover from a complete
 		failure of the whole disk array.
 	* Only file, time-stamps, symlinks and hardlinks are saved.
 		Permissions, ownership and extended attributes are not saved.

snapraid.txt

@@ -59,32 +59,31 @@ For more information, please visit the official SnapRAID site:
 3 LIMITATIONS
 =============
 
-SnapRAID is in between a RAID and a Backup program trying to get the best
-benefits of them. Although it also has some limitations that you should
+SnapRAID is in between a RAID and a Backup program, trying to get the best
+benefits of both. Although it also has some limitations that you should
 consider before using it.
 
-The main one is that if a disk fails, and you haven't recently synced,
+The main limitation is that if a disk fails, and you haven't recently synced,
 you may be unable to do a complete recover.
 More specifically, you may be unable to recover up to the size of the
 amount of the changed or deleted files from the last sync operation.
 This happens even if the files changed or deleted are not in the
-failed disk. This is the reason because SnapRAID is better suited for
-data that rarely change.
+failed disk. This is why SnapRAID is better suited for data that rarely change.
 
-Instead the new added files don't prevent the recovering of the already
-existing files. You may only lose the just added files, if they are on
+On the other hand, newly added files don't prevent recovering of already
+existing files. You may only lose the recently added files, if they are on
 the failed disk.
 
 Other limitations are:
 
-* You have different file-systems for each disk.
-  Using a RAID you have only a big file-system.
-* It doesn't stripe data.
+* With Snapraid, you still have separate file-systems for each disk.
+  With RAID you get a single large file-system.
+* Snapraid doesn't stripe data.
   With RAID you get a speed boost with striping.
-* It doesn't support real-time recovery.
+* Snapraid doesn't support real-time recovery.
   With RAID you do not have to stop working when a disk fails.
-* It's able to recover damages only from a limited number of disks.
-  With a Backup you are able to recover from a complete
+* Snapraid is able to recover damages only from a limited number of disks.
+  With a Backup you can recover from a complete
   failure of the whole disk array.
 * Only file, time-stamps, symlinks and hardlinks are saved.
   Permissions, ownership and extended attributes are not saved.
@@ -345,7 +344,7 @@ Run the fix command, storing the log in an external file with:
     snapraid -d NAME -l fix.log fix
 
 Where NAME is the name of the disk, like "d1" as in our previous example.
-In case the disk to recover is a parity disk, use the "parity", "2-parity"
+If the disk to recover is a parity disk, use the "parity", "2-parity"
 names.
 If you have more broken disks, use multiple -d options to specify all
 of them.