Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
trapexit committed Jun 1, 2018
1 parent 2cfc69c commit 85dcf3f
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions README.md
Expand Up @@ -4,16 +4,16 @@ A tool to help discover silent corruption on a filesystem. If using ZFS, BTRFS,

### Usage
```
usage: scorch [-h] -d DB [-v] [-r {sticky,readonly}] [-f FNFILTER]
usage: scorch [-h] [-d DB] [-v] [-r {sticky,readonly}] [-f FNFILTER]
[-s {none,radix,reverse-radix,natural,reverse-natural,random}]
[-m MAX] [-b]
{add,append,check,check+update,delete,cleanup,list,list-unhashed,list-dups}
{add,append,check,check+update,delete,cleanup,list,list-unhashed,list-dups,list-solo,list-missing,find}
dir [dir ...]
a tool to help discover file corruption
positional arguments:
{add,append,check,check+update,delete,cleanup,list,list-unhashed,list-dups}
{add,append,check,check+update,delete,cleanup,list,list-unhashed,list-dups,list-solo,list-missing,find}
actions
dir directories to work on
Expand All @@ -30,7 +30,6 @@ optional arguments:
acting on them
-m MAX, --max MAX max number of actions to take
-b, --break-on-error break on first failure / error
```

### Instructions
Expand All @@ -44,6 +43,9 @@ optional arguments:
* list: a **md5sum** compatible listing of files and their hashes.
* list-unhashed: list files which are not hashed in the database.
* list-dups: returns a listing of files which have the same hash value.
* list-solo: returns a listing of files which are unique (opposite of list-dups)
* list-missing: returns a listing of files present in the DB but not on the filesystem
* find: searches for the target in the hash DB (outputs CSV)

### Example

Expand Down

0 comments on commit 85dcf3f

Please sign in to comment.