source: gnome/platform/gvfs.xml@ 1778164

<?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.44/gvfs-&gvfs-version;.tar.xz">
  <!ENTITY gvfs-download-ftp  "&gnome-download-ftp;/gvfs/1.44/gvfs-&gvfs-version;.tar.xz">
  <!ENTITY gvfs-md5sum        "72383474f52d05c21ef2be96d0b91974">
  <!ENTITY gvfs-size          "1.2 MB">
  <!ENTITY gvfs-buildsize     "57 MB">
  <!ENTITY gvfs-time          "0.4 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>

    &lfs91_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">Additional Downloads</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Required patch:
          <ulink url="&patch-root;/gvfs-&gvfs-version;-fix_security_vulnerabilities-1.patch"/>
        </para>
      </listitem>
    </itemizedlist>
-->       
    <bridgehead renderas="sect3">Gvfs Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="dbus"/>,
      <xref linkend="glib2"/>,
      <xref linkend="libusb"/>,
      <xref linkend="libsecret"/> and
      <xref linkend="libsoup"/>
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="gcr"/>,
      <xref linkend="gtk3"/>,
      <xref linkend="libcdio"/>,
      <xref linkend="libgdata"/>,
      <xref linkend="libgudev"/>,
      <phrase revision="sysv"><xref linkend="elogind"/>,</phrase>
      <phrase revision="systemd"><xref linkend="systemd"/>,</phrase> and
      <xref linkend="udisks2"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="apache"/>,
      <xref linkend="avahi"/>,
      <xref linkend="bluez"/>,
      <xref linkend="dbus-glib"/>,
      <xref linkend="fuse3"/>,
      <xref linkend="gnome-online-accounts"/>,
      <xref linkend="gtk-doc"/>,
      <xref linkend="libarchive"/>,
      <xref linkend="libgcrypt"/>,
      <xref linkend="libxml2"/>,
      <xref linkend="libxslt"/>,
      <xref linkend="openssh"/>,
      <xref linkend="samba"/>,
      <ulink url="http://www.videolan.org/developers/libbluray.html">libbluray</ulink>,
      <ulink url="http://www.gphoto.org/">libgphoto2</ulink>,
      <ulink url="http://www.libimobiledevice.org/">libimobiledevice</ulink>,
      <ulink url="http://libmtp.sourceforge.net/">libmtp</ulink>,
      <ulink url="https://github.com/sahlberg/libnfs/">libnfs</ulink>, and
      <ulink url="http://twistedmatrix.com/trac/">Twisted</ulink>
    </para>

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

  <sect2 role="installation">
    <title>Installation of Gvfs</title>
<!--
    <para>
      First, apply a security patch to fix four security vulnerabilities:
    </para>

<screen><userinput remap="pre">patch -Np1 -i ../gvfs-&gvfs-version;-fix_security_vulnerabilities-1.patch</userinput></screen>
-->
    <para>
      Install <application>Gvfs</application> by running the following
      commands:
    </para>

<screen revision='sysv'><userinput>mkdir build &amp;&amp;
cd    build &amp;&amp;

meson --prefix=/usr     \
      --sysconfdir=/etc \
      -Dfuse=false      \
      -Dgphoto2=false   \
      -Dafc=false       \
      -Dbluray=false    \
      -Dnfs=false       \
      -Dmtp=false       \
      -Dsmb=false       \
      -Dtmpfilesdir=no  \
      -Ddnssd=false     \
      -Dgoa=false       \
      -Dgoogle=false    \
      -Dsystemduserunitdir=no .. &amp;&amp;
ninja</userinput></screen>

<screen revision='systemd'><userinput>mkdir build &amp;&amp;
cd    build &amp;&amp;

meson --prefix=/usr     \
      --sysconfdir=/etc \
      -Dfuse=false      \
      -Dgphoto2=false   \
      -Dafc=false       \
      -Dbluray=false    \
      -Dnfs=false       \
      -Dmtp=false       \
      -Dsmb=false       \
      -Ddnssd=false     \
      -Dgoa=false       \
      -Dgoogle=false    .. &amp;&amp;
ninja</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>ninja 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>-D&lt;option&gt;=false</parameter>: These switches are
      required if the corresponding optional dependency is not installed.
      Remove those where you have installed the corresponding application and
      wish to use it with <application>Gvfs</application>. The dnssd option 
      requires avahi and both goa/google require GNOME Online Accounts.
    </para>

    <para revision="sysv">
      <parameter>-Dtmpfilesdir=no -Dsystemduserunitdir=no</parameter>: These
      switches provide systemd directory locations. Setting them to
      <quote>no</quote> disables the dependency on systemd and logind.
    </para>

    <para>
      <option>-Dcdda=false</option>: This switch is required if libcdio is not
      installed. The cdda backend is useless on machines without a CDROM/DVD
      drive.
    </para>

  </sect2>

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

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

      <seglistitem>
        <seg>
<!--      All of the applications that were previously installed were
          removed in 1.37.2. There are 20+ library executables, but they
          won't get documented here.
          Proceeding with removing the obsolete command explanations. -->
          None
        </seg>
        <seg>
          libgvfscommon.so,
          libgvfsdaemon.so and
          some under /usr/lib/gio/modules/
        </seg>
        <seg>
          /usr/include/gvfs-client and
          /usr/{lib,share}/gvfs
        </seg>
      </seglistitem>
    </segmentedlist>

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

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