1<?xml version="1.0" encoding="utf-8"?> 2<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ 3<!ENTITY legal SYSTEM "legal.xml"> 4<!ENTITY appversion "1.10"> 5<!ENTITY manrevision "1.10"> 6<!ENTITY date "July 2015"> 7<!ENTITY app "Disk Usage Analyzer"> 8]> 9<!-- 10 (Do not remove this comment block.) 11 Maintained by the MATE Documentation Project 12 http://wiki.mate-desktop.org/dev-doc:doc-team-guide 13 Template version: 2.0 beta 14 Template last modified Apr 11, 2002 15 16--> 17<!-- =============Document Header ============================= --> 18<article id="index" lang="mg"> 19<!-- please do not change the id; for translations, change lang to --> 20<!-- appropriate code --> 21 <articleinfo> 22 <title lang="en">Disk Usage Analyzer Manual</title> 23 24 <abstract role="description"> 25 <para lang="en">Disk Usage Analyzer is a graphical, menu-driven viewer that you can 26 use to view and monitor your disk usage and folder structure.</para> 27 </abstract> 28 29 <copyright lang="en"> 30 <year>2015-2021</year> 31 <holder>MATE Documentation Project</holder> 32 </copyright> 33 <copyright lang="en"> 34 <year>2006</year> 35 <holder>Fabio Marzocca</holder> 36 </copyright> 37<!-- translators: uncomment this: 38 39 <copyright> 40 <year>2002</year> 41 <holder>ME-THE-TRANSLATOR (Latin translation)</holder> 42 </copyright> 43 44 --> 45 <publisher> 46 <publishername lang="en">MATE Documentation Project</publishername> 47 </publisher> 48 <publisher> 49 <publishername lang="en">GNOME Documentation Project</publishername> 50 </publisher> 51 52 53 54 <authorgroup> 55 <author role="maintainer" lang="en"> 56 <surname>MATE Documentation Team</surname> 57 <affiliation> 58 <orgname>MATE Desktop</orgname> 59 </affiliation> 60 </author> 61 <author lang="en"> 62 <firstname>Fabio</firstname> 63 <surname>Marzocca</surname> 64 <affiliation> 65 <orgname>GNOME Documentation Project</orgname> 66 <address> <email>thesaltydog@gmail.com</email> </address> 67 </affiliation> 68 </author> 69 70 <author role="maintainer" lang="en"> 71 <firstname>Fabio</firstname> 72 <surname>Marzocca</surname> 73 <affiliation> 74 <address><email>thesaltydog@gmail.com</email></address> 75 </affiliation> 76 </author> 77 78<!-- This is appropriate place for other contributors: translators, 79 maintainers, etc. Commented out by default. 80 <othercredit role="translator"> 81 <firstname>Latin</firstname> 82 <surname>Translator 1</surname> 83 <affiliation> 84 <orgname>Latin Translation Team</orgname> 85 <address> <email>translator@gnome.org</email> </address> 86 </affiliation> 87 <contrib>Latin translation</contrib> 88 </othercredit> 89--> 90 </authorgroup> 91 92 <releaseinfo revision="1.10" role="review"> 93 </releaseinfo> 94 95 <revhistory> 96 <revision lang="en"> 97 <revnumber>Disk Usage Analyzer Manual 1.10</revnumber> 98 <date>July 2015</date> 99 <revdescription> 100 <para role="author" lang="en">Wolfgang Ulbrich 101 </para> 102 <para role="publisher" lang="en">MATE Documentation Project</para> 103 </revdescription> 104 </revision> 105 <revision lang="en"> 106 <revnumber>Disk Usage Analyzer Manual 1.0</revnumber> 107 <date>April 2006</date> 108 <revdescription> 109 <para role="author" lang="en">Emmanuele Bassi 110 <email>ebassi@gmail.com</email> 111 </para> 112 <para role="publisher" lang="en">GNOME Documentation Project</para> 113 </revdescription> 114 </revision> 115 </revhistory> 116 117 <releaseinfo lang="en">This manual describes version 1.10 of Disk Usage Analyzer.</releaseinfo> 118 119 <legalnotice> 120 <title lang="en">Feedback</title> 121 <para lang="en">To report a bug or make a suggestion regarding the Disk Usage Analyzer application or 122 this manual, follow the directions in the 123 <ulink url="help:mate-user-guide/feedback" type="help">MATE Feedback Page</ulink>. 124 </para> 125<!-- Translators may also add here feedback address for translations --> 126 </legalnotice> 127 </articleinfo> 128 129 <indexterm lang="en"> 130 <primary>Disk Usage Analyzer</primary> 131 </indexterm> 132 133<!-- ============= Document Body ============================= --> 134<!-- ============= Introduction ============================== --> 135 136 <sect1 id="baobab-introduction"> 137 <title lang="en">Introduction</title> 138 139 <para lang="en"><application>Disk Usage Analyzer</application> is a graphical, menu-driven 140 application to analyze disk usage in any MATE environment. <application>Disk Usage Analyzer</application> can easily scan 141 either the whole filesystem tree, or a specific user-requested directory 142 branch (local or remote). </para> 143 <para lang="en">It also auto-detects in real-time any changes 144 made to your home directory as far as any mounted/unmounted device. 145 <application>Disk Usage Analyzer</application> also provides a full graphical treemap 146 window for each selected folder.</para> 147 148 </sect1> 149 150<!-- ================ Getting Started ================================ --> 151 <sect1 id="baobab-getting-started"> 152 <title lang="en">Getting Started</title> 153 154 <para lang="en"><application>Disk Usage Analyzer</application> can be started in three ways:</para> 155 <itemizedlist> 156 <listitem><para lang="en">from MATE menu <menuchoice><guimenu>Applications</guimenu><guimenuitem>Accessories</guimenuitem></menuchoice>;</para> 157 </listitem> 158 <listitem><para lang="en">from a terminal window;</para> 159 </listitem> 160 <listitem><para lang="en">from Caja "Open with..." ;</para> 161 </listitem> 162 </itemizedlist> 163 164 165<para lang="en">If you want to start <application>Disk Usage Analyzer</application> from a terminal window, just type:</para> 166 167<para lang="en"><command>mate-disk-usage-analyzer <full_path_to_a_directory></command>, then press <keycap>Return</keycap>.</para> 168<para/> 169 <para lang="en">If launched from MATE menu, <application>Disk Usage Analyzer</application> starts and remains in a stand-by state, waiting for user action.</para> 170 <para lang="en">When you start <application>Disk Usage Analyzer</application> from the MATE Menu, the following window is displayed.</para> 171 172 <!-- ==== Figure ==== --> 173 <figure id="baobab-fig"> 174 <title lang="en">Disk Usage Analyzer Window</title> 175 <screenshot> 176 <mediaobject lang="en"> 177 <imageobject> 178 <imagedata fileref="figures/baobab_window.png" format="PNG"/> 179 </imageobject> 180 <textobject> 181 <phrase>Shows Disk Usage Analyzer main window. Contains menubar, display area, scrollbars, and statusbar. </phrase> 182 </textobject> 183 </mediaobject> 184 </screenshot> 185 </figure> 186 <!-- ==== End of Figure ==== --> 187 188<para lang="en">The user can then:</para> 189 <itemizedlist> 190 <listitem><para lang="en">start a full filesystem scan;</para> 191 </listitem> 192 <listitem><para lang="en">select a specific local directory branch to scan</para> 193 </listitem> 194 <listitem><para lang="en">select a remote server and folder to scan</para> 195 </listitem> 196 <listitem><para lang="en">set preferences</para> 197 </listitem> 198 </itemizedlist> 199 200 201</sect1> 202 203<!-- ================ Usage ================================ --> 204 205 <sect1 id="baobab-usage"> 206 <title lang="en">Usage</title> 207 208 <sect2 id="baobab-fullscan"> 209 <title lang="en">Full filesystem scan</title> 210 <para lang="en">To start a full filesystem scan select <menuchoice><guimenu>Analyzer</guimenu><guimenuitem>Scan Filesystem</guimenuitem></menuchoice> 211 from the menu, or press on the <guibutton>Scan Filesystem</guibutton> toolbar button.</para> 212 213 <para lang="en">When the scanning process ends up, you will get the full tree of your filesystem, 214 like the one in the next Figure.</para> 215 216 <!-- ==== Figure ==== --> 217 <figure id="baobab-fullscan-fig"> 218 <title lang="en">Disk Usage Analyzer Full filesystem scan</title> 219 <screenshot> 220 <mediaobject lang="en"> 221 <imageobject> 222 <imagedata fileref="figures/baobab_fullscan.png" format="PNG"/> 223 </imageobject> 224 <textobject> 225 <phrase>Shows Disk Usage Analyzer full filesystem scan window. Contains menubar, display area, scrollbars, and statusbar. </phrase> 226 </textobject> 227 </mediaobject> 228 </screenshot> 229 </figure> 230 <!-- ==== End of Figure ==== --> 231 232 <note><para lang="en">When you run a full filesystem scan, 233 <application>Disk Usage Analyzer</application> window will start drawing the tree as soon 234 as the thread starts scanning the filesystem. If any large partition is mounted 235 on the filesystem, that will be scanned too.</para></note> 236 237 <para lang="en"><application>Disk Usage Analyzer</application> will display sizes in the 238 directory tree as allocated space. This means that the displayed sizes refer 239 to the actual disk usage and not to the apparent directory size. 240 If you want to view the apparent file size, uncheck <menuchoice><guimenu>View</guimenu><guimenuitem>Allocated Space</guimenuitem></menuchoice> .</para> 241 242 <warning><para lang="en"><application>Disk Usage Analyzer</application> will not count the /proc dir, nor 243 any file size that is not related to a "plain" file, so symlinks, character blocks, 244 device blocks will not be part of the directory size.</para></warning> 245 246 <para lang="en">Hard-links are managed in a different way: this first hardlink is 247 counted as a normal file, while the subsequent links to the same inode device 248 are not counted in the total, but highlighted in the right-hand column of the 249 window.</para> 250 </sect2> 251 252 <sect2 id="baobab-folderscan"> 253 <title lang="en">Single folder scan</title> 254 255 <para lang="en">To start a single folder scan select 256 <menuchoice><guimenu>Analyzer</guimenu><guimenuitem>Scan Folder...</guimenuitem></menuchoice> 257 from the menu, or press on the <guibutton>Scan Folder</guibutton> toolbar button.</para> 258 259 </sect2> 260 261 <sect2 id="baobab-remotescan"> 262 <title lang="en">Remote scan</title> 263 264 <para lang="en">If you need to scan a remote server-folder, just click on the toolbar 265 icon <guibutton>Scan Remote Folder</guibutton> or select <menuchoice><guimenu>Analyzer</guimenu><guimenuitem>Scan Remote Folder</guimenuitem></menuchoice> 266 from the menu and you will get the following dialog box. <application>Disk Usage Analyzer</application> 267 can connect to a server through ssh, ftp, smb, http and https.</para> 268 269 <!-- ==== Figure ==== --> 270 <figure id="baobab-remote-fig"> 271 <title lang="en">Disk Usage Analyzer Remote folder scan</title> 272 <screenshot> 273 <mediaobject lang="en"> 274 <imageobject> 275 <imagedata fileref="figures/baobab_remote.png" format="PNG"/> 276 </imageobject> 277 <textobject> 278 <phrase>Shows Disk Usage Analyzer remote folder dialog window. </phrase> 279 </textobject> 280 </mediaobject> 281 </screenshot> 282 </figure> 283 <!-- ==== End of Figure ==== --> 284 285 </sect2> 286 287 </sect1> 288 289 290<!-- ============= Preferences =============================== --> 291 <sect1 id="baobab-preferences"> 292 <title>Safidy</title> 293 294 <para lang="en">To change the <application>Disk Usage Analyzer</application> application 295 preferences, choose <menuchoice><guimenu>Edit</guimenu><guimenuitem>Preferences</guimenuitem></menuchoice>.</para> 296 297 <!-- ==== Figure ==== --> 298 <figure id="baobab-preferences-fig"> 299 <title lang="en">Disk Usage Analyzer Preferences Window</title> 300 <screenshot> 301 <mediaobject lang="en"> 302 <imageobject> 303 <imagedata fileref="figures/baobab_prefs.png" format="PNG"/> 304 </imageobject> 305 <textobject> 306 <phrase>Preferences window </phrase> 307 </textobject> 308 </mediaobject> 309 </screenshot> 310 </figure> 311 <!-- ==== End of Figure ==== --> 312 313 <sect2 id="baobab-scan-preferences"> 314 <title lang="en">Select devices to be scanned</title> 315 <para lang="en">In the first part of the Preferences window, all detected mounted devices 316 are listed. Click on the checkbox to include/exclude the partition into the 317 filesystem scanning operations. </para> 318 <note><para lang="en">The device mounted on "/" cannot be excluded from the scan.</para></note> 319 </sect2> 320 321 <sect2 id="baobab-monitor-preferences"> 322 <title lang="en">Enable monitoring of home</title> 323 <para lang="en">If this option is checked, <application>Disk Usage Analyzer</application> will 324 constantly monitor any external changes to home directory and warn 325 the user if a file is added/removed.</para> 326 </sect2> 327 </sect1> 328<!-- ================ Treemaps ================================ --> 329 330 <sect1 id="baobab-treemaps"> 331 <title lang="en">Treemaps</title> 332 333 <para lang="en"><guilabel>Treemap</guilabel> concepts have been developed by Ben Shneiderman in the '90s. 334 Read his <ulink type="http" url="http://www.cs.umd.edu/hcil/treemap-history/index.shtml">vision on treemaps</ulink>.</para> 335 336 <!-- ==== Figure ==== --> 337 <figure id="baobab-treemap-fig"> 338 <title lang="en">Disk Usage Analyzer Treemap Window</title> 339 <screenshot> 340 <mediaobject lang="en"> 341 <imageobject> 342 <imagedata fileref="figures/baobab_treemaps.png" format="PNG"/> 343 </imageobject> 344 <textobject> 345 <phrase>Treemap's theory. Shows 2 treemap diagrams </phrase> 346 </textobject> 347 </mediaobject> 348 </screenshot> 349 </figure> 350 <!-- ==== End of Figure ==== --> 351 352 353 <para lang="en">Figure shows an example of treemap's theory. Each node 354 (as shown in the tree diagram) has a name (a letter) and an associated size 355 (a number). The size of leaves may represent for instance the size of individual 356 files, the size of non-leaf nodes is the sum of the sizes of its children.</para> 357 358 <para lang="en">The treemap is constructed via recursive subdivision of the initial rectangle. 359 The size of each sub-rectangle corresponds to the size of the node. 360 The direction of subdivision alternates per level: first horizontally, 361 next vertically, etcetera. As a result, the initial rectangle is partitioned 362 into smaller rectangles, such that the size of each rectangle reflects the size 363 of the leaf. The structure of the tree is also reflected in the treemap, 364 as a result of its construction. Color and annotation can 365 be used to give extra information about the leaves.</para> 366 367 <note><para lang="en">Treemaps are very effective when size is the most important feature to be 368 displayed.</para></note> 369 </sect1> 370 <!-- ================ Ringschart ================================ --> 371 372 <sect1 id="baobab-ringschart"> 373 <title lang="en">Ringschart</title> 374 375 <para lang="en"><guilabel>Ringschart</guilabel> is a graphical 376 representation of the disk usage by a concrete folder. When 377 launching the application, it is notified the usage of 378 the file system as it can be seen in the next figure:</para> 379 380 <!-- ==== Figure ==== --> 381 <figure id="baobab-filesystem_scan"> 382 <title lang="en">Disk Usage Analyzer showing a ringschart with the file system usage</title> 383 <screenshot> 384 <mediaobject lang="en"> 385 <imageobject> 386 <imagedata fileref="figures/baobab_ringschart1.png" format="PNG"/> 387 </imageobject> 388 <textobject> 389 <phrase>After launching the application, it is showed the 390 file system usage. Graphical representation on the right. </phrase> 391 </textobject> 392 </mediaobject> 393 </screenshot> 394 </figure> 395 <!-- ==== End of Figure ==== --> 396 397 <para lang="en">When you start scanning a folder, the tree of subfolders is 398 created and listed on the left side. Each row contains 399 information for the name, how much space it is taking up 400 (percentage and size in KB, MB or GB) and the number of items 401 (adding files and directories). When this process ends up, 402 the <guilabel>Ringschart</guilabel> is drawn on the right 403 side. If you stop it before it has been completed, only a 404 partial representation is done based on the directories whose 405 usage was computed.</para> 406 407 408 <!-- ==== Figure ==== --> 409 <figure id="baobab-folder_scan"> 410 <title lang="en">Disk Usage Analyzer showing a ringschart with the usage of a folder</title> 411 <screenshot> 412 <mediaobject lang="en"> 413 <imageobject> 414 <imagedata fileref="figures/baobab_ringschart2.png" format="PNG"/> 415 </imageobject> 416 <textobject> 417 <phrase>After scanning a folder. </phrase> 418 </textobject> 419 </mediaobject> 420 </screenshot> 421 </figure> 422 <!-- ==== End of Figure ==== --> 423 424 <para lang="en">The <guilabel>Ringschart</guilabel> is composed of a set of 425 nested rings around a central circle. This circle symbolizes the 426 root folder of the partial tree (that is, the folder that the 427 user has selected for scanning). Each ring represents a level in 428 the partial tree, so i.e. the subfolders of the root folder will 429 be represented in the first ring, and deeper levels in the tree 430 correspond to outer rings in the chart. Each subfolder is 431 represented by a sector of the ring, its angle being proportional 432 to the size of the folder's contents, and painted with a different 433 color to ease visualization. Up to five levels can be drawn; in 434 case that a folder in that last fifth level contains even more 435 subfolders, this situation will be pointed by the presence of a 436 black curve close to the edge of that folder's ring sector. When a 437 folder with no further subfolders is selected to be the root of 438 the partial tree, only the inner circle will be drawn. When the 439 mouse pointer hovers one of the folders in the graphic, it will be 440 highlighted and a tooltip will appear with information about its 441 name and size. If there are any subfolders, small gray tooltips 442 will appear, indicating their names. It's possible that not all of 443 the subfolders' names are displayed, to avoid overlappings.</para> 444 445 <para lang="en">You can go up and down the rows in the list (optionally 446 expanding those with subfolders), the graphic representation will 447 change using the selected folder as the root of the partial tree 448 to be represented. The folders can also be navigated from the 449 <guilabel>ringschart</guilabel> itself. If you click with the left 450 button of your mouse inside a folder, you'll move deeper by 451 setting the root of the graphic to that folder. If you press the 452 middle button (no matter the place as long as you click inside the 453 <guilabel>ringschart</guilabel> frame) you'll get the opposite 454 behavior, going back one step in the hierarchy.</para> 455 456 <para lang="en">The percentage of its parent's radius that is used by a given 457 folder is directly proportional to the relation between its own 458 size and its parent's. It's easy to understand that the size of 459 a folder is equal or smaller than its parent's. Although only 460 directories are shown in this graphical representation, files are 461 taken into account to calculate the amount of space occupied by 462 folders.</para> 463 </sect1> 464</article> 465
