commit 40ea72e15035e85c7184d9d12ee572a6bee59034
parent c4e0f4508d3e6a0c3d526fec5b0cf42df735da63
Author: sin <sin@2f30.org>
Date: Sun, 5 May 2019 20:53:42 +0100
Rework manpages
Diffstat:
5 files changed, 21 insertions(+), 13 deletions(-)
diff --git a/dup-check.1 b/dup-check.1
@@ -1,4 +1,4 @@
-.Dd May 2, 2019
+.Dd May 5, 2019
.Dt DUP-CHECK 1
.Os
.Sh NAME
@@ -12,13 +12,19 @@
.Ar name
.Sh DESCRIPTION
.Nm
-checks that a snapshot is internally consistent.
+performs an internal consistency check on a
+snapshot with the given
+.Ar name .
+This is done by recalculating the hash of
+all blocks contained in the snapshot and checking
+whether the recorded hash of each block matches the
+actual hash.
.Sh OPTIONS
.Bl -tag -width "-k keyfile"
.It Fl k Ar keyfile
Path to encryption key.
.It Fl r Ar repo
-Repository directory.
+Path to the dedup repository.
By default the current working directory is used.
.It Fl v
Enable verbose mode.
diff --git a/dup-keygen.1 b/dup-keygen.1
@@ -1,17 +1,19 @@
-.Dd May 2, 2019
+.Dd May 5, 2019
.Dt DUP-KEYGEN 1
.Os
.Sh NAME
.Nm dup-keygen
-.Nd Generate dedup encryption key
+.Nd Generate dedup secret key
.Sh SYNOPSIS
.Nm dup-keygen
.Op Fl v
.Ar keyfile
.Sh DESCRIPTION
.Nm
-generates a 256-bit encryption key file.
-This key is used when operating on an encrypted dedup repository.
+generates a 256-bit secret key and stores it in the file specified by
+.Ar keyfile .
+The key can then be used to initialize an encrypted dedup repository using
+.Xr dup-init 1 .
.Sh OPTIONS
.Bl -tag -width "keyfile"
.It Fl v
diff --git a/dup-pack.1 b/dup-pack.1
@@ -1,4 +1,4 @@
-.Dd May 2, 2019
+.Dd May 5, 2019
.Dt DUP-PACK 1
.Os
.Sh NAME
@@ -28,7 +28,7 @@ should be used and piped into
.It Fl k Ar keyfile
Path to encryption key.
.It Fl r Ar repo
-Repository directory.
+Path to the dedup repository.
By default the current working directory is used.
.It Fl v
Enable verbose mode.
diff --git a/dup-rm.1 b/dup-rm.1
@@ -1,4 +1,4 @@
-.Dd May 2, 2019
+.Dd May 5, 2019
.Dt DUP-RM 1
.Os
.Sh NAME
@@ -19,7 +19,7 @@ removes the snapshot specified by
.It Fl k Ar keyfile
Path to encryption key.
.It Fl r Ar repo
-Repository directory.
+Path to the dedup repository.
By default the current working directory is used.
.It Fl v
Enable verbose mode.
diff --git a/dup-unpack.1 b/dup-unpack.1
@@ -1,4 +1,4 @@
-.Dd May 2, 2019
+.Dd May 5, 2019
.Dt DUP-UNPACK 1
.Os
.Sh NAME
@@ -20,7 +20,7 @@ from the dedup repository and writes the data to stdout.
.It Fl k Ar keyfile
Path to encryption key.
.It Fl r Ar repo
-Repository directory.
+Path to the dedup repository.
By default the current working directory is used.
.It Fl v
Enable verbose mode.
