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

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 ee22698 was ee22698, checked in by Ken Moffat <ken@…>, 12 years ago

tags

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