docs: update usage and shell style conventions

2026-04-28 01:03:19 +02:00
parent bf9cbe918f
commit ab346342d5
3 changed files with 88 additions and 77 deletions
@@ -2,13 +2,18 @@

 Wipe a block device.

-Warning: destructive and irreversible. The target must be a real block device, not mounted, and not in use.
+Warning: destructive and irreversible.
+Target must be a real block device, not mounted, and not in use.

 Usage:
-mtm-ddwipe DEVICE
+	mtm-ddwipe DEVICE
+	mtm-ddwipe -h | --help

 Options:
- `-h`, `--help`
+	-h, --help	Show help.

-Optional tools: `blkdiscard`, `ddrescue`, `dd_rescue`, `nvme`, `hdparm`.
+Notes:
+	- Interactive by default.
+	- Confirm exactly before wiping.
+	- Optional tools: blkdiscard, ddrescue, dd_rescue, nvme, hdparm.