Warning, /utilities/filelight/doc/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 filelight "<application>Filelight</application>">
0004   <!ENTITY % addindex "IGNORE">
0005   <!ENTITY % English "INCLUDE"><!-- change language only here -->
0006 ]>
0007 
0008 <book id="filelight" lang="&language;">
0009 
0010 <bookinfo>
0011    <title>The &filelight; Handbook</title>
0012    <authorgroup>
0013       <author>
0014          <firstname>Max</firstname>
0015          <surname>Howell</surname>
0016          <affiliation><address><email>max.howell@methylblue.com</email></address></affiliation>
0017       </author>
0018       <author>
0019         <firstname>Martin</firstname>
0020         <surname>Sandsmark</surname>
0021         <affiliation><address><email>martin.sandsmark@kde.org</email></address></affiliation>
0022       </author>
0023       <!-- TRANS:ROLES_OF_TRANSLATORS -->
0024    </authorgroup>
0025    <copyright><year>2006</year><holder>Max Howell</holder></copyright>
0026    <copyright><year>2009</year><holder>Martin Sandsmark</holder></copyright>
0027    <!-- Translators: put here the copyright notice of the translation -->
0028    <legalnotice>&FDLNotice;</legalnotice>
0029    <date>2015-08-04</date>
0030    <releaseinfo>&filelight; 1.21 (Applications 15.08)</releaseinfo>
0031    <abstract><para>Show disk usage and delete unused files.</para></abstract>
0032    <!-- These may be used by search engines -->
0033    <keywordset>
0034       <keyword>KDE</keyword>
0035       <keyword>Filelight</keyword>
0036       <keyword>du</keyword>
0037       <keyword>disk usage</keyword>
0038    </keywordset>
0039 </bookinfo>
0040 
0041 
0042 <chapter id="introduction">
0043    <title>Introduction</title>
0044    <screenshot>
0045       <screeninfo>&filelight; 1.20 Screenshot</screeninfo>
0046       <mediaobject>
0047          <imageobject><imagedata fileref="radial_map.png" format="PNG"/></imageobject>
0048          <textobject><phrase>Screenshot</phrase></textobject>
0049       </mediaobject>
0050    </screenshot>
0051    <para>&filelight; allows you to quickly understand exactly where your diskspace is being used by graphically representing your file system as a set of concentric segmented-rings. You can use it to locate hotspots of disk usage and then manipulate those areas using &dolphin; or &konqueror;.</para>
0052 </chapter>
0053 
0054 
0055 <chapter id="configuring">
0056 <title>Configuring &filelight;</title>
0057 
0058 <para>The &filelight; settings dialog has two tabs for configuring the &filelight; options. The two tabs are <guilabel>Scanning</guilabel> and <guilabel>Appearance</guilabel>. Below is a description of the settings tabs. The &filelight; settings dialog can be found by clicking <menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure Filelight</guimenuitem></menuchoice>.</para>
0059 
0060 <sect1 id="scanning">
0061 <title>Scanning</title>
0062 
0063 <screenshot>
0064 <screeninfo>Scanning Screenshot</screeninfo>
0065 <mediaobject>
0066 <imageobject><imagedata fileref="config_scan.png" format="PNG"/></imageobject>
0067 <textobject><phrase>Screenshot</phrase></textobject>
0068 </mediaobject>
0069 </screenshot>
0070 
0071 <para>The scanning tab allows you to configure how &filelight; scans folders. The <guilabel> Do not scan these folders</guilabel> is used to exclude certain folders from your scan. This option is very useful for skipping folders that you may not have permissions to read, or folders that are part of a virtual filesystem, such as /proc. To add a folder to the list, click the <guibutton>Add...</guibutton> button, this will start a dialog where you can choose the folder of your choice from a tree view. To remove a folder simply select the folder of your choice and click the <guibutton>Remove</guibutton> button.</para>
0072 <para>Using <guilabel>Scan across filesystem boundaries</guilabel> allows scans to enter folders that are part of other filesystems. For example, when unchecked, this will usually prevent the contents of <filename class="directory">/mnt</filename> from being scanned if you scan starting from the root folder <filename class="directory">/</filename>. 
0073 A scan of remote filesystems, &eg; NFS or Samba mounts, can generate high network traffic. To prevent scanning them check <guilabel>Exclude remote filesystems</guilabel>. The next option <guilabel>Exclude removable media</guilabel>
0074 prevents &filelight; from scanning removable media (&eg; &CD-ROM;s).</para>
0075 </sect1>
0076 
0077 <sect1 id="appearance">
0078 <title>Appearance</title>
0079 
0080 <screenshot>
0081 <screeninfo>Appearance Screenshot</screeninfo>
0082 <mediaobject>
0083 <imageobject><imagedata fileref="config_appear.png" format="PNG"/></imageobject>
0084 <textobject><phrase>Screenshot</phrase></textobject>
0085 </mediaobject>
0086 </screenshot>
0087 
0088 <para>The <guilabel>Appearance</guilabel> tab allows you to configure the way &filelight; looks.</para>
0089 <para>The <guilabel>Color scheme</guilabel> section is used to choose a color scheme for &filelight;. The color schemes are <guilabel>Rainbow</guilabel>, <guilabel>System Colors</guilabel>, and <guilabel>High Contrast</guilabel>. There is also a <guilabel>Contrast</guilabel> slider to adjust the contrast of the ring segments for easier viewing.</para>
0090 <para>The <guilabel>Use anti-aliasing</guilabel> check box is used to enable the use of anti-aliasing in the &filelight; view. Selected, this option makes the ring segments have a much cleaner look.</para>
0091 <para>The <guilabel>Vary label font sizes</guilabel> check box is useful when you have files or folders with long names. This option will change the size of the font to allow it to fit in the view better. When this option is enabled a <guilabel>Minimum font size</guilabel> spinbox becomes available for choosing the smallest size font to scale to.
0092 <!-- WhatsThisHelp is different, what is correcct? --></para>
0093 <para>The <guilabel>Show small files</guilabel> option is disabled by default as small files tend to clutter the &filelight; view. Enable this option if you would like to have your small files included in the &filelight; view. These files are merged all into a single <quote>multi-segment</quote>.</para>
0094 
0095 </sect1>
0096 </chapter>
0097 
0098 
0099 <chapter id="using">
0100 <title>Using &filelight;</title>
0101 
0102 <sect1 id="starting">
0103 <title>Starting &filelight;</title>
0104 <para>&filelight; can be started from the application launcher, or from the command-line</para>
0105 
0106 <sect2 id="starting-from-the-menu">
0107 <title>From the Application Launcher</title>
0108 <para>
0109 Open the application menu and move your
0110 cursor up the menu to the <guimenu>Utilities</guimenu> menu item. Choose
0111 <guimenuitem>&filelight;</guimenuitem>.
0112 </para>
0113 </sect2>
0114 
0115 <sect2 id="starting-from-the-command-line">
0116 <title>From the Command Line</title>
0117 <para>
0118 You can start &filelight; by typing its name on the command line.
0119 If you give it a folder name, as in the example below, it will scan that folder.
0120 </para>
0121 <informalexample>
0122 <screen>
0123 <prompt>%</prompt><userinput><command>filelight</command> <option><replaceable>/home</replaceable></option></userinput>
0124 </screen>
0125 </informalexample>
0126 </sect2>
0127 
0128 </sect1>
0129 
0130 <sect1 id="scanning-folders">
0131 <title>Scanning folders</title>
0132 <para>
0133 Scanning a folder shows it's contents as a filemap. To scan a folder, use the scan menu, or type a &URL; straight into the location bar.
0134 </para>
0135 </sect1>
0136 
0137 <sect1 id="exploring-filemaps">
0138 <title>Exploring Filemaps</title>
0139 <para>
0140 Once a scan has completed you will be presented with a filemap that represents the folder you scanned. The filemap is a series of segmented-rings that expand from the center. Brightly colored segments are folders, gray segments are files. Segments are sized in proportion to their filesize. Segments can be nested, so for example, <filename class="directory">/home/mxcl</filename> will be one level outwards and within the bounds of the segment representing <filename class="directory">/home</filename>. Segments are labeled and hovering the mouse over segments will give you more details of that segment and its child segments.
0141 </para>
0142 <screenshot>
0143 <screeninfo>Filemap Screenshot</screeninfo>
0144 <mediaobject>
0145 <imageobject><imagedata fileref="radial_map_context_menu.png" format="PNG"/></imageobject>
0146 <textobject><phrase>Screenshot</phrase></textobject>
0147 </mediaobject>
0148 </screenshot>
0149 <para>
0150 You can open folders with your default file manager or &konsole; using the context menu for that segment. A &MMB; click opens files by mimetype, &eg; images with <application>Gwenview</application>. You can right click a segment to get a context menu for the scanned folder with actions to copy the folder path to the clipboard or delete the folder or file. Left clicking segments will re-center the map on that segment.
0151 </para>
0152 </sect1>
0153 
0154 </chapter>
0155 
0156 
0157 <chapter id="commands">
0158 <title>Menu and Command Reference</title>
0159 
0160 <variablelist>
0161 <title>The Scan Menu</title>
0162 <varlistentry>
0163 <term><menuchoice>
0164 <guimenu>Scan</guimenu>
0165 <guimenuitem>Scan folder..</guimenuitem>
0166 </menuchoice></term>
0167 <listitem><para><action>Offers a folder selection dialog so you can choose a folder to scan.</action></para></listitem>
0168 </varlistentry>
0169 <varlistentry>
0170 <term><menuchoice>
0171 <shortcut>
0172 <keycombo action="simul">&Ctrl;<keysym>Home</keysym></keycombo>
0173 </shortcut>
0174 <guimenu>Scan</guimenu>
0175 <guimenuitem>Scan Home folder</guimenuitem>
0176 </menuchoice></term>
0177 <listitem><para><action>Starts a scan of the user's home folder.</action></para></listitem>
0178 </varlistentry>
0179 
0180 <varlistentry>
0181 <term><menuchoice>
0182 <guimenu>Scan</guimenu>
0183 <guimenuitem>Scan Root folder</guimenuitem>
0184 </menuchoice></term>
0185 <listitem><para><action>Starts a scan of the root folder.</action></para></listitem>
0186 </varlistentry>
0187 
0188 <varlistentry>
0189 <term><menuchoice>
0190 <shortcut>
0191 <keycap>F5</keycap>
0192 </shortcut>
0193 <guimenu>Scan</guimenu>
0194 <guimenuitem>Rescan</guimenuitem>
0195 </menuchoice></term>
0196 <listitem><para><action>Starts a new scan of the current working folder, this is useful when changes have been made to the filesystem.</action></para></listitem>
0197 </varlistentry>
0198 
0199 <varlistentry>
0200 <term><menuchoice>
0201 <shortcut>
0202 &Esc;
0203 </shortcut>
0204 <guimenu>Scan</guimenu>
0205 <guimenuitem>Stop</guimenuitem>
0206 </menuchoice></term>
0207 <listitem><para><action>Stops the current scan.</action></para></listitem>
0208 </varlistentry>
0209 
0210 <varlistentry>
0211 <term><menuchoice>
0212 <shortcut>
0213 <keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo>
0214 </shortcut>
0215 <guimenu>Scan</guimenu>
0216 <guimenuitem>Quit</guimenuitem>
0217 </menuchoice></term>
0218 <listitem><para><action>Quits &filelight;.</action></para></listitem>
0219 </varlistentry>
0220 
0221 </variablelist>
0222 
0223 <variablelist>
0224   <title>The View Menu</title>
0225     <varlistentry>
0226     <term><menuchoice>
0227     <shortcut>
0228     <keycombo action="simul">&Ctrl;<keycap>+</keycap></keycombo>
0229     </shortcut>
0230     <guimenu>View</guimenu>
0231     <guimenuitem>Zoom In</guimenuitem>
0232     </menuchoice></term>
0233     <listitem><para><action>Increase the view of the filemap.</action></para>
0234     </listitem>
0235     </varlistentry>
0236 
0237     <varlistentry>
0238     <term><menuchoice>
0239     <shortcut>
0240     <keycombo action="simul">&Ctrl;<keycap>-</keycap></keycombo>
0241     </shortcut>
0242     <guimenu>View</guimenu>
0243     <guimenuitem>Zoom Out</guimenuitem>
0244     </menuchoice></term>
0245     <listitem><para><action>Decrease the view of the filemap.</action></para>
0246     </listitem>
0247     </varlistentry>
0248 </variablelist>
0249 
0250 <variablelist>
0251 <title>The Go Menu</title>
0252 <varlistentry>
0253 <term><menuchoice>
0254 <shortcut>
0255 <keycombo action="simul">&Alt;<keycap>Up</keycap></keycombo>
0256 </shortcut>
0257 <guimenu>Go</guimenu>
0258 <guimenuitem>Up</guimenuitem>
0259 </menuchoice></term>
0260 <listitem><para><action>Moves you up one step in the filesystem to the parent folder.</action></para></listitem>
0261 </varlistentry>
0262 
0263 <varlistentry>
0264 <term><menuchoice>
0265 <guimenu>Go</guimenu>
0266 <guimenuitem>Back</guimenuitem>
0267 </menuchoice></term>
0268 <listitem><para><action>Moves you one step back in your browsing history of the filesystem.</action></para></listitem>
0269 </varlistentry>
0270 
0271 <varlistentry>
0272 <term><menuchoice>
0273 <guimenu>Go</guimenu>
0274 <guimenuitem>Forward</guimenuitem>
0275 </menuchoice></term>
0276 <listitem><para><action>Moves you one step forward in your browsing history of the filesystem.</action></para></listitem>
0277 </varlistentry>
0278 
0279 </variablelist>
0280 
0281 <para>Additionally &filelight; has the common &kde; <guimenu>Settings</guimenu> and <guimenu>Help</guimenu>
0282 menu items, for more information read the sections about the <ulink url="help:/fundamentals/menus.html#menus-settings"
0283 >Settings Menu</ulink> and <ulink url="help:/fundamentals/menus.html#menus-help">Help Menu</ulink>
0284 of the &kde; Fundamentals.
0285 </para>
0286 </chapter>
0287 
0288 
0289 <chapter id="credits">
0290    <title>Credits and License</title>
0291    <sect1 id="kapp">
0292       <title>&filelight;</title>
0293       <para>Program copyright 2006 Max B. Howell <email>max.howell@methylblue.com</email></para>
0294       <para>Program copyright 2008-2013 Martin Sandsmark <email>martin.sandsmark@kde.org</email></para>
0295       &underGPL;
0296    </sect1>
0297    <sect1 id="Documentation">
0298       <title>Documentation</title>
0299       <para>Documentation copyright 2003 Max B. Howell <email>max.howell@methylblue.com</email></para>
0300       <para>Documentation copyright 2009 Martin Sandsmark <email>martin.sandsmark@kde.org</email></para>
0301       <!-- TRANS:CREDIT_FOR_TRANSLATORS -->
0302       &underFDL;
0303    </sect1>
0304 </chapter>
0305 
0306 &documentation.index;
0307 
0308 </book>
0309 
0310 <!--
0311 Local Variables:
0312 mode: sgml
0313 sgml-minimize-attributes:nil
0314 sgml-general-insert-case:lower
0315 sgml-indent-step:0
0316 sgml-indent-data:nil
0317 End:
0318 -->