
                      "gt5" or "where has my diskspace gone?"
                    \_________________________________________/

Overview
~~~~~~~~
    Years ago, I was proud to own a 80MHz, 16MB RAM PC with a huge 512MB
    harddisk. But even on this incredible huge harddisk my diskspace seemed
    to disappear over the time. So I wrote a little tool to find out, where
    all my diskspace was gone: I called it "gettree", as it showed all files
    in the actual directory and also calculated the size of subtrees.
    Over the years the OS I used changed, but the problem stayed. Using
    Linux, there are some tools to deal with it, but I couldn't find
    something that was clearly laid out, intuitive to browse and doesn't need
    X-Windows.

Features
~~~~~~~~
      - gt5 shows the diskspace 'used by' and the number of entries 'within'
        a given directory,
      - all files and subdirectories with their size and percentage of their
        parent,
      - data which is less than 0.1% of his parent is cut to keep results
        readable,
      - you can easily browse through all subdirectories, using the
        cursor-keys,
      - optionally gt5 gives links to the files, so you can also browse them,
      - the results can be saved to a file, for later use

Implementation
~~~~~~~~~~~~~~
    I tried different ways to do the job and stuck with a small shell-script:
      - it is highly portable, as it only depends on some GNU-utilities,
      - it uses 'links', a textbrowser, for browsing the results,
      - it runs on console, xterm or remote over ssh

Screenshot
~~~~~~~~~~
    .____________________________________________________________________.
    |                                                                    |
    | gt5 v1.0 (pearl:/usr/src/linux): [921 lines (%<0.1) cut]           |
    |                                                                    |
    |     ----------------------------------------------------------     |
    |                                                                    |
    | ./:   [188MB in 23 files or directories, 12 lines cut]             |
    |                                                                    |
    |    90M [48.0%] ./drivers/                                          |
    |    36M [19.5%] ./arch/                                             |
    |    28M [14.9%] ./include/                                          |
    |    15M [ 8.3%] ./fs/                                               |
    |   8.6M [ 4.6%] ./net/                                              |
    |   6.5M [ 3.5%] ./Documentation/                                    |
    |   540K [ 0.3%] ./scripts/                                          |
    |   452K [ 0.2%] ./mm/                                               |
    |   428K [ 0.2%] ./crypto/                                           |
    |   408K [ 0.2%] ./kernel/                                           |
    |   396K [ 0.2%] ./lib/                                              |
    |                                                                    |
    |     ----------------------------------------------------------     |
    |____________________________________________________________________|


Navigation
~~~~~~~~~~
    If you are familiar to 'links' there is nothing to say: gt5's output is
    an HTML file, go browse it. If you don't know 'links': It is a
    Textmode-(HTML-)Browser. Here are the important Keys:

                     .---------------------------------------------------.
                     |   browsing in generel   |   meaning in gt5        |
    ======================================================================
    | Cursor Left    | go back                 | go one directory up     |
    |----------------|-------------------------|-------------------------|
    | Cursor Right   | follow link             | open directory          |
    |----------------|-------------------------|-------------------------|
    | Cursor Up/Down | go to link above/below  | move Cursor Up/Down     |
    |----------------|-------------------------|-------------------------|
    | Ctrl-C         | quit 'links'            | quit 'gt5'              |
    |----------------|-------------------------|-------------------------|
    | Insert/Delete  | scroll one line up/down | scroll one line up/down |
    |----------------|-------------------------|-------------------------|
    | "[" / "]"      | scroll page left/right  | scroll page left/right  |
    |----------------|-------------------------|-------------------------|
    | PgUp/PgDown    | scroll one page up/down | scroll one page up/down |
    |----------------|-------------------------|-------------------------|
    | Escape         | open links menu         | open links menu         |
    '--------------------------------------------------------------------'

Usage
~~~~~
    Syntax: gt5 [dir] [none, one or more of the following options]
         dir         the directory you want do check for used space
       --cut-at      don't show files below 'float'% of his parent
                     default is 0.1, use values between 0.01 and 39
       --keep-as     don't try to open results in browser, save them
       --min-kb      ignore anything below 'int'KB. This can give a
                     huge speedup on older boxes but directories that
                     content is below 'int'KB are shown as files
       --link-files  insert links to files for direct access

Known Problems
~~~~~~~~~~~~~~
    gt5 needs several MB of diskspace to store temporary data. These data
    will be deleted if you close the browser, but if you have much less than
    100MB of diskspace gt5 probably can't do his job. At the moment gt5 works
    good for me; if there is someone out there using this software, I will
    change it. :-)

Download
~~~~~~~~
    Files are hosted on SourceForge.net:
      http://sourceforge.net/project/showfiles.php?group_id=122114

Contact
~~~~~~~
    If you have any question/suggestion, feel free to contact me via
      http://sourceforge.net/users/tsattler/

