Added Cache-Control header + use POD for the ncdu manual

This commit is contained in:
Yorhel 2012-01-18 11:32:59 +01:00
parent b7746b3122
commit 72a63e80dd
2 changed files with 151 additions and 115 deletions

View file

@ -1,135 +1,180 @@
ncdu(1) ncdu manual ncdu(1) .TH ncdu 1 "Nov 3, 2011" "ncdu-1.8" "ncdu manual"
=head1 NAME
B<ncdu> - NCurses Disk Usage
=head1 SYNOPSIS
NAME B<ncdu> [I<options>] I<dir>
ncdu - NCurses Disk Usage
SYNOPSIS =head1 DESCRIPTION
ncdu [-hqvx] [--exclude PATTERN] [-X FILE] dir
ncdu (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.
DESCRIPTION =head1 OPTIONS
ncdu (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. =over
=item -h
Print a short help message.
=item -q
Quiet mode. While calculating disk space, 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.
=item -r
Read-only mode. This will disable the built-in file deletion feature.
=item -v
Print version.
=item -x
Only count files and directories on the same filesystem as the specified
I<dir>.
=item --exclude I<PATTERN>
Exclude files that match I<PATTERN>. This argument can be added multiple times
to add more patterns.
=item -X I<FILE>, --exclude-from I<FILE>
Exclude files that match any pattern in I<FILE>. Patterns should be separated
by a newline.
=back
OPTIONS =head1 KEYS
-h Print a small help message
-q Quiet mode. While calculating disk space, ncdu will update the =over
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.
-r Read-only mode. This will disable the built-in file deletion fea =item ?
ture.
-v Print version. Show help + keys + about screen
-x Only count files and directories on the same filesystem as the spec =item up, down j, k
ified dir.
--exclude PATTERN
Exclude files that match PATTERN. This argument can be added multi
ple times to add more patterns.
-X FILE, --exclude-from FILE
Exclude files that match any pattern in FILE. Patterns should be
separated by a newline.
KEYS
? Show help + keys + about screen
up, down j, k
Cycle through the items Cycle through the items
right, enter, l =item right, enter, l
Open selected directory Open selected directory
left, <, h =item left, <, h
Go to parent directory Go to parent directory
n Order by filename (press again for descending order) =item n
s Order by filesize (press again for descending order) Order by filename (press again for descending order)
a Toggle between showing disk usage and showing apparent size. =item s
d Delete the selected file or directory. An error message will be Order by filesize (press again for descending order)
shown when the contents of the directory do not match or do not
exist anymore on the filesystem.
t Toggle dirs before files when sorting. =item a
g Toggle between showing percentage, graph, both, or none. Percentage Toggle between showing disk usage and showing apparent size.
is relative to the size of the current directory, graph is relative
to the largest item in the current directory.
e Show/hide 'hidden' or 'excluded' files and directories. Please note =item d
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.
i Show information about the current selected item. 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.
r Refresh/recalculate the current directory. =item t
q Quit Toggle dirs before files when sorting.
=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.
=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.
=item i
Show information about the current selected item.
=item r
Refresh/recalculate the current directory.
=item q
Quit
=back
HARD LINKS =head1 HARD LINKS
Every disk usage analysis utility has its own way of (not) counting hard
links. There does not seem to be any universally agreed method of handling
hard links, and it is even inconsistent among different versions of ncdu.
This section explains what each version of ncdu does.
ncdu 1.5 and below does not support any hard link detection at all: each Every disk usage analysis utility has its own way of (not) counting hard links.
link is considered a separate inode and its size is counted for every link. There does not seem to be any universally agreed method of handling hard links,
This means that the displayed directory sizes are incorrect when analyzing and it is even inconsistent among different versions of ncdu. This section
explains what each version of ncdu does.
ncdu 1.5 and below does not support any hard link detection at all: each link
is considered a separate inode and its size is counted for every link. This
means that the displayed directory sizes are incorrect when analyzing
directories which contain hard links. directories which contain hard links.
ncdu 1.6 has basic hard link detection: When a link to a previously encoun ncdu 1.6 has basic hard link detection: When a link to a previously encountered
tered inode is detected, the link is considered to have a file size of zero inode is detected, the link is considered to have a file size of zero bytes.
bytes. Its size is not counted again, and the link is indicated in the Its size is not counted again, and the link is indicated in the browser
browser interface with a 'H' mark. The displayed directory sizes are only interface with a 'H' mark. The displayed directory sizes are only correct when
correct when all links to an inode reside within that directory. When this all links to an inode reside within that directory. When this is not the case,
is not the case, the sizes may or may not be correct, depending on which the sizes may or may not be correct, depending on which links were considered
links were considered as "duplicate" and which as "original". The indicated as "duplicate" and which as "original". The indicated size of the topmost
size of the topmost directory (that is, the one specified on the command directory (that is, the one specified on the command line upon starting ncdu)
line upon starting ncdu) is always correct. is always correct.
ncdu 1.7 has improved hard link detection. Each file that has more than two ncdu 1.7 and later has improved hard link detection. Each file that has more
links has the "H" mark visible in the browser interface. Each hard link is than two links has the "H" mark visible in the browser interface. Each hard
counted exactly once for every directory it appears in. The indicated size link is counted exactly once for every directory it appears in. The indicated
of each directory is therefore, correctly, the sum of the sizes of all size of each directory is therefore, correctly, the sum of the sizes of all
unique inodes that can be found in that directory. Note, however, that this unique inodes that can be found in that directory. Note, however, that this may
may not always be same as the space that will be reclaimed after deleting not always be same as the space that will be reclaimed after deleting the
the directory, as some inodes may still be accessible from hard links out directory, as some inodes may still be accessible from hard links outside it.
side it.
BUGS =head1 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.
Some minor glitches may appear when displaying filenames that contain Directory hard links are not supported. They will not be detected as being hard
multibyte or multicolumn characters. links, and will thus be scanned and counted multiple times.
Some minor glitches may appear when displaying filenames that contain multibyte
or multicolumn characters.
Please report any other bugs you may find at the bug tracker, which can be Please report any other bugs you may find at the bug tracker, which can be
found on the web site at http://dev.yorhel.nl/ncdu found on the web site at http://dev.yorhel.nl/ncdu
AUTHOR =head1 AUTHOR
Written by Yoran Heling <projects@yorhel.nl>. Written by Yoran Heling <projects@yorhel.nl>.
SEE ALSO =head1 SEE ALSO
du(1)
L<du(1)>
ncdu-1.8 Nov 3, 2011 ncdu(1)

View file

@ -13,7 +13,7 @@ BEGIN { ($ROOT = abs_path $0) =~ s{index\.cgi$}{}; }
TUWF::register( TUWF::register(
qr{} => sub { podpage(shift, 'home', '', '', "Yorhel's Projects") }, qr{} => sub { podpage(shift, 'home', '', '', "Yorhel's Projects") },
qr{ncdu} => sub { podpage(shift, 'ncdu', 'ncdu', '', 'NCurses Disk Usage') }, qr{ncdu} => sub { podpage(shift, 'ncdu', 'ncdu', '', 'NCurses Disk Usage') },
qr{ncdu/man} => sub { manpage(shift, 'ncdu-man', 'ncdu', 'man', 'Ncdu Manual') }, qr{ncdu/man} => sub { podpage(shift, 'ncdu-man', 'ncdu', 'man', 'Ncdu Manual') },
qr{ncdu/changes} => sub { changelog(shift, 'ncdu-changelog', 'ncdu', 'changes', 'Ncdu Changelog') }, qr{ncdu/changes} => sub { changelog(shift, 'ncdu-changelog', 'ncdu', 'changes', 'Ncdu Changelog') },
qr{ncdu/scr} => sub { podpage(shift, 'ncdu-scr', 'ncdu', 'scr', 'Ncdu Screenshots') }, qr{ncdu/scr} => sub { podpage(shift, 'ncdu-scr', 'ncdu', 'scr', 'Ncdu Screenshots') },
qr{ncdc} => sub { podpage(shift, 'ncdc', 'ncdc', '', 'NCurses Direct Connect') }, qr{ncdc} => sub { podpage(shift, 'ncdc', 'ncdc', '', 'NCurses Direct Connect') },
@ -34,23 +34,14 @@ TUWF::register(
TUWF::set( TUWF::set(
logfile => '/www/err.log', logfile => '/www/err.log',
#pre_request_handler => sub { $ENV{REQUEST_URI} = $_[0]->reqGet('path')||''; 1 },
error_404_handler => \&notfound, error_404_handler => \&notfound,
# this is a fairly static site, allow some aggressive caching
pre_request_handler => sub { $_[0]->resHeader('Cache-Control', 's-max-age=86400, max-age=3600'); 1; },
); );
TUWF::run(); TUWF::run();
sub test {
my $s = shift;
$s->htmlHeader(title => 'Test', page => 'ncdu', sec => 'changes');
(my $f = $INC{"TUWF.pm"}) =~ s/\.pm$/.pod/;
#$s->htmlPOD($f, 1);
$s->htmlPOD('home');
$s->htmlFooter;
}
sub podpage { sub podpage {
my($s, $f, $p, $se, $t, $toc) = @_; my($s, $f, $p, $se, $t, $toc) = @_;
$s->htmlHeader(title => $t, page => $p, sec => $se); $s->htmlHeader(title => $t, page => $p, sec => $se);