From f0f4e876ab006c067433a4c3d7529f21c479ce9b Mon Sep 17 00:00:00 2001 From: Manfred Lotz Date: Wed, 4 May 2022 10:03:51 +0200 Subject: [PATCH] add help text --- README.md | 28 ++++++++++++++++++++++------ 1 file changed, 22 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 9a1b622..c027b3f 100644 --- a/README.md +++ b/README.md @@ -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 +Find largest files in directory trees. + +USAGE: + flf [OPTIONS] [DIRS]... + +ARGS: + ... Specify directories to check for largest files + +OPTIONS: + -G Show sizes in powers of ten + --generate-completion [possible values: bash, elvish, fish, powershell, zsh] + -h, --help Print help information + -n 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 @@ -69,8 +90,3 @@ Example for fish: flf --generate-completion fish > ~/.config/fish/completions/flf.fish ```` - - - - -