apps/doc/kfind/index.docbook

   1 <?xml version="1.0" ?>
   2 <!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN"
   3 "dtd/kdex.dtd" [
   4   <!ENTITY kappname "&kfind;">
   5   <!ENTITY package "kdebase">
   6   <!ENTITY % addindex "IGNORE">
   7   <!ENTITY % English "INCLUDE">
   8 ]>
   9
  10 <book lang="&language;">
  11
  12 <bookinfo>
  13 <title>The &kfind; Handbook</title>
  14
  15 <authorgroup>
  16 <author>&Dirk.Doerflinger; &Dirk.Doerflinger.mail;</author>
  17
  18 <!-- TRANS:ROLES_OF_TRANSLATORS -->
  19
  20 </authorgroup>
  21
  22 <copyright>
  23 <year>2001</year>
  24 <holder>&Dirk.Doerflinger;</holder>
  25 </copyright>
  26
  27 <legalnotice>&FDLNotice;</legalnotice>
  28
  29 <date>2004-04-11</date>
  30 <releaseinfo>1.20.01</releaseinfo>
  31
  32 <abstract>
  33 <para>
  34 &kfind; is &kde;'s file find utility.
  35 </para>
  36 </abstract>
  37
  38 <keywordset>
  39 <keyword>KDE</keyword>
  40 <keyword>kdeutils</keyword>
  41 <keyword>kfind</keyword>
  42 <keyword>find</keyword>
  43 <keyword>search</keyword>
  44 </keywordset>
  45 </bookinfo>
  46
  47 <chapter id="introduction">
  48 <title>Introduction</title>
  49
  50 <para>
  51 &kfind; is the &kde; file find utility.
  52 </para>
  53
  54 <sect1 id="starting">
  55 <title>Launching &kfind;</title>
  56
  57 <para>
  58 The Find Files tool is a useful method of searching for specific files on your
  59 computer, or for searching for files that match a pattern. An example of
  60 this could include searching for files of a particular type or with certain
  61 letters in the filename.
  62
  63 You can load this utility by clicking on <guimenuitem>Find Files</guimenuitem>. This will
  64 launch &kfind;.
  65 </para>
  66
  67 </sect1>
  68 </chapter>
  69
  70 <chapter id="kfind">
  71 <title>Finding Files</title>
  72
  73 <sect1 id="name-tab">
  74 <title>The Name/Location Tab</title>
  75
  76 <para>
  77 When starting &kfind;, you will see a quite simple window. Type in the
  78 name of the file you are searching in the textbox labeled
  79 <guilabel>Named:</guilabel>. Choose a folder where you want to search
  80 by typing it in the field <guilabel>Look in:</guilabel>
  81 or by clicking <guibutton>Browse...</guibutton> and press
  82 <keycap>Enter</keycap> or click <guibutton>Find</guibutton>. If
  83 <guilabel>Include subfolders</guilabel> is checked all
  84 subfolders starting from your chosen folder will be searched
  85 too. The results will be displayed in the box below.
  86 </para>
  87
  88 <para>
  89 You can use the following wildcards:
  90 </para>
  91
  92 <variablelist>
  93 <varlistentry>
  94 <term>The Asterisk <quote><keycap>*</keycap></quote></term>
  95 <listitem>
  96 <para>
  97 The asterisk stands for any number of missing characters (even zero),
  98 that means &eg; searching for <userinput>marc*</userinput> may find the
  99 files <filename>marc</filename>, <filename>marc.png</filename> and
 100 <filename> marc_must_not_read_this.kwd</filename>.
 101 <userinput>mar*.kwd</userinput> may find
 102 <filename>marketplace.kwd</filename> and
 103 <filename>marc_must_not_read_this.kwd</filename>.
 104 </para>
 105 </listitem>
 106 </varlistentry>
 107
 108 <varlistentry>
 109 <term>The Question Mark <quote><keycap>?</keycap></quote></term>
 110 <listitem>
 111 <para>
 112 In contrast to the asterisk, the question mark stands for exactly one
 113 character, so <userinput>mar?</userinput> will find
 114 <filename>marc</filename>, but <userinput>marc?</userinput> will not find
 115 anything, as our files are called <filename>marc</filename> and
 116 <filename>marc.png</filename>. You can put as many question marks in the
 117 term as you want, it will find exactly that number of characters.
 118 </para>
 119 </listitem>
 120 </varlistentry>
 121
 122 </variablelist>
 123
 124 <para>
 125 Of course you can combine those two wildcard symbols in a search term.
 126 </para>
 127
 128 </sect1>
 129
 130 <sect1 id="kfind-date-range">
 131 <title>The Contents Tab</title>
 132
 133 <variablelist>
 134 <varlistentry>
 135 <term><guilabel>File type</guilabel></term>
 136 <listitem>
 137 <para>
 138 Here you can specify the type of file you are searching for.
 139 </para>
 140 </listitem>
 141 </varlistentry>
 142
 143 <varlistentry>
 144 <term><guilabel>Containing text</guilabel></term>
 145 <listitem>
 146 <para>
 147 Type in the word or phrase the files you are searching for must
 148 contain. Note: If you do this in a large folder or checked
 149 <guilabel>Include subfolders</guilabel> in the
 150 <guilabel>Name/Location</guilabel> tab, this may take a long time.
 151 </para>
 152
 153 <note>
 154 <para>This option will <emphasis>not</emphasis> work for all files listed
 155 under <guilabel>File type</guilabel>. Only the following file types
 156 are supported:
 157
 158 <itemizedlist>
 159 <listitem><para>Text files, &eg; source code and <filename>README</filename> files</para></listitem>
 160 <listitem><para>KWord &gt;= 1.2</para></listitem>
 161 <listitem><para>KPresenter &gt;= 1.2</para></listitem>
 162 <listitem><para>KSpread &gt;= 1.2</para></listitem>
 163 <listitem><para>OpenOffice.org Writer</para></listitem>
 164 <listitem><para>OpenOffice.org Impress</para></listitem>
 165 <listitem><para>OpenOffice.org Calc</para></listitem>
 166 </itemizedlist>
 167
 168 </para>
 169 </note>
 170
 171 </listitem>
 172 </varlistentry>
 173
 174 <varlistentry>
 175 <term><guilabel>Case sensitive</guilabel></term>
 176 <listitem>
 177 <para>
 178 If you enable this option, &kfind; will
 179 only find files with the exact case matching, &eg;
 180 <userinput>MARC</userinput> will only match
 181 <quote>MARC</quote>, not <quote>Marc</quote>.
 182 </para>
 183 </listitem>
 184 </varlistentry>
 185
 186 <varlistentry>
 187 <term><guilabel>Regular expression</guilabel></term>
 188 <listitem><para>If you have installed the &kregexpeditor; tool from
 189 the kdeutils package, you will have this additional option.  Enabling
 190 it will allow you to search for a <firstterm>regexp</firstterm> or
 191 regular expression.  A regexp is a way to specify conditions for your
 192 search, and they can be very complex, and equally they can be very
 193 powerful.  If you are unfamiliar with regular expressions, you can
 194 choose <guilabel>Edit Regular Expression</guilabel> to open
 195 &kregexpeditor;.  This tool allows you to construct your set of
 196 conditions graphically, and then generates the expression for
 197 you.</para>
 198
 199 <para>&kregexpeditor; is a very useful tool, and can be used from within
 200 many &kde; applications other than &kfind;.  You can find more
 201 information from within its own help file.</para>
 202 </listitem>
 203 </varlistentry>
 204
 205 <!-- TODO: "Search metainfo sections" -->
 206
 207 </variablelist>
 208
 209 </sect1>
 210
 211 <sect1 id="kfind-advanced">
 212 <title>The Properties Tab</title>
 213
 214 <para>
 215 Here you can refine your search. These are the special refinements
 216 you can choose:
 217 </para>
 218
 219 <variablelist>
 220
 221 <varlistentry>
 222 <term><guilabel>Find all files created or modified</guilabel></term>
 223 <listitem>
 224 <para>
 225 Here you can either enter two dates, between which the
 226 files were created or modified, or specify a time period.
 227 </para>
 228 </listitem>
 229 </varlistentry>
 230
 231 <varlistentry>
 232 <term><guilabel>File size is</guilabel></term>
 233 <listitem>
 234 <para>Here you can specify if the file has to be at least or as most as
 235 big as the size you entered in the following box.
 236 </para>
 237 </listitem>
 238 </varlistentry>
 239
 240 <varlistentry>
 241 <term><guilabel>Files owned by user, Files owned by group</guilabel></term>
 242 <listitem>
 243 <para>Here you can specify user and group names.
 244 </para>
 245 </listitem>
 246 </varlistentry>
 247
 248 </variablelist>
 249
 250 </sect1>
 251
 252 </chapter>
 253
 254 <chapter id="credits">
 255
 256 <title>Credits and License</title>
 257
 258 <para>
 259 &kfind;
 260 </para>
 261
 262 <para>
 263 Program copyright:
 264 </para>
 265
 266 <itemizedlist>
 267 <title>Developers</title>
 268 <listitem>
 269 <para>Martin Hartig</para>
 270 </listitem>
 271
 272 <listitem>
 273 <para>Stephan Kulow <email>coolo@kde.org</email></para>
 274 </listitem>
 275
 276 <listitem>
 277 <para>Mario Weilguni <email>mweilguni@sime.com</email></para>
 278 </listitem>
 279
 280 <listitem>
 281 <para>Alex Zepeda <email>jazepeda@pacbell.net</email></para>
 282 </listitem>
 283
 284 <listitem>
 285 <para>Miroslav Flídr <email>flidr@kky.zcu.cz</email></para>
 286 </listitem>
 287
 288 <listitem>
 289 <para>Harri Porten <email>porten@kde.org</email></para>
 290 </listitem>
 291
 292 <listitem>
 293 <para>Dima Rogozin <email>dima@mercury.co.il</email></para>
 294 </listitem>
 295
 296 <listitem>
 297 <para>Carsten Pfeiffer <email>pfeiffer@kde.org</email></para>
 298 </listitem>
 299
 300 <listitem>
 301 <para>Hans Petter Bieker <email>bieker@kde.org</email></para>
 302 </listitem>
 303
 304 <listitem>
 305 <para>Waldo Bastian <email>bastian@kde.org</email></para>
 306 </listitem>
 307
 308 </itemizedlist>
 309
 310 <para>
 311 Documentation copyright 2001 &Dirk.Doerflinger;
 312 &Dirk.Doerflinger.mail;</para>
 313
 314 <!-- TRANS:CREDIT_FOR_TRANSLATORS -->
 315
 316 &underFDL;               <!-- FDL: do not remove -->
 317 &underBSDLicense;        <!-- BSD License -->
 318
 319 </chapter>
 320
 321 <appendix id="installation">
 322 <title>Installation</title>
 323
 324 <sect1 id="getting-kfind">
 325 <title>How to obtain &kfind;</title>
 326
 327 &install.intro.documentation;
 328
 329 </sect1>
 330
 331 <sect1 id="requirements">
 332 <title>Requirements</title>
 333
 334 <para>
 335 In order to successfully use &kfind;, you need &kde; 3.x.
 336 </para>
 337
 338 </sect1>
 339
 340 <sect1 id="compilation">
 341 <title>Compilation and Installation</title>
 342
 343 &install.compile.documentation;
 344
 345 </sect1>
 346
 347 </appendix>
 348
 349 &documentation.index;
 350
 351 </book>
 352
 353 <!--
 354 Local Variables:
 355 mode: sgml
 356 sgml-minimize-attributes:nil
 357 sgml-general-insert-case:lower
 358 sgml-indent-step:0
 359 sgml-indent-data:nil
 360 End:
 361
 362 // vim:ts=0:sw=2:tw=78:noet
 363 -->