BOOK/chapter06/findutils.xml

   1 <?xml version="1.0" encoding="ISO-8859-1"?>
   2 <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   3   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
   4   <!ENTITY % general-entities SYSTEM "../general.ent">
   5   %general-entities;
   6 ]>
   7
   8 <sect1 id="ch-system-findutils" role="wrap">
   9   <?dbhtml filename="findutils.html"?>
  10
  11   <sect1info condition="script">
  12     <productname>findutils</productname>
  13     <productnumber>&findutils-version;</productnumber>
  14     <address>&findutils-url;</address>
  15   </sect1info>
  16
  17   <title>Findutils-&findutils-version;</title>
  18
  19   <indexterm zone="ch-system-findutils">
  20     <primary sortas="a-Findutils">Findutils</primary>
  21   </indexterm>
  22
  23   <sect2 role="package">
  24     <title/>
  25
  26     <para>The Findutils package contains programs to find files. These programs
  27     are provided to recursively search through a directory tree and to
  28     create, maintain, and search a database (often faster than the recursive
  29     find, but unreliable if the database has not been recently updated).</para>
  30
  31     <segmentedlist>
  32       <segtitle>&buildtime;</segtitle>
  33       <segtitle>&diskspace;</segtitle>
  34
  35       <seglistitem>
  36         <seg>&findutils-ch6-sbu;</seg>
  37         <seg>&findutils-ch6-du;</seg>
  38       </seglistitem>
  39     </segmentedlist>
  40
  41   </sect2>
  42
  43   <sect2 role="installation">
  44     <title>Installation of Findutils</title>
  45
  46     <para>Prepare Findutils for compilation:</para>
  47
  48 <screen><userinput remap="configure">./configure --prefix=/usr --localstatedir=/var/lib/locate</userinput></screen>
  49
  50     <variablelist>
  51       <title>The meaning of the configure options:</title>
  52
  53       <varlistentry>
  54         <term><parameter>--localstatedir</parameter></term>
  55         <listitem>
  56           <para>This option changes the location of the <command>locate</command>
  57           database to be in <filename class="directory">/var/lib/locate</filename>,
  58           which is FHS-compliant.</para>
  59         </listitem>
  60       </varlistentry>
  61
  62     </variablelist>
  63
  64     <para>Compile the package:</para>
  65
  66 <screen><userinput remap="make">make</userinput></screen>
  67
  68     <para>To test the results, issue:</para>
  69
  70 <screen><userinput remap="test">make check</userinput></screen>
  71
  72     <para>Install the package:</para>
  73
  74 <screen><userinput remap="install">make install</userinput></screen>
  75
  76     <para revision="sysv">Some of the scripts in the LFS-Bootscripts package
  77     depend on <command>find</command>.  As <filename
  78     class="directory">/usr</filename> may not be available during the early
  79     stages of booting, this program needs to be on the root partition.  The
  80     <command>updatedb</command> script also needs to be modified to correct an
  81     explicit path:</para>
  82
  83     <para revision="systemd"> Some packages in BLFS and beyond expect the
  84     <command>find</command> program in <filename
  85     class="directory">/bin</filename>, so make sure it's placed there:</para>
  86
  87 <screen><userinput remap="install">mv -v /usr/bin/find /bin
  88 sed -i 's|find:=${BINDIR}|find:=/bin|' /usr/bin/updatedb</userinput></screen>
  89
  90   </sect2>
  91
  92   <sect2 id="contents-findutils" role="content">
  93     <title>Contents of Findutils</title>
  94
  95     <segmentedlist>
  96       <segtitle>Installed programs</segtitle>
  97
  98       <seglistitem>
  99         <seg>code, find, locate, oldfind, updatedb, and xargs</seg>
 100       </seglistitem>
 101     </segmentedlist>
 102
 103     <variablelist>
 104       <bridgehead renderas="sect3">Short Descriptions</bridgehead>
 105       <?dbfo list-presentation="list"?>
 106       <?dbhtml list-presentation="table"?>
 107
 108       <varlistentry id="code">
 109         <term><command>code</command></term>
 110         <listitem>
 111           <para>Was formerly used to produce <command>locate</command>
 112           databases; it is the ancestor of <command>frcode</command></para>
 113           <indexterm zone="ch-system-findutils code">
 114             <primary sortas="b-code">code</primary>
 115           </indexterm>
 116         </listitem>
 117       </varlistentry>
 118
 119       <varlistentry id="find">
 120         <term><command>find</command></term>
 121         <listitem>
 122           <para>Searches given directory trees for files matching the specified
 123           criteria</para>
 124           <indexterm zone="ch-system-findutils find">
 125             <primary sortas="b-find">find</primary>
 126           </indexterm>
 127         </listitem>
 128       </varlistentry>
 129
 130       <varlistentry id="locate">
 131         <term><command>locate</command></term>
 132         <listitem>
 133           <para>Searches through a database of file names and reports the names
 134           that contain a given string or match a given pattern</para>
 135           <indexterm zone="ch-system-findutils locate">
 136             <primary sortas="b-locate">locate</primary>
 137           </indexterm>
 138         </listitem>
 139       </varlistentry>
 140
 141       <varlistentry id="oldfind">
 142         <term><command>oldfind</command></term>
 143         <listitem>
 144           <para>Older version of find, using a different algorithm</para>
 145           <indexterm zone="ch-system-findutils oldfind">
 146             <primary sortas="b-oldfind">oldfind</primary>
 147           </indexterm>
 148         </listitem>
 149       </varlistentry>
 150
 151       <varlistentry id="updatedb">
 152       <term><command>updatedb</command></term>
 153         <listitem>
 154           <para>Updates the <command>locate</command> database; it scans the
 155           entire file system (including other file systems that are currently
 156           mounted, unless told not to) and puts every file name it finds into
 157           the database</para>
 158           <indexterm zone="ch-system-findutils updatedb">
 159             <primary sortas="b-updatedb">updatedb</primary>
 160           </indexterm>
 161         </listitem>
 162       </varlistentry>
 163
 164       <varlistentry id="xargs">
 165         <term><command>xargs</command></term>
 166         <listitem>
 167           <para>Can be used to apply a given command to a list of files</para>
 168           <indexterm zone="ch-system-findutils xargs">
 169             <primary sortas="b-xargs">xargs</primary>
 170           </indexterm>
 171         </listitem>
 172       </varlistentry>
 173
 174     </variablelist>
 175
 176   </sect2>
 177
 178 </sect1>