source: postlfs/filesystems/sshfs-fuse.xml@ 77d57d12

<?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-fuse-download-http
    "https://github.com/libfuse/sshfs/releases/download/sshfs_&sshfs-fuse-download-version;/sshfs-fuse-&sshfs-fuse-version;.tar.gz">
  <!ENTITY sshfs-fuse-download-ftp  " ">
  <!ENTITY sshfs-fuse-md5sum        "17494910db8383a366b1301e5f5148a9">
  <!ENTITY sshfs-fuse-size          "136 KB">
  <!ENTITY sshfs-fuse-buildsize     "1.8 MB">
  <!ENTITY sshfs-fuse-time          "less than 0.1 SBU">
]>

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

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
  </sect1info>

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

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

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

    <para>
      The <application>Sshfs Fuse</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>

    &lfs7a_checked;

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

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

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

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

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

    <para>
      Install <application>Sshfs Fuse</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 id="sshfs-fuse-install">
    <title>Using Sshfs Fuse</title>

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

<screen><userinput>sshfs THINGY:~ ~/MOUNTPATH</userinput></screen>

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

<screen><userinput>fusermount -u ~/MOUNTPATH</userinput></screen>
  </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">
        <term><command>sshfs</command></term>
        <listitem>
          <para>
            mounts an <command>ssh</command> server as a local file system.
          </para>
          <indexterm zone="sshfs-fuse sshfs">
            <primary sortas="b-sshfs">sshfs</primary>
          </indexterm>
        </listitem>
      </varlistentry>
    </variablelist>
  </sect2>
</sect1>