New --entire option

[vbig.git] / vbig.1

diff --git a/vbig.1 b/vbig.1
index 1c8216f981b629bec3a237a665bd6f061d471c30..a3f963ba76034c9e8fa9af4bd7e1e8febbefd7c2 100644 (file)
--- a/vbig.1
+++ b/vbig.1
@@ -1,8 +1,25 @@
+\"
+\" This file is part of vbig.
+\" Copyright (C) 2011 Richard Kettlewell
+\"
+\" 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
+\" the Free Software Foundation, either version 3 of the License, or
+\" (at your option) any later version.
+\"
+\" This program is distributed in the hope that it will be useful,
+\" but WITHOUT ANY WARRANTY; without even the implied warranty of
+\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+\" GNU General Public License for more details.
+\"
+\" You should have received a copy of the GNU General Public License
+\" along with this program.  If not, see <http://www.gnu.org/licenses/>.
+\"
 .TH vbig 1
 .SH NAME
 vbig \- create or verify a large but pseudo-random file
 .SH SYNOPSIS
-\fBvbig \fR[\fB--seed \fRSEED\fR] \fB--create\fR|\fB--verify \fIPATH SIZE
+\fBvbig \fR[\fB--seed \fRSEED\fR] \fB--create\fR|\fB--verify \fIPATH \fR[\fISIZE\fR]
 .br
 \fBvbig --help
 .br
@@ -15,6 +32,8 @@ say on the tin.
 .PP
 \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.
 .SH OPTIONS
 .TP
 .B --seed\fR, \fB-s \fISEED
@@ -34,6 +53,12 @@ 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 --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
+or device.  \fISIZE\fR should not be specified.  The actual size
+written or verified will be printed to stdout.
+.TP
 .B --help\fR, \fB-h
 Displays a usage message.
 .TP