source: archive/ncpfs.xml@ acb648f

<?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 ncpfs-download-http "http://platan.vc.cvut.cz/ftp/pub/linux/ncpfs/ncpfs-&ncpfs-version;.tar.gz">
  <!ENTITY ncpfs-download-ftp  "ftp://platan.vc.cvut.cz/pub/linux/ncpfs/ncpfs-&ncpfs-version;.tar.gz">
  <!ENTITY ncpfs-md5sum        "5fd2ec0680ba7e66df142637e17a5ac9">
  <!ENTITY ncpfs-size          "1.6 MB">
  <!ENTITY ncpfs-buildsize     "30 MB">
  <!ENTITY ncpfs-time          "0.52 SBU">
]>

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

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

  <title>NCPFS-&ncpfs-version;</title>

  <indexterm zone="ncpfs">
    <primary sortas="a-NCPFS">NCPFS</primary>
  </indexterm>

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

    <para>The <application>NCPFS</application> package
    contains client and administration tools for use with Novell
    networks.</para>

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

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

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"><xref linkend="linux-pam"/> and <xref linkend="php"/></para>

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

  </sect2>

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

    <para>Install <application>NCPFS</application> by running
    the following commands:</para>

<screen><userinput>./configure --prefix="" --includedir=/usr/include \
    --mandir=/usr/share/man --datadir=/usr/share &amp;&amp;
make &amp;&amp;
make install &amp;&amp;
make install-dev</userinput></screen>

  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

    <para><parameter>--prefix=""</parameter>:
    Installs binaries on the root partition so that they are available at
    boot time.  This may not be ideal for all systems.  If
    <filename class="directory">/usr</filename> is mounted locally,
    <parameter>--prefix=/usr</parameter> may be a better option.</para>

    <para><parameter>--includedir=/usr/include</parameter>: Tells
    <command>configure</command> to look in
    <filename class="directory">/usr/include</filename> for header
    files. It also tells <command>make</command> to install
    <application>NCPFS</application>'s headers here.</para>

    <para><parameter>--mandir=/usr/share/man</parameter>: Installs the man
    pages in the correct location.</para>

    <para><parameter>--datadir=/usr/share</parameter>: Correctly installs the
    locale files to <filename class="directory">/usr/share</filename>.</para>

    <note>
      <para>If you do not need to use the IPX protocol, or you use a different
      IPX package, you can optionally pass <option>--disable-ipx</option> and/or
      <option>--disable-ipx-tools</option> to the <command>configure</command>
      script to disable these options.</para>
    </note>

  </sect2>

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

    <sect3 id="ncpfs-config">
      <title>Config Files</title>

      <para><filename>~/.nwclient</filename></para>

      <indexterm zone="ncpfs ncpfs-config">
        <primary sortas="e-AA.nwclient">~/.nwclient</primary>
      </indexterm>

    </sect3>

    <sect3>
      <title>Configuration Information</title>

      <para>A config file <filename>~/.nwclient</filename> should be placed in the
      home directory of each user that intends to use
      <application>NCPFS</application>. The permissions on this file should be set
      to 600, for obvious security reasons.  The configuration file should contain
      a single line per server that the user will use.  Each line should contain
      the server name, the user name, and optionally the password.  Below is a
      sample <filename>.nwclient</filename> file.</para>

<screen><literal># Begin example ~/.nwclient config file

Server1/User1 Password
Server2/User1
Server2/Guest1 -

# End example .nwclient config file</literal></screen>

      <para>The syntax for the <filename>.nwclient</filename> file is simple,
      <literal>server_name/user_name password</literal>.  Be extremely
      careful when creating or editing this file as the client utilities are
      very picky about syntax.  There should always be a space immediately
      after the username.  If this space is substituted by a tab or multiple
      spaces, you will not get the expected results when attempting to use
      the <application>NCPFS</application> tools.  If no password is supplied,
      the client utilities will ask for a password when it is needed.  If no
      password is needed, for instance when using a guest account, a single '-'
      should be put in place of a password.</para>

      <para>It should be noted that <command>ncpmount</command>
      is not intended to mount individual volumes because each mount point
      creates a separate client connection to the Novell server.  Mounting
      each individual volume separately would be unwise, as mounting all
      volumes on a server under one mount point uses only one client
      connection.</para>

    </sect3>

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

      <para>If you need to set up the IPX protocol at boot, you can install the
      <filename>/etc/sysconfig/network-devices/services/ipx</filename>
      network service script included with the
      <xref linkend="bootscripts"/> package.</para>

      <indexterm zone="ncpfs ncpfs-init">
        <primary sortas="f-ncpfs">ncpfs (IPX service script)</primary>
      </indexterm>

<screen><userinput>make install-service-ipx</userinput></screen>

      <para>Next install the
      <filename>/etc/sysconfig/network-devices/ifconfig.eth0/ipx</filename>
      configuration file with the following commands:</para>

<screen role="root"><userinput>install -v -d /etc/sysconfig/network-devices/ifconfig.eth0 &amp;&amp;
cat &gt; /etc/sysconfig/network-devices/ifconfig.eth0/ipx &lt;&lt; "EOF"
<literal>ONBOOT="yes"
SERVICE="ipx"
FRAME="<replaceable>&lt;802.2&gt;</replaceable>"</literal>
EOF</userinput></screen>

    </sect3>

  </sect2>

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

    <segmentedlist>
      <segtitle>Client Utilities</segtitle>
      <segtitle>Server Admin Utilities</segtitle>
      <segtitle>IPX Interface Utilities</segtitle>
      <segtitle>Other Utilities</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>ncpmount, ncpumountt, nprintt, nsendt, nwpasswdt,
        nwsfindt, pqlistt, pqrmt, pqstatt, and slist</seg>
        <seg>ncopyt, nwbocreatet, nwbolst, nwbopropst, nwbormt,
        nwbpaddt, nwbpcreatet, nwbprmt, nwbpsett, nwbpvaluest,
        nwdirt, nwdpvaluest, nwfsctrlt, nwfsinfot, nwfstimet, nwgrantt,
        nwpurget, nwrevoket, nwrightst, nwtrusteet, nwtrustee2t,
        nwuserlistt,  and nwvolinfo</seg>
        <seg>ipx_cmdt, ipx_configuret, ipx_interfacet, ipx_internal_nett,
        and ipx_route</seg>
        <seg>ncpmap and nwauth</seg>
        <seg>None</seg>
        <seg>None</seg>
      </seglistitem>
    </segmentedlist>

  </sect2>

</sect1>