summaryrefslogtreecommitdiff
path: root/seivots-summary.1.in
diff options
context:
space:
mode:
Diffstat (limited to 'seivots-summary.1.in')
-rw-r--r--seivots-summary.1.in33
1 files changed, 33 insertions, 0 deletions
diff --git a/seivots-summary.1.in b/seivots-summary.1.in
new file mode 100644
index 0000000..119c7e4
--- /dev/null
+++ b/seivots-summary.1.in
@@ -0,0 +1,33 @@
+.\" 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 SEIVOTS-SUMMARY 1
+.SH NAME
+seivots-summary \- summarize seivot output files
+.SH SYNOPSIS
+.SH DESCRIPTION
+.B seivots-summary
+reads some benchmark result files created by
+.BR summain (1),
+and produces summaries of them in tabular form,
+making it easy to compare results from different benchmark runs.
+.SH OPTIONS
+.SH EXAMPLE
+To summarize all benchmark files:
+.IP
+seivots-summary $HOME/obnam/benchmarks/*/*.seivot | less -S
+.SH "SEE ALSO"
+.BR seivot (1),
+.BR obnam (1).