source: server/major/nfs-utils.xml@ db70961a

10.0 10.1 11.0 11.1 11.2 11.3 12.0 12.1 6.2 6.2.0 6.2.0-rc1 6.2.0-rc2 6.3 6.3-rc1 6.3-rc2 6.3-rc3 7.10 7.4 7.5 7.6 7.6-blfs 7.6-systemd 7.7 7.8 7.9 8.0 8.1 8.2 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind gnome kde5-13430 kde5-14269 kde5-14686 kea ken/TL2024 ken/inkscape-core-mods ken/tuningfonts krejzi/svn lazarus lxqt nosym perl-modules plabs/newcss plabs/python-mods python3.11 qt5new rahul/power-profiles-daemon renodr/vulkan-addition systemd-11177 systemd-13485 trunk upgradedb xry111/intltool xry111/llvm18 xry111/soup3 xry111/test-20220226 xry111/xf86-video-removal
Last change on this file since db70961a was e20c8110, checked in by Randy McMurchy <randy@…>, 18 years ago

Updated to NFS Utilities-1.0.8

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@5977 af4574ff-66df-0310-9fd7-8a98e5e911e0
  • Property mode set to 100644
File size: 16.4 KB
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
3 "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
4 <!ENTITY % general-entities SYSTEM "../../general.ent">
5 %general-entities;
6
7 <!ENTITY nfs-utils-download-http "http://ftp.kernel.org/pub/linux/utils/nfs/nfs-utils-&nfs-utils-version;.tar.gz">
8 <!ENTITY nfs-utils-download-ftp "ftp://ftp.kernel.org/pub/linux/utils/nfs/nfs-utils-&nfs-utils-version;.tar.gz">
9 <!ENTITY nfs-utils-md5sum "ee7903365255b7d840a45be4d6e2b0e2">
10 <!ENTITY nfs-utils-size "508 KB">
11 <!ENTITY nfs-utils-buildsize "12.2 MB">
12 <!ENTITY nfs-utils-time "0.3 SBU">
13]>
14
15<sect1 id="nfs-utils" xreflabel="NFS Utilities-&nfs-utils-version;">
16 <?dbhtml filename="nfs-utils.html"?>
17
18 <sect1info>
19 <othername>$LastChangedBy$</othername>
20 <date>$Date$</date>
21 <keywordset>
22 <keyword role="package">nfs-utils-&nfs-utils-version;.tar</keyword>
23 <keyword role="ftpdir">nfs-utils</keyword>
24 </keywordset>
25 </sect1info>
26
27 <title>NFS Utilities-&nfs-utils-version;</title>
28
29 <indexterm zone="nfs-utils">
30 <primary sortas="a-Nfs-utils">NFS Utilities</primary>
31 </indexterm>
32
33 <sect2 role="package">
34 <title>Introduction to NFS Utilities</title>
35
36 <para>The <application>NFS Utilities</application> package contains the
37 userspace server and client tools necessary to use the kernel's NFS
38 abilities. NFS is a protocol that allows sharing file systems over the
39 network.</para>
40
41 <bridgehead renderas="sect3">Package information</bridgehead>
42 <itemizedlist spacing='compact'>
43 <listitem>
44 <para>Download (HTTP): <ulink url="&nfs-utils-download-http;"/></para>
45 </listitem>
46 <listitem>
47 <para>Download (FTP): <ulink url="&nfs-utils-download-ftp;"/></para>
48 </listitem>
49 <listitem>
50 <para>Download MD5 sum: &nfs-utils-md5sum;</para>
51 </listitem>
52 <listitem>
53 <para>Download size: &nfs-utils-size;</para>
54 </listitem>
55 <listitem>
56 <para>Estimated disk space required: &nfs-utils-buildsize;</para>
57 </listitem>
58 <listitem>
59 <para>Estimated build time: &nfs-utils-time;</para>
60 </listitem>
61 </itemizedlist>
62
63 <!--
64 <bridgehead renderas="sect3">Additional Downloads</bridgehead>
65 <itemizedlist spacing='compact'>
66 <listitem>
67 <para>Required patch: <ulink
68 url="&patch-root;/nfs-utils-&nfs-utils-version;-gcc4-1.patch"/></para>
69 </listitem>
70 </itemizedlist>
71 -->
72
73 <bridgehead renderas="sect3">NFS Utilities Dependencies</bridgehead>
74
75 <bridgehead renderas="sect4">Required</bridgehead>
76 <para role="required"><xref linkend="portmap"/></para>
77
78 <bridgehead renderas="sect4">Optional</bridgehead>
79 <para role="optional"><xref linkend="tcpwrappers"/></para>
80
81 <bridgehead renderas="sect4">Optional for NFSv4 Support</bridgehead>
82 <para role="optional"><xref linkend="pkgconfig"/> and
83 <ulink url="http://www.monkey.org/~provos/libevent/">libevent</ulink> and
84 <ulink url="http://www.citi.umich.edu/projects/nfsv4/linux/">libnsfidmap</ulink>
85 </para>
86
87 <bridgehead renderas="sect4">Optional for GSS (RPC Security) Support</bridgehead>
88 <para role="optional"><xref linkend="pkgconfig"/>, and
89 <xref linkend="mitkrb"/> or
90 <xref linkend="heimdal"/> or
91 <ulink url="http://www.citi.umich.edu/projects/nfsv4/linux/">libgssapi</ulink>, and
92 <ulink url="http://www.citi.umich.edu/projects/nfsv4/linux/">librpcsecgss</ulink>;
93 for additional SPKM-3 support, install
94 <ulink url="http://www.citi.umich.edu/projects/nfsv4/linux/">SPKM-3</ulink></para>
95
96 <para condition="html" role="usernotes">User Notes:
97 <ulink url="&blfs-wiki;/nfs-utils"/></para>
98
99 </sect2>
100
101 <sect2 role="kernel" id='nfs-utils-kernel'>
102 <title>Kernel Configuration</title>
103
104 <para>Enable the following options in the kernel configuration
105 and recompile the kernel if necessary:</para>
106
107<screen><literal>File systems:
108 Network File Systems:
109 NFS File System Support: M or Y
110 NFS Server Support: M or Y</literal></screen>
111
112 <para>Select the appropriate sub-options that appear when the above options
113 are selected.</para>
114
115 <indexterm zone="nfs-utils nfs-utils-kernel">
116 <primary sortas="d-nfs-utils">NFS Utilities</primary>
117 </indexterm>
118
119 </sect2>
120
121 <sect2 role="installation" id='nfs-utils-install'
122 xreflabel='NFS Utilities Installation'>
123 <title>Installation of NFS Utilities</title>
124
125 <para>Before you compile the program, ensure that the
126 <systemitem class="username">nobody</systemitem> user and
127 <systemitem class="groupname">nogroup</systemitem> group have been
128 created. You can add them by running the following commands as the
129 <systemitem class="username">root</systemitem> user:</para>
130
131<screen role="root"><userinput>groupadd -g 99 nogroup &amp;&amp;
132useradd -c "Unprivileged Nobody" -d /dev/null -g nogroup \
133 -s /bin/false -u 99 nobody</userinput></screen>
134
135 <note>
136 <para>The classic uid and gid values are 65534 which is also -2 when
137 interpreted as a signed 16-bit number. These values impact other files
138 on some filesystems that do not have support for sparse files. The
139 <systemitem class="username">nobody</systemitem> and <systemitem
140 class="groupname">nogroup</systemitem> values are relatively arbitrary.
141 The impact on a server is nil if the <filename>exports</filename> file
142 is configured correctly. If it is misconfigured, an
143 <command>ls -l</command> or <command>ps</command> listing will show a
144 uid or gid number of 65534 instead of a name. The client uses <systemitem
145 class="username">nobody</systemitem> only as the user running
146 <command>rpc.statd</command>.</para>
147 </note>
148
149 <para>Install <application>NFS Utilities</application> by running
150 the following commands:</para>
151
152<screen><userinput>./configure --prefix=/usr \
153 --sysconfdir=/etc \
154 --disable-nfsv4 \
155 --disable-gss &amp;&amp;
156make</userinput></screen>
157
158 <para>This package does not come with a test suite.</para>
159
160 <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
161
162 <note>
163 <para>If your <filename class="directory">/usr</filename> directory
164 is NFS mounted, you should install the executables in
165 <filename class="directory">/sbin</filename> by passing
166 an additional parameter <option>--sbindir=/sbin</option> to the
167 above <command>./configure</command> command.</para>
168 </note>
169
170<screen role='root'><userinput>make install</userinput></screen>
171
172 </sect2>
173
174 <sect2 role="commands">
175 <title>Command Explanations</title>
176
177 <para><parameter>--disable-nfsv4</parameter>: Disables support
178 for NFS version 4.</para>
179
180 <para><parameter>--disable-gss</parameter>: Disables support for
181 RPCSEC GSS (RPC Security).</para>
182
183 <para><option>--with-tcp-wrappers</option>: Use this option to enable
184 tcpwrappers support.</para>
185
186 </sect2>
187
188 <sect2 role="configuration">
189 <title>Configuring NFS Utilities</title>
190
191 <sect3 id='nfs-utils-server-config'>
192 <title>Server Configuration</title>
193
194 <para><filename>/etc/exports</filename> contains the exported directories
195 on NFS servers. Refer to the <filename>exports.5</filename> manual page
196 for the syntax of this file. Also refer to the "NFS HowTo" available at
197 <ulink url="http://nfs.sourceforge.net/nfs-howto/"/> for information on
198 how to configure the servers and clients in a secure manner. For example,
199 for sharing the <filename class="directory">/home</filename> directory
200 over the local network, the following line may be added:</para>
201
202<screen role="root"><userinput>/home <replaceable>&lt;192.168.0.0/255.255.255.0&gt;</replaceable>(rw,anonuid=99,anongid=99)</userinput></screen>
203
204 <indexterm zone="nfs-utils nfs-utils-server-config">
205 <primary sortas="e-etc-exportfs">/etc/exportfs</primary>
206 </indexterm>
207
208 <sect4 id="nfs-utils-server-init">
209 <title>Boot Script</title>
210
211 <para>Install the <filename>/etc/rc.d/init.d/nfs-server</filename>
212 init script included in the <xref
213 linkend="bootscripts"/> package to start the server
214 at boot.</para>
215
216<screen role="root"><userinput>make install-nfs-server</userinput></screen>
217
218 <indexterm zone="nfs-utils nfs-utils-server-init">
219 <primary sortas="f-nfs-server">nfs-server</primary>
220 </indexterm>
221
222 <para>Now create the <filename>/etc/sysconfig/nfs-server</filename>
223 configuration file:</para>
224
225<screen role="root"><userinput>cat &gt; /etc/sysconfig/nfs-server &lt;&lt; "EOF"
226<literal>PORT="2049"
227PROCESSES="8"
228QUOTAS="no"
229KILLDELAY="10"</literal>
230EOF</userinput></screen>
231
232 <indexterm zone="nfs-utils nfs-utils-server-init">
233 <primary
234 sortas="e-etc-sysconfig-nfs-server">/etc/sysconfig/nfs-server</primary>
235 </indexterm>
236
237 </sect4>
238
239 <sect4 id="nfs-utils-server-wrappers-support">
240 <title>tcpwrappers Configuration</title>
241
242 <para>If you enabled support for <application>tcpwrappers</application>,
243 ensure you have an entry in the <filename>/etc/hosts.allow</filename>
244 file for access from the <command>portmap</command> daemon if you have a
245 restrictive <filename>/etc/hosts.deny</filename> file.</para>
246
247 </sect4>
248
249 </sect3>
250
251 <sect3 id='nfs-utils-client-config'>
252 <title>Client Configuration</title>
253
254 <para><filename>/etc/fstab</filename> contains the directories that
255 are to be mounted on the client. Alternately the partitions can be
256 mounted by using the <command>mount</command> command with the proper
257 options. To mount the <filename class="directory">/home</filename>
258 and <filename class="directory">/usr</filename> partitions, add the
259 following to the <filename>/etc/fstab</filename>:</para>
260
261<screen role="root"><userinput>&lt;server-name&gt;:/home /home nfs rw,_netdev,rsize=8192,wsize=8192 0 0
262&lt;server-name&gt;:/usr /usr nfs ro,_netdev,rsize=8192 0 0</userinput></screen>
263
264 <indexterm zone="nfs-utils nfs-utils-client-config">
265 <primary sortas="e-etc-fstab">/etc/fstab</primary>
266 </indexterm>
267
268 <sect4 id="nfs-utils-client-init">
269 <title>Boot Script</title>
270
271 <para>Install the <filename>/etc/rc.d/init.d/nfs-client</filename>
272 init script included in the
273 <xref linkend="bootscripts"/> package to
274 start the client services at boot.</para>
275
276<screen role="root"><userinput>make install-nfs-client</userinput></screen>
277
278 <indexterm zone="nfs-utils nfs-utils-client-config">
279 <primary sortas="f-nfs-client">nfs-client</primary>
280 </indexterm>
281
282 <para>To automatically mount <systemitem
283 class="filesystem">nfs</systemitem> filesystems, clients will also
284 need to install the <filename>netfs</filename> bootscript as described
285 in <xref linkend='postlfs-config-netfs'/>.</para>
286
287 <indexterm zone="nfs-utils nfs-utils-client-config">
288 <primary sortas="f-netfs">netfs</primary>
289 </indexterm>
290
291 </sect4>
292
293 </sect3>
294
295 </sect2>
296
297 <sect2 role="content">
298 <title>Contents</title>
299 <segmentedlist>
300 <segtitle>Installed Programs</segtitle>
301 <segtitle>Installed Libraries</segtitle>
302 <segtitle>Installed Directories</segtitle>
303
304 <seglistitem>
305 <seg>exportfs, nfsstat, nhfsgraph, nhfsnums, nhfsrun, nhfsstone,
306 rpc.lockd, rpc.mountd, rpc.nfsd, rpc.rquotad, rpc.statd,
307 and showmount</seg>
308 <seg>None</seg>
309 <seg>/var/lib/nfs</seg>
310 </seglistitem>
311 </segmentedlist>
312
313 <variablelist>
314 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
315 <?dbfo list-presentation="list"?>
316 <?dbhtml list-presentation="table"?>
317
318 <varlistentry id="exportfs">
319 <term><command>exportfs</command></term>
320 <listitem>
321 <para>maintains a list of NFS exported file systems.</para>
322 <indexterm zone="nfs-utils exportfs">
323 <primary sortas="b-exportfs">exportfs</primary>
324 </indexterm>
325 </listitem>
326 </varlistentry>
327
328 <varlistentry id="nfsstat">
329 <term><command>nfsstat</command></term>
330 <listitem>
331 <para>prints NFS statistics.</para>
332 <indexterm zone="nfs-utils nfsstat">
333 <primary sortas="b-nfsstat">nfsstat</primary>
334 </indexterm>
335 </listitem>
336 </varlistentry>
337
338 <varlistentry id="nhfsgraph">
339 <term><command>nhfsgraph</command></term>
340 <listitem>
341 <para>runs <command>nhfsstone</command> over multiple loads.</para>
342 <indexterm zone="nfs-utils nhfsgraph">
343 <primary sortas="b-nhfsgraph">nhfsgraph</primary>
344 </indexterm>
345 </listitem>
346 </varlistentry>
347
348 <varlistentry id="nhfsnums">
349 <term><command>nhfsnums</command></term>
350 <listitem>
351 <para>converts raw numbers from <command>nhfsstone</command>
352 output into plot format.</para>
353 <indexterm zone="nfs-utils nhfsnums">
354 <primary sortas="b-nhfsnums">nhfsnums</primary>
355 </indexterm>
356 </listitem>
357 </varlistentry>
358
359 <varlistentry id="nhfsrun">
360 <term><command>nhfsrun</command></term>
361 <listitem>
362 <para>executes <command>nhfsstone</command> with a range of
363 different loads.</para>
364 <indexterm zone="nfs-utils nhfsrun">
365 <primary sortas="b-nhfsrun">nhfsrun</primary>
366 </indexterm>
367 </listitem>
368 </varlistentry>
369
370 <varlistentry id="nhfsstone">
371 <term><command>nhfsstone</command></term>
372 <listitem>
373 <para>is used on a NFS client to generate an artificial load
374 with a particular mix of NFS operations.</para>
375 <indexterm zone="nfs-utils nhfsstone">
376 <primary sortas="b-nhfsstone">nhfsstone</primary>
377 </indexterm>
378 </listitem>
379 </varlistentry>
380
381 <varlistentry id="rpclockd">
382 <term><command>rpc.lockd</command></term>
383 <listitem>
384 <para>starts the NFS lock manager (NLM) on kernels that don't
385 start it automatically. However, since most kernels do start it
386 automatically it is usually not required.</para>
387 <indexterm zone="nfs-utils rpclockd">
388 <primary sortas="b-rpclockd">rpc.lockd</primary>
389 </indexterm>
390 </listitem>
391 </varlistentry>
392
393 <varlistentry id="rpcmountd">
394 <term><command>rpc.mountd</command></term>
395 <listitem>
396 <para>implements the NFS mount protocol on an NFS server.</para>
397 <indexterm zone="nfs-utils rpcmountd">
398 <primary sortas="b-rpcmountd">rpc.mountd</primary>
399 </indexterm>
400 </listitem>
401 </varlistentry>
402
403 <varlistentry id="rpcnfsd">
404 <term><command>rpc.nfsd</command></term>
405 <listitem>
406 <para>implements the user level part of the NFS
407 service on the server.</para>
408 <indexterm zone="nfs-utils rpcnfsd">
409 <primary sortas="b-rpcnfsd">rpc.nfsd</primary>
410 </indexterm>
411 </listitem>
412 </varlistentry>
413
414 <varlistentry id="rpcrquotad">
415 <term><command>rpc.rquotad</command></term>
416 <listitem>
417 <para>is an rpc server which returns quotas for a user of a
418 local file system which is mounted by a remote machine over
419 the NFS.</para>
420 <indexterm zone="nfs-utils rpcrquotad">
421 <primary sortas="b-rpcrquotad">rpc.rquotad</primary>
422 </indexterm>
423 </listitem>
424 </varlistentry>
425
426 <varlistentry id="rpcstatd">
427 <term><command>rpc.statd</command></term>
428 <listitem>
429 <para>is used by the NFS file locking service,
430 <command>rpc.lockd</command>, to implement lock recovery when
431 the NFS server machine crashes and reboots. Runs on the NFS
432 server only.</para>
433 <indexterm zone="nfs-utils rpcstatd">
434 <primary sortas="b-rpcstatd">rpc.statd</primary>
435 </indexterm>
436 </listitem>
437 </varlistentry>
438
439 <varlistentry id="showmount">
440 <term><command>showmount</command></term>
441 <listitem>
442 <para>displays mount information for an NFS server.</para>
443 <indexterm zone="nfs-utils showmount">
444 <primary sortas="b-showmount">showmount</primary>
445 </indexterm>
446 </listitem>
447 </varlistentry>
448
449 </variablelist>
450
451 </sect2>
452
453</sect1>
Note: See TracBrowser for help on using the repository browser.