# The &filelight; Handbook

## Introduction

Filelight Screenshot Screenshot

&filelight; allows you to quickly understand exactly where your diskspace is being used by graphically representing your filesystem as a set of concentric segmented-rings. You can use it to locate hotspots of disk usage and then manipulate those areas using Konqueror.

## Configuring &filelight;

The &filelight; settings dialog has two tabs for configuring the &filelight; options. The two tabs are Scanning and Appearance. Below is a description of the settings tabs. The &filelight; settings dialog can be found by clicking Settings Configure Filelight.

### Scanning

Scanning Screenshot Screenshot

The scanning tab allows you to configure how &filelight; scans directories. The Don't scan these directories: is used to excluded certain directories from your scan. This option is very useful for skipping directories that you may not have permissions to read, or directories that are part of a virtual filesystem, such as /proc. To add a directory to the list, click the Add... button, this will start a dialog where you can choose the directory of your choice from a tree view. To remove a directory simply select the directory of your choice and click the Remove button.

### Appearance

Appearance Screenshot Screenshot

The Appearance tab allows you to configure the way &filelight; looks.

The Scheme section is used to choose a color scheme for &filelight;. The color schemes are Rainbow, TDE Colours, and High Contrast. There is also a Contrast: slider to adjust the contrast of the ring segments for easier viewing.

The Use anti-aliasing checkbox is used to enable the use of anti-aliasing in the &filelight; view. Selected, this option makes the ring segments have a much cleaner look.

The Vary label font sizes check box is useful when you have files or directories with long names. This option will change the size of the font to allow it to fit in the view better. When this option is enabled a Minimum font size: spinbox becomes available for choosing the smallest size font to scale to.

The Show small files option is disabled by default as small files tend to clutter the &filelight; view. Enable this option if you would like to have your small files included in the &filelight; view.

## Using &filelight;

### Starting &filelight;

&filelight; can be started from the TDE-Menu, or from the command-line

#### From the TDE-Menu

Open the Menu by clicking on the big "T-like" icon on your panel. This will raise the program menu. Move your cursor up the menu to the Utilities menu item, then to File. Choose Disk Usage Statistics (Filelight).

#### From the Command Line

You can start &filelight; by typing its name on the command line. If you give it a directory name, as in the example below, it will scan that directory.

    %filelight /home

### Scanning Directories

Scanning a directory shows it's contents as a filemap. To scan a directory, use the scan menu, or type a url straight into the location bar.

### Exploring Filemaps

Once a scan has completed you will be presented with a filemap that represents the directory you scanned. The filemap is a series of segmented-rings that expand from the center. Brightly coloured segments are directories, grey segments are files. Segments are sized in proportion to their filesize. Segments can be nested, so for example, /home/mxcl will be one level outwards and within the bounds of the segment representing /home. Segments are labeled and hovering the mouse over segments will give you more details of that segment and its child segments.

Filemap Screenshot Screenshot

You can open directories with Konqueror or Konsole using the context menu for that segment. Middle clicks open files by mimetype, so images with Kuickshow. You can right click the central circle to get a context menu for the scanned directory. Left clicking segments will re-center the map on that segment.

If you want to improve the documentation, We'll happily accept patches :) Thanks.

## Menu and Command Reference

### The Scan Menu

Ctrl o Scan Scan Directory..

- Offers a directory selection dialog so you can choose a directory to scan.

Ctrl Home Scan Scan Home Directory

- Starts a scan of the user's home directory.

Scan Scan Root Directory

- Starts a scan of the root directory.

Scan Recent Scans

- Provides a list of your most recent scanned directories allowing quick access to these directories.

F5 Scan Rescan

- Starts a new scan of the current working directory, this is useful when changes have been made to the filesystem.

Esc Scan Stop

- Stops the current scan.

Ctrl q Scan Quit

- Quits &filelight;.

### The Go Menu

Alt Up Go Up

- Moves you up once in the filesystem.

Alt Left Go Back

- Moves you one step back in your browsing of the filesystem.

Alt Right Go Forward

- Moves you one step forward in your browsing of the filesystem.

### The Settings Menu

Settings Toolbars Show Main Toolbar

- Enables or disable the main application toolbar.

Settings Toolbars Show Location Toolbar

- Enables or disable the location toolbar.

Settings Configure Shortcuts...

- Allows you to configure the &filelight; shortcuts.

Settings Configure Toolbars...

- Allows you to configure the &filelight; toolbar options.

Settings Configure Filelight...

- Starts the Configure &filelight; dialog.

### The Help Menu

Help Filelight Handbook

- Opens this help document.

Shift F1 Help What's This?

- Activates the "What's This?" mouse cursor allowing you to click an object to get a "What's this?" tooltip.

Help Report Bug...

- Starts the bug report tool dialog window.

Help About Filelight

- Starts the About &filelight; dialog window.

Help About TDE

- Starts the About &tde; dialog window.

## Credits and License

### &filelight;

Program copyright 2003 Max B. Howell max.howell@methylblue.com

&underGPL;

### Documentation

Documentation copyright 2003 Max B. Howell max.howell@methylblue.com

&underFDL;

## Installation

### How to obtain &filelight;

&filelight; is now part of the TDE project, it can be found at: http://trinitydesktop.org/.

### Compilation and Installation

In order to compile and install &filelight; on your system, type the following in the base directory of the &filelight; distribution:

    % mkdir -p build
    % cd build
    % cmake ../
    % make
    % make install

Since &filelight; uses cmake you should have not trouble compiling it. Default options for cmake build are available in the INSTALL file.

&documentation.index;