summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorLars Wirzenius <liw@liw.fi>2011-05-16 13:50:02 +0100
committerLars Wirzenius <liw@liw.fi>2011-05-16 13:50:02 +0100
commit48c64951cdb2a8bed2082c7ba13ba6970dec6f16 (patch)
tree39209ebd750c50b26e5216cc88b9448d686bcf2a /README
parent3cc9a2911cc701a9c3a94c27599eee4c5c862af8 (diff)
downloadseivot-48c64951cdb2a8bed2082c7ba13ba6970dec6f16.tar.gz
Update README.
Diffstat (limited to 'README')
-rw-r--r--README20
1 files changed, 19 insertions, 1 deletions
diff --git a/README b/README
index 74c1f70..8a803da 100644
--- a/README
+++ b/README
@@ -1,4 +1,22 @@
-Seivot is a program for benchmarking backup software.
+README for seivot
+-----------------
+
+Seivot is a program for benchmarking backup software. It was written
+for developing Obnam, but it should be possible to adapt it to also
+support other on-disk backup solutions, such as rsync or rdiff-backup.
+
+Example:
+
+ ./seivot --log=foo.log --log-level=debug \
+ --initial-data=1m --incremental-data=1m --generations=2 \
+ --output=foo.seivot
+
+Use the --use-sftp option to simulate backups over a network. This happens
+over localhost, so it's hardly a realistic simulation, but it at least
+measures the overhead of using SFTP over direct file access.
+
+Legalese
+--------
Copyright (C) 2008-2011 Lars Wirzenius, Richard Braakman