Merge pull request martijnvanbrummelen#300 from andreasheil/update-ma…

…n-and-help Update man and help
PartialVolume · Dec 19, 2020 · 2061346 · 2061346
2 parents ab6c4c0 + 69fed30
commit 2061346
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 9 deletions.
diff --git a/man/nwipe.1 b/man/nwipe.1
@@ -38,8 +38,18 @@ those specified devices immediately.
 Power off system on completion of wipe delayed for for one minute. During
 this one minute delay you can abort the shutdown by typing sudo shutdown -c
 .TP
-\fB\-\-sync\fR
-Open devices in sync mode
+\fB\-\-sync\fR=\fINUM\fR
+Will perform a syn after NUM writes (default: 10000)
+.IP
+0    \- fdatasync after the disk is completely written
+       fdatasync errors not detected until completion.
+       0 is not recommended as disk errors may cause nwipe
+       to appear to hang
+.IP
+1    \- fdatasync after every write
+       Warning: Lower values will reduce wipe speeds.
+.IP
+1000 \- fdatasync after 1000 writes
 .TP
 \fB\-\-noblank\fR
 Do not perform the final blanking pass after the wipe (default is to blank,

diff --git a/src/options.c b/src/options.c
@@ -489,13 +489,13 @@ void display_help()
     puts( "                          for one minute. During this one minute delay you can" );
     puts( "                          abort the shutdown by typing sudo shutdown -c\n" );
     printf( "      --sync=NUM          Will perform a sync after NUM writes (default: %d)\n", DEFAULT_SYNC_RATE );
-    puts( "                          0 - fdatasync after the disk is completely written" );
-    puts( "                              fdatasync errors not detected until completion." );
-    puts( "                              0 is not recommended as disk errors may cause nwipe" );
-    puts( "                              to appear to hang" );
-    puts( "                          1 - fdatasync after every write" );
-    puts( "                              Warning: Lower values will reduce wipe speeds." );
-    puts( "                          1000000 - fdatasync after 1000000 writes etc.)\n" );
+    puts( "                          0    - fdatasync after the disk is completely written" );
+    puts( "                                 fdatasync errors not detected until completion." );
+    puts( "                                 0 is not recommended as disk errors may cause" );
+    puts( "                                 nwipe to appear to hang" );
+    puts( "                          1    - fdatasync after every write" );
+    puts( "                                 Warning: Lower values will reduce wipe speeds." );
+    puts( "                          1000 - fdatasync after 1000 writes etc.\n" );
     puts( "      --verify=TYPE       Whether to perform verification of erasure" );
     puts( "                          (default: last)" );
     puts( "                          off   - Do not verify" );