<!DOCTYPE article PUBLIC "-//GNOME//DTD DocBook PNG Variant V1.1//EN" [
<!ENTITY version "1.4"> 
]>


<!-- =============Document Header ============================= -->


<article id="index"> 
   <artheader> 
    <title>GDiskFree Manual</title> 
   <copyright>
      <year>2000</year>
      <holder>John Fleck</holder>
    </copyright>
          
     <legalnotice id="legalnotice">
      <para>Permission is granted to copy, distribute and/or modify this document
	under the terms of the <ulink type="help"
	url="gnome-help:fdl"><citetitle>GNU Free Documentation
	    License</citetitle></ulink>, Version 1.1 or any later version 
	published by the Free Software Foundation with no Invariant Sections, 
	no Front-Cover Texts, and no Back-Cover Texts.  A copy of the license
	can be found <ulink type="help" url="gnome-help:fdl">here</ulink>.
      </para>
      <para>Many of the names used by companies to distinguish their products and
	services are claimed as trademarks. Where those names appear in any
	GNOME documentation, and those trademarks are made aware to the members
	of the GNOME Documentation Project, the names have been printed in caps
	or initial caps.
      </para>
    </legalnotice>

    <releaseinfo> 
		  This is version 1.2 of the GDiskFree manual.
     </releaseinfo>
  </artheader>

<!-- =============Document Body ============================= -->

<!-- =============Introduction ============================= -->
  <sect1 id="intro">
      <title>Introduction</title> 

    <para>
      <application>GDiskFree</application> is a program for monitoring
      disk usage on your computer. It is included in the
      <filename>GNOME-Utils</filename> package, which is a
      part of the GNOME desktop environment. This document describes
      version &version; of <application>GDiskFree</application>.
    </para>

    <para>You can start <application>GDiskFree</application> by
      selecting <guimenuitem>GNOME DiskFree</guimenuitem> from the
      <guisubmenu>Utilities</guisubmenu> submenu of the
      <guimenu>System Menu</guimenu>, or by running the command
      <command>gdiskfree</command> on the command line.  
    </para>

     </sect1>


<!-- =============New section============================= --> 

  <sect1 id="usage"> 
    <title>Using GDiskFree</title>
 

      <!-- =========Subsection=========================== -->   
      <sect2 id="mainwin">
      <title>Basic usage</title>
      <para>
	When you start <application>GDiskFree</application>, you see
	the program's <interface>Main window</interface>, as shown in 
	<xref linkend="mainshot">.
<!-- ==============Figure=================================== -->
	<figure id="mainshot">
	  <title>GDiskFree Main Window</title>
	  <screenshot>
	    <screeninfo>GDiskFree Main Window</screeninfo>
	    <graphic fileref="figures/gdiskfree" format="png"
	    srccredit="John Fleck">
	    </graphic>
	  </screenshot>
	</figure>
<!-- ==============End of Figure=================================== -->
      </para>

      <para>You'll see a dial for each of the mounted disk drives
      and/or disk partitions on your computer. The position of the
      pointer, and the number beneath it, indicate the amount of space used on the
      disk.</para>

      <para>Optionally, <application>GDiskFree</application> also displays the
      size of the disk drive.</para>

      <para>The label at the top of each dial identifies the drive
      or partition it's measuring. <filename>/dev/hda1</filename>, for
      example, measures the first partition on the first hard drive
      (hda). <filename>/dev/fd0</filename> indicates it's the first
      floppy disk. Other identifiers can include
      <filename>/dev/sda</filename>, for the first
      <acronym>SCSI</acronym> hard drive, and
      <filename>/dev/sga</filename> for the first generic
      <acronym>SCSI</acronym> device.</para>
     
      <para>By default, the drive's mount point (the directory where the drive
      shows up in your filesystem) will be shown beneath the dial.</para>
  
    </sect2>

      <!-- =========Subsection=========================== -->   
    <sect2 id="menubar">
      <title> Menus</title>
      <para>
         The menu bar, located at the top of the <interface>Main
         Window</interface>, provides the following commands:
      </para>
      <!-- =========List=========================== -->
      <variablelist>
	<varlistentry> <term><guimenu>File</guimenu></term>
          <listitem><para> This menu contains command
	      <menuchoice>
	        <shortcut><keysym>Ctrl-q</keysym>
		</shortcut>
		<guimenuitem>Exit</guimenuitem>
	      </menuchoice>
	     which is self-explanatory.
	    </para>
	  </listitem> 
	</varlistentry> 

	
	<varlistentry> <term><guimenu>Settings</guimenu></term>
          <listitem><para> This menu contains command
	      <menuchoice>
	       
		<guimenuitem>Properties</guimenuitem>
	      </menuchoice>
	     which launches the  <link
		  linkend="prefs"><interface>General Settings
		  </interface>dialog</link>. 
	    </para>
	  </listitem> 
	</varlistentry> 

	



	<varlistentry>
	  <term><guimenu>Help</guimenu></term>
	  <listitem><para>
	      This menu contains commands
	      <itemizedlist>
		<listitem>
		  <para><guimenuitem>Manual</guimenuitem> &mdash;
		    shows this manual
		  </para>
		</listitem>

		<listitem>
		  <para><guimenuitem>About</guimenuitem> &mdash;
		    shows basic information about
		    <application>GDiskFree</application>, such as
		    author's name and version number.
		  </para>
		</listitem>
	      </itemizedlist>

	      </para>
	  </listitem>
	</varlistentry>

	</variablelist>
      <!-- =========End of list=========================== -->
	</sect2>

  </sect1>   

 <sect1 id="prefs">
    <title>Customization</title> 
     <para>
      To change default settings, select
      <guimenuitem>Properties</guimenuitem> command in
      <guimenu>Settings</guimenu> menu. This launches the
      <interface>General Settings</interface> dialog, shown in <xref
      linkend="shot2">. 
     </para>
