summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorYorhel <git@yorhel.nl>2009-04-05 15:23:16 +0200
committerYorhel <git@yorhel.nl>2009-04-05 15:23:16 +0200
commite45afea1d62e3998ff9d1356f4872d50e801ff50 (patch)
tree246c83d807969d8f929775ec2da6c5413d9bdee4 /doc
parentb56a70afc357eefb3905ab79d46bbd44b31aeb8f (diff)
Small manual page formatting cleanup
Diffstat (limited to 'doc')
-rw-r--r--doc/ncdu.160
1 files changed, 23 insertions, 37 deletions
diff --git a/doc/ncdu.1 b/doc/ncdu.1
index 73b958a..c85a20c 100644
--- a/doc/ncdu.1
+++ b/doc/ncdu.1
@@ -1,19 +1,16 @@
.TH NCDU 1 "September 10, 2008" "ncdu-git" "ncdu manual"
+
.SH NAME
\fBncdu \fP- NCurses Disk Usage
+
.SH SYNOPSIS
-.nf
-.fam C
\fBncdu\fP [\fB-hqvx\fP] [\fB--exclude PATTERN\fP] [\fB-X FILE\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
-For a more detailed explanation of \fBncdu\fP, please check
-http://dev.yorhel.nl/ncdu/
+
.SH OPTIONS
.TP
\fB-h\fP
@@ -40,78 +37,67 @@ be added multiple times to add more patterns.
\fB-X\fP FILE, \fB--exclude-from\fP FILE
Exclude files that match any pattern in FILE. Patterns
should be seperated by a newline.
+
.SH KEYS
.TP
-.B
-?
+\fB?\fP
Show help + keys + about screen
.TP
-.B
-up/down
+\fBup/down\fP
Cycle through the items
.TP
-.B
-right/enter
+\fBright/enter\fP
Open selected directory
.TP
-.B
-left
+\fBleft\fP
Go to parent directory
.TP
-.B
-n
+\fBn\fP
Order by filename (press again for descending order)
.TP
-.B
-s
+\fBs\fP
Order by filesize (press again for descending order)
.TP
-.B
-a
+\fBa\fP
Toggle between showing disk usage and showing apparent size.
.TP
-.B
-d
+\fBd\fP
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
+\fBt\fP
Toggle dirs before files when sorting.
.TP
-.B
-g
+\fBg\fP
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
+\fBp\fP
Use powers of 1000 instead of 1024, press again to switch back
.TP
-.B
-h
+\fBh\fP
Show/hide 'hidden' or 'excluded' 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
-i
+\fBi\fP
Show information about the current selected item.
.TP
-.B
-r
+\fBr\fP
Refresh/recalculate the current directory.
.TP
-.B
-q
+\fBq\fP
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)