Ignore:
Timestamp:
03/22/2020 03:52:07 PM (4 years ago)
Author:
Pierre Labastie <pieere@…>
Branches:
10.0, 10.1, 11.0, 11.1, 11.2, 11.3, 12.0, 12.1, kea, ken/TL2024, ken/inkscape-core-mods, ken/tuningfonts, lazarus, lxqt, 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
Children:
254bc90d
Parents:
dcee7a56
Message:

Format netprogs

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

File:
1 edited

Legend:

Unmodified
Added
Removed

  • networking/netprogs/nfs-utils.xml

    rdcee7a56 rb51fe6e  
    3131    <title>Introduction to NFS Utilities</title>
    3232
    33     <para>The <application>NFS Utilities</application> package contains the
    34     userspace server and client tools necessary to use the kernel's NFS
    35     abilities. NFS is a protocol that allows sharing file systems over the
    36     network.</para>
     33    <para>
     34      The <application>NFS Utilities</application> package contains the
     35      userspace server and client tools necessary to use the kernel's NFS
     36      abilities. NFS is a protocol that allows sharing file systems over the
     37      network.
     38    </para>
    3739
    3840    &lfs91_checked;
    … …  
    4143    <itemizedlist spacing='compact'>
    4244      <listitem>
    43         <para>Download (HTTP): <ulink url="&nfs-utils-download-http;"/></para>
     45        <para>
     46          Download (HTTP): <ulink url="&nfs-utils-download-http;"/>
     47        </para>
    4448      </listitem>
    4549      <listitem>
    46         <para>Download (FTP): <ulink url="&nfs-utils-download-ftp;"/></para>
     50        <para>
     51          Download (FTP): <ulink url="&nfs-utils-download-ftp;"/>
     52        </para>
    4753      </listitem>
    4854      <listitem>
    49         <para>Download MD5 sum: &nfs-utils-md5sum;</para>
     55        <para>
     56          Download MD5 sum: &nfs-utils-md5sum;
     57        </para>
    5058      </listitem>
    5159      <listitem>
    52         <para>Download size: &nfs-utils-size;</para>
     60        <para>
     61          Download size: &nfs-utils-size;
     62        </para>
    5363      </listitem>
    5464      <listitem>
    55         <para>Estimated disk space required: &nfs-utils-buildsize;</para>
     65        <para>
     66          Estimated disk space required: &nfs-utils-buildsize;
     67        </para>
    5668      </listitem>
    5769      <listitem>
    58         <para>Estimated build time: &nfs-utils-time;</para>
     70        <para>
     71          Estimated build time: &nfs-utils-time;
     72        </para>
    5973      </listitem>
    6074    </itemizedlist>
    … …  
    7589      <xref linkend="sqlite"/>,
    7690      <xref linkend="mitkrb"/> or
    77       <ulink url="http://www.citi.umich.edu/projects/nfsv4/linux/">libgssapi</ulink>, and
    78       <ulink url="http://www.citi.umich.edu/projects/nfsv4/linux/">librpcsecgss</ulink> (for GSS and RPC security support) and
    79      
     91      <ulink url="http://www.citi.umich.edu/projects/nfsv4/linux/">
     92        libgssapi
     93      </ulink>, and
     94      <ulink url="http://www.citi.umich.edu/projects/nfsv4/linux/">
     95        librpcsecgss
     96      </ulink> (for GSS and RPC security support), and
    8097      <xref linkend="libcap-pam"/>
    8198    </para>
    … …  
    103120    <title>Kernel Configuration</title>
    104121
    105     <para>Enable the following options in the kernel configuration
    106     (choose client and/or server support as appropriate) and recompile the
    107     kernel if necessary:</para>
     122    <para>
     123      Enable the following options in the kernel configuration
     124      (choose client and/or server support as appropriate) and recompile the
     125      kernel if necessary:
     126    </para>
    108127
    109128<screen><literal>File systems  ---&gt;
    … …  
    112131    &lt;*/M&gt; NFS server support             [CONFIG_NFSD]</literal></screen>
    113132
    114     <para>Select the appropriate sub-options that appear when the above options
    115     are selected.</para>
     133    <para>
     134      Select the appropriate sub-options that appear when the above options
     135      are selected.
     136    </para>
    116137
    117138    <note>
    … …  
    142163    <title>Installation of NFS Utilities</title>
    143164
    144     <para>Before you compile the program, ensure that the <systemitem
    145     class="username">nobody</systemitem> user and <systemitem
    146     class="groupname">nogroup</systemitem> group have been created as done in
    147     the current LFS book.  You can add them by running the following commands
    148     as the <systemitem class="username">root</systemitem> user:</para>
     165    <para>
     166      Before you compile the program, ensure that the <systemitem
     167      class="username">nobody</systemitem> user and <systemitem
     168      class="groupname">nogroup</systemitem> group have been created as done in
     169      the current LFS book.  You can add them by running the following commands
     170      as the <systemitem class="username">root</systemitem> user:
     171    </para>
    149172
    150173<screen role="nodump"><userinput>groupadd -g 99 nogroup &amp;&amp;
    … …  
    153176
    154177    <note>
    155       <para>The classic uid and gid values are 65534 which is also -2 when
    156       interpreted as a signed 16-bit number.  These values impact other files
    157       on some filesystems that do not have support for sparse files.  The
    158       <systemitem class="username">nobody</systemitem> and <systemitem
    159       class="groupname">nogroup</systemitem> values are relatively arbitrary.
    160       The impact on a server is nil if the <filename>exports</filename> file
    161       is configured correctly. If it is misconfigured, an
    162       <command>ls -l</command> or <command>ps</command> listing will show a
    163       uid or gid number of 65534 instead of a name. The client uses <systemitem
    164       class="username">nobody</systemitem> only as the user running
    165       <command>rpc.statd</command>.</para>
     178      <para>
     179        The classic uid and gid values are 65534 which is also -2 when
     180        interpreted as a signed 16-bit number.  These values impact other files
     181        on some filesystems that do not have support for sparse files.  The
     182        <systemitem class="username">nobody</systemitem> and <systemitem
     183        class="groupname">nogroup</systemitem> values are relatively arbitrary.
     184        The impact on a server is nil if the <filename>exports</filename> file
     185        is configured correctly. If it is misconfigured, an
     186        <command>ls -l</command> or <command>ps</command> listing will show a
     187        uid or gid number of 65534 instead of a name. The client uses
     188        <systemitem class="username">nobody</systemitem> only as the user
     189        running <command>rpc.statd</command>.
     190      </para>
    166191    </note>
    167192
    168     <para>Install <application>NFS Utilities</application> by running
    169     the following commands:</para>
     193    <para>
     194      Install <application>NFS Utilities</application> by running
     195      the following commands:
     196    </para>
    170197
    171198<screen><userinput>./configure --prefix=/usr          \
    … …  
    178205    <!-- Test breakage: see
    179206    http://lists.linuxfromscratch.org/pipermail/blfs-book/2017-December/071861.html -->
    180     <para>This package does not come with a working test suite.</para>
    181 
    182     <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
     207    <para>
     208      This package does not come with a working test suite.
     209    </para>
     210
     211    <para>
     212      Now, as the <systemitem class="username">root</systemitem> user:
     213    </para>
    183214
    184215<!-- dev note: make statduser=$(whoami) DESTDIR=<DESTDIR> install -->
    … …  
    190221
    191222    <!-- commented, in case the tests get fixed
    192     <para>The tests for this package require that the package be installed and
    193     configured as specified below.  In addition, the daemon from <xref
    194     linkend="rpcbind"/> needs to be running and the tests need to be run as the
    195     <systemitem class="username">root</systemitem> user.</para>
    196 
    197     <para>To test the results, issue, as root: <command>make check</command>.</para>-->
     223    <para>
     224      The tests for this package require that the package be installed and
     225      configured as specified below.  In addition, the daemon from <xref
     226      linkend="rpcbind"/> needs to be running and the tests need to be run as
     227      the <systemitem class="username">root</systemitem> user.
     228    </para>
     229
     230    <para>
     231      To test the results, issue, as root: <command>make check</command>.
     232    </para>-->
    198233
    199234  </sect2>
    … …  
    202237    <title>Command Explanations</title>
    203238<!--
    204     <para><command>sed ... support/nsm/rpc.c</command>: This sed it required
    205     to fix a build issue with glibc-2.26 and later.</para>
     239    <para>
     240      <command>sed ... support/nsm/rpc.c</command>: This sed it required
     241      to fix a build issue with glibc-2.26 and later.
     242    </para>
    206243-->
    207     <para><parameter>--disable-nfsv4</parameter>: This allows the package to be
    208     built when libnfsidmap has not been installed.</para>
    209 
    210     <para><parameter>--disable-gss</parameter>: Disables support for
    211     RPCSEC GSS (RPC Security).</para>
    212 
    213     <para><command>chown nobody.nogroup /var/lib/nfs</command>: The
    214     rpc.statd program uses the ownership of this directory to set
    215     it's UID and GID.  This command sets those to unprivileged entries.
     244    <para>
     245      <parameter>--disable-nfsv4</parameter>: This allows the package to be
     246      built when libnfsidmap has not been installed.
     247    </para>
     248
     249    <para>
     250      <parameter>--disable-gss</parameter>: Disables support for
     251      RPCSEC GSS (RPC Security).
     252    </para>
     253
     254    <para>
     255      <command>chown nobody.nogroup /var/lib/nfs</command>: The
     256      rpc.statd program uses the ownership of this directory to set
     257      it's UID and GID.  This command sets those to unprivileged entries.
    216258    </para>
    217259
    … …  
    224266      <title>Server Configuration</title>
    225267
    226       <para><filename>/etc/exports</filename> contains the exported directories
    227       on NFS servers. Refer to the <filename>exports.5</filename> manual page
    228       for the syntax of this file. Also refer to the "NFS HowTo" available at
    229       <ulink url="http://nfs.sourceforge.net/nfs-howto/"/> for information on
    230       how to configure the servers and clients in a secure manner. For example,
    231       for sharing the <filename class="directory">/home</filename> directory
    232       over the local network, the following line may be added:</para>
     268      <para>
     269        <filename>/etc/exports</filename> contains the exported directories
     270        on NFS servers. Refer to the <filename>exports.5</filename> manual page
     271        for the syntax of this file. Also refer to the "NFS HowTo" available at
     272        <ulink url="http://nfs.sourceforge.net/nfs-howto/"/> for information on
     273        how to configure the servers and clients in a secure manner. For
     274        example, for sharing the <filename class="directory">/home</filename>
     275        directory over the local network, the following line may be added:
     276      </para>
    233277
    234278<screen role="nodump"><userinput>cat &gt;&gt; /etc/exports &lt;&lt; EOF
    … …  
    236280EOF</userinput></screen>
    237281
    238       <note><para>Be sure to replace the directory, network address. and prefix above
    239       to match your network.  The only space in the line above should be between
    240       the directory and the network address.</para></note>
     282      <note>
     283        <para>
     284          Be sure to replace the directory, network address. and prefix above
     285          to match your network.  The only space in the line above should be
     286          between the directory and the network address.
     287        </para>
     288      </note>
    241289
    242290      <indexterm zone="nfs-utils nfs-utils-server-config">
    … …  
    248296               <phrase revision="systemd">Systemd Units</phrase></title>
    249297
    250         <para>Install the
    251         <phrase revision="sysv"><filename>/etc/rc.d/init.d/nfs-server</filename>
    252         init script</phrase>
    253         <phrase revision="systemd">NFSv4 server units</phrase>
    254         included in the <xref linkend="bootscripts" revision="sysv"/>
    255         <xref linkend="systemd-units" revision="systemd"/> package
    256         to start the server at boot.</para>
     298        <para>
     299          Install the
     300          <phrase revision="sysv">
     301            <filename>/etc/rc.d/init.d/nfs-server</filename>
     302            init script
     303          </phrase>
     304          <phrase revision="systemd">NFSv4 server units</phrase>
     305          included in the <xref linkend="bootscripts" revision="sysv"/>
     306          <xref linkend="systemd-units" revision="systemd"/> package
     307          to start the server at boot.
     308        </para>
    257309
    258310<screen role="root" revision="systemd"><userinput>make install-nfsv4-server</userinput></screen>
    … …  
    271323        </indexterm>
    272324
    273         <para revision="sysv">Now create the
     325        <para revision="sysv">
     326          Now create the
    274327          <filename>/etc/sysconfig/nfs-server</filename> configuration file:
    275328        </para>
    … …  
    282335
    283336        <note revision="sysv">
    284           <para>The above parameters may be optionally placed in
     337          <para>
     338            The above parameters may be optionally placed in
    285339            <filename>/etc/sysconfig/rc.site</filename>.
    286340          </para>
    … …  
    302356        </indexterm>
    303357
    304 
    305 
    306358      </sect4>
    307359
    … …  
    311363      <title>Client Configuration</title>
    312364
    313       <para><filename>/etc/fstab</filename> contains the directories that
    314       are to be mounted on the client. Alternately the partitions can be
    315       mounted by using the <command>mount</command> command with the proper
    316       options. To mount the <filename class="directory">/home</filename>
    317       and <filename class="directory">/usr</filename> partitions, add the
    318       following to the <filename>/etc/fstab</filename>:</para>
     365      <para>
     366        <filename>/etc/fstab</filename> contains the directories that
     367        are to be mounted on the client. Alternately the partitions can be
     368        mounted by using the <command>mount</command> command with the proper
     369        options. To mount the <filename class="directory">/home</filename>
     370        and <filename class="directory">/usr</filename> partitions, add the
     371        following to the <filename>/etc/fstab</filename>:
     372      </para>
    319373
    320374<screen role="nodump"><userinput><replaceable>&lt;server-name&gt;</replaceable>:/home  /home nfs   rw,_netdev 0 0
    321375<replaceable>&lt;server-name&gt;</replaceable>:/usr   /usr  nfs   ro,_netdev 0 0</userinput></screen>
    322376
    323       <para>The options which can be used are specified in <command>man 5 nfs</command>.
    324       If both the client and server are running recent versions of linux, most of the
    325       options will be negotiated (but see the Note above on nfsver=3). You can specify
    326       either <literal>rw</literal> or
    327       <literal>ro</literal>, <literal>_netdev</literal> if the filesystem is to be
    328       automatically mounted at boot, or <literal>noauto</literal> (and perhaps
    329       <literal>user</literal>) for other filesystems.</para>
    330 
    331       <para>If the fileserver is not running a recent version of linux, you may need to
    332       specifiy other options.</para>
    333 
    334       <para>If you are using systemd, you may need to enable autofs v4 in your kernel,
    335       and add the option <literal>comment=systemd.automount</literal>. Some machines
    336       need this, because systemd tries to mount the external fs&apos;s before the network
    337       is up, others do not need it. An alternative is for <systemitem
    338       class="username">root</systemitem> to run <command>mount -a</command>.</para>
     377      <para>
     378        The options which can be used are specified in <command>man 5 nfs
     379        </command>. If both the client and server are running recent versions
     380        of linux, most of the options will be negotiated (but see the Note
     381        above on nfsver=3). You can specify either <literal>rw</literal> or
     382        <literal>ro</literal>, <literal>_netdev</literal> if the filesystem is
     383        to be automatically mounted at boot, or <literal>noauto</literal> (and
     384        perhaps <literal>user</literal>) for other filesystems.
     385      </para>
     386
     387      <para>
     388        If the fileserver is not running a recent version of linux, you may
     389        need to specifiy other options.
     390      </para>
     391
     392      <para revision="systemd">
     393        You may need to enable autofs v4 in your kernel, and add the option
     394        <literal>comment=systemd.automount</literal>. Some machines need this,
     395        because systemd tries to mount the external fs&apos;s before the
     396        network is up, others do not need it. An alternative is for
     397        <systemitem class="username">root</systemitem> to run
     398        <command>mount -a</command>.
     399      </para>
    339400
    340401      <indexterm zone="nfs-utils nfs-utils-client-config">
    … …  
    355416        </note>
    356417
    357         <para>Install the
    358         <phrase revision="sysv">
    359         <filename>/etc/rc.d/init.d/nfs-client</filename> init script</phrase>
    360         <phrase revision="systemd">units</phrase> included in the
    361         <xref linkend="bootscripts" revision="sysv"/>
    362         <xref linkend="systemd-units" revision="systemd"/> package to start
    363         the client services at boot.</para>
     418        <para>
     419          Install the
     420          <phrase revision="sysv">
     421            <filename>/etc/rc.d/init.d/nfs-client</filename> init script
     422          </phrase>
     423          <phrase revision="systemd">units</phrase> included in the
     424          <xref linkend="bootscripts" revision="sysv"/>
     425          <xref linkend="systemd-units" revision="systemd"/> package to start
     426          the client services at boot.
     427        </para>
    364428
    365429<screen role="root"><userinput>make install-nfs-client</userinput></screen>
    … …  
    369433        </indexterm>
    370434
    371         <para revision="sysv">To automatically mount <systemitem
    372         class="filesystem">nfs</systemitem> filesystems, clients will also need
    373         to install the <filename>netfs</filename> bootscript as described in
    374         <xref linkend="postlfs-config-netfs"/>.</para>
     435        <para revision="sysv">
     436          To automatically mount <systemitem class="filesystem">nfs
     437          </systemitem> filesystems, clients will also need to install the
     438          <filename>netfs</filename> bootscript as described in <xref
     439          linkend="postlfs-config-netfs"/>.
     440        </para>
    375441
    376442        <indexterm zone="nfs-utils nfs-utils-client-config" revision="sysv">
    … …  
    409475        <term><command>exportfs</command></term>
    410476        <listitem>
    411           <para>maintains a list of NFS exported file systems.</para>
     477          <para>
     478            maintains a list of NFS exported file systems.
     479          </para>
    412480          <indexterm zone="nfs-utils exportfs">
    413481            <primary sortas="b-exportfs">exportfs</primary>
    … …  
    419487        <term><command>mountstats</command></term>
    420488        <listitem>
    421           <para>displays NFS client per-mount statistics.</para>
     489          <para>
     490            displays NFS client per-mount statistics.
     491          </para>
    422492          <indexterm zone="nfs-utils mountstats">
    423493            <primary sortas="b-mountstats">mountstats</primary>
    … …  
    429499        <term><command>mount.nfs</command></term>
    430500        <listitem>
    431           <para>is used to mount a network share using NFS</para>
     501          <para>
     502            is used to mount a network share using NFS.
     503          </para>
    432504          <indexterm zone="nfs-utils mount.nfs">
    433505            <primary sortas="b-mount.nfs">mount.nfs</primary>
    … …  
    439511        <term><command>mount.nfs4</command></term>
    440512        <listitem>
    441           <para>is used to mount a network share using NFSv4</para>
     513          <para>
     514            is used to mount a network share using NFSv4.
     515          </para>
    442516          <indexterm zone="nfs-utils mount.nfs4">
    443517            <primary sortas="b-mount.nfs4">mount.nfs4</primary>
    … …  
    449523        <term><command>nfsconf</command></term>
    450524        <listitem>
    451           <para>can be used to test for and retrieve configuration settings from
    452           a range of nfs-utils configuration files.</para>
     525          <para>
     526            can be used to test for and retrieve configuration settings from
     527            a range of nfs-utils configuration files.
     528          </para>
    453529          <indexterm zone="nfs-utils nfsconf">
    454530            <primary sortas="b-nfsconf">nfsconf</primary>
    … …  
    460536        <term><command>nfsiostat</command></term>
    461537        <listitem>
    462           <para>reports input/output statistics for network filesystems.</para>
     538          <para>
     539            reports input/output statistics for network filesystems.
     540          </para>
    463541          <indexterm zone="nfs-utils nfsiostat-nfs-utils">
    464542            <primary sortas="b-nfsiostat-nfs-utils">nfsiostat</primary>
    … …  
    470548        <term><command>nfsstat</command></term>
    471549        <listitem>
    472           <para>displays statistics kept about NFS client and server activity.</para>
     550          <para>
     551            displays statistics kept about NFS client and server activity.
     552          </para>
    473553          <indexterm zone="nfs-utils nfsstat">
    474554            <primary sortas="b-nfsstat">nfsstat</primary>
    … …  
    481561        <term><command>osd_login</command></term>
    482562        <listitem>
    483           <para>is a script that is a part of the autologin feature
    484            mandated by the pnfs-objects standard.</para>
     563          <para>
     564            is a script that is a part of the autologin feature
     565            mandated by the pnfs-objects standard.
     566          </para>
    485567          <indexterm zone="nfs-utils osd_login">
    486568            <primary sortas="b-osd_login">osd_login</primary>
    … …  
    493575        <term><command>rpc.mountd</command></term>
    494576        <listitem>
    495           <para>implements the NFS mount protocol on an NFS server.</para>
     577          <para>
     578            implements the NFS mount protocol on an NFS server.
     579          </para>
    496580          <indexterm zone="nfs-utils rpc.mountd">
    497581            <primary sortas="b-rpc.mountd">rpc.mountd</primary>
    … …  
    503587        <term><command>rpc.nfsd</command></term>
    504588        <listitem>
    505           <para>implements the user level part of the NFS
    506           service on the server.</para>
     589          <para>
     590            implements the user level part of the NFS
     591            service on the server.
     592          </para>
    507593          <indexterm zone="nfs-utils rpc.nfsd">
    508594            <primary sortas="b-rpc.nfsd">rpc.nfsd</primary>
    … …  
    514600        <term><command>rpc.statd</command></term>
    515601        <listitem>
    516           <para>is used by the NFS file locking service. Run on both sides,
    517           client as well as server, when you want file locking enabled.</para>
     602          <para>
     603            is used by the NFS file locking service. Run on both sides,
     604            client as well as server, when you want file locking enabled.
     605          </para>
    518606          <indexterm zone="nfs-utils rpc.statd">
    519607            <primary sortas="b-rpc.statd">rpc.statd</primary>
    … …  
    525613        <term><command>rpcdebug</command></term>
    526614        <listitem>
    527           <para>sets or clears the kernel's NFS client and server debug
    528           flags.</para>
     615          <para>
     616            sets or clears the kernel's NFS client and server debug flags.
     617          </para>
    529618          <indexterm zone="nfs-utils rpcdebug">
    530619            <primary sortas="b-rpcdebug">rpcdebug</primary>
    … …  
    536625        <term><command>showmount</command></term>
    537626        <listitem>
    538           <para>displays mount information for an NFS server.</para>
     627          <para>
     628            displays mount information for an NFS server.
     629          </para>
    539630          <indexterm zone="nfs-utils showmount">
    540631            <primary sortas="b-showmount">showmount</primary>
    … …  
    546637        <term><command>sm-notify</command></term>
    547638        <listitem>
    548           <para>is used to send Network Status Monitor reboot messages.</para>
     639          <para>
     640            is used to send Network Status Monitor reboot messages.
     641          </para>
    549642          <indexterm zone="nfs-utils sm-notify">
    550643            <primary sortas="b-sm-notify">sm-notify</primary>
    … …  
    556649        <term><command>start-statd</command></term>
    557650        <listitem>
    558           <para>is a script called by nfsmount when mounting a filesystem with
    559           locking enabled, if statd does not appear to be running. It can be
    560           customised with whatever flags are appropriate for the site.</para>
     651          <para>
     652            is a script called by nfsmount when mounting a filesystem with
     653            locking enabled, if statd does not appear to be running. It can be
     654            customised with whatever flags are appropriate for the site.
     655          </para>
    561656          <indexterm zone="nfs-utils start-statd">
    562657            <primary sortas="b-start-statd">start-statd</primary>
    … …  
    568663        <term><command>umount.nfs</command></term>
    569664        <listitem>
    570           <para>is used to unmount a network share using NFS</para>
     665          <para>
     666            is used to unmount a network share using NFS.
     667          </para>
    571668          <indexterm zone="nfs-utils umount.nfs">
    572669            <primary sortas="b-umount.nfs">umount.nfs</primary>
    … …  
    578675        <term><command>umount.nfs4</command></term>
    579676        <listitem>
    580           <para>is used to unmount a network share using NFSv4</para>
     677          <para>
     678            is used to unmount a network share using NFSv4.
     679          </para>
    581680          <indexterm zone="nfs-utils umount.nfs4">
    582681            <primary sortas="b-umount.nfs4">umount.nfs4</primary>
Note: See TracChangeset for help on using the changeset viewer.