docs: updates to grubbers and usurp docs

CCBR · Jan 26, 2024 · 43db803 · 43db803
1 parent 7e3e0a9
commit 43db803
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 1 deletion.
diff --git a/docs/grubbers.md b/docs/grubbers.md
@@ -42,7 +42,7 @@ The output is displayed on STDOUT and is tab-delimited with these columns:
 | 2      | number of duplicates found            |
 | 3      | total size of all duplicates          |
 | 4      | size of each duplicate                |
-| 5      | "##"-separated list of duplicates     |
+| 5      | ";"-separated list of duplicates      |
 | 6      | duplicate files                       |
 
 Here is an example output line:

diff --git a/docs/usurp.md b/docs/usurp.md
@@ -14,6 +14,16 @@ Deleting these high-value duplicates has the biggest impact on the users overall
 - `--hash` a hash from its first column of the grubber TSV.
 - `--force` (OPTIONAL) if the duplicates are cross-device then hard links cannot be made, with `--force` you can force using sym-links instead.
 
+The GRUBBER file has the following columns:
+| Column | Description                           |
+| ------ | ------------------------------------- |
+| 1      | combined hash                         |
+| 2      | number of duplicates found            |
+| 3      | total size of all duplicates          |
+| 4      | size of each duplicate                |
+| 5      | ";"-separated list of duplicates      |
+| 6      | duplicate files                       |
+
 ```bash
 usage: spacesavers2_usurp [-h] -g GRUBBER -x HASH [-f | --force | --no-force]