add README

This commit is contained in:
dave 2017-05-02 20:19:43 -07:00
parent cad2a1f073
commit 6a0da48e1b
1 changed files with 31 additions and 0 deletions

31
README.md Normal file
View File

@ -0,0 +1,31 @@
findbig
=======
A command-line utility for finding the biggest files in a directory tree.
```
usage: findbig [-h] [-v] [-f FORMAT] [-l LIMIT] [-u {k,b,g,m,t}] [-r ROUND]
[-m MIN_SIZE]
base_dir
Find large files in a directory
positional arguments:
base_dir Root dir to begin search
optional arguments:
-h, --help show this help message and exit
output options:
-v, --verbose Enable verbose output
-f FORMAT, --format FORMAT
Output format
-l LIMIT, --limit LIMIT
Limit result count
-u {k,b,g,m,t}, --unit {k,b,g,m,t}
Convert sizes to unit
-r ROUND, --round ROUND
Number of places to round to
-m MIN_SIZE, --min-size MIN_SIZE
Ignore files smaller than threshold
```