Add manpage for seivot.

1 files changed, 49 insertions, 0 deletions

diff --git a/seivot.1.in b/seivot.1.in
new file mode 100644
index 0000000..679a638
--- /dev/null
+++ b/seivot.1.in
@@ -0,0 +1,49 @@
+.\" Copyright 2011 Lars Wirzenius <liw@liw.fi>
+.\" 
+.\" 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 SEIVOT 1
+.SH NAME
+seivot \- benchmark backup application (obnam)
+.SH SYNOPSIS
+.SH DESCRIPTION
+.B seivot
+benchmarks a backup application.
+It has been written primarily for 
+.IR obnam (1),
+but could be extended for other backup applications.
+.PP
+.B seivot
+generates some live data using 
+.BR genbackupdata (1),
+and then runs the backup application.
+It then generates some more live data,
+and runs a second backup generation,
+etc.
+It stores the measurements in an output file.
+See
+.BR seivots-summary (1)
+for a tool to show data from such files in a tabular fashion.
+.RB ( seivot
+does not itself show the tabular data,
+because one is rarely interested in the output from just one run,
+and instead wants to contrast it with other runs).
+.SH OPTIONS
+.SH EXAMPLE
+To run a simple benchmark:
+.IP
+seivot --initial-data=10G --incremental-data=1G
+.SH "SEE ALSO"
+.BR seivots-summary (1),
+.BR obnam (1).