Add README and deadshred.1

Signed-off-by: Mattias Andrée <maandree@kth.se>

1 files changed, 46 insertions, 0 deletions

diff --git a/deadshred.1 b/deadshred.1
new file mode 100644
index 0000000..eb321d5
--- /dev/null
+++ b/deadshred.1
@@ -0,0 +1,46 @@
+.TH DEADSHRED 1 deadshred
+.SH NAME
+deadshred \- override the contents of a device that may be broken
+
+.SH SYNOPSIS
+.B deadshred
+.I device
+<
+.I random-source
+
+.SH DESCRIPTION
+The
+.B deadshred
+utility fills a file or block devices with
+nonsense data. The utility is designed specifically for
+erasing the content of failing hard disc drives, for this
+purpose, the
+.I deadshred
+utility will skip any section it fails
+to override and retries it later.
+
+.SH OPTIONS
+No options are supported.
+
+.SH OPERANDS
+The following operand is supported:
+.TP
+.I file
+The file to override. Must be either a regular file or
+a block device.
+
+.SH STDIN
+The standard input shall be an unless source of either random
+data or a particular byte to fill the device with.
+
+.SH NOTES
+While the
+.B deadshred
+utility is designed for block devices, it
+also works for regular files, however does not provide options
+that are useful for erasing regular files and is not designed
+to work with filesystems that use copy on write.
+
+.SH SEE ALSO
+.BR dd (1),
+.BR shred (1)