Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
N
nccf
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package registry
Container Registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Terms and privacy
Keyboard shortcuts
?
Snippets
Groups
Projects
This is an archived project. Repository and other project resources are read-only.
Show more breadcrumbs
702
Provoz
nccf
Commits
b1059caf
Commit
b1059caf
authored
12 years ago
by
Yorhel
Browse files
Options
Downloads
Patches
Plain Diff
Update man page with new options
parent
7feaeb14
No related branches found
Branches containing commit
No related tags found
Tags containing commit
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
doc/ncdu.pod
+80
-21
80 additions, 21 deletions
doc/ncdu.pod
with
80 additions
and
21 deletions
doc/ncdu.pod
+
80
−
21
View file @
b1059caf
...
@@ -18,46 +18,105 @@ provides a fast way to see what directories are using your disk space.
...
@@ -18,46 +18,105 @@ provides a fast way to see what directories are using your disk space.
=head1 OPTIONS
=head1 OPTIONS
=head2 Mode Selection
=over
=over
=item -h
=item -h
Print a short help message.
Print a short help message
and quit
.
=item -q
=item -v
Print ncdu version and quit.
=item -f I<FILE>
Load the given file, which has earlier been created with the C<-o> option. If
I<FILE> is equivalent to C<->, the file is read from standard input.
For the sake of preventing a screw-up, the current version of ncdu will assume
that the directory information in the imported file does not represent the
filesystem on which the file is being imported. That is, the refresh and file
deletion options in the browser will be disabled.
=item I<dir>
Quiet mode. While calculating disk space, ncdu will update the screen 10 times
Scan the given directory.
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.
=item -0, -1, -2
=item -o I<FILE>
Export all necessary information to I<FILE> instead of opening the browser
interface. If I<FILE> is C<->, the data is written to standard output.
Be warned that the exported data may grow quite large when exporting a
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.
=back
=head2 Interface options
=over
Interface used to give feedback on scanning progress. C<-0> will prevent any
=item -0
output from being displayed before ncdu is done scanning, while C<-1> will
display compact progress information on a single line of output. C<-2> presents
Don't give any feedback while scanning a directory or importing a file, other
a full-screen ncurses interface while scanning (the default). C<-0> and C<-1> do
than when a fatal error occurs. Ncurses will not be initialized until the scan
not initialize ncurses before the directory has been scanned, while C<-2> is the
is complete. When exporting the data with C<-o>, ncurses will not be
only interface that provides feedback on recoverable errors. This does not
initialized at all. This option is the default when exporting to standard
affect the interface used when re-scanning a directory from the ncurses
output.
browser, where the full ncurses interface is always used.
=item -1
Similar to C<-0>, but does give feedback on the scanning progress with a single
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, C<-2> is probably a better choice.
=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.
=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 C<-0> is used.
=item -r
=item -r
Read-only mode. This will disable the built-in file deletion feature.
Read-only mode. This will disable the built-in file deletion feature. This
option has no effect when C<-o> is used, because there will not be a browser
interface in that case. It has no effect when C<-f> is used, either, because
the deletion feature is disabled in that case anyway.
=
item -v
=
back
Print version.
=head2 Scan Options
These options affect the scanning progress, and have no effect when importing
directory information from a file.
=over
=item -x
=item -x
Only count files and directories on the same filesystem as the specified
Do not cross filesystem boundaries, i.e. only count files and directories on
I<dir>
.
the same filesystem as the directory being scanned
.
=item --exclude I<PATTERN>
=item --exclude I<PATTERN>
Exclude files that match I<PATTERN>. This argument can be added multiple times
Exclude files that match I<PATTERN>. The files will still be displayed by
to add more patterns.
default, but are not counted towards the disk usage statistics. This argument
can be added multiple times to add more patterns.
=item -X I<FILE>, --exclude-from I<FILE>
=item -X I<FILE>, --exclude-from I<FILE>
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment