Skip to content

Commit

Permalink
add help text
Browse files Browse the repository at this point in the history
  • Loading branch information
manfredlotz committed May 4, 2022
1 parent a142cad commit f0f4e87
Showing 1 changed file with 22 additions and 6 deletions.
28 changes: 22 additions & 6 deletions README.md
Expand Up @@ -17,7 +17,28 @@ Other similar utilities

## Getting help information

Run `flf --help` to get usage information.
Run `flf --help` to get help.

```
flf 0.1.0
Manfred Lotz <manfred.lotz@posteo.de>
Find largest files in directory trees.
USAGE:
flf [OPTIONS] [DIRS]...
ARGS:
<DIRS>... Specify directories to check for largest files
OPTIONS:
-G Show sizes in powers of ten
--generate-completion <GENERATOR> [possible values: bash, elvish, fish, powershell, zsh]
-h, --help Print help information
-n <NUMFILES> Number of files to display [default: 10]
--skip-hidden Skip hidden files and directories
-V, --version Print version information
-X Don't descend into other file systems
```

## Find largest files

Expand Down Expand Up @@ -69,8 +90,3 @@ Example for fish:
flf --generate-completion fish > ~/.config/fish/completions/flf.fish
````






0 comments on commit f0f4e87

Please sign in to comment.