From 2e55bedc45e836899a18ea7f4a488f50597afad5 Mon Sep 17 00:00:00 2001
From: Mattias Andrée <maandree@kth.se>
Date: Sat, 21 Sep 2024 19:31:16 +0200
Subject: misc
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Signed-off-by: Mattias Andrée <maandree@kth.se>
---
 deadshred.1 | 44 +++++++++++++++++++++++++++++++++++++++-----
 1 file changed, 39 insertions(+), 5 deletions(-)

(limited to 'deadshred.1')

diff --git a/deadshred.1 b/deadshred.1
index e445c05..8d36103 100644
--- a/deadshred.1
+++ b/deadshred.1
@@ -13,8 +13,9 @@ deadshred \- override the contents of a device that may be broken
 |
 -e
 .IR postend ]
-[-r]
+[-rY]
 .I device
+.RI [ map-file ]
 [<
 .IR random-source ]
 
@@ -67,6 +68,9 @@ to overwrite.
 .B -r
 Start writing from the end instead of from the
 beginning on the first pass over the device.
+.TP
+.B -Y
+Do not ask for confirmation.
 .PP
 The value of the
 .B -belo
@@ -95,11 +99,21 @@ is recognised as a synonym, but the value is otherwise
 case sensitive).
 
 .SH OPERANDS
-The following operand is supported:
+The following operands are supported:
 .TP
-.I file
+.I device
 The file to override. Must be either a regular file or
 a block device.
+.TP
+.I map-file
+If the file
+.I map-file exists
+and is non-empty, it specifies what sections in the
+.I device
+to overwrite; this file will be periodically, and
+upon exit, updated to remove parts that has been
+successfully overwritten. This file will be unlinked
+when it becomes empty.
 
 .SH STDIN
 Unless the standard input is a terminal device, it shall be an
@@ -108,10 +122,12 @@ fill the device with.
 
 .SH STDOUT
 If the process is terminated using either of the signals
-SIGTERM or SIGINT, the process will write to standard output
+SIGTERM or SIGINT, and a
+.I map-file
+was not specified, the process will write to standard output
 a map of sections that has not been overwritten yet. The
 output will be the concatenation of one string per section,
-each on the format
+followed by a <newline>, each on the format
 .PP
 .nf
 \fB\(dq%s%x-%x/%x\(dq,\fP <\fB\(dq0x\(dq\fP for the first section, \fB\(dq,\(dq\fP otherwise>\fB,\fP
@@ -120,6 +136,24 @@ each on the format
               <\fIthe block size that should be used when trying to overwrite\fP>
 .fi
 
+.SH INPUT FILES
+If a
+.I map-file
+is specified, its content shall either be empty or
+conform to the format specified for the standard
+output. See the
+.B STDOUT
+section for more information.
+
+.SH OUTPUT FILES
+If a
+.I map-file
+is specified, the data written to it will conform
+to the format specified for the standard
+output. See the
+.B STDOUT
+section for more information.
+
 .SH NOTES
 While the
 .B deadshred
-- 
cgit v1.2.3-70-g09d2