chiark / gitweb /
Typo fixes to man page.
[vbig.git] / vbig.1
diff --git a/vbig.1 b/vbig.1
index 7d59b0a16377a1164022025fa554ae2a50c01361..134caae80b0f4d3831667bb398b56f1f9b715b7d 100644 (file)
--- a/vbig.1
+++ b/vbig.1
@@ -1,6 +1,7 @@
 \"
 \" This file is part of vbig.
 \" Copyright (C) 2011 Richard Kettlewell
+\" Copyright (C) 2013 Ian Jackson
 \"
 \" This program is free software: you can redistribute it and/or modify
 \" it under the terms of the GNU General Public License as published by
@@ -21,9 +22,9 @@ vbig \- create or verify a large but pseudo-random file
 .SH SYNOPSIS
 \fBvbig \fR[\fB--seed \fRSEED\fR] [\fB--both\fR|\fB--create\fR|\fB--verify\fR] \fIPATH \fR[\fISIZE\fR]
 .br
-\fBvbig --help
+\fBvbig \-\-help
 .br
-\fBvbig --version
+\fBvbig \-\-version
 .SH DESCRIPTION
 \fBvbig\fR creates a file of specified size full of predictable
 psuedo-random data, and/or verifies that it has the expected contents.
@@ -35,11 +36,11 @@ specified file or device until the device is full, read the data back
 to check that everything written was properly stored, and report
 the device's size.  Ideally, if you have privilege to do so, you
 would also specify \fB-f\fR (to flush the operating system disk
-cache between the write and read).
+cache between the write and read).  Also you probably want \fB-p\fR.
 .PP
-\fBPATH\fR can refer to an ordinary file on a mounted file system,
+\fIPATH\fR can refer to an ordinary file on a mounted file system,
 which vbig will create or truncate as necessary, or a block device.
-Note that if its a file vbig won't delete it after it's done.  Also,
+Note that if it's a file, vbig won't delete it after it's done.  Also,
 be careful when specifying a block device - don't accidentally
 overwrite a filesystem you care about!  vbig doesn't do sanity checks
 and is as dangerous as \fBdd\fR.
@@ -47,7 +48,7 @@ and is as dangerous as \fBdd\fR.
 \fISIZE\fR may end with \fBK\fR, \fBM\fR or \fBG\fR to select (binary)
 kilobytes, megabytes or gigabytes.
 The size is mandatory when creating a file but optional when verifying
-it, unless \-\-entire is specified.  If \fBSIZE\fR not specified when
+it, unless \-\-entire is specified.  If \fISIZE\fR not specified when
 writing-then-verifying, it is as if \fB\-\-entire\fR was specified.
 .PP
 If no seed or seed file is specified:
@@ -87,6 +88,9 @@ by the equivalent \fB--create\fR call.
 Flush cached data after creating the file or before verifying it.
 On some platforms, only root can use this option.
 .TP
+.B --progress\fR, \fB-p
+Show the progress (in bytes) on stdout.
+.TP
 .B --entire\fR, \fB-e
 When writing, keep going until the device is full (No space left
 on device).  When reading, keep going until the end of the file
@@ -96,7 +100,7 @@ written or verified will be printed to stdout.
 .B --help\fR, \fB-h
 Displays a usage message.
 .TP
-.B --version\fR, \fB-h
+.B --version\fR, \fB-V
 Displays the version strings.
 .SH AUTHOR
 Richard Kettlewell <rjk@greenend.org.uk>