oliverbooth
/
fdup
mirror of https://github.com/oliverbooth/fdup.git
1
0
Fork 0
Code Issues

[ci skip] docs: update usage docs and example

This commit is contained in:
Oliver Booth 2024-04-17 15:06:16 +01:00
parent 5876499f2c
commit 9681f41354
Signed by: oliverbooth
GPG Key ID: E60B570D1B7557B5
1 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -11,22 +11,23 @@ fdup is a small command-line utility written in C# to quickly and easily find du
```bash ```bash
$ fdup --help $ fdup --help
USAGE: USAGE:
fdup <path> [OPTIONS] fdup.exe [path] [OPTIONS]
ARGUMENTS: ARGUMENTS:
<path> The path to search [path] The path to search. Defaults to the current directory
OPTIONS: OPTIONS:
-h, --help Prints help information -h, --help Prints help information
-v, --version Prints version information -v, --version Prints version information
-r, --recursive When this flag is set, the directory will be scanned recursively. This may take longer -r, --recursive When this flag is set, the directory will be scanned recursively. This may take longer
--verbose Enable verbose output
``` ```
## Example ## Example
```bash ```bash
$ echo "Hello World" > file1 $ echo "Hello World" > file1
$ echo "Goodbye World" > file2 $ echo "Goodbye World" > file2
$ fdup . $ fdup
Searching /home/user/example Searching /home/user/example
Recursive mode is OFF Recursive mode is OFF
Checking hash for file2 Checking hash for file2
@ -34,7 +35,7 @@ Checking hash for file1
No duplicates found! No duplicates found!
$ echo "Hello World" > file2 $ echo "Hello World" > file2
$ fdup . $ fdup
Searching /home/user/example Searching /home/user/example
Recursive mode is OFF Recursive mode is OFF
Checking hash for file2 Checking hash for file2