github.com/robhaswell/grandperspective-scan@v0.1.0/README.md (about)

     1  # gpscan
     2  A utility to create GrandPerspective scan files on other operating systems.
     3  
     4  ## What does it do?
     5  
     6  [GrandPerspective](http://grandperspectiv.sourceforge.net/) is a small utility application for OSX that graphically shows the disk usage of a file system.
     7  
     8  ![Screenshot of GrandPerspective](resources/screenshot.png?raw=true "GrandPerspective")
     9  
    10  `gpscan` is a cross-platform utility which can be run on almost any operating which will create scan data files which can be loaded by GrandPerspective to visualize disk usage on non-OSX operating systems.
    11  
    12  ![Screenshot of GrandPerspective's File menu demonstrating the Load Scan Data option](resources/load.png?raw=true "Load Save Data")
    13  
    14  The Go source code can be cross-compiled for a large selection of platforms.
    15  
    16  ## Why was it created?
    17  
    18  I wanted to use GrandPerspective (or any Sequoia View-clone) to visualize disk usage on a Linux server that I administrate.
    19  Unfortunately I only have access to Windows and OSX GUI environments.
    20  
    21  ## How do I use it?
    22  
    23  `gpscan` takes two arguments: The directory to scan, and a filename to save the result to.
    24  It is recommended that you use a `.gpscan` file extension so that the file is automatically opened with GrandPerspective.
    25  You can pass `-` as an output file in order to output to standard output.
    26  
    27  ```bash
    28  $ gpscan path/to/dir scan.gpscan
    29  ```
    30  
    31  ## How do I install it?
    32  
    33  Download a relevant release, unzip and copy to a location in your `$PATH`, e.g. `/usr/local/bin/gpscan`.
    34  
    35  # Project status
    36  
    37  This project is developed only to the point where I could complete my original task, however I will gladly review pull-requests and take bug reports in the Issues section.