source: general/sysutils/gvfs.xml@ d0cf396

<?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 gvfs-download-http "&gnome-download-http;/gvfs/1.12/gvfs-&gvfs-version;.tar.xz">
  <!ENTITY gvfs-download-ftp  "&gnome-download-ftp;/gvfs/1.12/gvfs-&gvfs-version;.tar.xz">
  <!ENTITY gvfs-md5sum        "fc828681caa5f26a39bfb661c40d29e9">
  <!ENTITY gvfs-size          "1.4 MB">
  <!ENTITY gvfs-buildsize     "76 MB">
  <!ENTITY gvfs-time          "0.8 SBU">
]>

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

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

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

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

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

    <para>The <application>gvfs</application> package is a userspace virtual
    filesystem designed to work with the I/O abstractions of GLib's GIO
    library.</para>

    &lfs70_checked;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="dbus"/>,
      <xref linkend="intltool"/> and
      <xref linkend="pkgconfig"/>
    </para>

    <bridgehead renderas="sect4">Recommended if building GNOME</bridgehead>
    <para role="recommended">
      <xref linkend="libgnome-keyring"/>,
      <xref linkend="libsoup"/> and
      <xref linkend="udisks2"/>
      (Useful if you want to mount disks via Nautilus).
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="avahi"/> (For DNS/SD Backend),
      <ulink url="http://www.bluez.org/">BlueZ</ulink>
      (For ObexFTP Backend),
      <xref linkend="fuse"/> (For gvfs-fuse-daemon),
      <xref linkend="libarchive"/>,
      <ulink url="http://www.videolan.org/developers/libbluray.html">
      libbluray</ulink> (For accessing BluRay disks),
      <ulink url="http://www.gnu.org/software/libcdio/">libcdio</ulink>
      (For accessing CD's),
      <ulink url="http://www.gphoto.org/">libgphoto2</ulink>
      (For accessing GPhoto devices),
      <ulink url="http://www.libimobiledevice.org/">libimobiledevice</ulink>
      (For mounting iPhone, iPad and other Apple devices) and
      <xref linkend="samba3"/> (For mounting Samba shares).
    </para>

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

  </sect2>

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

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

<screen><userinput>./configure --prefix=/usr \
            --sysconfdir=/etc \
            --libexecdir=/usr/lib/gvfs &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="content">
    <title>Contents</title>

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

      <seglistitem>
        <seg>
          gvfs-cat, gvfs-copy, gvfs-info, gvfs-less, gvfs-ls, 
          gvfs-mime, gvfs-mkdir, gvfs-monitor-dir, gvfs-monitor-file, 
          gvfs-mount, gvfs-move, gvfs-open, gvfs-rename, gvfs-rm, 
          gvfs-save, gvfs-set-attribute, gvfs-trash, gvfs-tree 
          and several executables in /usr/lib/gvfs
        </seg>
        <seg>
          libgvfscommon.so and libgvfscommon-dnssd.so
        </seg>
        <seg>
          /usr/include/gvfs-client, /usr/lib/gvfs and /usr/share/gvfs
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="gvfs-cat">
        <term><command>gvfs-cat</command></term>
        <listitem>
          <para>prints a file to standard output using the virtual 
          file system to access the file via a URI.</para>
          <indexterm zone="gvfs gvfs-cat">
            <primary sortas="b-gvfs-cat">gvfs-cat</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="gvfs-copy">
        <term><command>gvfs-copy</command></term>
        <listitem>
          <para>copies a file from one URI location to another using 
          the virtual file system.</para>
          <indexterm zone="gvfs gvfs-copy">
            <primary sortas="b-gvfs-copy">gvfs-copy</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="gvfs-info">
        <term><command>gvfs-info</command></term>
        <listitem>
          <para>prints information about files and directories using 
          the virtual file system.</para>
          <indexterm zone="gvfs gvfs-info">
            <primary sortas="b-gvfs-info">gvfs-info</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="gvfs-less">
        <term><command>gvfs-less</command></term>
        <listitem>
          <para>executes <command>less</command> using the VFS as 
          input preprocesor, so less can access any resource accessible 
          by any of the gvfs backends.</para>
          <indexterm zone="gvfs gvfs-less">
            <primary sortas="b-gvfs-less">gvfs-less</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="gvfs-ls">
        <term><command>gvfs-ls</command></term>
        <listitem>
          <para>lists the content of directories using the virtual file 
          system.</para>
          <indexterm zone="gvfs gvfs-ls">
            <primary sortas="b-gvfs-ls">gvfs-ls</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="gvfs-mkdir">
        <term><command>gvfs-mkdir</command></term>
        <listitem>
          <para>makes a directory specified by an URI using 
          the virtual file system.</para>
          <indexterm zone="gvfs gvfs-mkdir">
            <primary sortas="b-gvfs-mkdir">gvfs-mkdir</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="gvfs-monitor-dir">
        <term><command>gvfs-monitor-dir</command></term>
        <listitem>
          <para>monitors the change content of a directory using 
          the virtual file system.</para>
          <indexterm zone="gvfs gvfs-monitor-dir">
            <primary sortas="b-gvfs-monitor-dir">gvfs-monitor-dir</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="gvfs-monitor-file">
        <term><command>gvfs-monitor-file</command></term>
        <listitem>
          <para>monitors the change of a file using the virtual file 
          system.</para>
          <indexterm zone="gvfs gvfs-monitor-file">
            <primary sortas="b-gvfs-monitor-file">gvfs-monitor-file</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="gvfs-mount">
        <term><command>gvfs-mount</command></term>
        <listitem>
          <para>mounts, unmounts and lists file systems using the 
          virtual file system.</para>
          <indexterm zone="gvfs gvfs-mount">
            <primary sortas="b-gvfs-mount">gvfs-mount</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="gvfs-move">
        <term><command>gvfs-move</command></term>
        <listitem>
          <para>moves a file from one URI location to another using 
          the virtual file system.</para>
          <indexterm zone="gvfs gvfs-move">
            <primary sortas="b-gvfs-move">gvfs-move</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="gvfs-open">
        <term><command>gvfs-open</command></term>
        <listitem>
          <para>opens an URI using the appropiate application.</para>
          <indexterm zone="gvfs gvfs-open">
            <primary sortas="b-gvfs-open">gvfs-open</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="gvfs-rename">
        <term><command>gvfs-rename</command></term>
        <listitem>
          <para>changes the name of a file or directory using the 
          virtual file system.</para>
          <indexterm zone="gvfs gvfs-rename">
            <primary sortas="b-gvfs-rename">gvfs-rename</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="gvfs-rm">
        <term><command>gvfs-rm</command></term>
        <listitem>
          <para>removes a directory entry using the virtual file 
          system via a URI.</para>
          <indexterm zone="gvfs gvfs-rm">
            <primary sortas="b-gvfs-rm">gvfs-rm</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="gvfs-save">
        <term><command>gvfs-save</command></term>
        <listitem>
          <para>saves information to a file using the virtual 
          file system.</para>
          <indexterm zone="gvfs gvfs-save">
            <primary sortas="b-gvfs-save">gvfs-save</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="gvfs-trash">
        <term><command>gvfs-trash</command></term>
        <listitem>
          <para>moves a directory entry to the trash using the 
          virtual file system.</para>
          <indexterm zone="gvfs gvfs-trash">
            <primary sortas="b-gvfs-trash">gvfs-trash</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="gvfs-tree">
        <term><command>gvfs-tree</command></term>
        <listitem>
          <para>lists contents of directories in a tree-like format 
          using the virtual file system.</para>
          <indexterm zone="gvfs gvfs-tree">
            <primary sortas="b-gvfs-tree">gvfs-tree</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libgvfscommon">
        <term><filename class='libraryfile'>libgvfscommon.so</filename></term>
        <listitem>
          <para>contains common API functions used in GVFS programs.</para>
          <indexterm zone="gvfs libgvfscommon">
            <primary sortas="c-libgvfscommon">libgvfscommon.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libgvfscommon-dnssd">
        <term><filename class='libraryfile'>libgvfscommon-dnssd.so</filename></term>
        <listitem>
          <para>contains API functions used in GVFS DNS/SD backend.</para>
          <indexterm zone="gvfs libgvfscommon-dnssd">
            <primary sortas="c-libgvfscommon-dnssd">libgvfscommon-dnssd.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>