xref: /haiku/docs/apps/diskusage/DiskUsage.html (revision 2600324b57fa31cdea1627d584d314f2a579c4a8)
1<html>
2<head>
3<title>DiskUsage</title>
4</head>
5
6<body bgcolor=#ffffff>
7
8<br>
9<br>
10<h2><img src="icon.png">&nbsp;<code>DiskUsage</code><br>
11Volume Utilization Visualizer</h2>
12
13<hr>
14
15
16<h3>What is it?</h3>
17
18<code>DiskUsage</code> shows a graphical representation of how the space on your
19volumes is utilized.  It uses concentric circles to represent different levels
20in the file system hierarchy.  It is useful for answering the question, "Where
21has all my disk space gone?"  And sometimes it's fun just to look at the
22pictures. <p>
23
24Here is a picture of <code>DiskUsage</code> in action, so to speak. <p>
25
26<center><img src="home.png"></center> <p>
27
28The circle in the middle represents my <code>/boot/home</code> directory.
29Each segment of the ring immediately outside that circle represents a file or
30directory within <code>/boot/home</code>.  And so on.
31
32
33<h3>Usage</h3>
34
35<strong>Startup.</strong>  You can launch <code>DiskUsage</code> from the
36<code>Tracker</code>, either directly or by dropping a volume or folder on its
37icon; or from the <code>Terminal</code>, optionally passing the names of one
38or more files or folders as arguments.  If you launch <code>DiskUsage</code>
39without specifying a volume, it will wait until you drop one or more volumes
40or folders on its window or select a volume from the menu.  <p>
41
42While <code>DiskUsage</code> is scanning a volume, it displays a status bar
43showing its progress.  Multiple volumes are scanned in parallel (each in its
44own thread).  You can view the progress on a volume by selecting that volume
45from the menu. <p>
46
47<strong>The main display.</strong>  When <code>DiskUsage</code> finishes scanning
48a volume, it displays a graphical representation of the volume's files and
49directories.  As you move the mouse over each part of the picture, information
50about each file or directory appears in the area at the bottom of the window.
51You can resize the window to increase or decrease the number of levels that
52<code>DiskUsage</code> displays. <p>
53
54<strong>Zooming.</strong>  You can "zoom" in on a directory by clicking the
55primary mouse button on it.  The picture is redrawn with that directory in the
56center circle.  You can zoom out one level by clicking the center circle.  At
57the outermost level, the center circle represents the volume itself, showing
58free and used space as pie slices. <p>
59
60<strong>Pop-up menu.</strong>  Clicking the secondary mouse button on a part
61of the picture pops up a menu with <code>Tracker</code>-like options
62applicable to that file or directory.  For directories, the menu includes an
63option to rescan that directory and its subdirectories (not the entire
64volume).  This is useful since <code>DiskUsage</code> does not monitor changes
65to the file system. <p>
66
67<strong>Drag-and-drop.</strong>  You can drag files and directories from
68<code>DiskUsage</code> to other applications (or to the desktop, the trash, etc.)
69with the primary mouse button.  You can drop volumes and folders on
70<code>DiskUsage</code>'s window to zoom directly to them. <p>
71
72<strong>Other controls.</strong>  The buttons in the top right corner of the
73<code>DiskUsage</code> window rescan the selected volume and display the
74documentation (this file). <p>
75
76<strong>Notes:</strong>
77
78<ul>
79
80<li> If the graphical representation of a file or directory comprises less
81than about two degrees of a circle, it is excluded from the display.
82
83<li> The number of files that <code>DiskUsage</code> reports for a directory
84includes files in subdirectories too.  A directory counts as a file.
85
86<li> <code>DiskUsage</code> ignores symbolic links.
87
88<li> If you don't like the colors <code>DiskUsage</code> uses, you can change
89them with your favorite resource editor.
90
91</ul>
92
93
94<h3>Credits, etc.</h3>
95
96Thanks to Steffen Gerlach for creating the Windows
97<a href="http://www.steffengerlach.de/freeware/index.html">Scanner</a>
98utility, from which I took the idea for using concentric circles to represent
99disk usage. <p>
100
101Thanks to the <a href="http://www.vim.org/">Vim</a> development team for
102creating the best programmer's editor on the planet, with which
103<code>DiskUsage</code>'s original code and documentation were lovingly
104hand-crafted. <p>
105
106Thanks to the folks at <u><font color=#0000ff>B</font><font
107color=#ff0000>e</font></u> for creating such a kick-butt OS.  It has made
108programming fun again. <p>
109
110Thanks to Mike Steed for doing the programming.  All the code is original. <p>
111
112<code>DiskUsage</code> used to be called <code>guido</code> by it's original
113author. The name <code>guido</code> originated from GUI + <code>du</code>
114 -- the command-line disk usage utility.  Plus, one of his favorite languages,
115<a href="http://www.python.org/">Python</a>, was created by a fine programmer
116named Guido.
117
118
119<h3>Known problems</h3>
120
121<ul>
122
123<li> You can drop multiple volumes or folders on the icon, but
124<code>DiskUsage</code> sees only one of them.  Why?
125
126<li> Dropping a floppy disk volume on <code>DiskUsage</code>'s window works, but
127dropping it on the icon does not work (unless you force it by holding the Ctrl
128key while you drag).  <em>Why?!</em>
129
130</ul>
131
132
133<h3>License</h3>
134
135<code>DiskUsage</code> is Copyright (c) 1999 Mike Steed.  You are free to use
136and distribute this software as long as it is accompanied by this documentation
137and copyright notice.  The software comes with no warranty, etc. <p>
138
139<hr>
140
141</body>
142</html>
143