source: gnome/platform/gvfs.xml@ 1c4f3b1f

<?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.18/gvfs-&gvfs-version;.tar.xz">
  <!ENTITY gvfs-download-ftp  "&gnome-download-ftp;/gvfs/1.18/gvfs-&gvfs-version;.tar.xz">
  <!ENTITY gvfs-md5sum        "3620baa478f1748bd32d2f47bcbe30d0">
  <!ENTITY gvfs-size          "1.5 MB">
  <!ENTITY gvfs-buildsize     "110 MB">
  <!ENTITY gvfs-time          "0.6 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>

    &lfs75_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="glib2"/>, and
      <xref linkend="intltool"/>
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="gtk3"/>,
      <xref linkend="libsecret"/>,
      <xref linkend="libsoup"/>,
      <xref linkend="udev-extras"/> (for GUdev), and
      <xref linkend="udisks2"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="avahi"/>,
      <xref linkend="bluez"/> and
      <xref linkend="dbus-glib"/>,
      <xref linkend="fuse"/>,
      <ulink url="&gnome-download-http;/gnome-online-accounts">
      GNOME Online Accounts</ulink>,
      <xref linkend="gtk-doc"/>,
      <xref linkend="libarchive"/>,
      <ulink url="http://www.videolan.org/developers/libbluray.html">
      libbluray</ulink>,
      <ulink url="http://www.gnu.org/software/libcdio/">libcdio-paranoia</ulink>,
      <xref linkend="libgcrypt"/>,
      <ulink url="http://www.gphoto.org/">libgphoto2</ulink>,
      <ulink url="http://www.libimobiledevice.org/">libimobiledevice</ulink>,
      <ulink url="http://sourceforge.net/projects/libmtp/">libmtp</ulink>,
      <xref linkend="openssh"/>, and
      <xref linkend="samba"/>
    </para>

    <bridgehead renderas="sect4">Optional (Runtime)</bridgehead>
    <para role="optional">
      <xref linkend="obex-data-server"/>
    </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 \
            --disable-gphoto2 &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>

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
      href="../../xincludes/gsettings-destdir.xml"/>
  </sect2>

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

    <para>
      <parameter>--disable-gphoto2</parameter>: This switch is required if
      <application>libgphoto2</application> is not installed. Remove
      it if you installed <application>libgphoto2</application> and
      wish to use it with <application>Gvfs</application>.
    </para>

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
      href="../../xincludes/gtk-doc-rebuild.xml"/>

  </sect2>

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

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Library</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,
          gvfsd, gvfsd-fuse, and gvfsd-metadata
        </seg>
        <seg>
          libgvfscommon.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>
            concatenates the given files and prints them
            to the standard output.
          </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.
          </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>
            shows information about the given locations.
          </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 <application>Gvfs</application> 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 information about the given locations.
          </para>
          <indexterm zone="gvfs gvfs-ls">
            <primary sortas="b-gvfs-ls">gvfs-ls</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="gvfs-mime">
        <term><command>gvfs-mime</command></term>
        <listitem>
          <para>
            is used to query information about applications that are
            registered to handle a mime-type, or set the default
            handler for a mime-type.
          </para>
          <indexterm zone="gvfs gvfs-mime">
            <primary sortas="b-gvfs-mime">gvfs-mime</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="gvfs-mkdir">
        <term><command>gvfs-mkdir</command></term>
        <listitem>
          <para>
            creates a directory specified by an URI.
          </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>
            prints information about file creation, deletion, file content and
            attribute changes and mount and unmount operations inside the
            specified directories.
          </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>
            prints information about creation, deletion, content and attribute
            changes and mount and unmount operations affecting the monitored files.
          </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>
            provides commandline access to various aspects of GIOs mounting
            functionality.
          </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.
          </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 files with the default application that is registered
            to handle files of that type.
          </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.
          </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 file.
          </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>
            reads from the standard input and saves the data to
            the given location.
          </para>
          <indexterm zone="gvfs gvfs-save">
            <primary sortas="b-gvfs-save">gvfs-save</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="gvfs-set-attribute">
        <term><command>gvfs-set-attribute</command></term>
        <listitem>
          <para>
            allows to set a file attribute on a file.
          </para>
          <indexterm zone="gvfs gvfs-set-attribute">
            <primary sortas="b-gvfs-set-attribute">gvfs-set-attribute</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="gvfs-trash">
        <term><command>gvfs-trash</command></term>
        <listitem>
          <para>
            sends files or directories to the "Trashcan".
          </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 the contents of the given directories recursively,
            in a tree-like format.
          </para>
          <indexterm zone="gvfs gvfs-tree">
            <primary sortas="b-gvfs-tree">gvfs-tree</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="gvfsd">
        <term><command>gvfsd</command></term>
        <listitem>
          <para>
            is the main daemon for the <application>Gvfs</application>
           virtual filesystem.
          </para>
          <indexterm zone="gvfs gvfsd">
            <primary sortas="b-gvfsd">gvfsd</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="gvfsd-fuse">
        <term><command>gvfsd-fuse</command></term>
        <listitem>
          <para>
            maintains a FUSE mount to make <application>Gvfs</application>
            backends available to POSIX applications.
          </para>
          <indexterm zone="gvfs gvfsd-fuse">
            <primary sortas="b-gvfsd-fuse">gvfsd-fuse</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="gvfsd-metadata">
        <term><command>gvfsd-metadata</command></term>
        <listitem>
          <para>
            is a daemon acting as a write serialiser to the internal
            <application>Gvfs</application> metadata storage.
          </para>
          <indexterm zone="gvfs gvfsd-metadata">
            <primary sortas="b-gvfsd-metadata">gvfsd-metadata</primary>
          </indexterm>
        </listitem>
      </varlistentry>

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

    </variablelist>

  </sect2>

</sect1>