|
|
|
|
@ -132,8 +132,8 @@
|
|
|
|
|
.rm #[ #] #H #V #F C
|
|
|
|
|
.\" ========================================================================
|
|
|
|
|
.\"
|
|
|
|
|
.IX Title "NCDU 1"
|
|
|
|
|
.TH NCDU 1 "2021-07-22" "ncdu-2.0" "ncdu manual"
|
|
|
|
|
.IX Title "STDIN 1"
|
|
|
|
|
.TH STDIN 1 "2022-06-13" "perl v5.32.1" "User Contributed Perl Documentation"
|
|
|
|
|
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
|
|
|
|
|
.\" way too many mistakes in technical documents.
|
|
|
|
|
.if n .ad l
|
|
|
|
|
@ -151,13 +151,13 @@ provides a fast way to see what directories are using your disk space.
|
|
|
|
|
.IX Header "OPTIONS"
|
|
|
|
|
.SS "Mode Selection"
|
|
|
|
|
.IX Subsection "Mode Selection"
|
|
|
|
|
.IP "\-h, \-\-help" 4
|
|
|
|
|
.IP "\fB\-h\fR, \-\fB\-help\fR" 4
|
|
|
|
|
.IX Item "-h, --help"
|
|
|
|
|
Print a short help message and quit.
|
|
|
|
|
.IP "\-v, \-V, \-\-version" 4
|
|
|
|
|
.IP "\fB\-v\fR, \fB\-V\fR, \fB\-\-version\fR" 4
|
|
|
|
|
.IX Item "-v, -V, --version"
|
|
|
|
|
Print ncdu version and quit.
|
|
|
|
|
.IP "\-f \fI\s-1FILE\s0\fR" 4
|
|
|
|
|
.IP "\fB\-f\fR \fI\s-1FILE\s0\fR" 4
|
|
|
|
|
.IX Item "-f FILE"
|
|
|
|
|
Load the given file, which has earlier been created with the \f(CW\*(C`\-o\*(C'\fR option. If
|
|
|
|
|
\&\fI\s-1FILE\s0\fR is equivalent to \f(CW\*(C`\-\*(C'\fR, the file is read from standard input.
|
|
|
|
|
@ -169,7 +169,7 @@ deletion and shell spawning options in the browser will be disabled.
|
|
|
|
|
.IP "\fIdir\fR" 4
|
|
|
|
|
.IX Item "dir"
|
|
|
|
|
Scan the given directory.
|
|
|
|
|
.IP "\-o \fI\s-1FILE\s0\fR" 4
|
|
|
|
|
.IP "\fB\-o\fR \fI\s-1FILE\s0\fR" 4
|
|
|
|
|
.IX Item "-o FILE"
|
|
|
|
|
Export all necessary information to \fI\s-1FILE\s0\fR instead of opening the browser
|
|
|
|
|
interface. If \fI\s-1FILE\s0\fR is \f(CW\*(C`\-\*(C'\fR, the data is written to standard output. See the
|
|
|
|
|
@ -180,12 +180,12 @@ directory with many files. 10.000 files will get you an export in the order of
|
|
|
|
|
600 to 700 KiB uncompressed, or a little over 100 KiB when compressed with
|
|
|
|
|
gzip. This scales linearly, so be prepared to handle a few tens of megabytes
|
|
|
|
|
when dealing with millions of files.
|
|
|
|
|
.IP "\-e" 4
|
|
|
|
|
.IX Item "-e"
|
|
|
|
|
Enable extended information mode. This will, in addition to the usual file
|
|
|
|
|
information, also read the ownership, permissions and last modification time
|
|
|
|
|
for each file. This will result in higher memory usage (by roughly ~30%) and in
|
|
|
|
|
a larger output file when exporting.
|
|
|
|
|
.IP "\fB\-e\fR, \fB\-\-extended\fR, \fB\-\-no\-extended\fR" 4
|
|
|
|
|
.IX Item "-e, --extended, --no-extended"
|
|
|
|
|
Enable/disable extended information mode. This will, in addition to the usual
|
|
|
|
|
file information, also read the ownership, permissions and last modification
|
|
|
|
|
time for each file. This will result in higher memory usage (by roughly ~30%)
|
|
|
|
|
and in a larger output file when exporting.
|
|
|
|
|
.Sp
|
|
|
|
|
When using the file export/import function, this flag will need to be added
|
|
|
|
|
both when exporting (to make sure the information is added to the export), and
|
|
|
|
|
@ -195,16 +195,59 @@ information.
|
|
|
|
|
.Sp
|
|
|
|
|
This enables viewing and sorting by the latest child mtime, or modified time,
|
|
|
|
|
using 'm' and 'M', respectively.
|
|
|
|
|
.IP "\fB\-\-ignore\-config\fR" 4
|
|
|
|
|
.IX Item "--ignore-config"
|
|
|
|
|
Do not attempt to load any configuration files.
|
|
|
|
|
.SS "Scan Options"
|
|
|
|
|
.IX Subsection "Scan Options"
|
|
|
|
|
These options affect the scanning progress, and have no effect when importing
|
|
|
|
|
directory information from a file.
|
|
|
|
|
.IP "\fB\-x\fR, \fB\-\-one\-file\-system\fR" 4
|
|
|
|
|
.IX Item "-x, --one-file-system"
|
|
|
|
|
Do not cross filesystem boundaries, i.e. only count files and directories on
|
|
|
|
|
the same filesystem as the directory being scanned.
|
|
|
|
|
.IP "\fB\-\-cross\-file\-system\fR" 4
|
|
|
|
|
.IX Item "--cross-file-system"
|
|
|
|
|
Do cross filesystem boundaries. This is the default, but can be specified to
|
|
|
|
|
overrule a previously given \f(CW\*(C`\-x\*(C'\fR.
|
|
|
|
|
.IP "\fB\-\-exclude\fR \fI\s-1PATTERN\s0\fR" 4
|
|
|
|
|
.IX Item "--exclude PATTERN"
|
|
|
|
|
Exclude files that match \fI\s-1PATTERN\s0\fR. The files will still be displayed by
|
|
|
|
|
default, but are not counted towards the disk usage statistics. This argument
|
|
|
|
|
can be added multiple times to add more patterns.
|
|
|
|
|
.IP "\fB\-X\fR \fI\s-1FILE\s0\fR, \fB\-\-exclude\-from\fR \fI\s-1FILE\s0\fR" 4
|
|
|
|
|
.IX Item "-X FILE, --exclude-from FILE"
|
|
|
|
|
Exclude files that match any pattern in \fI\s-1FILE\s0\fR. Patterns should be separated
|
|
|
|
|
by a newline.
|
|
|
|
|
.IP "\fB\-\-include\-caches\fR, \fB\-\-exclude\-caches\fR" 4
|
|
|
|
|
.IX Item "--include-caches, --exclude-caches"
|
|
|
|
|
Include (default) or exclude directories containing \s-1CACHEDIR.TAG.\s0 The
|
|
|
|
|
directories will still be displayed, but their contents will not be scanned or
|
|
|
|
|
counted towards the disk usage statistics.
|
|
|
|
|
<http://www.brynosaurus.com/cachedir/>
|
|
|
|
|
.IP "\fB\-L\fR, \fB\-\-follow\-symlinks\fR, \fB\-\-no\-follow\-symlinks\fR" 4
|
|
|
|
|
.IX Item "-L, --follow-symlinks, --no-follow-symlinks"
|
|
|
|
|
Follow (or not) symlinks and count the size of the file they point to. As of
|
|
|
|
|
ncdu 1.14, this option will not follow symlinks to directories and will count
|
|
|
|
|
each symlinked file as a unique file (i.e. unlike how hard links are handled).
|
|
|
|
|
This is subject to change in later versions.
|
|
|
|
|
.IP "\fB\-\-include\-kernfs\fR, \fB\-\-exclude\-kernfs\fR" 4
|
|
|
|
|
.IX Item "--include-kernfs, --exclude-kernfs"
|
|
|
|
|
(Linux only) Include (default) or exclude Linux pseudo filesystems, e.g. /proc
|
|
|
|
|
(procfs), /sys (sysfs).
|
|
|
|
|
.Sp
|
|
|
|
|
The complete list of currently known pseudo filesystems is: binfmt, bpf, cgroup,
|
|
|
|
|
cgroup2, debug, devpts, proc, pstore, security, selinux, sys, trace.
|
|
|
|
|
.SS "Interface options"
|
|
|
|
|
.IX Subsection "Interface options"
|
|
|
|
|
.IP "\-0" 4
|
|
|
|
|
.IP "\fB\-0\fR" 4
|
|
|
|
|
.IX Item "-0"
|
|
|
|
|
Don't give any feedback while scanning a directory or importing a file, other
|
|
|
|
|
than when a fatal error occurs. Ncurses will not be initialized until the scan
|
|
|
|
|
is complete. When exporting the data with \f(CW\*(C`\-o\*(C'\fR, ncurses will not be
|
|
|
|
|
initialized at all. This option is the default when exporting to standard
|
|
|
|
|
output.
|
|
|
|
|
.IP "\-1" 4
|
|
|
|
|
.IP "\fB\-1\fR" 4
|
|
|
|
|
.IX Item "-1"
|
|
|
|
|
Similar to \f(CW\*(C`\-0\*(C'\fR, but does give feedback on the scanning progress with a single
|
|
|
|
|
line of output. This option is the default when exporting to a file.
|
|
|
|
|
@ -212,146 +255,199 @@ line of output. This option is the default when exporting to a file.
|
|
|
|
|
In some cases, the ncurses browser interface which you'll see after the
|
|
|
|
|
scan/import is complete may look garbled when using this option. If you're not
|
|
|
|
|
exporting to a file, \f(CW\*(C`\-2\*(C'\fR is probably a better choice.
|
|
|
|
|
.IP "\-2" 4
|
|
|
|
|
.IP "\fB\-2\fR" 4
|
|
|
|
|
.IX Item "-2"
|
|
|
|
|
Provide a full-screen ncurses interface while scanning a directory or importing
|
|
|
|
|
a file. This is the only interface that provides feedback on any non-fatal
|
|
|
|
|
errors while scanning.
|
|
|
|
|
.IP "\-q" 4
|
|
|
|
|
.IX Item "-q"
|
|
|
|
|
Quiet mode. While scanning or importing the directory, ncdu 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. This option has no effect when \f(CW\*(C`\-0\*(C'\fR is used.
|
|
|
|
|
.IP "\-r" 4
|
|
|
|
|
.IP "\fB\-q\fR, \fB\-\-slow\-ui\-updates\fR, \fB\-\-fast\-ui\-updates\fR" 4
|
|
|
|
|
.IX Item "-q, --slow-ui-updates, --fast-ui-updates"
|
|
|
|
|
Change the \s-1UI\s0 update interval while scanning or importing. Ncdu will update the
|
|
|
|
|
screen 10 times a second by default (\f(CW\*(C`\-\-fast\-ui\-updates\*(C'\fR), this can be
|
|
|
|
|
decreased to once every 2 seconds with \f(CW\*(C`\-q\*(C'\fR or \f(CW\*(C`\-\-slow\-ui\-updates\*(C'\fR. This
|
|
|
|
|
feature can be used to save bandwidth over remote connections. This option has
|
|
|
|
|
no effect when \f(CW\*(C`\-0\*(C'\fR is used.
|
|
|
|
|
.IP "\fB\-\-enable\-shell\fR, \fB\-\-disable\-shell\fR" 4
|
|
|
|
|
.IX Item "--enable-shell, --disable-shell"
|
|
|
|
|
Enable or disable shell spawning from the browser. This feature is enabled by
|
|
|
|
|
default when scanning a live directory and disabled when importing from file.
|
|
|
|
|
.IP "\fB\-\-enable\-delete\fR, \fB\-\-disable\-delete\fR" 4
|
|
|
|
|
.IX Item "--enable-delete, --disable-delete"
|
|
|
|
|
Enable or disable the built-in file deletion feature. This feature is enabled
|
|
|
|
|
by default when scanning a live directory and disabled when importing from
|
|
|
|
|
file. Explicitly disabling the deletion feature can work as a safeguard to
|
|
|
|
|
prevent accidental data loss.
|
|
|
|
|
.IP "\fB\-\-enable\-refresh\fR, \fB\-\-disable\-refresh\fR" 4
|
|
|
|
|
.IX Item "--enable-refresh, --disable-refresh"
|
|
|
|
|
Enable or disable directory refreshing from the browser. This feature is
|
|
|
|
|
enabled by default when scanning a live directory and disabled when importing
|
|
|
|
|
from file.
|
|
|
|
|
.IP "\fB\-r\fR" 4
|
|
|
|
|
.IX Item "-r"
|
|
|
|
|
Read-only mode. This will disable the built-in file deletion feature. This
|
|
|
|
|
option has no effect when \f(CW\*(C`\-o\*(C'\fR is used, because there will not be a browser
|
|
|
|
|
interface in that case. It has no effect when \f(CW\*(C`\-f\*(C'\fR is used, either, because
|
|
|
|
|
the deletion feature is disabled in that case anyway.
|
|
|
|
|
.Sp
|
|
|
|
|
\&\s-1WARNING:\s0 This option will only prevent deletion through the file browser. It is
|
|
|
|
|
still possible to spawn a shell from ncdu and delete or modify files from
|
|
|
|
|
there. To disable that feature as well, pass the \f(CW\*(C`\-r\*(C'\fR option twice (see
|
|
|
|
|
\&\f(CW\*(C`\-rr\*(C'\fR).
|
|
|
|
|
.IP "\-rr" 4
|
|
|
|
|
.IX Item "-rr"
|
|
|
|
|
In addition to \f(CW\*(C`\-r\*(C'\fR, this will also disable the shell spawning feature of the
|
|
|
|
|
file browser.
|
|
|
|
|
.IP "\-\-si" 4
|
|
|
|
|
.IX Item "--si"
|
|
|
|
|
Read-only mode. When given once, this is an alias for \f(CW\*(C`\-\-disable\-delete\*(C'\fR, when
|
|
|
|
|
given twice it will also add \f(CW\*(C`\-\-disable\-shell\*(C'\fR, thus ensuring that there is no
|
|
|
|
|
way to modify the file system from within ncdu.
|
|
|
|
|
.IP "\fB\-\-si\fR, \fB\-\-no\-si\fR" 4
|
|
|
|
|
.IX Item "--si, --no-si"
|
|
|
|
|
List sizes using base 10 prefixes, that is, powers of 1000 (\s-1KB, MB,\s0 etc), as
|
|
|
|
|
defined in the International System of Units (\s-1SI\s0), instead of the usual base 2
|
|
|
|
|
prefixes, that is, powers of 1024 (KiB, MiB, etc).
|
|
|
|
|
.IP "\-\-confirm\-quit" 4
|
|
|
|
|
.IX Item "--confirm-quit"
|
|
|
|
|
Requires a confirmation before quitting ncdu. Very helpful when you
|
|
|
|
|
accidentally press 'q' during or after a very long scan.
|
|
|
|
|
.IP "\-\-color \fI\s-1SCHEME\s0\fR" 4
|
|
|
|
|
.IP "\fB\-\-disk\-usage\fR, \fB\-\-apparent\-size\fR" 4
|
|
|
|
|
.IX Item "--disk-usage, --apparent-size"
|
|
|
|
|
Select whether to display disk usage (default) or apparent sizes. Can also be
|
|
|
|
|
toggled in the browser with the 'a' key.
|
|
|
|
|
.IP "\fB\-\-show\-hidden\fR, \fB\-\-hide\-hidden\fR" 4
|
|
|
|
|
.IX Item "--show-hidden, --hide-hidden"
|
|
|
|
|
Show (default) or hide \*(L"hidden\*(R" and excluded files. Can also be toggled in the
|
|
|
|
|
browser with the 'e' key.
|
|
|
|
|
.IP "\fB\-\-show\-itemcount\fR, \fB\-\-hide\-itemcount\fR" 4
|
|
|
|
|
.IX Item "--show-itemcount, --hide-itemcount"
|
|
|
|
|
Show or hide (default) the item counts column. Can also be toggled in the
|
|
|
|
|
browser with the 'c' key.
|
|
|
|
|
.IP "\fB\-\-show\-mtime\fR, \fB\-\-hide\-mtime\fR" 4
|
|
|
|
|
.IX Item "--show-mtime, --hide-mtime"
|
|
|
|
|
Show or hide (default) the last modification time column. Can also be toggled
|
|
|
|
|
in the browser with the 'm' key. This option is ignored when not in extended
|
|
|
|
|
mode (see \f(CW\*(C`\-e\*(C'\fR).
|
|
|
|
|
.IP "\fB\-\-show\-graph\fR, \fB\-\-hide\-graph\fR" 4
|
|
|
|
|
.IX Item "--show-graph, --hide-graph"
|
|
|
|
|
Show (default) or hide the relative size bar column. Can also be toggled in the
|
|
|
|
|
browser with the 'g' key.
|
|
|
|
|
.IP "\fB\-\-show\-percent\fR, \fB\-\-hide\-percent\fR" 4
|
|
|
|
|
.IX Item "--show-percent, --hide-percent"
|
|
|
|
|
Show (default) or hide the relative size percent column. Can also be toggled in
|
|
|
|
|
the browser with the 'g' key.
|
|
|
|
|
.IP "\fB\-\-graph\-style\fR \fI\s-1OPTION\s0\fR" 4
|
|
|
|
|
.IX Item "--graph-style OPTION"
|
|
|
|
|
Change the way that the relative size bar column is drawn. Recognized values
|
|
|
|
|
are \fIhash\fR to draw \s-1ASCII\s0 \f(CW\*(C`#\*(C'\fR characters (default and most portable),
|
|
|
|
|
\&\fIhalf-block\fR to use half-block drawing characters or \fIeighth-block\fR to use
|
|
|
|
|
eighth-block drawing characters. Eighth-block characters are the most precise
|
|
|
|
|
but may not render correctly in all terminals.
|
|
|
|
|
.IP "\fB\-\-shared\-column\fR \fI\s-1OPTION\s0\fR" 4
|
|
|
|
|
.IX Item "--shared-column OPTION"
|
|
|
|
|
Set to \fIoff\fR to disable the shared size column for directories, \fIshared\fR
|
|
|
|
|
(default) to display shared directory sizes as a separate column or \fIunique\fR
|
|
|
|
|
to display unique directory sizes as a separate column. These options can also
|
|
|
|
|
be cycled through in the browser with the 'u' key.
|
|
|
|
|
.IP "\fB\-\-sort\fR \fI\s-1COLUMN\s0\fR" 4
|
|
|
|
|
.IX Item "--sort COLUMN"
|
|
|
|
|
Change the default column to sort on. Accepted values are \fIdisk-usage\fR (the
|
|
|
|
|
default), \fIname\fR, \fIapparent-size\fR, \fIitemcount\fR or \fImtime\fR. The latter only
|
|
|
|
|
makes sense in extended mode, see \f(CW\*(C`\-e\*(C'\fR.
|
|
|
|
|
.Sp
|
|
|
|
|
The column can be suffixed with \fI\-asc\fR or \fI\-desc\fR to set the order to
|
|
|
|
|
ascending or descending, respectively. e.g. \f(CW\*(C`\-\-sort=name\-desc\*(C'\fR will sort by
|
|
|
|
|
name in descending order.
|
|
|
|
|
.IP "\fB\-\-group\-directories\-first\fR, \fB\-\-no\-group\-directories\-first\fR" 4
|
|
|
|
|
.IX Item "--group-directories-first, --no-group-directories-first"
|
|
|
|
|
Sort (or not) directories before files.
|
|
|
|
|
.IP "\fB\-\-confirm\-quit\fR, \fB\-\-no\-confirm\-quit\fR" 4
|
|
|
|
|
.IX Item "--confirm-quit, --no-confirm-quit"
|
|
|
|
|
Require a confirmation before quitting ncdu. Very helpful when you accidentally
|
|
|
|
|
press 'q' during or after a very long scan.
|
|
|
|
|
.IP "\fB\-\-confirm\-delete\fR, \fB\-\-no\-confirm\-delete\fR" 4
|
|
|
|
|
.IX Item "--confirm-delete, --no-confirm-delete"
|
|
|
|
|
Require a confirmation before deleting a file or directory. Enabled by default,
|
|
|
|
|
but can be disabled if you're absolutely sure you won't accidentally press 'd'.
|
|
|
|
|
.IP "\fB\-\-color\fR \fI\s-1SCHEME\s0\fR" 4
|
|
|
|
|
.IX Item "--color SCHEME"
|
|
|
|
|
Select a color scheme. Currently only two schemes are recognized: \fIoff\fR to
|
|
|
|
|
disable colors (the default) and \fIdark\fR for a color scheme intended for dark
|
|
|
|
|
backgrounds.
|
|
|
|
|
.SS "Scan Options"
|
|
|
|
|
.IX Subsection "Scan Options"
|
|
|
|
|
These options affect the scanning progress, and have no effect when importing
|
|
|
|
|
directory information from a file.
|
|
|
|
|
.IP "\-x" 4
|
|
|
|
|
.IX Item "-x"
|
|
|
|
|
Do not cross filesystem boundaries, i.e. only count files and directories on
|
|
|
|
|
the same filesystem as the directory being scanned.
|
|
|
|
|
.IP "\-\-exclude \fI\s-1PATTERN\s0\fR" 4
|
|
|
|
|
.IX Item "--exclude PATTERN"
|
|
|
|
|
Exclude files that match \fI\s-1PATTERN\s0\fR. The files will still be displayed by
|
|
|
|
|
default, but are not counted towards the disk usage statistics. This argument
|
|
|
|
|
can be added multiple times to add more patterns.
|
|
|
|
|
.IP "\-X \fI\s-1FILE\s0\fR, \-\-exclude\-from \fI\s-1FILE\s0\fR" 4
|
|
|
|
|
.IX Item "-X FILE, --exclude-from FILE"
|
|
|
|
|
Exclude files that match any pattern in \fI\s-1FILE\s0\fR. Patterns should be separated
|
|
|
|
|
by a newline.
|
|
|
|
|
.IP "\-\-exclude\-caches" 4
|
|
|
|
|
.IX Item "--exclude-caches"
|
|
|
|
|
Exclude directories containing \s-1CACHEDIR.TAG.\s0 The directories will still be
|
|
|
|
|
displayed, but not their content, and they are not counted towards the disk
|
|
|
|
|
usage statistics.
|
|
|
|
|
See http://www.brynosaurus.com/cachedir/
|
|
|
|
|
.IP "\-L, \-\-follow\-symlinks" 4
|
|
|
|
|
.IX Item "-L, --follow-symlinks"
|
|
|
|
|
Follow symlinks and count the size of the file they point to. As of ncdu 1.14,
|
|
|
|
|
this option will not follow symlinks to directories and will count each
|
|
|
|
|
symlinked file as a unique file (i.e. unlike how hard links are handled). This
|
|
|
|
|
is subject to change in later versions.
|
|
|
|
|
.IP "\-\-exclude\-firmlinks" 4
|
|
|
|
|
.IX Item "--exclude-firmlinks"
|
|
|
|
|
(MacOS only) Exclude firmlinks.
|
|
|
|
|
.IP "\-\-exclude\-kernfs" 4
|
|
|
|
|
.IX Item "--exclude-kernfs"
|
|
|
|
|
(Linux only) Exclude Linux pseudo filesystems, e.g. /proc (procfs), /sys (sysfs).
|
|
|
|
|
Select a color scheme. The following schemes are recognized: \fIoff\fR to disable
|
|
|
|
|
colors, \fIdark\fR for a color scheme intended for dark backgrounds and \fIdark-bg\fR
|
|
|
|
|
for a variation of the \fIdark\fR color scheme that also works in terminals with a
|
|
|
|
|
light background.
|
|
|
|
|
.Sp
|
|
|
|
|
The complete list of currently known pseudo filesystems is: binfmt, bpf, cgroup,
|
|
|
|
|
cgroup2, debug, devpts, proc, pstore, security, selinux, sys, trace.
|
|
|
|
|
The default is \fIdark-bg\fR unless the \f(CW\*(C`NO_COLOR\*(C'\fR environment variable is set.
|
|
|
|
|
.SH "CONFIGURATION"
|
|
|
|
|
.IX Header "CONFIGURATION"
|
|
|
|
|
Ncdu can be configured by placing command-line options in \f(CW\*(C`/etc/ncdu.conf\*(C'\fR or
|
|
|
|
|
\&\f(CW\*(C`$HOME/.config/ncdu/config\*(C'\fR. If both files exist, the system configuration
|
|
|
|
|
will be loaded before the user configuration, allowing users to override
|
|
|
|
|
options set in the system configuration. Options given on the command line will
|
|
|
|
|
override options set in the configuration files. The files will not be read at
|
|
|
|
|
all when \f(CW\*(C`\-\-ignore\-config\*(C'\fR is given on the command line.
|
|
|
|
|
.PP
|
|
|
|
|
The configuration file format is simply one command line option per line. Lines
|
|
|
|
|
starting with \f(CW\*(C`#\*(C'\fR are ignored. Example configuration file:
|
|
|
|
|
.PP
|
|
|
|
|
.Vb 2
|
|
|
|
|
\& # Always enable extended mode
|
|
|
|
|
\& \-e
|
|
|
|
|
\&
|
|
|
|
|
\& # Disable file deletion
|
|
|
|
|
\& \-\-disable\-delete
|
|
|
|
|
\&
|
|
|
|
|
\& # Exclude .git directories
|
|
|
|
|
\& \-\-exclude .git
|
|
|
|
|
.Ve
|
|
|
|
|
.SH "KEYS"
|
|
|
|
|
.IX Header "KEYS"
|
|
|
|
|
.IP "?" 4
|
|
|
|
|
.IP "\fB?\fR" 4
|
|
|
|
|
.IX Item "?"
|
|
|
|
|
Show help + keys + about screen
|
|
|
|
|
.IP "up, down j, k" 4
|
|
|
|
|
.IX Item "up, down j, k"
|
|
|
|
|
.IP "\fBup\fR, \fBdown\fR, \fBj\fR, \fBk\fR" 4
|
|
|
|
|
.IX Item "up, down, j, k"
|
|
|
|
|
Cycle through the items
|
|
|
|
|
.IP "right, enter, l" 4
|
|
|
|
|
.IP "\fBright\fR, \fBenter\fR, \fBl\fR" 4
|
|
|
|
|
.IX Item "right, enter, l"
|
|
|
|
|
Open selected directory
|
|
|
|
|
.IP "left, <, h" 4
|
|
|
|
|
.IP "\fBleft\fR, \fB<\fR, \fBh\fR" 4
|
|
|
|
|
.IX Item "left, <, h"
|
|
|
|
|
Go to parent directory
|
|
|
|
|
.IP "n" 4
|
|
|
|
|
.IP "\fBn\fR" 4
|
|
|
|
|
.IX Item "n"
|
|
|
|
|
Order by filename (press again for descending order)
|
|
|
|
|
.IP "s" 4
|
|
|
|
|
.IP "\fBs\fR" 4
|
|
|
|
|
.IX Item "s"
|
|
|
|
|
Order by filesize (press again for descending order)
|
|
|
|
|
.IP "C" 4
|
|
|
|
|
.IP "\fBC\fR" 4
|
|
|
|
|
.IX Item "C"
|
|
|
|
|
Order by number of items (press again for descending order)
|
|
|
|
|
.IP "a" 4
|
|
|
|
|
.IP "\fBa\fR" 4
|
|
|
|
|
.IX Item "a"
|
|
|
|
|
Toggle between showing disk usage and showing apparent size.
|
|
|
|
|
.IP "M" 4
|
|
|
|
|
.IP "\fBM\fR" 4
|
|
|
|
|
.IX Item "M"
|
|
|
|
|
Order by latest child mtime, or modified time. (press again for descending order)
|
|
|
|
|
Requires the \-e flag.
|
|
|
|
|
.IP "d" 4
|
|
|
|
|
.IP "\fBd\fR" 4
|
|
|
|
|
.IX Item "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.
|
|
|
|
|
.IP "t" 4
|
|
|
|
|
.IP "\fBt\fR" 4
|
|
|
|
|
.IX Item "t"
|
|
|
|
|
Toggle dirs before files when sorting.
|
|
|
|
|
.IP "g" 4
|
|
|
|
|
.IP "\fBg\fR" 4
|
|
|
|
|
.IX Item "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.
|
|
|
|
|
.IP "c" 4
|
|
|
|
|
.IP "\fBu\fR" 4
|
|
|
|
|
.IX Item "u"
|
|
|
|
|
Toggle display of the shared / unique size column for directories that share
|
|
|
|
|
hard links. This column is only visible if the current listing contains
|
|
|
|
|
directories with shared hard links.
|
|
|
|
|
.IP "\fBc\fR" 4
|
|
|
|
|
.IX Item "c"
|
|
|
|
|
Toggle display of child item counts.
|
|
|
|
|
.IP "m" 4
|
|
|
|
|
.IP "\fBm\fR" 4
|
|
|
|
|
.IX Item "m"
|
|
|
|
|
Toggle display of latest child mtime, or modified time. Requires the \-e flag.
|
|
|
|
|
.IP "e" 4
|
|
|
|
|
.IP "\fBe\fR" 4
|
|
|
|
|
.IX Item "e"
|
|
|
|
|
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.
|
|
|
|
|
.IP "i" 4
|
|
|
|
|
.IP "\fBi\fR" 4
|
|
|
|
|
.IX Item "i"
|
|
|
|
|
Show information about the current selected item.
|
|
|
|
|
.IP "r" 4
|
|
|
|
|
.IP "\fBr\fR" 4
|
|
|
|
|
.IX Item "r"
|
|
|
|
|
Refresh/recalculate the current directory.
|
|
|
|
|
.IP "b" 4
|
|
|
|
|
.IP "\fBb\fR" 4
|
|
|
|
|
.IX Item "b"
|
|
|
|
|
Spawn shell in current directory.
|
|
|
|
|
.Sp
|
|
|
|
|
@ -371,30 +467,36 @@ spawning the shell. This variable allows you to detect when your shell is
|
|
|
|
|
running from within ncdu, which can be useful to avoid nesting multiple
|
|
|
|
|
instances of ncdu. Ncdu itself does not (currently) warn when attempting to run
|
|
|
|
|
nested instances.
|
|
|
|
|
.IP "q" 4
|
|
|
|
|
.IP "\fBq\fR" 4
|
|
|
|
|
.IX Item "q"
|
|
|
|
|
Quit
|
|
|
|
|
.SH "FILE FLAGS"
|
|
|
|
|
.IX Header "FILE FLAGS"
|
|
|
|
|
Entries in the browser interface may be prefixed by a one-character flag. These
|
|
|
|
|
flags have the following meaning:
|
|
|
|
|
.IP "!" 4
|
|
|
|
|
.IP "\fB!\fR" 4
|
|
|
|
|
.IX Item "!"
|
|
|
|
|
An error occurred while reading this directory.
|
|
|
|
|
.IP "." 4
|
|
|
|
|
.IP "\fB.\fR" 4
|
|
|
|
|
.IX Item "."
|
|
|
|
|
An error occurred while reading a subdirectory, so the indicated size may not be
|
|
|
|
|
correct.
|
|
|
|
|
.IP "<" 4
|
|
|
|
|
.IP "\fB<\fR" 4
|
|
|
|
|
.IX Item "<"
|
|
|
|
|
File or directory is excluded from the statistics by using exclude patterns.
|
|
|
|
|
.IP ">" 4
|
|
|
|
|
.IP "\fB>\fR" 4
|
|
|
|
|
.IX Item ">"
|
|
|
|
|
Directory is on another filesystem.
|
|
|
|
|
.IP "^" 4
|
|
|
|
|
.IP "\fB^\fR" 4
|
|
|
|
|
.IX Item "^"
|
|
|
|
|
Directory is excluded from the statistics due to being a Linux pseudo filesystem.
|
|
|
|
|
.IP "@" 4
|
|
|
|
|
.IP "\fB@\fR" 4
|
|
|
|
|
.IX Item "@"
|
|
|
|
|
This is neither a file nor a folder (symlink, socket, ...).
|
|
|
|
|
.IP "H" 4
|
|
|
|
|
.IP "\fBH\fR" 4
|
|
|
|
|
.IX Item "H"
|
|
|
|
|
Same file was already counted (hard link).
|
|
|
|
|
.IP "e" 4
|
|
|
|
|
.IP "\fBe\fR" 4
|
|
|
|
|
.IX Item "e"
|
|
|
|
|
Empty directory.
|
|
|
|
|
.SH "EXAMPLES"
|
|
|
|
|
@ -479,25 +581,25 @@ not always be same as the space that will be reclaimed after deleting the
|
|
|
|
|
directory, as some inodes may still be accessible from hard links outside it.
|
|
|
|
|
.SH "BUGS"
|
|
|
|
|
.IX Header "BUGS"
|
|
|
|
|
Directory hard links are not supported. They will not be detected as being hard
|
|
|
|
|
links, and will thus be scanned and counted multiple times.
|
|
|
|
|
Directory hard links and firmlinks (MacOS) are not supported. They will not be
|
|
|
|
|
detected as being hard links, and may thus be scanned and counted multiple
|
|
|
|
|
times.
|
|
|
|
|
.PP
|
|
|
|
|
Some minor glitches may appear when displaying filenames that contain multibyte
|
|
|
|
|
or multicolumn characters.
|
|
|
|
|
.PP
|
|
|
|
|
The unique and shared directory sizes are calculated based on the assumption
|
|
|
|
|
that the link count of hard links does not change during a filesystem scan or
|
|
|
|
|
in between refreshes. If it does, for example after deleting a hard link, then
|
|
|
|
|
these numbers will be very much incorrect and a full refresh by restarting ncdu
|
|
|
|
|
is needed to get correct numbers again.
|
|
|
|
|
.PP
|
|
|
|
|
All sizes are internally represented as a signed 64bit integer. If you have a
|
|
|
|
|
directory larger than 8 EiB minus one byte, ncdu will clip its size to 8 EiB
|
|
|
|
|
minus one byte. When deleting items in a directory with a clipped size, the
|
|
|
|
|
resulting sizes will be incorrect.
|
|
|
|
|
.PP
|
|
|
|
|
Item counts are stored in a signed 32\-bit integer without overflow detection.
|
|
|
|
|
If you have a directory with more than 2 billion files, quite literally
|
|
|
|
|
anything can happen.
|
|
|
|
|
.PP
|
|
|
|
|
On macOS 10.15 and later, running ncdu on the root directory without
|
|
|
|
|
`\-\-exclude\-firmlinks` may cause directories to be scanned and counted multiple
|
|
|
|
|
times. Firmlink cycles are currently (1.16) not detected, so it may also cause
|
|
|
|
|
ncdu to get stuck in an infinite loop and eventually run out of memory.
|
|
|
|
|
minus one byte. When deleting or refreshing items in a directory with a clipped
|
|
|
|
|
size, the resulting sizes will be incorrect. Likewise, item counts are stored
|
|
|
|
|
in a 32\-bit integer, so will be incorrect in the unlikely event that you happen
|
|
|
|
|
to have more than 4 billion items in a directory.
|
|
|
|
|
.PP
|
|
|
|
|
Please report any other bugs you may find at the bug tracker, which can be
|
|
|
|
|
found on the web site at https://dev.yorhel.nl/ncdu
|
|
|
|
|
|
