Warning, /utilities/kdf/doc/app/index.docbook is written in an unsupported language. File is not indexed.

0001 <?xml version="1.0" ?>
0002 <!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN" "dtd/kdedbx45.dtd" [
0003   <!ENTITY kappname "&kdiskfree;">
0004   <!ENTITY % English "INCLUDE" > <!-- change language only here -->
0005   <!ENTITY % addindex "IGNORE">
0006 ]>
0007 
0008 <book id="kdf" lang="&language;">
0009 
0010 <bookinfo>
0011 <title>The &kdiskfree; Handbook</title>
0012 
0013 <authorgroup>
0014 <author>
0015 &Jonathan.Singer; &Jonathan.Singer.mail;
0016 </author>
0017 
0018 <author>
0019 &Michael.Kropfberger; &Michael.Kropfberger.mail;
0020 </author>
0021 
0022 <!-- TRANS:ROLES_OF_TRANSLATORS -->
0023 
0024 </authorgroup>
0025 
0026 <copyright>
0027 <year>2000-2002</year>
0028 <holder>&Jonathan.Singer;</holder>
0029 </copyright>
0030 
0031 <legalnotice>&FDLNotice;</legalnotice>
0032 
0033 <date>2016-04-13</date>
0034 <releaseinfo>Applications 16.08</releaseinfo>
0035 
0036 <abstract><para>&kdiskfree; displays available file devices, along with
0037 information about them.</para>
0038 
0039 </abstract>
0040 
0041 <keywordset>
0042 <keyword>KDE</keyword>
0043 <keyword>kdf</keyword>
0044 <keyword>kdeutils</keyword>
0045 <keyword>disks</keyword>
0046 <keyword>devices</keyword>
0047 <keyword>mount</keyword>
0048 <keyword>unmount</keyword>
0049 </keywordset>
0050 
0051 </bookinfo>
0052 
0053 <chapter id="introduction">
0054 <title>Introduction</title>
0055 
0056 <para>&kdiskfree; displays the available file devices (hard drive
0057 partitions, floppy and &CD; drives, USB sticks &etc;) along with information on
0058 their capacity, free space, type and mount point. It also allows you
0059 to mount and unmount drives and view them in a file manager.</para>
0060 
0061 <para>&kdiskfree; is similar to the &systemsettings; Storage Devices module, 
0062 but takes up less screen
0063 space. It is useful if you want to keep a &kdiskfree; window available at
0064 all times.</para>
0065 
0066 </chapter>
0067 
0068 <chapter id="using-kdf">
0069 <title>Using &kdiskfree;</title>
0070 
0071 <sect1 id="starting-kdf">
0072 <title>Starting &kdiskfree;</title> 
0073 
0074 <para>Type <userinput><command>kdf</command></userinput> at a command
0075 prompt or select <guimenuitem>KDiskFree</guimenuitem> from the
0076 <guisubmenu>System</guisubmenu> group in the application 
0077 launcher. The standard &Qt; and &kde; command options are available, and
0078 can be listed by entering <userinput><command>kdf</command>
0079 <option>--help</option></userinput> at the command prompt.</para>
0080 
0081 <para>To run the application as an applet in the systemtray, use 
0082 <menuchoice><guisubmenu>System</guisubmenu><guimenuitem>KwikDisk</guimenuitem></menuchoice>
0083 in application launcher.</para>
0084 
0085 <para>The features of &kdiskfree; are also available in the &systemsettings; module
0086 <guilabel>Storage Devices</guilabel>.</para>
0087 </sect1>
0088 
0089 <sect1 id="main-window">
0090 <title>The Main window</title>
0091 
0092 <para>The main &kdiskfree; window displays the available file devices.</para>
0093 
0094 <para>Normally, the following pieces of information are included:</para>
0095 <screenshot>
0096 <screeninfo>&kdiskfree; Screen</screeninfo>
0097         <mediaobject>
0098           <imageobject>
0099             <imagedata fileref="kdf.png" format="PNG"/>
0100           </imageobject>
0101           <textobject>
0102             <phrase>&kdiskfree; Screen</phrase>
0103           </textobject>
0104         </mediaobject>
0105 </screenshot>
0106 
0107 <itemizedlist>
0108 <listitem><para>an icon depicting the type of storage</para></listitem>
0109 <listitem><para>device name</para></listitem>
0110 <listitem><para>filesystem type</para></listitem>
0111 <listitem><para>total size</para></listitem>
0112 <listitem><para>mount point</para></listitem>
0113 <listitem><para>free disk space</para></listitem>
0114 <listitem><para>the percentage of space used as a number and as a
0115 graph.</para></listitem>
0116 </itemizedlist>
0117 
0118 <para><mousebutton>Left</mousebutton> clicking on the header of a
0119 particular column sorts the devices according to that variable. A
0120 second <mousebutton>left</mousebutton> click sorts in the opposite
0121 order.</para>
0122 
0123 <para>Clicking with the &RMB; on a row pops up a menu. If that device is not
0124 currently mounted, the <guimenuitem>Mount Device</guimenuitem> option
0125 is available. If the device is mounted, it can be unmounted by
0126 choosing <guimenuitem>Unmount Device</guimenuitem>. Selecting
0127 <guimenuitem>Open in File Manager</guimenuitem> opens a new window with a
0128 graphical view of the files on that device.</para>
0129 <para>The setting for the file manager used by &kdiskfree; is independent from the choice
0130 in the &systemsettings; module <guilabel>Default Applications</guilabel>.</para>
0131 </sect1>
0132 
0133 <sect1 id="menus-and-configuration">
0134 <title>Menu Bar and Configuration</title>
0135 
0136 <sect2>
0137 <title>The File Menu</title>
0138 
0139 <variablelist>
0140 <varlistentry>
0141 <term>
0142 <menuchoice>
0143 <shortcut><keycap>F5</keycap></shortcut>
0144 <guimenu>File</guimenu>
0145 <guimenuitem>Update</guimenuitem>
0146 </menuchoice></term>
0147 <listitem><para><action>Immediately updates the display to reflect the current
0148 status</action></para></listitem>
0149 </varlistentry>
0150 <varlistentry>
0151 
0152 <term>
0153 <menuchoice>
0154 <shortcut>
0155 <keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo>
0156 </shortcut>
0157 <guimenu>File</guimenu>
0158 <guimenuitem>Quit</guimenuitem>
0159 </menuchoice></term>
0160 <listitem><para><action>Closes</action> &kdiskfree;</para></listitem>
0161 </varlistentry>
0162 </variablelist>
0163 
0164 <para>
0165 Additionally &kdiskfree; has some common &kde; <guimenu>Settings</guimenu> and <guimenu>Help</guimenu>
0166 menu items, for more information read the sections about the <ulink url="help:/fundamentals/menus.html#menus-settings"
0167 >Settings Menu</ulink> and <ulink url="help:/fundamentals/menus.html#menus-help">Help Menu</ulink>
0168 of the &kde; Fundamentals.
0169 </para>
0170 
0171 </sect2>
0172 
0173 <sect2>
0174 <title>The Settings Dialog</title>
0175 
0176 <screenshot>
0177 <screeninfo>Configure &kdiskfree; Screen</screeninfo>
0178         <mediaobject>
0179           <imageobject>
0180             <imagedata fileref="kdf_config.png" format="PNG"/>
0181           </imageobject>
0182           <textobject>
0183             <phrase>Configure &kdiskfree; Screen</phrase>
0184           </textobject>
0185         </mediaobject>
0186 </screenshot>
0187 
0188 <para>This dialog has two tabbed windows, <guilabel>General Settings</guilabel>
0189 and <guilabel>Mount Commands</guilabel></para>
0190 <variablelist>
0191 <varlistentry>
0192 <term>General Settings</term> <listitem><para>Click on the word
0193 <guilabel>visible</guilabel> or <guilabel>hidden</guilabel> to turn
0194 display of an data field on or off.</para> <para>Change the update
0195 frequency by editing the value. The value in the box is
0196 the interval (in seconds) between updates of the &kdiskfree; display to
0197 reflect the current status.</para> <para>The <guilabel>File Manager</guilabel> setting
0198 controls the command executed when the <guimenuitem>Open
0199 Filemanager</guimenuitem> popup menu item is selected.</para>
0200 <para>There are also two check boxes. One controls if a file manager
0201 window will be automatically opened when a device is mounted. The
0202 other causes an alert window to pop up if a disk gets critically
0203 full.</para>
0204 </listitem>
0205 </varlistentry>
0206 <varlistentry>
0207 <term><guilabel>Mount Commands</guilabel></term>
0208 <listitem><para>Allows the user to specify the mount and unmount commands for a
0209 given device, as well as the icon used to represent it. More information on
0210 these commands can be found on the man page for <application>mount</application> (type
0211 <userinput><command>man</command> <option>mount</option></userinput> at the
0212 command prompt).</para></listitem>
0213 </varlistentry>
0214 </variablelist>
0215 
0216 </sect2>
0217 
0218 </sect1>
0219 </chapter>
0220 
0221 <chapter id="credits">
0222 <title>Credits and License</title>
0223 
0224 <para>&kdiskfree;</para>
0225 
0226 <para>Program Copyright &copy; 1998-2000 &Michael.Kropfberger; &Michael.Kropfberger.mail;</para>
0227 
0228 <para>Documentation Copyright &copy; 2000 &Jonathan.Singer; &Jonathan.Singer.mail;</para>
0229 
0230 <!-- TRANS:CREDIT_FOR_TRANSLATORS -->
0231 &underFDL;
0232 &underGPL;
0233 
0234 </chapter>
0235 
0236 &documentation.index; 
0237 </book>
0238 
0239 <!--
0240 Local Variables:
0241 mode: sgml
0242 sgml-minimize-attributes:nil
0243 sgml-general-insert-case:lower
0244 sgml-indent-step:0
0245 sgml-indent-data:nil
0246 End:
0247 
0248 // vim:ts=2:sw=2:tw=78:noet
0249 -->