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

10.0 10.1 11.0 11.1 11.2 11.3 12.0 12.1 7.10 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 cca69d7 was cca69d7, checked in by Igor Živković <igor@…>, 10 years ago

typo

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