docs: Update readme

This commit is contained in:
2026-09-15 08:47:24 -05:00
parent 53a6565eae
commit 31259fd8ee
+31 -16
View File
@@ -1,38 +1,53 @@
GENERIC PLEX SALVAGE # LVM Salvage Tools
====================
Scan: Tools to scan and recover files from damaged LVM volumes.
./scan.sh '/Warez/Books'
./scan.sh '/Warez/3D Printing'
./scan.sh '/Media/Some Folder'
Recover: ## Scan:
./recover.sh '/Warez/Books'
The source tree is mirrored beneath /mnt/recovery: ```bash
/Warez/Books -> /mnt/recovery/Warez/Books ./scan.sh '/lvm-vol/path1'
./scan.sh '/lvm-vol/path2'
./scan.sh '/lvm-vol/path3'
```
The scan creates uniquely named manifest/summary files under /mnt/recovery. ## Recover:
```bash
./recover.sh '/lvm-vol/path1'
```
The source tree is mirrored beneath `/mnt/recovery`:
```bash
/lvm-vol/path1 -> /mnt/recovery/lvm-vol/path1
/lvm-vol/path2 -> /mnt/recovery/lvm-vol/path2
/lvm-vol/path3 -> /mnt/recovery/lvm-vol/path3
```
The scan creates uniquely named manifest/summary files under `/mnt/recovery`.
Classifications: Classifications:
```plain
SAFE SAFE
LOST LOST
ETB_LOST ETB_LOST
ETB_SURVIVES ETB_SURVIVES
UNKNOWN UNKNOWN
OTHER OTHER
```
Only SAFE files are recovered. Only `SAFE` files are recovered.
Safety: Safety:
- damaged LV must remain kernel read-only; - damaged LV must remain kernel read-only;
- /mnt/recovery must be a separate mounted filesystem; - `/mnt/recovery` must be a separate mounted filesystem;
- filesystem root "/" is refused; - filesystem root `"/"` is refused;
- ".." is refused; - `".."` is refused;
- each file is dumped by inode; - each file is dumped by inode;
- dumped byte size must match inode size; - dumped byte size must match inode size;
- existing same-size recovered files are skipped; - existing same-size recovered files are skipped;
- at least 2 GiB free is preserved on /mnt/recovery. - at least 2 GiB free is preserved on `/mnt/recovery`.
Known dead ext4 block range: Known dead ext4 block range:
3418636288 - 4395389951 3418636288 - 4395389951