.TH DUCHK "1" "July 2003" "duchk"
.SH NAME
duchk \- list disk usage in a directory or directory tree
.SH SYNOPSIS
.B duchk
[\fI options \fR] \fIDirectory\fR
.SH DESCRIPTION
.\" Add any additional description here
.PP
Examine a directory or a directory tree and list files and their sizes
in kbytes.  Sort in descending size order.  Display all files at
least 1 kbyte in size unless a minimum size is otherwise indicated.
.TP
\fB\-h\fR, \fB\-\-help\fR
List usage
.TP
\fB\-r\fR, \fB\-\-recursive\fR
Treat \fBDirectory\fR as the root node of a directory tree.  Report on
files in entire directory tree.  The default is not to consider
\fBDirectory\fR as a tree, and not to report on subdirectories.
.TP
\fB\-s\fR, \fB\-\-size\fR \fISize\fR
Limit display of files and sizes to those files whose size is greater
then or equal to \fISize\fR kbytes.  The default is to display
information for all files of at least 1 kbyte in size.
.PP
Directories are displayed with trailing slashes.
.PP
If the recursive option is selected, \fBduchk\fR will examine the given
\fIDirectory\fR and then recursively examine subdirectories of
subdirectories...  Each level of subdirectory examined will be indented
a level for readability.
.PP
Please note that the default behavior of \fBduchk\fR is to display
information on all files greater than or equal to 1 kbyte in size. 
This may cause copious amounts of output for some directories or
trees.  The \fB--size\fR option may be used to limit this output.
.PP
The minimum size a file must have to be included in \fBduchk\fR output
is determined by (in order of precedence):
.TP "'\fBFIELDWIDTHS\fR'u+1n"
.B 1.
A valid argument to the \fI--size\fR option.  A valid argument will
consist only of digits.
.TP "'\fBFIELDWIDTHS\fR'u+1n"
.B 2.
A valid value in the environment variable \fIDUCHK_SIZE\fR.  A valid
value will consist only of digits.
.TP "'\fBFIELDWIDTHS\fR'u+1n"
.B 3.
The default value of 1 kbyte
.SH REPRESENTATION OF UNUSUAL CHARACTERS IN FILENAMES
"Unusual" characters in filenames are printed as follows in
\fBduchk\fR.  Each space in a filename is escaped with a backslash. 
Each tab in a filename is printed as "\\t".  Each newline in a filename
is printed as "\\n".  Each backslash in a filename is printed as a
pair of backslashes.  Each non\-printable character is output as a
backslash\-escaped three digit octal number, representing the octal
ascii code for the character.
.SH AUTHOR
Written by David Alban <extasia@extasia.org>
.SH "REPORTING BUGS"
Report bugs to <extasia@extasia.org>.
.SH COPYRIGHT
Copyright \(co 2003\-2004 David Alban
.br
This is free software; see the source for copying conditions.  There is NO
warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
.SH "SEE ALSO"
\fBdu(1)\fR