source: gnome/core/gnome-user-share.xml@ 7ef3d467

<?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 gnome-user-share-download-http "&gnome-download-http;/gnome-user-share/3.0/gnome-user-share-&gnome-user-share-version;.tar.xz">
  <!ENTITY gnome-user-share-download-ftp  "&gnome-download-ftp;/gnome-user-share/3.0/gnome-user-share-&gnome-user-share-version;.tar.xz">
  <!ENTITY gnome-user-share-md5sum        "1c236fd3486f9c9c070a3141b5f5fbb9">
  <!ENTITY gnome-user-share-size          "978 KB">
  <!ENTITY gnome-user-share-buildsize     "?? MB">
  <!ENTITY gnome-user-share-time          "?? SBU">
]>

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

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

  <title>gnome-user-share-&gnome-user-share-version;</title>

  <indexterm zone="gnome-user-share">
    <primary sortas="a-gnome-user-share">gnome-user-share</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to gnome-user-share</title>

    <para>The <application>gnome-user-share</application> package allows easy
    user-level file sharing via WebDAV or ObexFTP. The shared files are
    announced on the network by <application>Avahi</application>.</para>

    <!-- &lfs65_checked; not for this version! -->

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

    <bridgehead renderas="sect3">gnome-user-share Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required"><xref linkend="gnome-bluetooth"/> and
    <xref linkend="libcanberra"/></para>

    <bridgehead renderas="sect4">Required (Runtime)</bridgehead>
    <para role="required"><xref linkend="mod_dnssd"/></para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"><xref linkend="rarian"/></para>

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

  </sect2>

  <sect2 role="installation">
    <title>Installation of gnome-user-share</title>

    <para>Install <application>gnome-user-share</application> by running the following
    commands:</para>

<screen><userinput>./configure --prefix=$GNOME_PREFIX \
            --sysconfdir=$GNOME_SYSCONFDIR \
            --libexecdir=$GNOME_PREFIX/lib/gnome-user-share  \
            --with-modules-path=/usr/lib/apache \
            --disable-scrollkeeper &amp;&amp;
make</userinput></screen>

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

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

  </sect2>

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

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

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

    <para><parameter>--libexecdir=$GNOME_PREFIX/lib/gnome-user-share</parameter>:
    This parameter is used so that the
    <application>gnome-user-share</application> internal support programs are
    installed in the preferred location of <filename
    class='directory'>$GNOME_PREFIX/lib/gnome-user-share</filename> instead of
    <filename class='directory'>$GNOME_PREFIX/libexec</filename>.</para>

    <para><parameter>--disable-scrollkeeper</parameter>: Do not make updates to
    the <application>scrollkeeper</application> database. Remove it if you have
    <application>rarian</application> installed.</para>

  </sect2>

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

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

      <seglistitem>
        <seg>gnome-file-share-properties and gnome-user-share</seg>
        <seg>libnautilus-share-extension.so</seg>
        <seg><envar>$GNOME_PREFIX</envar>/{lib/gnome-user-share,
        share/{gnome-user-share,gnome/help/gnome-user-share/*,
        omf/gnome-user-share}}</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="gnome-file-share-properties">
        <term><command>gnome-file-share-properties</command></term>
        <listitem>
          <para>is a tool to manage shares.</para>
          <indexterm zone="gnome-user-share gnome-file-share-properties">
            <primary sortas="b-gnome-file-share-properties">gnome-file-share-properties</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>