source: networking/netprogs/nfs-utils.xml@ b0b87ad6

10.0 10.1 11.0 11.1 11.2 11.3 12.0 12.1 7.10 7.7 7.8 7.9 8.0 8.1 8.2 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind 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 trunk upgradedb xry111/intltool xry111/llvm18 xry111/soup3 xry111/test-20220226 xry111/xf86-video-removal
Last change on this file since b0b87ad6 was b0b87ad6, checked in by Bruce Dubbs <bdubbs@…>, 10 years ago

Update to utils-1.3.1
Update to icu4c-54_1
Update to at_3.1.16

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