Added an example in the man page and changed the help for the -m option.
[dus.git] / dus.1
1 .TH "DUS" "1.1" "Mar 2010" "Francois Fleuret" "User Commands"
2
3 \" This man page was written by Francois Fleuret <francois@fleuret.org>
4 \" and is distributed under a Creative Commons Attribution-Share Alike
5 \" 3.0 License.
6
7 .SH "NAME"
8
9 dus \- A simple command line utility for size-sorting files
10
11 .SH "SYNOPSIS"
12
13 \fBdus\fP [OPTION]... [FILE]...
14
15 .SH "DESCRIPTION"
16
17 \fBdus\fP lists files and directories according to their size. It
18 computes the said sizes by summing recursively exact file sizes
19 through directories. If a directory has its name appended with '/', it
20 is not listed, but the elements it contains are. If no files or
21 directories are provided as arguments, the current directory is used
22 as default.
23
24 .SH "OPTIONS"
25 .TP
26 \fB-h\fR, \fB--help\fR
27 display help and exit
28 .TP
29 \fB-d\fR, \fB--ignore-dots\fR
30 ignore files and directories whose name starts with a dot
31 .TP
32 \fB-f\fR, \fB--fancy\fR
33 display floating point size with K, M and G units
34 .TP
35 \fB-r\fR, \fB--reverse-order\fR
36 reverse the sorting order (big to small instead of small to big)
37 .TP
38 \fB-t\fR, \fB--show-top\fR
39 show the top of the list instead of the bottom
40 .TP
41 \fB-c \fI<cols>\fR, \fB--nb-columns \fI<cols>\fR
42 force the number of columns, -1 means no limit (it is by default no
43 limits if the stdout is not a tty and the tty width otherwise)
44 .TP
45 \fB-l \fI<lines>\fR, \fB--nb-lines \fI<lines>\fR
46 same as \fB-c\fR but for the number of lines
47 .TP
48 \fB-m \fI<size min>\fR, \fB--min-size \fI<size min>\fR
49 restrict the printing of files and directories to these of size bigger
50 than a lower bound. The size can be specified using the G, M, K, and B
51 units
52
53 .SH "EXAMPLE"
54
55 .B dus -m 1M -rt ~/private/
56
57 .fi
58 List the largest files and directories present in ~/private/, of sizes
59 greater than 1024kb, sorted in decreasing order.
60
61 .SH "BUGS"
62
63 None known, probably many though.
64
65 .SH "AUTHOR"
66
67 Written by Francois Fleuret <francois@fleuret.org> and distributed
68 under the terms of the GNU General Public License version 3 as
69 published by the Free Software Foundation. This is free software: you
70 are free to change and redistribute it. There is NO WARRANTY, to the
71 extent permitted by law.