Add README and deadshred.1

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

1 files changed, 35 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..f9de47b
--- /dev/null
+++ b/README
@@ -0,0 +1,35 @@
+NAME
+	deadshred - override the contents of a device that may be broken
+
+SYNOPSIS
+	deadshred device < random-source
+
+DESCRIPTION
+	The 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 deadshred utility will skip any section it fails
+	to override and retries it later.
+
+OPTIONS
+	No options are supported.
+
+OPERANDS
+	The following operand is supported:
+
+	file
+		The file to override. Must be either a regular file or
+		a block device.
+
+STDIN
+	The standard input shall be an unless source of either random
+	data or a particular byte to fill the device with.
+
+NOTES
+	While the 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.
+
+SEE ALSO
+	dd(1), shred(1)