aboutsummaryrefslogtreecommitdiffstats
path: root/deadshred.1
diff options
context:
space:
mode:
Diffstat (limited to 'deadshred.1')
-rw-r--r--deadshred.163
1 files changed, 62 insertions, 1 deletions
diff --git a/deadshred.1 b/deadshred.1
index be586b2..5c3eb63 100644
--- a/deadshred.1
+++ b/deadshred.1
@@ -4,6 +4,13 @@ deadshred \- override the contents of a device that may be broken
.SH SYNOPSIS
.B deadshred
+[-o
+.IR offset ]
+[-l
+.I length
+|
+-e
+.IR postend ]
.I device
[<
.IR random-source ]
@@ -20,7 +27,61 @@ utility will skip any section it fails
to override and retries it later.
.SH OPTIONS
-No options are supported.
+The following options are supported:
+.TP
+.BR -e \ \fIpostend\fP
+Position in the
+.I device
+to stop writing at. The byte indexed by the value
+.I postend
+will not be overwritten.
+.TP
+.BR -l \ \fIlength\fP
+The number of bytes in the
+.I device
+to overwrite. If the
+.B -o
+option is unused (or the
+.I offset
+0 is used), this is equivalent to the
+.B -e
+option, however the
+.B -o
+option is used, writing will stop at
+.I length
+bytes past
+.IR offset .
+.TP
+.BR -o \ \fIoffset\fP
+The index of the first byte in the
+.I device
+to overwrite.
+.PP
+The value of the
+.B -elo
+flags can be expressed a sum of terms (delimited by
+SP
+.RB (' " " '),
+comma
+.RB (' , '),
+or plus
+.RB (' + '))
+expressed either as a integer representing a byte count,
+or a real number with an optionally prefixed byte size
+unit, which shall be either
+.B B
+(for bytes, which requires the number to be an integer)
+or a prefix followed by
+.B iB
+(for base 1024)
+or
+.B B
+(for base 1000), or just the prefix (also for base 1024).
+The lowest supported prefix is
+.B k
+.RB ( K
+is recognised as a synonym, but the value is otherwise
+case sensitive).
.SH OPERANDS
The following operand is supported: