From f45a07a8f0e120ce2c5587f7cf24d88bce22ce7f Mon Sep 17 00:00:00 2001
From: Mattias Andrée <maandree@kth.se>
Date: Tue, 17 Sep 2024 19:25:32 +0200
Subject: Add README and deadshred.1
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Signed-off-by: Mattias Andrée <maandree@kth.se>
---
 README      | 35 +++++++++++++++++++++++++++++++++++
 TODO        |  2 --
 deadshred.1 | 46 ++++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 81 insertions(+), 2 deletions(-)
 create mode 100644 README
 create mode 100644 deadshred.1

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)
diff --git a/TODO b/TODO
index c0e3a11..041198a 100644
--- a/TODO
+++ b/TODO
@@ -1,5 +1,3 @@
-Add README
-Add man page
 Add `-n iterations`
 Add shred map for continuing later (print to stdout on SIGTERM)
 Use rand(3) if stdin is a TTY
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)
-- 
cgit v1.2.3-70-g09d2