source: networking/netprogs/nfs-utils.xml@ 01155b9

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 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 01155b9 was 01155b9, checked in by Bruce Dubbs <bdubbs@…>, 9 years ago

Update to nfs-utils-1.3.2

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@15484 af4574ff-66df-0310-9fd7-8a98e5e911e0
  • Property mode set to 100644
File size: 17.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 "1e2f3c1ed468dee02d00c534c002ea10">
10 <!ENTITY nfs-utils-size "772 KB">
11 <!ENTITY nfs-utils-buildsize "16 MB">
12 <!ENTITY nfs-utils-time "0.1 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; [CONFIG_NETWORK_FILESYSTEMS]
97 &lt;*/M&gt; NFS client support [CONFIG_NFS_FS]
98 &lt;*/M&gt; NFS server support [CONFIG_NFSD]</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>192.168.0.0/24</replaceable>(rw,subtree_check,anonuid=99,anongid=99)</userinput></screen>
192
193 <note><para>Be sure to replace the directory, network address. and prefix above
194 to match your network. The only space in the line above should be between
195 the directory and the network address.</para></note>
196
197 <indexterm zone="nfs-utils nfs-utils-server-config">
198 <primary sortas="e-etc-exportfs">/etc/exportfs</primary>
199 </indexterm>
200
201 <sect4 id="nfs-utils-server-init">
202 <title>Boot Script</title>
203
204 <para>Install the <filename>/etc/rc.d/init.d/nfs-server</filename>
205 init script included in the <xref linkend="bootscripts"/> package
206 to start the server at boot.</para>
207
208<screen role="root"><userinput>make install-nfs-server</userinput></screen>
209
210 <indexterm zone="nfs-utils nfs-utils-server-init">
211 <primary sortas="f-nfs-server">nfs-server</primary>
212 </indexterm>
213
214 <para>Now create the <filename>/etc/sysconfig/nfs-server</filename>
215 configuration file:</para>
216
217<screen role="root"><userinput>cat &gt; /etc/sysconfig/nfs-server &lt;&lt; "EOF"
218<literal>PORT="2049"
219PROCESSES="8"
220QUOTAS="no"
221KILLDELAY="10"</literal>
222EOF</userinput></screen>
223
224 <note><para>The above parameters may be optionally placed in
225 <filename>/etc/sysconfig/rc.site</filename>.</para></note>
226
227 <indexterm zone="nfs-utils nfs-utils-server-init">
228 <primary
229 sortas="e-etc-sysconfig-nfs-server">/etc/sysconfig/nfs-server</primary>
230 </indexterm>
231
232 </sect4>
233
234 </sect3>
235
236 <sect3 id='nfs-utils-client-config'>
237 <title>Client Configuration</title>
238
239 <para><filename>/etc/fstab</filename> contains the directories that
240 are to be mounted on the client. Alternately the partitions can be
241 mounted by using the <command>mount</command> command with the proper
242 options. To mount the <filename class="directory">/home</filename>
243 and <filename class="directory">/usr</filename> partitions, add the
244 following to the <filename>/etc/fstab</filename>:</para>
245
246<screen role="root"><userinput><replaceable>&lt;server-name&gt;</replaceable>:/home /home nfs rw,_netdev 0 0
247<replaceable>&lt;server-name&gt;</replaceable>:/usr /usr nfs ro,_netdev 0 0</userinput></screen>
248
249 <para>The options which can be used are specified in <command>man 5 nfs</command>.
250 If both the client and server are running recent versions of linux, most of the
251 options will be negotiated. You can specify either <literal>rw</literal> or
252 <literal>ro</literal>, <literal>_netdev</literal> if the filesystem is to be
253 automatically mounted at boot, or <literal>noauto</literal> (and perhaps
254 <literal>user</literal>) for other filesystems.</para>
255
256 <para>If the fileserver is not running a recent version of linux, you may need to
257 specifiy other options.</para>
258
259 <para>If you are using systemd, you may need to enable autofs v4 in your kernel,
260 and add the option <literal>comment=systemd.automount</literal>. Some machines
261 need this, because systemd tries to mount the external fs&apos;s before the network
262 is up, others do not need it. An alternative is for <systemitem
263 class="username">root</systemitem> to run <command>mount -a</command>.</para>
264
265 <indexterm zone="nfs-utils nfs-utils-client-config">
266 <primary sortas="e-etc-fstab">/etc/fstab</primary>
267 </indexterm>
268
269 <sect4 id="nfs-utils-client-init">
270 <title>Boot Script</title>
271
272 <note><para>The following boot script is not required if the
273 nfs-server script is installed.</para></note>
274
275 <para>Install the <filename>/etc/rc.d/init.d/nfs-client</filename> init
276 script included in the <xref linkend="bootscripts"/> package to start
277 the client services at boot.</para>
278
279<screen role="root"><userinput>make install-nfs-client</userinput></screen>
280
281 <indexterm zone="nfs-utils nfs-utils-client-config">
282 <primary sortas="f-nfs-client">nfs-client</primary>
283 </indexterm>
284
285 <para>To automatically mount <systemitem
286 class="filesystem">nfs</systemitem> filesystems, clients will also need
287 to install the <filename>netfs</filename> bootscript as described in
288 <xref linkend="postlfs-config-netfs"/>.</para>
289
290 <indexterm zone="nfs-utils nfs-utils-client-config">
291 <primary sortas="f-netfs">netfs</primary>
292 </indexterm>
293
294 </sect4>
295
296 </sect3>
297
298 </sect2>
299
300 <sect2 role="content">
301 <title>Contents</title>
302 <segmentedlist>
303 <segtitle>Installed Programs</segtitle>
304 <segtitle>Installed Libraries</segtitle>
305 <segtitle>Installed Directories</segtitle>
306
307 <seglistitem>
308 <seg>exportfs, mountstats, mount.nfs, mount.nfs4 (link to mount.nfs),
309 nfsiostat, nfsstat, osd_login, rpc.mountd, rpc.nfsd, rpc.statd, rpcdebug,
310 showmount, sm-notify, start-statd, umount.nfs (link to mount.nfs),
311 and umount.nfs4 (link to mount.nfs)</seg>
312 <seg>None</seg>
313 <seg>/var/lib/nfs</seg>
314 </seglistitem>
315 </segmentedlist>
316
317 <variablelist>
318 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
319 <?dbfo list-presentation="list"?>
320 <?dbhtml list-presentation="table"?>
321
322 <varlistentry id="exportfs">
323 <term><command>exportfs</command></term>
324 <listitem>
325 <para>maintains a list of NFS exported file systems.</para>
326 <indexterm zone="nfs-utils exportfs">
327 <primary sortas="b-exportfs">exportfs</primary>
328 </indexterm>
329 </listitem>
330 </varlistentry>
331
332 <varlistentry id="mountstats">
333 <term><command>mountstats</command></term>
334 <listitem>
335 <para>displays NFS client per-mount statistics.</para>
336 <indexterm zone="nfs-utils mountstats">
337 <primary sortas="b-mountstats">mountstats</primary>
338 </indexterm>
339 </listitem>
340 </varlistentry>
341
342 <varlistentry id="mountnfs">
343 <term><command>mount.nfs</command></term>
344 <listitem>
345 <para>Used to mount a network share using NFS</para>
346 <indexterm zone="nfs-utils mountnfs">
347 <primary sortas="b-mountnfs">mount.nfs</primary>
348 </indexterm>
349 </listitem>
350 </varlistentry>
351
352 <varlistentry id="mountnfs4">
353 <term><command>mount.nfs4</command></term>
354 <listitem>
355 <para>Used to mount a network share using NFSv4</para>
356 <indexterm zone="nfs-utils mountnfs4">
357 <primary sortas="b-mountnfs4">mount.nfs4</primary>
358 </indexterm>
359 </listitem>
360 </varlistentry>
361
362 <varlistentry id="nfsiostat-nfs-utils">
363 <term><command>nfsiostat</command></term>
364 <listitem>
365 <para>Report input/output statistics for network filesystems.</para>
366 <indexterm zone="nfs-utils nfsiostat-nfs-utils">
367 <primary sortas="b-nfsiostat-nfs-utils">nfsiostat</primary>
368 </indexterm>
369 </listitem>
370 </varlistentry>
371
372 <varlistentry id="nfsstat">
373 <term><command>nfsstat</command></term>
374 <listitem>
375 <para>displays statistics kept about NFS client and server activity.</para>
376 <indexterm zone="nfs-utils nfsstat">
377 <primary sortas="b-nfsstat">nfsstat</primary>
378 </indexterm>
379 </listitem>
380 </varlistentry>
381
382 <varlistentry id="rpcmountd">
383 <term><command>rpc.mountd</command></term>
384 <listitem>
385 <para>implements the NFS mount protocol on an NFS server.</para>
386 <indexterm zone="nfs-utils rpcmountd">
387 <primary sortas="b-rpcmountd">rpc.mountd</primary>
388 </indexterm>
389 </listitem>
390 </varlistentry>
391
392 <varlistentry id="rpcnfsd">
393 <term><command>rpc.nfsd</command></term>
394 <listitem>
395 <para>implements the user level part of the NFS
396 service on the server.</para>
397 <indexterm zone="nfs-utils rpcnfsd">
398 <primary sortas="b-rpcnfsd">rpc.nfsd</primary>
399 </indexterm>
400 </listitem>
401 </varlistentry>
402
403 <varlistentry id="rpcstatd">
404 <term><command>rpc.statd</command></term>
405 <listitem>
406 <para>is used by the NFS file locking service. Run on both sides,
407 client as well as server, when you want file locking enabled.</para>
408 <indexterm zone="nfs-utils rpcstatd">
409 <primary sortas="b-rpcstatd">rpc.statd</primary>
410 </indexterm>
411 </listitem>
412 </varlistentry>
413
414 <varlistentry id="rpcdebug">
415 <term><command>rpcdebug</command></term>
416 <listitem>
417 <para>sets or clears the kernel's NFS client and server debug
418 flags.</para>
419 <indexterm zone="nfs-utils rpcdebug">
420 <primary sortas="b-rpcdebug">rpcdebug</primary>
421 </indexterm>
422 </listitem>
423 </varlistentry>
424
425 <varlistentry id="showmount">
426 <term><command>showmount</command></term>
427 <listitem>
428 <para>displays mount information for an NFS server.</para>
429 <indexterm zone="nfs-utils showmount">
430 <primary sortas="b-showmount">showmount</primary>
431 </indexterm>
432 </listitem>
433 </varlistentry>
434
435 <varlistentry id="sm-notify">
436 <term><command>sm-notify</command></term>
437 <listitem>
438 <para>is used to send Network Status Monitor reboot messages.</para>
439 <indexterm zone="nfs-utils sm-notify">
440 <primary sortas="b-sm-notify">sm-notify</primary>
441 </indexterm>
442 </listitem>
443 </varlistentry>
444
445 <varlistentry id="start-statd">
446 <term><command>start-statd</command></term>
447 <listitem>
448 <para>is a script called by nfsmount when mounting a filesystem with
449 locking enabled, if statd does not appear to be running. It can be
450 customised with whatever flags are appropriate for the site.</para>
451 <indexterm zone="nfs-utils start-statd">
452 <primary sortas="b-start-statd">start-statd</primary>
453 </indexterm>
454 </listitem>
455 </varlistentry>
456
457 <varlistentry id="umountnfs">
458 <term><command>umount.nfs</command></term>
459 <listitem>
460 <para>Used to unmount a network share using NFS</para>
461 <indexterm zone="nfs-utils umountnfs">
462 <primary sortas="b-umountnfs">umount.nfs</primary>
463 </indexterm>
464 </listitem>
465 </varlistentry>
466
467 <varlistentry id="umountnfs4">
468 <term><command>umount.nfs4</command></term>
469 <listitem>
470 <para>Used to unmount a network share using NFSv4</para>
471 <indexterm zone="nfs-utils umountnfs4">
472 <primary sortas="b-umountnfs4">umount.nfs4</primary>
473 </indexterm>
474 </listitem>
475 </varlistentry>
476
477 </variablelist>
478
479 </sect2>
480
481</sect1>
Note: See TracBrowser for help on using the repository browser.