source: server/major/nfs-utils.xml@ 5254d12

10.0 10.1 11.0 11.1 11.2 11.3 12.0 12.1 6.2 6.2.0 6.2.0-rc1 6.2.0-rc2 6.3 6.3-rc1 6.3-rc2 6.3-rc3 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 5254d12 was 5254d12, checked in by Randy McMurchy <randy@…>, 18 years ago

Standardized the id tag name of the Bootscripts package

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@5497 af4574ff-66df-0310-9fd7-8a98e5e911e0

  • Property mode set to 100644
File size: 14.7 KB
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
3 "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
4 <!ENTITY % general-entities SYSTEM "../../general.ent">
5 %general-entities;
6
7 <!ENTITY nfs-utils-download-http "http://ftp.kernel.org/pub/linux/utils/nfs/nfs-utils-&nfs-utils-version;.tar.gz">
8 <!ENTITY nfs-utils-download-ftp "ftp://ftp.kernel.org/pub/linux/utils/nfs/nfs-utils-&nfs-utils-version;.tar.gz">
9 <!ENTITY nfs-utils-md5sum "8f863120261cd572ad320a9152581e11">
10 <!ENTITY nfs-utils-size "396 KB">
11 <!ENTITY nfs-utils-buildsize "5.8 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 <keywordset>
22 <keyword role="package">nfs-utils-&nfs-utils-version;.tar</keyword>
23 <keyword role="ftpdir">nfs-utils</keyword>
24 </keywordset>
25 </sect1info>
26
27 <title>NFS Utilities-&nfs-utils-version;</title>
28
29 <indexterm zone="nfs-utils">
30 <primary sortas="a-Nfs-utils">NFS Utilities</primary>
31 </indexterm>
32
33 <sect2 role="package">
34 <title>Introduction to NFS Utilities</title>
35
36 <para>The <application>NFS Utilities</application> package contains the
37 userspace server and client tools necessary to use the kernel's nfs
38 abilities. NFS is a protocol that allows sharing file systems over the
39 network.</para>
40
41 <bridgehead renderas="sect3">Package information</bridgehead>
42 <itemizedlist spacing='compact'>
43 <listitem>
44 <para>Download (HTTP): <ulink url="&nfs-utils-download-http;"/></para>
45 </listitem>
46 <listitem>
47 <para>Download (FTP): <ulink url="&nfs-utils-download-ftp;"/></para>
48 </listitem>
49 <listitem>
50 <para>Download MD5 sum: &nfs-utils-md5sum;</para>
51 </listitem>
52 <listitem>
53 <para>Download size: &nfs-utils-size;</para>
54 </listitem>
55 <listitem>
56 <para>Estimated disk space required: &nfs-utils-buildsize;</para>
57 </listitem>
58 <listitem>
59 <para>Estimated build time: &nfs-utils-time;</para>
60 </listitem>
61 </itemizedlist>
62
63 <bridgehead renderas="sect3">NFS Utilities Dependencies</bridgehead>
64
65 <bridgehead renderas="sect4">Required</bridgehead>
66 <para role="required"><xref linkend="portmap"/></para>
67
68 <bridgehead renderas="sect4">Optional</bridgehead>
69 <para role="optional"><ulink
70 url="http://www.monkey.org/~provos/libevent/">libevent</ulink> and <ulink
71 url="http://www.citi.umich.edu/projects/nfsv4/linux/libnfsidmap/">libnsfidmap</ulink>
72 for nfsv4 support, and <xref linkend="mitkrb"/> or <xref linkend="heimdal"/>
73 for gss (RPC Security) support.</para>
74
75 </sect2>
76
77 <sect2 role="kernel" id='nfs-utils-kernel'>
78 <title>Kernel Configuration</title>
79
80 <para>Enable the following options in the kernel configuration
81 and recompile the kernel if necessary:</para>
82
83<screen><literal>File systems:
84 Network File Systems:
85 NFS File System Support: M or Y
86 NFS Server Support: M or Y</literal></screen>
87
88 <para>Select the appropriate sub-options that appear when the above options
89 are selected.</para>
90
91 <indexterm zone="nfs-utils nfs-utils-kernel">
92 <primary sortas="d-nfs-utils">NFS Utilities</primary>
93 </indexterm>
94
95 </sect2>
96
97 <sect2 role="installation" id='nfs-utils-install' xreflabel='NFS Utilities Installation'>
98 <title>Installation of NFS Utilities</title>
99
100 <para>Before you compile the program, you need to be sure the
101 <systemitem class="username">nobody</systemitem> user and
102 <systemitem class="groupname">nogroup</systemitem> group are available.
103 You can add these by running the following commands as the
104 <systemitem class="username">root</systemitem> user:</para>
105
106<screen role="root"><userinput>groupadd -g 99 nogroup &amp;&amp;
107useradd -c "Unprivileged Nobody" -d /dev/null -g nogroup \
108 -s /bin/false -u 99 nobody</userinput></screen>
109
110 <note>
111 <para>The classic uid and gid values are 65534 which is also -2 when
112 interpreted as a signed 16-bit number. These values impact other files
113 on some filesystems that do not have support for sparse files. The
114 <systemitem class="username">nobody</systemitem> and <systemitem
115 class="groupname">nogroup</systemitem> values are relatively arbitrary.
116 The impact on a server is nil if the exports file is configured
117 correctly. If it is misconfigured, the <command>ls -l</command> or
118 <command>ps</command> listing will show a uid or gid number of 65534
119 instead of a name. The client uses <systemitem
120 class="username">nobody</systemitem> only as the user running
121 <command>rpc.statd</command>.</para>
122 </note>
123
124 <para>Install <application>NFS Utilities</application> by running
125 the following commands:</para>
126
127<screen><userinput>./configure --prefix=/usr --sysconfdir=/etc \
128 --disable-nfsv4 --disable-gss &amp;&amp;
129make</userinput></screen>
130
131 <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
132
133<screen role='root'><userinput>make install</userinput></screen>
134
135 <note>
136 <para>If your <filename class="directory">/usr</filename> directory
137 is NFS mounted, you should install the executables in
138 <filename class="directory">/sbin</filename> by passing
139 an additional parameter <option>--sbindir=/sbin</option> to the
140 above <command>./configure</command> command.</para>
141 </note>
142
143 </sect2>
144
145 <sect2 role="commands">
146 <title>Command Explanations</title>
147
148 <para><parameter>--disable-nfsv4</parameter>: Disables support
149 for NFS Version 4.</para>
150
151 <para><parameter>--disable-gss</parameter>: Disables support for
152 RPCSEC GSS (RPC Security).</para>
153
154 </sect2>
155
156 <sect2 role="configuration">
157 <title>Configuring NFS Utilities</title>
158
159 <sect3 id='nfs-utils-server-config'>
160 <title>Server Configuration</title>
161
162 <para><filename>/etc/exports</filename> contains the exported directories
163 on NFS servers. Refer to the exports manual page for the syntax of this
164 file. Also refer to the "NFS HowTo" available at <ulink
165 url="http://nfs.sourceforge.net/nfs-howto/"/> on how to configure the
166 servers and clients in a secure manner. For example, for sharing the
167 <filename class="directory">/home</filename> directory over the local
168 network, the following line may be added:</para>
169
170<screen role="root"><userinput>/home 192.168.0.0/255.255.255.0(rw,anonuid=99,anongid=99)</userinput></screen>
171
172 <indexterm zone="nfs-utils nfs-utils-server-config">
173 <primary sortas="e-etc-exportfs">/etc/exportfs</primary>
174 </indexterm>
175
176 <sect4 id="nfs-utils-server-init">
177 <title>Boot Script</title>
178
179 <para>Install the <filename>/etc/rc.d/init.d/nfs-server</filename>
180 init script included in the <xref
181 linkend="bootscripts"/> package to start the server
182 at boot.</para>
183
184<screen role="root"><userinput>make install-nfs-server</userinput></screen>
185
186 <indexterm zone="nfs-utils nfs-utils-server-init">
187 <primary sortas="f-nfs-server">nfs-server</primary>
188 </indexterm>
189
190 <para>Now create the <filename>/etc/sysconfig/nfs-server</filename>
191 configuration file:</para>
192
193<screen role="root"><userinput>cat &gt; /etc/sysconfig/nfs-server &lt;&lt; "EOF"
194<literal>PORT="2049"
195PROCESSES="8"
196QUOTAS="no"
197KILLDELAY="10"</literal>
198EOF</userinput></screen>
199
200 <indexterm zone="nfs-utils nfs-utils-server-init">
201 <primary
202 sortas="e-etc-sysconfig-nfs-server">/etc/sysconfig/nfs-server</primary>
203 </indexterm>
204
205 </sect4>
206
207 </sect3>
208
209 <sect3 id='nfs-utils-client-config'>
210 <title>Client Configuration</title>
211
212 <para><filename>/etc/fstab</filename> contains the directories that
213 are to be mounted on the client. Alternately the partitions can be
214 mounted by using the <command>mount</command> command with the proper
215 options. To mount the <filename class="directory">/home</filename>
216 and <filename class="directory">/usr</filename> partitions, add the
217 following to the <filename>/etc/fstab</filename>:</para>
218
219<screen role="root"><userinput>&lt;server-name&gt;:/home /home nfs rw,_netdev,rsize=8192,wsize=8192 0 0
220&lt;server-name&gt;:/usr /usr nfs ro,_netdev,rsize=8192 0 0</userinput></screen>
221
222 <indexterm zone="nfs-utils nfs-utils-client-config">
223 <primary sortas="e-etc-fstab">/etc/fstab</primary>
224 </indexterm>
225
226 <sect4 id="nfs-utils-client-init">
227 <title>Boot Script</title>
228
229
230 <para>Install the <filename>/etc/rc.d/init.d/nfs-client</filename>
231 init script included in the
232 <xref linkend="bootscripts"/> package to
233 start the client services at boot.</para>
234
235<screen role="root"><userinput>make install-nfs-client</userinput></screen>
236
237 <indexterm zone="nfs-utils nfs-utils-client-config">
238 <primary sortas="f-nfs-client">nfs-client</primary>
239 </indexterm>
240
241 <para>To automatically mount <systemitem
242 class="filesystem">nfs</systemitem> filesystems, clients will also
243 need to install the <filename>netfs</filename> bootscript as described
244 in <xref linkend='postlfs-config-netfs'/>.</para>
245
246 <indexterm zone="nfs-utils nfs-utils-client-config">
247 <primary sortas="f-netfs">netfs</primary>
248 </indexterm>
249
250 </sect4>
251
252 </sect3>
253
254 </sect2>
255
256 <sect2 role="content">
257 <title>Contents</title>
258 <segmentedlist>
259 <segtitle>Installed Programs</segtitle>
260 <segtitle>Installed Libraries</segtitle>
261 <segtitle>Installed Directories</segtitle>
262
263 <seglistitem>
264 <seg>exportfs, nfsstat, nhfsgraph, nhfsnums, nhfsrun, nhfsstone,
265 rpc.lockd, rpc.mountd, rpc.nfsd, rpc.rquotad, rpc.statd,
266 and showmount</seg>
267 <seg>None</seg>
268 <seg>/var/lib/nfs</seg>
269 </seglistitem>
270 </segmentedlist>
271
272 <variablelist>
273 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
274 <?dbfo list-presentation="list"?>
275 <?dbhtml list-presentation="table"?>
276
277 <varlistentry id="exportfs">
278 <term><command>exportfs</command></term>
279 <listitem>
280 <para>maintains a list of NFS exported file systems.</para>
281 <indexterm zone="nfs-utils exportfs">
282 <primary sortas="b-exportfs">exportfs</primary>
283 </indexterm>
284 </listitem>
285 </varlistentry>
286
287 <varlistentry id="nfsstat">
288 <term><command>nfsstat</command></term>
289 <listitem>
290 <para>prints NFS statistics.</para>
291 <indexterm zone="nfs-utils nfsstat">
292 <primary sortas="b-nfsstat">nfsstat</primary>
293 </indexterm>
294 </listitem>
295 </varlistentry>
296
297 <varlistentry id="nhfsgraph">
298 <term><command>nhfsgraph</command></term>
299 <listitem>
300 <para>runs <command>nhfsstone</command> over multiple loads.</para>
301 <indexterm zone="nfs-utils nhfsgraph">
302 <primary sortas="b-nhfsgraph">nhfsgraph</primary>
303 </indexterm>
304 </listitem>
305 </varlistentry>
306
307 <varlistentry id="nhfsnums">
308 <term><command>nhfsnums</command></term>
309 <listitem>
310 <para>converts raw numbers from <command>nhfsstone</command>
311 output into plot format.</para>
312 <indexterm zone="nfs-utils nhfsnums">
313 <primary sortas="b-nhfsnums">nhfsnums</primary>
314 </indexterm>
315 </listitem>
316 </varlistentry>
317
318 <varlistentry id="nhfsrun">
319 <term><command>nhfsrun</command></term>
320 <listitem>
321 <para>executes <command>nhfsstone</command> with a range of
322 different loads.</para>
323 <indexterm zone="nfs-utils nhfsrun">
324 <primary sortas="b-nhfsrun">nhfsrun</primary>
325 </indexterm>
326 </listitem>
327 </varlistentry>
328
329 <varlistentry id="nhfsstone">
330 <term><command>nhfsstone</command></term>
331 <listitem>
332 <para>is used on a NFS client to generate an artificial load
333 with a particular mix of NFS operations.</para>
334 <indexterm zone="nfs-utils nhfsstone">
335 <primary sortas="b-nhfsstone">nhfsstone</primary>
336 </indexterm>
337 </listitem>
338 </varlistentry>
339
340 <varlistentry id="rpclockd">
341 <term><command>rpc.lockd</command></term>
342 <listitem>
343 <para>starts the NFS lock manager (NLM) on kernels that don't
344 start it automatically. However, since most kernels do start it
345 automatically it is usually not required.</para>
346 <indexterm zone="nfs-utils rpclockd">
347 <primary sortas="b-rpclockd">rpc.lockd</primary>
348 </indexterm>
349 </listitem>
350 </varlistentry>
351
352 <varlistentry id="rpcmountd">
353 <term><command>rpc.mountd</command></term>
354 <listitem>
355 <para>implements the NFS mount protocol on an NFS server.</para>
356 <indexterm zone="nfs-utils rpcmountd">
357 <primary sortas="b-rpcmountd">rpc.mountd</primary>
358 </indexterm>
359 </listitem>
360 </varlistentry>
361
362 <varlistentry id="rpcnfsd">
363 <term><command>rpc.nfsd</command></term>
364 <listitem>
365 <para>implements the user level part of the NFS
366 service on the server.</para>
367 <indexterm zone="nfs-utils rpcnfsd">
368 <primary sortas="b-rpcnfsd">rpc.nfsd</primary>
369 </indexterm>
370 </listitem>
371 </varlistentry>
372
373 <varlistentry id="rpcrquotad">
374 <term><command>rpc.rquotad</command></term>
375 <listitem>
376 <para>is an rpc server which returns quotas for a user of a
377 local file system which is mounted by a remote machine over
378 the NFS.</para>
379 <indexterm zone="nfs-utils rpcrquotad">
380 <primary sortas="b-rpcrquotad">rpc.rquotad</primary>
381 </indexterm>
382 </listitem>
383 </varlistentry>
384
385 <varlistentry id="rpcstatd">
386 <term><command>rpc.statd</command></term>
387 <listitem>
388 <para>is used by the NFS file locking service,
389 <command>rpc.lockd</command>, to implement lock recovery when
390 the NFS server machine crashes and reboots. Runs on the NFS
391 server only.</para>
392 <indexterm zone="nfs-utils rpcstatd">
393 <primary sortas="b-rpcstatd">rpc.statd</primary>
394 </indexterm>
395 </listitem>
396 </varlistentry>
397
398 <varlistentry id="showmount">
399 <term><command>showmount</command></term>
400 <listitem>
401 <para>displays mount information for an NFS server.</para>
402 <indexterm zone="nfs-utils showmount">
403 <primary sortas="b-showmount">showmount</primary>
404 </indexterm>
405 </listitem>
406 </varlistentry>
407
408 </variablelist>
409
410 </sect2>
411
412</sect1>
Note: See TracBrowser for help on using the repository browser.