<!-- ==============Figure=================================== -->
	<figure id="shot2">
	  <title>General Settings dialog</title>
	  <screenshot>
	    <screeninfo>Properties dialog</screeninfo>
	    <graphic fileref="figures/gdiskfree-prefs" format="png"
	    srccredit="John Fleck">
	    </graphic>
	  </screenshot>
	</figure>
<!-- ==============End of Figure=================================== -->
    
<sect2 id="sync">
      <title>Invoking Sync</title>
    <para>The <guilabel>Invoke sync before getting usage
    info</guilabel> check box ensures
    <application>GDiskFree</application> has the most up-to-date data
    when its display is updated. Under normal operating conditions,
    the kernel doesn't
    always immediately write file data to the disks, storing it in a
    memory buffer and then periodically writing to the disks
    to speed up operations. Checking this box forces the kernel to
    update the disk files before GDiskFree's display is updated, ensuring
    up-to-date information. This comes at the cost of slightly slower
    performance.</para>
</sect2> 
    <sect2 id="mountpoints">
      <title>Mount Points</title>
    
  
    <para>Checking the <guilabel>Show drive mount points</guilabel>
    check box displays the mount point beneath each drive. This is the
    equivalent of the directory in your file system in which the
    disk's contents appear.</para>
  </sect2>

    <sect2 id="showdrivesize">
      <title>Show Drive Size</title>
      <para>Checking <guilabel>Show drive size</guilabel> causes
      <application>GDiskFree</application> to display the total size of the disk
      drive.</para>
    </sect2>

 <sect2 id="orientation">
      <title>Orientation</title>
    
    <para><guilabel>Dial Orientation</guilabel> can be used to change
    the appearance of <application>GDiskFree's</application> display,
    either lining the dials up horizontally or stacking them vertically.</para>
  </sect2>
 <sect2 id="updateinterval">
      <title>Update Interval</title>
    
    <para><guilabel>Update interval</guilabel> determines the time, in
    seconds, between <application>GDiskFree</application>
    updates. Change the number by left-clicking with your mouse on the
    slider bar and sliding it to the left or right. The update
    interval, in seconds, displays above the slider bar.</para>

    <warning>
	<title>Warning</title>
	<para>Setting this to 1 second is probably a bad idea, as your
	  computer will spend a substantial portion of its time and energy
	  updating <application>GDiskFree</application> instead of doing
	  real work.</para>
      </warning>
  </sect2>

    <sect2 id="geometry">
      <title>Geometry</title>
      <para>You can also control the size and positioning of
      <application>GDiskFree</application> when launching it from the
      command line with the <command>geometry</command> command line
      option. <command>gdiskfree --geometry 200x300+30+50</command>,
      for example, will create a <application>GDiskFree</application>
      window 200 pixels wide and 300 pixels high, with its top left
      corner located 30 pixels horizontally and 50 pixels vertically
      from the top left corner of your screen.</para>
    </sect2>

  </sect1>





  <sect1 id="authors">
    <title>Authors</title>
     <para>
      <application>GDiskFree</application> was written by Gregory McLean
      (<email>gregm@comstar.net</email>). Please send all comments, suggestions, and bug reports to the
      <ulink url="http://bugzilla.gnome.org" type="http">GNOME bug
      tracking database</ulink>. Instructions for submitting bug reports
      can be found on-line at <ulink
      url="http://bugs.gnome.org/Reporting.html" type="http">
      http://bugs.gnome.org/Reporting.html</ulink>. If you are using GNOME
      1.1 or later, you can also use command
      <command>bug-buddy</command> for submitting bug reports. 
      </para>
    <para>
      This manual was written by John Fleck
      (<email>jfleck@inkstain.net</email>). Please send all comments
      and suggestions regarding the manual to the GNOME Documentation
      Project at <email>docs@gnome.org</email>.  You can also add your
      comments online by using <ulink type="http"
      url="http://developer.gnome.org/projects/gdp/doctable/">GNOME Documentation
      Status Table</ulink>. 
      </para>

   <para>This program was written by Gregory McLean and can be freely
      redistributed under the terms of the <ulink url="gnome-help:gpl">
      GNU General Public License</ulink>
      as published by the Free Software Foundation, either version 2
      of the License, or (at your option) any later version.</para>

    <para>This program is distributed in the hope that it will be
     useful, but WITHOUT ANY WARRANTY; without even the implied warranty of 
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 
     General Public License for more details.</para>

    </sect1>

</article>
















