summaryrefslogtreecommitdiffstats
path: root/doc/kdf/index.docbook
blob: 807c51ff7dbbdb68bf690ea1cf46b5b7d9c48196 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
<?xml version="1.0" ?>
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
  <!ENTITY kappname "&kdiskfree;">
  <!ENTITY package "tdeutils">
  <!ENTITY % English "INCLUDE" > <!-- change language only here -->
  <!ENTITY % addindex "IGNORE">
]>

<book lang="&language;">

<bookinfo>
<title>The &kdiskfree; Handbook</title>

<authorgroup>
<author>
&Jonathan.Singer; &Jonathan.Singer.mail;
</author>

<author>
&Michael.Kropfberger; &Michael.Kropfberger.mail;
</author>

<!-- TRANS:ROLES_OF_TRANSLATORS -->

</authorgroup>

<copyright>
<year>2000-2002</year>
<holder>&Jonathan.Singer;</holder>
</copyright>

<legalnotice>&FDLNotice;</legalnotice>

<date>2003-09-16</date>
<releaseinfo>0.</releaseinfo>

<abstract><para>&kdiskfree; displays available file devices, along with
information about them.</para>

</abstract>

<keywordset>
<keyword>KDE</keyword>
<keyword>kdf</keyword>
<keyword>tdeutils</keyword>
<keyword>disks</keyword>
<keyword>devices</keyword>
<keyword>mount</keyword>
<keyword>unmount</keyword>
</keywordset>

</bookinfo>

<chapter id="introduction">
<title>Introduction</title>

<para>&kdiskfree; displays the available file devices (hard drive
partitions, floppy and &CD; drives, &etc;) along with information on
their capacity, free space, type and mount point. It also allows you
to mount and unmount drives and view them in a file manager.</para>

<para>&kdiskfree; is similar to the &kcontrol; Disk-Free module <!--
(<application>kcmdf</application>) -->, but takes up less screen
space. It is useful if you want to keep a &kdiskfree; window available at
all times.</para>

</chapter>

<chapter id="using-kdf">
<title>Using &kdiskfree;</title>

<sect1 id="starting-kdf">
<title>Starting &kdiskfree;</title> 

<para>Type <userinput><command>kdf</command></userinput> at a command
prompt or select <guimenuitem>Disk Free</guimenuitem> from the
<guisubmenu>System</guisubmenu> group in the <guimenu>K</guimenu>
menu. The standard &Qt; and &kde; command options are available, and
can be listed by entering <userinput><command>kdf</command>
<option>--help</option></userinput> at the command prompt.</para>

</sect1>

<sect1 id="main-window">
<title>The Main window</title>

<para>The main &kdiskfree; window displays the available file devices.</para>

<para>Normally, the following pieces of information are included:</para>
<screenshot>
<screeninfo>&kdiskfree; Screen</screeninfo>
        <mediaobject>
          <imageobject>
            <imagedata fileref="kdf.png" format="PNG"/>
          </imageobject>
          <textobject>
            <phrase>&kdiskfree; Screen</phrase>
          </textobject>
        </mediaobject>
</screenshot>

<itemizedlist>
<listitem><para>an icon depicting the type of storage</para></listitem>
<listitem><para>device name</para></listitem>
<listitem><para>filesystem type</para></listitem>
<listitem><para>total size</para></listitem>
<listitem><para>mount point</para></listitem>
<listitem><para>free disk space</para></listitem>
<listitem><para>the percentage of space used as a number and as a
graph.</para></listitem>
</itemizedlist>

<para>In the picture above, four devices are shown: one reiserfs-formatted
hard drive partition mounted at the filesystem root (<filename
class="directory">/</filename>), two &CD-ROM;'s, and a floppy drive.</para>

<para><mousebutton>Left</mousebutton> clicking on the header of a
particular column sorts the devices according to that variable. A
second <mousebutton>left</mousebutton> click sorts in the opposite
order.</para>

<para>Clicking on a row pops up a menu. If that device is not
currently mounted, the <guimenuitem>Mount Device</guimenuitem> option
is available. If the device is mounted, it can be unmounted by
choosing <guimenuitem>Unmount Device</guimenuitem>. Selecting
<guimenuitem>Open in File Manager</guimenuitem> opens a new window with a
graphical view of the files on that device.</para>

</sect1>

<sect1 id="the-menus">
<title>The &kdiskfree; menu bar</title>

<sect2>
<title>The <guimenu>File</guimenu> Menu</title>

<variablelist>
<varlistentry>
<term>
<menuchoice>
<guimenu>File</guimenu>
<guimenuitem>Update</guimenuitem>
</menuchoice></term>
<listitem><para><action>Immediately updates the display to reflect the current
status</action></para></listitem>
</varlistentry>
<varlistentry>

<term>
<menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo>
</shortcut>
<guimenu>File</guimenu>
<guimenuitem>Quit</guimenuitem>
</menuchoice></term>
<listitem><para><action>Closes</action> &kdiskfree;</para></listitem>
</varlistentry>
</variablelist>

</sect2>

<sect2>
<title>The <guimenu>Settings</guimenu> menu and dialog</title>

<variablelist>
<varlistentry>
<term>
<menuchoice><guimenu>Settings</guimenu>
<guimenuitem>Configure Shortcuts...</guimenuitem></menuchoice>
</term>
<listitem>
<para>The standard &kde; dialog for setting shortcuts.</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<menuchoice>
<guimenu>Settings</guimenu>
<guimenuitem>Configure KDiskFree...</guimenuitem>
</menuchoice>
</term>
<listitem><para><action>Opens a configuration dialog.</action></para>
<screenshot>
<screeninfo>Configure &kdiskfree; Screen</screeninfo>
        <mediaobject>
          <imageobject>
            <imagedata fileref="kdf_config.png" format="PNG"/>
          </imageobject>
          <textobject>
            <phrase>Configure &kdiskfree; Screen</phrase>
          </textobject>
        </mediaobject>
</screenshot>

<para>This dialog has two tabbed windows, <guilabel>General Settings</guilabel>
and <guilabel>Mount Commands</guilabel></para>
<variablelist>
<varlistentry>
<term>General Settings</term> <listitem><para>Click on the word
<guilabel>visible</guilabel> or <guilabel>hidden</guilabel> to turn
display of an data field on or off.</para> <para>Change the update
frequency by moving the slider. The value in the box on the left is
the interval (in seconds) between updates of the &kdiskfree; display to
reflect the current status.</para> <para>The File Manager setting
controls the command executed when the <guimenuitem>Open
Filemanager</guimenuitem> pop-up menu item is selected.</para>
<para>There are also two check boxes. One controls if a file manager
window will be automatically opened when a device is mounted. The
other causes an alert window to pop up if a disk gets critically
full.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Mount Commands</guilabel></term>
<listitem><para>Allows the user to specify the mount and unmount commands for a
given device, as well as the icon used to represent it. More information on
these commands can be found on the man page for <application>mount</application> (type
<userinput><command>man</command> <option>mount</option></userinput> at the
command prompt).</para></listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
</variablelist>
</sect2>

<sect2>
<title>The <guimenu>Help</guimenu> menu</title>

&help.menu.documentation;

</sect2>

</sect1>
</chapter>

<chapter id="credits">
<title>Credits and License</title>

<para>&kdiskfree;</para>

<para>Program Copyright &copy; 1998-2000 &Michael.Kropfberger; &Michael.Kropfberger.mail;</para>

<para>Documentation Copyright &copy; 2000 &Jonathan.Singer; &Jonathan.Singer.mail;</para>

&underFDL;
&underGPL;

</chapter>

&documentation.index; 
</book>