chiark / gitweb /
Document short-form options.
[vbig.git] / vbig.1
1 .TH vbig 1
2 .SH NAME
3 vbig \- create or verify a large but pseudo-random file
4 .SH SYNOPSIS
5 \fBvbig \fR[\fB--seed \fRSEED\fR] \fB--create\fR|\fB--verify \fIPATH SIZE
6 .br
7 \fBvbig --help
8 .br
9 \fBvbig --version
10 .SH DESCRIPTION
11 \fBvbig\fR either creates a file of specified size full of predictable
12 psuedo-random data, or verifies that it has the expected contents.
13 The intended use is to test whether storage media really do what they
14 say on the tin.
15 .PP
16 \fISIZE\fR may end with \fBK\fR, \fBM\fR or \fBG\fR to select (binary)
17 kilobytes, megabytes or gigabytes.
18 .SH OPTIONS
19 .TP
20 .B --seed\fR, \fB-s \fISEED
21 Specifies the random seed to use.
22 Optional.
23 .TP
24 .B --create\fR, \fB-c
25 Selects create mode.
26 \fIPATH\fR will be filled with \fISIZE\fR psuedo-random bytes.
27 .TP
28 .B --verify\fR, \fB-v
29 Selects verify mode.
30 Checks that \fIPATH\fR has exactly the contents that would be produced
31 by the equivalent \fB--create\fR call.
32 .TP
33 .B --flush\fR, \fB-f
34 Flush cached data after creating the file or before verifying it.
35 Only root can use this option.
36 .TP
37 .B --help\fR, \fB-h
38 Displays a usage message.
39 .TP
40 .B --version\fR, \fB-h
41 Displays the version strings.
42 .SH AUTHOR
43 Richard Kettlewell <rjk@greenend.org.uk>