source: BOOK/final-system/common/findutils.xml @ c2102b28

clfs-3.0.0-sysvinitsysvinit
Last change on this file since c2102b28 was c2102b28, checked in by Chris Staub <chris@…>, 10 years ago

Improve consistency in package installation lists, mainly removing 'and'

Conflicts:

BOOK/final-system/common/attr.xml

  • Property mode set to 100644
File size: 5.7 KB
Line 
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  <title>Findutils-&findutils-version;</title>
12
13  <indexterm zone="ch-system-findutils">
14    <primary sortas="a-Findutils">Findutils</primary>
15  </indexterm>
16
17  <sect2 role="package">
18    <title/>
19
20    <para>The Findutils package contains programs to find files. These programs
21    are provided to recursively search through a directory tree and to
22    create, maintain, and search a database (often faster than the recursive
23    find, but unreliable if the database has not been recently updated).</para>
24
25  </sect2>
26
27  <sect2 role="installation">
28    <title>Installation of Findutils</title>
29
30    <para os="a">Prepare Findutils for compilation:</para>
31
32<screen os="b"><userinput>./configure --prefix=/usr --libexecdir=/usr/lib/locate \
33    --localstatedir=/var/lib/locate</userinput></screen>
34
35    <variablelist os="c">
36      <title>The meaning of the configure options:</title>
37
38      <varlistentry>
39        <term><parameter>--localstatedir</parameter></term>
40        <listitem>
41          <para>This option changes the location of the <command>locate</command>
42          database to be in <filename class="directory">/var/lib/locate</filename>,
43          which is FHS-compliant.</para>
44        </listitem>
45      </varlistentry>
46
47    </variablelist>
48
49    <para os="d">Compile the package:</para>
50
51<screen os="e"><userinput>make</userinput></screen>
52
53    <para os="f">To test the results, issue:</para>
54
55<screen os="f2"><userinput remap="test">make check</userinput></screen>
56
57    <para os="g">Install the package:</para>
58
59<screen os="h"><userinput>make install</userinput></screen>
60
61  </sect2>
62
63  <sect2 id="contents-findutils" role="content">
64    <title>Contents of Findutils</title>
65
66    <segmentedlist>
67      <segtitle>Installed programs</segtitle>
68      <segtitle>Installed directory</segtitle>
69
70      <seglistitem>
71        <seg>bigram, code, find, frcode, locate, oldfind, updatedb, xargs</seg>
72        <seg>/usr/lib/locate</seg>
73      </seglistitem>
74    </segmentedlist>
75
76    <variablelist>
77      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
78      <?dbfo list-presentation="list"?>
79      <?dbhtml list-presentation="table"?>
80
81      <varlistentry id="bigram">
82        <term><command>bigram</command></term>
83        <listitem>
84          <para>Was formerly used to produce <command>locate</command>
85          databases</para>
86          <indexterm zone="ch-system-findutils bigram">
87            <primary sortas="b-bigram">bigram</primary>
88          </indexterm>
89        </listitem>
90      </varlistentry>
91
92      <varlistentry id="code">
93        <term><command>code</command></term>
94        <listitem>
95          <para>Was formerly used to produce <command>locate</command>
96          databases; it is the ancestor of <command>frcode</command>.</para>
97          <indexterm zone="ch-system-findutils code">
98            <primary sortas="b-code">code</primary>
99          </indexterm>
100        </listitem>
101      </varlistentry>
102
103      <varlistentry id="find">
104        <term><command>find</command></term>
105        <listitem>
106          <para>Searches given directory trees for files matching the specified
107          criteria</para>
108          <indexterm zone="ch-system-findutils find">
109            <primary sortas="b-find">find</primary>
110          </indexterm>
111        </listitem>
112      </varlistentry>
113
114      <varlistentry id="frcode">
115        <term><command>frcode</command></term>
116        <listitem>
117          <para>Is called by <command>updatedb</command> to compress the list
118          of file names; it uses front-compression, reducing the database size
119          by a factor of four to five.</para>
120          <indexterm zone="ch-system-findutils frcode">
121            <primary sortas="b-frcode">frcode</primary>
122          </indexterm>
123        </listitem>
124      </varlistentry>
125
126      <varlistentry id="locate">
127        <term><command>locate</command></term>
128        <listitem>
129          <para>Searches through a database of file names and reports the names
130          that contain a given string or match a given pattern</para>
131          <indexterm zone="ch-system-findutils locate">
132            <primary sortas="b-locate">locate</primary>
133          </indexterm>
134        </listitem>
135      </varlistentry>
136
137      <varlistentry id="oldfind">
138        <term><command>oldfind</command></term>
139        <listitem>
140          <para>Older version of find, using a different algorithm</para>
141          <indexterm zone="ch-system-findutils oldfind">
142            <primary sortas="b-oldfind">oldfind</primary>
143          </indexterm>
144        </listitem>
145      </varlistentry>
146
147      <varlistentry id="updatedb">
148        <term><command>updatedb</command></term>
149        <listitem>
150          <para>Updates the <command>locate</command> database; it scans the
151          entire file system (including other file systems that are currently
152          mounted, unless told not to) and puts every file name it finds into
153          the database</para>
154          <indexterm zone="ch-system-findutils updatedb">
155            <primary sortas="b-updatedb">updatedb</primary>
156          </indexterm>
157        </listitem>
158      </varlistentry>
159
160      <varlistentry id="xargs">
161        <term><command>xargs</command></term>
162        <listitem>
163          <para>Can be used to apply a given command to a list of files</para>
164          <indexterm zone="ch-system-findutils xargs">
165            <primary sortas="b-xargs">xargs</primary>
166          </indexterm>
167        </listitem>
168      </varlistentry>
169
170    </variablelist>
171
172  </sect2>
173
174</sect1>
Note: See TracBrowser for help on using the repository browser.