source: networking/netprogs/nfs-utils.xml@ 5d9021ea

10.0 10.1 11.0 11.1 11.2 11.3 12.0 12.1 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 5d9021ea was 5d9021ea, checked in by Ken Moffat <ken@…>, 11 years ago

more tags

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@11663 af4574ff-66df-0310-9fd7-8a98e5e911e0
  • Property mode set to 100644
File size: 17.6 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 <!ENTITY nfs-utils-download-http "&sourceforge-repo;/nfs/nfs-utils-&nfs-utils-version;.tar.bz2">
8 <!ENTITY nfs-utils-download-ftp " ">
9 <!ENTITY nfs-utils-md5sum "6e7d97de51e428a0b8698c16ca23db77">
10 <!ENTITY nfs-utils-size "2.6 MB">
11 <!ENTITY nfs-utils-buildsize "18 MB">
12 <!ENTITY nfs-utils-time "0.2 SBU">
13]>
14
15<sect1 id="nfs-utils" xreflabel="nfs-utils-&nfs-utils-version;">
16 <?dbhtml filename="nfs-utils.html"?>
17
18 <sect1info>
19 <othername>$LastChangedBy$</othername>
20 <date>$Date$</date>
21 </sect1info>
22
23 <title>NFS-Utils-&nfs-utils-version;</title>
24
25 <indexterm zone="nfs-utils">
26 <primary sortas="a-Nfs-utils">NFS Utilities</primary>
27 </indexterm>
28
29 <sect2 role="package">
30 <title>Introduction to NFS Utilities</title>
31
32 <para>The <application>NFS Utilities</application> package contains the
33 userspace server and client tools necessary to use the kernel's NFS
34 abilities. NFS is a protocol that allows sharing file systems over the
35 network.</para>
36
37 &lfs74_checked;
38
39 <bridgehead renderas="sect3">Package information</bridgehead>
40 <itemizedlist spacing='compact'>
41 <listitem>
42 <para>Download (HTTP): <ulink url="&nfs-utils-download-http;"/></para>
43 </listitem>
44 <listitem>
45 <para>Download (FTP): <ulink url="&nfs-utils-download-ftp;"/></para>
46 </listitem>
47 <listitem>
48 <para>Download MD5 sum: &nfs-utils-md5sum;</para>
49 </listitem>
50 <listitem>
51 <para>Download size: &nfs-utils-size;</para>
52 </listitem>
53 <listitem>
54 <para>Estimated disk space required: &nfs-utils-buildsize;</para>
55 </listitem>
56 <listitem>
57 <para>Estimated build time: &nfs-utils-time;</para>
58 </listitem>
59 </itemizedlist>
60
61 <bridgehead renderas="sect3">NFS Utilities Dependencies</bridgehead>
62
63 <bridgehead renderas="sect4">Required</bridgehead>
64 <para role="required">
65 <xref linkend="libtirpc"/> and
66 <xref linkend="pkgconfig"/>
67 </para>
68
69 <para role="required">
70 <xref linkend="rpcbind"/> (Runtime dependency)
71 </para>
72
73 <bridgehead renderas="sect4">Optional for NFSv4 Support</bridgehead>
74 <para role="optional">
75 <xref linkend="libevent"/>,
76 <xref linkend="sqlite"/>, and
77 <ulink url="http://www.citi.umich.edu/projects/nfsv4/linux/">libnfsidmap</ulink>
78 </para>
79
80 <bridgehead renderas="sect4">Optional for GSS (RPC Security) Support</bridgehead>
81 <para role="optional">
82 <xref linkend="mitkrb"/> or
83 <ulink url="http://www.citi.umich.edu/projects/nfsv4/linux/">libgssapi</ulink>, and
84 <ulink url="http://www.citi.umich.edu/projects/nfsv4/linux/">librpcsecgss</ulink>
85 </para>
86
87 <bridgehead renderas="sect4">Optional for SPKM-3 Support</bridgehead>
88 <para>
89 <ulink url="http://www.citi.umich.edu/projects/nfsv4/linux/">SPKM-3</ulink>
90 </para>
91
92 <para condition="html" role="usernotes">User Notes:
93 <ulink url="&blfs-wiki;/nfs-utils"/></para>
94
95 </sect2>
96
97 <sect2 role="kernel" id='nfs-utils-kernel'>
98 <title>Kernel Configuration</title>
99
100 <para>Enable the following options in the kernel configuration
101 and recompile the kernel if necessary:</para>
102
103<screen><literal>File systems:
104 Network File Systems:
105 NFS File System Support: M or Y
106 NFS Server Support: M or Y</literal></screen>
107
108 <para>Select the appropriate sub-options that appear when the above options
109 are selected.</para>
110
111 <indexterm zone="nfs-utils nfs-utils-kernel">
112 <primary sortas="d-nfs-utils">NFS Utilities</primary>
113 </indexterm>
114
115 </sect2>
116
117 <sect2 role="installation" id='nfs-utils-install'
118 xreflabel='NFS Utilities Installation'>
119 <title>Installation of NFS Utilities</title>
120
121 <para>Before you compile the program, ensure that the
122 <systemitem class="username">nobody</systemitem> user and
123 <systemitem class="groupname">nogroup</systemitem> group have been
124 created. You can add them by running the following commands as the
125 <systemitem class="username">root</systemitem> user:</para>
126
127<screen role="root"><userinput>groupadd -g 99 nogroup &amp;&amp;
128useradd -c "Unprivileged Nobody" -d /dev/null -g nogroup \
129 -s /bin/false -u 99 nobody</userinput></screen>
130
131 <note>
132 <para>The classic uid and gid values are 65534 which is also -2 when
133 interpreted as a signed 16-bit number. These values impact other files
134 on some filesystems that do not have support for sparse files. The
135 <systemitem class="username">nobody</systemitem> and <systemitem
136 class="groupname">nogroup</systemitem> values are relatively arbitrary.
137 The impact on a server is nil if the <filename>exports</filename> file
138 is configured correctly. If it is misconfigured, an
139 <command>ls -l</command> or <command>ps</command> listing will show a
140 uid or gid number of 65534 instead of a name. The client uses <systemitem
141 class="username">nobody</systemitem> only as the user running
142 <command>rpc.statd</command>.</para>
143 </note>
144
145 <para>Install <application>NFS Utilities</application> by running
146 the following commands:</para>
147
148<screen><userinput>./configure --prefix=/usr \
149 --sysconfdir=/etc \
150 --without-tcp-wrappers \
151 --disable-nfsv4 \
152 --disable-nfsv41 \
153 --disable-gss &amp;&amp;
154make</userinput></screen>
155
156 <para>If your <filename class="directory">/usr</filename> directory
157 is NFS mounted, you should install the executables in
158 <filename class="directory">/sbin</filename> by passing
159 an additional parameter <option>--sbindir=/sbin</option> to the
160 above <command>./configure</command> command.</para>
161
162 <!-- details of testsuite issuesi are in ticket #3840 -->
163 <para>This package does not come with a working test suite.</para>
164
165 <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
166
167<screen role='root'><userinput>make install</userinput></screen>
168
169 </sect2>
170
171 <sect2 role="commands">
172 <title>Command Explanations</title>
173
174 <para><parameter>--disable-nfsv4</parameter> and
175 <parameter>--disable-nfsv41</parameter>: Disables support
176 for NFS version 4 and version 4.1.</para>
177
178 <para><parameter>--disable-gss</parameter>: Disables support for
179 RPCSEC GSS (RPC Security).</para>
180
181 <para><parameter>--without-tcp-wrappers</parameter>: This option is
182 needed because TCP Wrappers is not in BLFS.</para>
183
184 </sect2>
185
186 <sect2 role="configuration">
187 <title>Configuring NFS Utilities</title>
188
189 <sect3 id='nfs-utils-server-config'>
190 <title>Server Configuration</title>
191
192 <para><filename>/etc/exports</filename> contains the exported directories
193 on NFS servers. Refer to the <filename>exports.5</filename> manual page
194 for the syntax of this file. Also refer to the "NFS HowTo" available at
195 <ulink url="http://nfs.sourceforge.net/nfs-howto/"/> for information on
196 how to configure the servers and clients in a secure manner. For example,
197 for sharing the <filename class="directory">/home</filename> directory
198 over the local network, the following line may be added:</para>
199
200<screen role="root"><userinput>/home <replaceable>&lt;192.168.0.0/24&gt;</replaceable>(rw,subtree_check,anonuid=99,anongid=99)</userinput></screen>
201
202 <indexterm zone="nfs-utils nfs-utils-server-config">
203 <primary sortas="e-etc-exportfs">/etc/exportfs</primary>
204 </indexterm>
205
206 <sect4 id="nfs-utils-server-init">
207 <title>Boot Script</title>
208
209 <para>Install the <filename>/etc/rc.d/init.d/nfs-server</filename>
210 init script included in the <xref linkend="bootscripts"/> package
211 to start the server at boot.</para>
212
213<screen role="root"><userinput>make install-nfs-server</userinput></screen>
214
215 <indexterm zone="nfs-utils nfs-utils-server-init">
216 <primary sortas="f-nfs-server">nfs-server</primary>
217 </indexterm>
218
219 <para>Now create the <filename>/etc/sysconfig/nfs-server</filename>
220 configuration file:</para>
221
222<screen role="root"><userinput>cat &gt; /etc/sysconfig/nfs-server &lt;&lt; "EOF"
223<literal>PORT="2049"
224PROCESSES="8"
225QUOTAS="no"
226KILLDELAY="10"</literal>
227EOF</userinput></screen>
228
229 <note><para>The above parameters may be optionally placed in
230 <filename>/etc/sysconfig/rc.site</filename>.</para></note>
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 </sect3>
240
241 <sect3 id='nfs-utils-client-config'>
242 <title>Client Configuration</title>
243
244 <para><filename>/etc/fstab</filename> contains the directories that
245 are to be mounted on the client. Alternately the partitions can be
246 mounted by using the <command>mount</command> command with the proper
247 options. To mount the <filename class="directory">/home</filename>
248 and <filename class="directory">/usr</filename> partitions, add the
249 following to the <filename>/etc/fstab</filename>:</para>
250
251<screen role="root"><userinput><replaceable>&lt;server-name&gt;</replaceable>:/home /home nfs rw,_netdev,rsize=8192,wsize=8192 0 0
252<replaceable>&lt;server-name&gt;</replaceable>:/usr /usr nfs ro,_netdev,rsize=8192 0 0</userinput></screen>
253
254 <indexterm zone="nfs-utils nfs-utils-client-config">
255 <primary sortas="e-etc-fstab">/etc/fstab</primary>
256 </indexterm>
257
258 <para>In some circumstances an <filename>/etc/netconfig</filename> file
259 is required by an nfs client. It does no harm to create one even if it
260 is not in fact needed. As the <systemitem class="username">root</systemitem>
261 user:</para>
262
263<screen role="root"><userinput>cat &gt; /etc/netconfig &lt;&lt; "EOF"
264udp6 tpi_clts v inet6 udp - -
265tcp6 tpi_cots_ord v inet6 tcp - -
266udp tpi_clts v inet udp - -
267tcp tpi_cots_ord v inet tcp - -
268rawip tpi_raw - inet - - -
269local tpi_cots_ord - loopback - - -
270EOF</userinput></screen>
271
272 <indexterm zone="nfs-utils nfs-utils-client-config">
273 <primary sortas="e-etc-netconfig">/etc/netconfig</primary>
274 </indexterm>
275
276
277 <sect4 id="nfs-utils-client-init">
278 <title>Boot Script</title>
279
280 <note><para>The following boot script is not required if the
281 nfs-server script is installed.</para></note>
282
283 <para>Install the <filename>/etc/rc.d/init.d/nfs-client</filename> init
284 script included in the <xref linkend="bootscripts"/> package to start
285 the client services at boot.</para>
286
287<screen role="root"><userinput>make install-nfs-client</userinput></screen>
288
289 <indexterm zone="nfs-utils nfs-utils-client-config">
290 <primary sortas="f-nfs-client">nfs-client</primary>
291 </indexterm>
292
293 <para>To automatically mount <systemitem
294 class="filesystem">nfs</systemitem> filesystems, clients will also need
295 to install the <filename>netfs</filename> bootscript as described in
296 <xref linkend="postlfs-config-netfs"/>.</para>
297
298 <indexterm zone="nfs-utils nfs-utils-client-config">
299 <primary sortas="f-netfs">netfs</primary>
300 </indexterm>
301
302 </sect4>
303
304 </sect3>
305
306 </sect2>
307
308 <sect2 role="content">
309 <title>Contents</title>
310 <segmentedlist>
311 <segtitle>Installed Programs</segtitle>
312 <segtitle>Installed Libraries</segtitle>
313 <segtitle>Installed Directories</segtitle>
314
315 <seglistitem>
316 <seg>exportfs, mountstats, mount.nfs, mount.nfs4 (link to mount.nfs),
317 nfsiostat, nfsstat, rpc.mountd, rpc.nfsd, rpc.statd, rpcdebug,
318 showmount, sm-notify, start-statd, umount.nfs (link to mount.nfs),
319 and umount.nfs4 (link to mount.nfs)</seg>
320 <seg>None</seg>
321 <seg>/var/lib/nfs</seg>
322 </seglistitem>
323 </segmentedlist>
324
325 <variablelist>
326 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
327 <?dbfo list-presentation="list"?>
328 <?dbhtml list-presentation="table"?>
329
330 <varlistentry id="exportfs">
331 <term><command>exportfs</command></term>
332 <listitem>
333 <para>maintains a list of NFS exported file systems.</para>
334 <indexterm zone="nfs-utils exportfs">
335 <primary sortas="b-exportfs">exportfs</primary>
336 </indexterm>
337 </listitem>
338 </varlistentry>
339
340 <varlistentry id="mountstats">
341 <term><command>mountstats</command></term>
342 <listitem>
343 <para>displays NFS client per-mount statistics.</para>
344 <indexterm zone="nfs-utils mountstats">
345 <primary sortas="b-mountstats">mountstats</primary>
346 </indexterm>
347 </listitem>
348 </varlistentry>
349
350 <varlistentry id="mountnfs">
351 <term><command>mount.nfs</command></term>
352 <listitem>
353 <para>Used to mount a network share using NFS</para>
354 <indexterm zone="nfs-utils mountnfs">
355 <primary sortas="b-mountnfs">mount.nfs</primary>
356 </indexterm>
357 </listitem>
358 </varlistentry>
359
360 <varlistentry id="mountnfs4">
361 <term><command>mount.nfs4</command></term>
362 <listitem>
363 <para>Used to mount a network share using NFSv4</para>
364 <indexterm zone="nfs-utils mountnfs4">
365 <primary sortas="b-mountnfs4">mount.nfs4</primary>
366 </indexterm>
367 </listitem>
368 </varlistentry>
369
370 <varlistentry id="nfsiostat-nfs-utils">
371 <term><command>nfsiostat</command></term>
372 <listitem>
373 <para>Report input/output statistics for network filesystems.</para>
374 <indexterm zone="nfs-utils nfsiostat-nfs-utils">
375 <primary sortas="b-nfsiostat-nfs-utils">nfsiostat</primary>
376 </indexterm>
377 </listitem>
378 </varlistentry>
379
380 <varlistentry id="nfsstat">
381 <term><command>nfsstat</command></term>
382 <listitem>
383 <para>displays statistics kept about NFS client and server activity.</para>
384 <indexterm zone="nfs-utils nfsstat">
385 <primary sortas="b-nfsstat">nfsstat</primary>
386 </indexterm>
387 </listitem>
388 </varlistentry>
389
390 <varlistentry id="rpcmountd">
391 <term><command>rpc.mountd</command></term>
392 <listitem>
393 <para>implements the NFS mount protocol on an NFS server.</para>
394 <indexterm zone="nfs-utils rpcmountd">
395 <primary sortas="b-rpcmountd">rpc.mountd</primary>
396 </indexterm>
397 </listitem>
398 </varlistentry>
399
400 <varlistentry id="rpcnfsd">
401 <term><command>rpc.nfsd</command></term>
402 <listitem>
403 <para>implements the user level part of the NFS
404 service on the server.</para>
405 <indexterm zone="nfs-utils rpcnfsd">
406 <primary sortas="b-rpcnfsd">rpc.nfsd</primary>
407 </indexterm>
408 </listitem>
409 </varlistentry>
410
411 <varlistentry id="rpcstatd">
412 <term><command>rpc.statd</command></term>
413 <listitem>
414 <para>is used by the NFS file locking service. Run on both sides,
415 client as well as server, when you want file locking enabled.</para>
416 <indexterm zone="nfs-utils rpcstatd">
417 <primary sortas="b-rpcstatd">rpc.statd</primary>
418 </indexterm>
419 </listitem>
420 </varlistentry>
421
422 <varlistentry id="rpcdebug">
423 <term><command>rpcdebug</command></term>
424 <listitem>
425 <para>sets or clears the kernel's NFS client and server debug
426 flags.</para>
427 <indexterm zone="nfs-utils rpcdebug">
428 <primary sortas="b-rpcdebug">rpcdebug</primary>
429 </indexterm>
430 </listitem>
431 </varlistentry>
432
433 <varlistentry id="showmount">
434 <term><command>showmount</command></term>
435 <listitem>
436 <para>displays mount information for an NFS server.</para>
437 <indexterm zone="nfs-utils showmount">
438 <primary sortas="b-showmount">showmount</primary>
439 </indexterm>
440 </listitem>
441 </varlistentry>
442
443 <varlistentry id="sm-notify">
444 <term><command>sm-notify</command></term>
445 <listitem>
446 <para>is used to send Network Status Monitor reboot messages.</para>
447 <indexterm zone="nfs-utils sm-notify">
448 <primary sortas="b-sm-notify">sm-notify</primary>
449 </indexterm>
450 </listitem>
451 </varlistentry>
452
453 <varlistentry id="start-statd">
454 <term><command>start-statd</command></term>
455 <listitem>
456 <para>is a script called by nfsmount when mounting a filesystem with
457 locking enabled, if statd does not appear to be running. It can be
458 customised with whatever flags are appropriate for the site.</para>
459 <indexterm zone="nfs-utils start-statd">
460 <primary sortas="b-start-statd">start-statd</primary>
461 </indexterm>
462 </listitem>
463 </varlistentry>
464
465 <varlistentry id="umountnfs">
466 <term><command>umount.nfs</command></term>
467 <listitem>
468 <para>Used to unmount a network share using NFS</para>
469 <indexterm zone="nfs-utils umountnfs">
470 <primary sortas="b-umountnfs">umount.nfs</primary>
471 </indexterm>
472 </listitem>
473 </varlistentry>
474
475 <varlistentry id="umountnfs4">
476 <term><command>umount.nfs4</command></term>
477 <listitem>
478 <para>Used to unmount a network share using NFSv4</para>
479 <indexterm zone="nfs-utils umountnfs4">
480 <primary sortas="b-umountnfs4">umount.nfs4</primary>
481 </indexterm>
482 </listitem>
483 </varlistentry>
484
485 </variablelist>
486
487 </sect2>
488
489</sect1>
Note: See TracBrowser for help on using the repository browser.