From: Richard Kettlewell <rjk@greenend.org.uk>
Date: Mon, 13 Jun 2011 19:00:07 +0000 (+0100)
Subject: Add a README and man page
X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=commitdiff_plain;h=2453a90de6592cbecc8ceeea67b2c9509e875817;p=vbig.git

Add a README and man page
---

diff --git a/Makefile.am b/Makefile.am
index 9155853..ef591a6 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -1,2 +1,5 @@
 bin_PROGRAMS=vbig
 vbig_SOURCES=vbig.cc Arcfour.h Arcfour.cc
+man_MANS=vbig.1
+EXTRA_DIST=${man_MANS}
+
diff --git a/README b/README
new file mode 100644
index 0000000..bda324b
--- /dev/null
+++ b/README
@@ -0,0 +1,18 @@
+vbig
+====
+
+vbig creates or verifies a file full of psuedo-random data.
+
+Installation
+============
+
+  ./configure
+  make
+  sudo make install
+
+If building from git, do './autogen.sh' first.
+
+Author
+======
+
+Richard Kettlewell <rjk@greenend.org.uk>
diff --git a/vbig.1 b/vbig.1
new file mode 100644
index 0000000..61db4b8
--- /dev/null
+++ b/vbig.1
@@ -0,0 +1,39 @@
+.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
+.br
+\fBvbig --help
+.br
+\fBvbig --version
+.SH DESCRIPTION
+\fBvbig\fR either creates a file of specified size full of predictable
+psuedo-random data, or verifies that it has the expected contents.
+The intended use is to test whether storage media really do what they
+say on the tin.
+.PP
+\fISIZE\fR may end with \fBK\fR, \fBM\fR or \fBG\fR to select (binary)
+kilobytes, megabytes or gigabytes.
+.SH OPTIONS
+.TP
+.B --seed
+Specifies the random seed to use.
+Optional.
+.TP
+.B --create
+Selects create mode.
+\fIPATH\fR will be filled with \fISIZE\fR psuedo-random bytes.
+.TP
+.B --verify
+Selects verify mode.
+Checks that \fIPATH\fR has exactly the contents that would be produced
+by the equivalent \fB--create\fR call.
+.TP
+.B --help
+Displays a usage message.
+.TP
+.B --version
+Displays the version strings.
+.SH AUTHOR
+Richard Kettlewell <rjk@greenend.org.uk>