summaryrefslogtreecommitdiff
path: root/doc/ncdu.1
diff options
context:
space:
mode:
Diffstat (limited to 'doc/ncdu.1')
-rw-r--r--doc/ncdu.1127
1 files changed, 127 insertions, 0 deletions
diff --git a/doc/ncdu.1 b/doc/ncdu.1
new file mode 100644
index 0000000..4197d13
--- /dev/null
+++ b/doc/ncdu.1
@@ -0,0 +1,127 @@
+." Text automatically generated by txt2man
+.TH NCDU 1 "April 30, 2007" "ncdu-1.1" "ncdu manual"
+.SH NAME
+\fBncdu \fP- NCurses Disk Usage
+.SH SYNOPSIS
+.nf
+.fam C
+\fBncdu\fP [\fB-ahqvx\fP] [\fIdir\fP]
+.fam T
+.fi
+.SH DESCRIPTION
+\fBncdu\fP (NCurses Disk Usage) is a curses-based version of
+the well-known 'du', and provides a fast way to see what
+directories are using your disk space.
+.PP
+If \fIdir\fP is specified, \fBncdu\fP will automatically start
+calculating the disk size. Otherwise, you will be prompted
+with a small configuration window.
+.PP
+For a more detailed explanation of \fBncdu\fP, please check
+http://dev.yorhel.nl/\fBncdu\fP/
+.SH OPTIONS
+.TP
+.B
+\fB-a\fP
+Apparent sizes. Normally, \fBncdu\fP would calculate the
+disk usage of each file, setting \fB-a\fP will tell \fBncdu\fP
+to simply calculate the actual size of the files.
+.TP
+.B
+\fB-h\fP
+Print a small help message
+.TP
+.B
+\fB-q\fP
+Quiet mode. While calculating disk space, \fBncdu\fP will
+update the screen 10 times a second by default, this
+will be decreased to once every 2 seconds in quiet
+mode. Use this feature to save bandwidth over remote
+connections.
+.TP
+.B
+\fB-v\fP
+Print version.
+.TP
+.B
+\fB-x\fP
+Only count files and directories on the same
+filesystem as the specified \fIdir\fP.
+.SH KEYS
+.SS SETTINGS WINDOW
+.TP
+.B
+up/down/tab
+Cycle through the form fields.
+.TP
+.B
+Enter
+Post form
+.SS CALCULATING WINDOW
+.TP
+.B
+q
+Quit
+.SS BROWSER
+.TP
+.B
+?
+Show help + keys + about screen
+.TP
+.B
+up/down
+Cycle through the items
+.TP
+.B
+right/enter
+Open selected directory
+.TP
+.B
+left
+Go to parent directory
+.TP
+.B
+n
+Order by filename (press again for descending order)
+.TP
+.B
+s
+Order by filesize (press again for descending order)
+.TP
+.B
+d
+Delete the selected file or directory. An error message will be shown
+when the contents of the directory do not match or do not exist anymore
+on the filesystem.
+.TP
+.B
+t
+Toggle dirs before files when sorting.
+.TP
+.B
+g
+Toggle between showing percentage, graph, both, or none. Percentage
+is relative to the size of the current directory, graph is relative
+to the largest item in the current directory.
+.TP
+.B
+p
+Use powers of 1000 instead of 1024, press again to switch back
+.TP
+.B
+h
+Show/Hide 'hidden' files and directories. Please note that even though
+you can't see the hidden files and directories, they are still there
+and they are still included in the directory sizes. If you suspect that
+the totals shown at the bottom of the screen are not correct, make sure
+you haven't enabled this option.
+.TP
+.B
+q
+Quit
+.SH AUTHOR
+Written by Yoran Heling <projects@yorhel.nl>.
+.SH BUGS
+Infinite. Please contact the author if you find one.
+.SH SEE ALSO
+\fBdu\fP(1)