source: archive/portmap.xml@ 48b59802

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

    <!-- Inserted as a reminder to do this. The mention of a test suite
         is usually right before the root user installation commands. Please
         delete these 12 (including one blank) lines after you are done.-->

    <!-- Use one of the two mentions below about a test suite,
         delete the line that is not applicable. Of course, if the
         test suite uses syntax other than "make check", revise the
         line to reflect the actual syntax to run the test suite -->

    <!-- <para>This package does not come with a test suite.</para> -->
    <!-- <para>To test the results, issue: <command>make check</command>.</para> -->

  <!ENTITY portmap-download-http "http://neil.brown.name/portmap/portmap-&portmap-version;.tgz">
  <!ENTITY portmap-download-ftp  " ">
  <!ENTITY portmap-md5sum        "ac108ab68bf0f34477f8317791aaf1ff">
  <!ENTITY portmap-size          "21 KB">
  <!ENTITY portmap-buildsize     "268 KB">
  <!ENTITY portmap-time          "0.01 SBU">
]>

<sect1 id="portmap" xreflabel="portmap-&portmap-version;">
  <?dbhtml filename="portmap.html"?>

  <sect1info>
    <date>$Date$</date>
  </sect1info>

  <title>Portmap-&portmap-version;</title>

  <indexterm zone="portmap">
    <primary sortas="a-Portmap">Portmap</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to Portmap</title>

    <para>The <application>portmap</application> package is a more secure
    replacement for the original SUN <application>portmap</application> package.
    <application>Portmap</application> is used to forward RPC requests to RPC
    daemons such as NFS and NIS.</para>

    &lfs70_checked;

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>Download (HTTP): <ulink url="&portmap-download-http;"/></para>
      </listitem>
      <listitem>
        <para>Download (FTP): <ulink url="&portmap-download-ftp;"/></para>
      </listitem>
      <listitem>
        <para>Download MD5 sum: &portmap-md5sum;</para>
      </listitem>
      <listitem>
        <para>Download size: &portmap-size;</para>
      </listitem>
      <listitem>
        <para>Estimated disk space required: &portmap-buildsize;</para>
      </listitem>
      <listitem>
        <para>Estimated build time: &portmap-time;</para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">Portmap Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="libtirpc"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="tcpwrappers"/>
    </para>

    <para condition="html" role="usernotes">User Notes:
    <ulink url="&blfs-wiki;/portmap"/></para>

  </sect2>

  <sect2 role="installation">
    <title>Installation of Portmap</title>

    <para>Portmap runs as a daemon with a uid of 1.  This uid is only
    configurable at compile time and is used as default. To set up a
    user to match this uid, as the <systemitem class="username">root</systemitem>
    user, issue:</para>

<screen><userinput>useradd -u 1 -g 1 -d /dev/null -s /bin/false bin</userinput></screen>

    <para>Install <application>portmap</application> with the following
    commands:</para>

<screen><userinput>LDLIBS=-ltirpc make</userinput></screen>

    <para>Note that the LDLIBS environment variable must be before the
    <command>make</command> command.</para>

    <para>If you want the portmap daemon to use a uid/gid other than the
    defaults, pass DAEMON_UID=x and DAEMON_GID=y as shown below:</para>

    <para><command>LDLIBS=-ltirpc make DAEMON_UID=x DAEMON_GID=y</command></para>

    <para>If you want to build the portmap daemon without
    <application>tcpwrappers</application>, add
    <userinput>NO_TCP_WRAPPER=true</userinput> to the make line as shown below:</para>

    <para><command>LDLIBS=-ltirpc make NO_TCP_WRAPPER=true</command></para>

    <para>Now, as the <systemitem class="username">root</systemitem> user:</para>

<screen role='root'><userinput>make install</userinput></screen>

    <note>
      <para>The above installation places executable <command>portmap</command>
      in <filename class="directory">/sbin</filename>. You may choose to move the
      file to <filename class="directory">/usr/sbin</filename>. If you do,
      remember to modify the bootscript also.</para>
    </note>

  </sect2>

  <sect2 role="configuration">
    <title>Configuring Portmap</title>

    <sect3  id="portmap-init">
      <title>Boot Script</title>

      <para>Install the <filename>/etc/rc.d/init.d/portmap</filename> init script
      included in the <xref linkend="bootscripts"/> package.</para>

      <indexterm zone="portmap portmap-init">
        <primary sortas="f-portmap">portmap</primary>
      </indexterm>

<screen role="root"><userinput>make install-portmap</userinput></screen>

    </sect3>

  </sect2>

  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>pmap_dump, pmap_set, and portmap</seg>
        <seg>None</seg>
        <seg>None</seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="pmap_dump">
         <!-- Don't remove the extra space, it prevent a FOP warning. -->
        <term><command>pmap_dump</command> </term>
        <listitem>
          <para>saves the port mapping table to an ASCII file.</para>
          <indexterm zone="portmap pmap_dump">
            <primary sortas="b-pmap_dump">pmap_dump</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="pmap_set">
        <term><command>pmap_set</command></term>
        <listitem>
          <para>restores the port mapping table from an ASCII file.</para>
          <indexterm zone="portmap pmap_set">
            <primary sortas="b-pmap_set">pmap_set</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="portmap-prog">
        <term><command>portmap</command></term>
        <listitem>
          <para>is an RPC port mapper.</para>
          <indexterm zone="portmap portmap-prog">
            <primary sortas="b-portmap">portmap</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>