Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ChapterSevenSeeds authored Jun 2, 2021
1 parent b8698b7 commit 49ac9bc
Showing 1 changed file with 16 additions and 8 deletions.
24 changes: 16 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,18 @@
# Tyson's Duplcate File Finder Engine
## A Windows-only command line tool for finding duplicate files.
### A Windows-only command line tool for finding duplicate files.

### Arguments
| Argument | Description | Example | Comments |
| -------- | ----------- | ------- | -------- |
| -i | Specifies the root folder. | C:\Users\Tyson | Required. Wrap the path in double quotes if it contains whitespace. Relative paths not supported. |
| -o | Specifies the output file path and name. | C:\Users\Tyson\Results.txt | Required. Wrap the path in double quotes if it contains whitespace. Relative paths not supported. Will be converted to lowercase. |
| -exd | Semicolon delimited names of subfolders to be excluded in the search.. | node_modules;documents;pictures | Wrap the entire list in double quotes if any paths contain whitespace. |
|
#### Arguments
| Argument | Description | Example | Default | Comments |
| -------- | ----------- | ------- | ------- | -------- |
| -i | Specifies the root folder. | C:\Users\Tyson | N/A | Required. Wrap the path in double quotes if it contains whitespace. Relative paths not supported. |
| -o | Specifies the output file path and name. | C:\Users\Tyson\Results.txt | N/A | Required. Wrap the path in double quotes if it contains whitespace. Relative paths not supported. Will be converted to lowercase. |
| -exd | Semicolon delimited names of subfolders to be excluded in the search. | node_modules;documents;pictures | None | Wrap the entire list in double quotes if any paths contain whitespace. |
| -exf | Semicolon delimited names of files to be excluded in the search. | desktop.ini;myface.png;hello.docx | None | Wrap the entire list in double quotes if any paths contain whitespace. |
| -ine | Semicolon delimited extensions (with the dot) to be searched for. | .js;.docx;.png | * | If this parameter is used, all other extensions not specified in the list will be ignored. |
| -exe | Semicolon delimited extensions (with the dot) to be excluded in the search. | .ts;.ini;.sys;.dll | None | This parameter cannot be used together with the previous parameter. |
| -smax | File size minimum in bytes. Ignores all files smaller than this size. | 50000 | 1 | None. |
| -smin | File size maximum in bytes. Ignores all files larger than this size. | 1000000 | 18446744073709551615 | None. |
| -mode | Specifies the type of file comparison. Can be one of three values: name, size, or hash. | name | hash | If the hash mode is selected, files will be compared first by size and then by SHA256 checksum. |

#### Notes
All comparisons are performed without regarding case since the Win32 API takes no regard to casing when searching for files.

0 comments on commit 49ac9bc

Please sign in to comment.