source: postlfs/filesystems/sshfs.xml@ 0a137358

<?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;

  <!ENTITY sshfs-download-http
    "https://github.com/libfuse/sshfs/releases/download/sshfs-&sshfs-version;/sshfs-&sshfs-version;.tar.xz">
  <!ENTITY sshfs-download-ftp  " ">
  <!ENTITY sshfs-md5sum        "f261fe7ec77adc3a53f2116f3b8cb8ab">
  <!ENTITY sshfs-size          "48 KB">
  <!ENTITY sshfs-buildsize     "1.9 MB">
  <!ENTITY sshfs-time          "less than 0.1 SBU">
]>

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

  <sect1info>
    <othername>$LastChangedBy: renodr $</othername>
    <date>$Date: 2016-08-27 23:14:16 +0200 (sam. 27 août 2016) $</date>
  </sect1info>

  <title>sshfs-&sshfs-version;</title>

  <indexterm zone="sshfs">
    <primary sortas="a-sshfs">sshfs</primary>
  </indexterm>

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

    <para>
      The <application>Sshfs</application> package contains a filesystem
      client based on the SSH File Transfer Protocol. This is useful for
      mounting a remote computer that you have ssh access to as a local
      filesystem. This allows you to drag and drop files or run shell commands
      on the remote files as if they were on your local computer.
    </para>

    &lfs81_checked;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="fuse3"/>,
      <xref linkend="glib2"/>, and
      <xref linkend="openssh"/>.
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="docutils"/> (required to build the man page)
    </para>

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

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

    <para>
      If you are building on i686, <application>sshfs</application> needs
      an extra CFLAGS setting to be defined. This prevents an integer
      overflow. To do this, run the following command:
    </para>

<screen><userinput>if [ $(uname -m) = "i686" ]; then
  export CFLAGS+="-D_FILE_OFFSET_BITS=64";
fi</userinput></screen>

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

<screen><userinput>./configure --prefix=/usr &amp;&amp;
make</userinput></screen>

    <para>
      This package does not come with a test suite.
    </para>

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

<screen role="root"><userinput>make install</userinput></screen>
  </sect2>

  <sect2 role="using">
    <title>Using Sshfs</title>

    <para>
      To mount an ssh server you need to be able to log into the server. For
      example, to mount your remote home folder to the local ~/examplepath (the
      directory must exist and you must have permissions to write to it):
    </para>

<screen><userinput>sshfs example.com:/home/userid ~/examplepath</userinput></screen>

    <para>
      When you've finished work and want to unmount it again:
    </para>

<screen><userinput>fusermount -u ~/example</userinput></screen>

    <para>
      You can also mount an <application>sshfs</application> filesystem at boot
      by adding an entry similar to the following in the
      <filename>/etc/fstab</filename> file:
    </para>

<screen>userid@example.com:/path /media/path fuse.sshfs  _netdev,IdentityFile=/home/userid/.ssh/id_rsa 0 0</screen>

    <para>
      See <command>man 1 sshfs</command> and <command>man 8 mount.fuse</command>
      for all available mount options.
    </para>

  </sect2>

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

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

      <seglistitem>
        <seg>
          sshfs
        </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="sshfs-prog">
        <term><command>sshfs</command></term>
        <listitem>
          <para>
            mounts an <command>ssh</command> server as a local file system.
          </para>
          <indexterm zone="sshfs sshfs-prog">
            <primary sortas="b-sshfs">sshfs</primary>
          </indexterm>
        </listitem>
      </varlistentry>
    </variablelist>
  </sect2>
</sect1>