Warning, /utilities/kfind/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 % addindex "IGNORE">
0004   <!ENTITY % English "INCLUDE"> 
0005 ]>
0006 
0007 <book id="kfind" lang="&language;">
0008 
0009 <bookinfo>
0010 <title>The &kfind; Handbook</title>
0011 
0012 <authorgroup>
0013 <author>&Dirk.Doerflinger; &Dirk.Doerflinger.mail;</author>
0014 
0015 <!-- TRANS:ROLES_OF_TRANSLATORS -->
0016 
0017 </authorgroup>
0018 
0019 <copyright>
0020 <year>2001</year>
0021 <holder>&Dirk.Doerflinger;</holder>
0022 </copyright>
0023 
0024 <legalnotice>&FDLNotice;</legalnotice>
0025 
0026 <date>2018-10-22</date>
0027 <releaseinfo>Applications 18.12</releaseinfo>
0028 
0029 <abstract>
0030 <para>
0031 &kfind; is a file find utility by &kde;.
0032 </para>
0033 </abstract>
0034 
0035 <keywordset>
0036 <keyword>KDE</keyword>
0037 <keyword>file</keyword>
0038 <keyword>kfind</keyword>
0039 <keyword>find</keyword>
0040 <keyword>search</keyword>
0041 </keywordset>
0042 </bookinfo>
0043 
0044 <chapter id="introduction">
0045 <title>Introduction</title>
0046 
0047 <para>
0048 &kfind; is a file find utility by &kde;.
0049 </para>
0050 
0051 <sect1 id="starting">
0052 <title>Launching &kfind;</title>
0053 
0054 <para>
0055 The Find Files tool is a useful method of searching for specific files on your
0056 computer, or for searching for files that match a pattern. An example of
0057 this could include searching for files of a particular type or with certain
0058 letters in the filename.
0059 
0060 You can load this utility in &konqueror; (in file manager mode) 
0061 by selecting <menuchoice><shortcut><keycombo action="simul">&Ctrl;
0062 <keycap>F</keycap></keycombo></shortcut><guimenu>Tools</guimenu>
0063 <guimenuitem>Find File</guimenuitem></menuchoice> from the menu. 
0064 If you want to use &kfind; as a standalone search tool, launch it by using &krunner;.
0065 </para>
0066 
0067 </sect1>
0068 </chapter>
0069 
0070 <chapter id="using-kfind">
0071 <title>Finding Files</title>
0072 
0073 <sect1 id="name-tab">
0074 <title>The Name/Location Tab</title>
0075 
0076 <para>
0077 When starting &kfind;, you will see a quite simple window. Type in the
0078 name of the file you are searching for in the text box labeled
0079 <guilabel>Named:</guilabel>. You can use wildcard matching and 
0080 a semicolon (<quote>;</quote>) for separating multiple names.</para>
0081 <para>Choose a folder where you want to search
0082 by typing it in the field <guilabel>Look in:</guilabel>
0083 or by clicking <guibutton>Browse...</guibutton> (you can toggle the 
0084 display of the hidden files and folder in the dialog using the shortcuts 
0085 <keycombo action="simul">&Alt;<keycap>.</keycap></keycombo> or <keycap>F8</keycap>) 
0086 and press &Enter; or click the <guibutton>Find</guibutton> button. 
0087 Use the <guibutton>Stop</guibutton> button to cancel a search.
0088 A search result can be saved in &HTML; format or as plain text with the
0089 <guibutton>Save As...</guibutton> button.</para>
0090 <para>
0091 If <guilabel>Include subfolders</guilabel> is checked all
0092 subfolders starting from your chosen folder will be searched
0093 too. If you enable <guilabel>Case sensitive search</guilabel>, &kfind; will
0094 only find files with the exact case matching names.
0095 Enable the option <guilabel>Show hidden files</guilabel> to include
0096 them in your search.
0097 Selecting <guilabel>Use files index</guilabel> lets you use the 
0098 files' index created by the <quote>locate</quote> package 
0099 to speed-up the search.</para>
0100 <para>
0101 You can use the following wildcards for file or folder names:
0102 </para>
0103 
0104 <variablelist>
0105 <varlistentry>
0106 <term>The Asterisk <quote><keycap>*</keycap></quote></term>
0107 <listitem>
0108 <para>
0109 The asterisk stands for any number of missing characters (even zero),
0110 that means &eg; searching for <userinput>marc*</userinput> may find the
0111 files <filename>marc</filename>, <filename>marc.png</filename> and
0112 <filename> marc_must_not_read_this.kwd</filename>. 
0113 <userinput>mar*.kwd</userinput> may find
0114 <filename>marketplace.kwd</filename> and
0115 <filename>marc_must_not_read_this.kwd</filename>.
0116 </para>
0117 </listitem>
0118 </varlistentry>
0119 
0120 <varlistentry>
0121 <term>The Question Mark <quote><keycap>?</keycap></quote></term>
0122 <listitem>
0123 <para>
0124 In contrast to the asterisk, the question mark stands for exactly one
0125 character, so <userinput>mar?</userinput> will find
0126 <filename>marc</filename>, but <userinput>marc?</userinput> will not find
0127 anything, as our files are called <filename>marc</filename> and
0128 <filename>marc.png</filename>. You can put as many question marks in the
0129 term as you want, it will find exactly that number of characters.
0130 </para>
0131 </listitem>
0132 </varlistentry>
0133 
0134 <varlistentry>
0135 <term>The Character Set <quote>[...]</quote></term>
0136 <listitem>
0137 <para>
0138 This matches any of the characters between the braces.
0139 </para>
0140 </listitem>
0141 </varlistentry>
0142 
0143 </variablelist>
0144 
0145 <para>
0146 Of course you can combine two or more wildcard symbols in a search term.
0147 </para>
0148 
0149 <para>
0150 The results of your search will be displayed in the box below. A click with the
0151 &RMB; on a selection in this box opens a context menu with a list of
0152 actions for the selected files or folders.
0153 </para>
0154 
0155 </sect1>
0156 
0157 <sect1 id="kfind-date-range">
0158 <title>The Contents Tab</title>
0159 
0160 <variablelist>
0161 <varlistentry>
0162 <term><guilabel>File type</guilabel></term>
0163 <listitem>
0164 <para>
0165 Here you can specify the type of file you are searching for.
0166 </para>
0167 </listitem>
0168 </varlistentry>
0169 
0170 <varlistentry>
0171 <term><guilabel>Containing text</guilabel></term>
0172 <listitem>
0173 <para>
0174 Type in the word or phrase the files you are searching for must
0175 contain. Note: If you do this in a large folder or checked
0176 <guilabel>Include subfolders</guilabel> in the
0177 <guilabel>Name/Location</guilabel> tab, this may take a long time.
0178 </para>
0179 
0180 <note>
0181 <para>This option will <emphasis>not</emphasis> work for all files listed 
0182 under <guilabel>File type</guilabel>. Only the following file types
0183 are supported:
0184 <itemizedlist>
0185 <listitem><para>Text files, &eg; source code and <filename>README</filename> files</para></listitem>
0186 <listitem><para>OpenOffice.org Writer / LibreOffice Writer</para></listitem>
0187 <listitem><para>OpenOffice.org Impress / LibreOffice Impress</para></listitem>
0188 <listitem><para>OpenOffice.org Calc / LibreOffice Calc</para></listitem>
0189 <listitem><para>Calligra Words</para></listitem>
0190 <listitem><para>Calligra Sheets</para></listitem>
0191 <listitem><para>Calligra Stage</para></listitem>
0192 </itemizedlist>
0193 
0194 </para>
0195 </note>
0196 
0197 </listitem>
0198 </varlistentry>
0199 
0200 <varlistentry>
0201 <term><guilabel>Case sensitive</guilabel></term>
0202 <listitem>
0203 <para>
0204 If you enable this option, &kfind; will
0205 only find text in files with the exact case matching, &eg;
0206 <userinput>MARC</userinput> will only match
0207 <quote>MARC</quote>, not <quote>Marc</quote>.
0208 </para>
0209 </listitem>
0210 </varlistentry>
0211 
0212 <varlistentry>
0213 <term><guilabel>Regular expression</guilabel></term>
0214 <listitem><para>If you have installed the &kregexpeditor; tool from
0215 playground/utils on the &kde; git server, you will have this additional option.  Enabling
0216 it will allow you to search for a <firstterm>regexp</firstterm> or
0217 regular expression.  A regexp is a way to specify conditions for your
0218 search, and they can be very complex, and equally they can be very
0219 powerful.  If you are unfamiliar with regular expressions, you can
0220 choose <guibutton>Edit</guibutton> button to open
0221 &kregexpeditor;.  This tool allows you to construct your set of
0222 conditions graphically, and then generates the expression for
0223 you.</para>
0224 
0225 <para>&kregexpeditor; is a very useful tool, and can be used from within
0226 many &kde; applications other than &kfind;.  You can find more
0227 information from within its own help file.</para>
0228 </listitem>
0229 </varlistentry>
0230 <varlistentry>
0231 <term><guilabel>Include binary files</guilabel></term>
0232 <listitem><para>This lets you search in any type of file, even those that 
0233 usually do not contain text (for example program files and images).</para>
0234 </listitem>
0235 </varlistentry>
0236 
0237 <varlistentry>
0238 <term><guilabel>Search metainfo sections</guilabel></term>
0239 <listitem>
0240 <para>
0241 These two fields can be used to search within files' specific comments or metainfo.
0242 </para>
0243 <para>
0244     Here are some major cases:
0245 </para>
0246 <itemizedlist>
0247     <listitem>
0248         <para>
0249             <emphasis>Video files (avi, mp4, &etc;)</emphasis>: specify some tag (<userinput>Bitrate</userinput>, <userinput>Duration</userinput>, &etc;) and its value to find items which have the specified parameter value in their metadata.
0250         </para>
0251     </listitem>
0252     <listitem>
0253         <para>
0254             <emphasis>Images (png, jpeg, &etc;)</emphasis>: specify some tag (<userinput>Width</userinput>, <userinput>Height</userinput>, &etc;) and its value to find items which have the specified parameter value in their metadata.
0255         </para>
0256     </listitem>
0257     <listitem>
0258         <para>
0259             <emphasis>Audio files (mp3, flac, &etc;)</emphasis>: specify some tag (<userinput>Title</userinput>, <userinput>Album</userinput>, &etc;) and its value to find items which have the specified parameter value in their metadata.
0260         </para>
0261     </listitem>
0262     <listitem>
0263         <para>
0264             <emphasis>Ebooks (epub, azw, fb2, &etc;)</emphasis>: specify some tag (<userinput>Title</userinput>, <userinput>Author</userinput>, &etc;) and its value to find items which have the specified parameter value in their metadata.
0265         </para>
0266     </listitem>
0267 </itemizedlist>
0268 <note>
0269     <para>
0270         If there is a translation of the tags into your language you can use the localized tag names in the search criterion.
0271     </para>
0272 </note>
0273 </listitem>
0274 </varlistentry>
0275 </variablelist>
0276 
0277 </sect1>
0278 
0279 <sect1 id="kfind-advanced">
0280 <title>The Properties Tab</title>
0281 
0282 <para>
0283 Here you can refine your search. These are the special refinements 
0284 you can choose:
0285 </para>
0286 
0287 <variablelist>
0288 
0289 <varlistentry>
0290 <term><guilabel>Find all files created or modified</guilabel></term>
0291 <listitem>
0292 <para>
0293 Here you can either enter two dates, between which the
0294 files were created or modified, or specify a time period.
0295 </para>
0296 </listitem>
0297 </varlistentry>
0298 
0299 <varlistentry>
0300 <term><guilabel>File size is</guilabel></term>
0301 <listitem>
0302 <para>Here you can specify if the file has to be at least or at most as
0303 big as the size you entered in the following box, or else equal
0304 to the size.
0305 </para>
0306 </listitem>
0307 </varlistentry>
0308 
0309 <varlistentry>
0310 <term><guilabel>Files owned by user</guilabel>, <guilabel>Files owned by group</guilabel></term>
0311 <listitem>
0312 <para>Here you can specify user and group names as owner of the files.
0313 </para>
0314 </listitem>
0315 </varlistentry>
0316 
0317 </variablelist>
0318 
0319 </sect1>
0320 
0321 </chapter>
0322 
0323 <chapter id="credits">
0324 
0325 <title>Credits and License</title>
0326 
0327 <para>
0328 &kfind; 
0329 </para>
0330 
0331 <para>
0332 Program copyright:
0333 </para>
0334 
0335 <itemizedlist>
0336 <title>Developers</title>
0337 <listitem>
0338 <para>Martin Hartig</para>
0339 </listitem>
0340 
0341 <listitem>
0342 <para>&Stephan.Kulow; &Stephan.Kulow.mail;</para>
0343 </listitem>
0344 
0345 <listitem>
0346 <para>&Mario.Weilguni; &Mario.Weilguni.mail;</para>
0347 </listitem>
0348 
0349 <listitem>
0350 <para>&Alex.Zepeda; <email>jazepeda@pacbell.net</email></para>
0351 </listitem>
0352 
0353 <listitem>
0354 <para>Miroslav FlĂ­dr <email>flidr@kky.zcu.cz</email></para>
0355 </listitem>
0356 
0357 <listitem>
0358 <para>&Harri.Porten; &Harri.Porten.mail;</para>
0359 </listitem>
0360 
0361 <listitem>
0362 <para>Dima Rogozin <email>dima@mercury.co.il</email></para>
0363 </listitem>
0364 
0365 <listitem>
0366 <para>&Carsten.Pfeiffer; &Carsten.Pfeiffer.mail;</para>
0367 </listitem>
0368 
0369 <listitem>
0370 <para>Hans Petter Bieker <email>bieker@kde.org</email></para>
0371 </listitem>
0372 
0373 <listitem>
0374 <para>&Waldo.Bastian; &Waldo.Bastian.mail;</para>
0375 </listitem>
0376     
0377 </itemizedlist>
0378 
0379 <para>
0380 Documentation copyright 2001 &Dirk.Doerflinger; 
0381 &Dirk.Doerflinger.mail;</para> 
0382 
0383 <!-- TRANS:CREDIT_FOR_TRANSLATORS -->
0384 
0385 &underFDL;               <!-- FDL: do not remove -->
0386 &underGPL;               <!-- GPL License -->
0387 
0388 </chapter>
0389 
0390 &documentation.index;
0391 
0392 </book>
0393 
0394 <!--
0395 Local Variables:
0396 mode: sgml
0397 sgml-minimize-attributes:nil
0398 sgml-general-insert-case:lower
0399 sgml-indent-step:0
0400 sgml-indent-data:nil
0401 End:
0402 
0403 // vim:ts=0:sw=2:tw=78:noet
0404 -->