glfs/networking/netutils/avahi.xml

<?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 avahi-download-http "http://avahi.org/download/avahi-&avahi-version;.tar.gz">
  <!ENTITY avahi-download-ftp  " ">
  <!ENTITY avahi-md5sum        "a83155a6e29e3988f07e5eea3287b21e">
  <!ENTITY avahi-size          "1.1 MB">
  <!ENTITY avahi-buildsize     "27 MB">
  <!ENTITY avahi-time          "0.6 SBU">
]>

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

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

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

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

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

    <para>The <application>avahi</application> package is a system which
    facilitates service discovery on a local network.</para>

    &lfs65_built;

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

    <bridgehead renderas="sect3">Additional Downloads</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>Required patch: <ulink
        url="&patch-root;/avahi-&avahi-version;-lfs_initscript_fixes-1.patch"/></para>
      </listitem>
    </itemizedlist>

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

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

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"><xref linkend="dbus-python"/>,
    <xref linkend="gtk2"/>,
    <xref linkend="libdaemon"/>,
    <xref linkend="libglade"/>,
    <xref linkend="python"/>,
    <xref linkend="pygtk"/>,
    <xref linkend="qt"/>, and
    <xref linkend="qt4"/></para>

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

  </sect2>

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

    <para>It is recommended to have a dedicated user and group to take
    control of the <command>avahi-daemon</command> daemon after it is
    started. Issue the following commands as the
    <systemitem class="username">root</systemitem> user:</para>

<screen role='root'><userinput>groupadd -fg 84 avahi &amp;&amp;
useradd -c "Avahi Daemon Owner" -d /dev/null -u 84 \
    -g avahi -s /bin/false avahi  || [ $? == 9 ]</userinput></screen>

    <para>It is recommended to have a dedicated priviliged access group for
    <application>Avahi</application> clients. Issue the following command as
    the <systemitem class="username">root</systemitem> user:</para>

<screen role='root'><userinput>groupadd -fg 86 netdev</userinput></screen>

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

<screen><userinput>patch -Np1 -i ../avahi-&avahi-version;-lfs_initscript_fixes-1.patch &amp;&amp;
autoreconf -i -v &amp;&amp;
./configure --prefix=/usr \
            --sysconfdir=/etc \
            --localstatedir=/var \
            --with-distro=lfs \
            --disable-qt3 \
            --disable-qt4 \
            --disable-gtk \
            --disable-dbus \
            --disable-libdaemon \
            --disable-python \
            --disable-mono \
            --disable-monodoc \
            --enable-core-docs &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="commands">
    <title>Command Explanations</title>

    <para><parameter>--with-distro=lfs</parameter>: This parameter specifies the
    LFS distribution to target.</para>

    <para><parameter>--disable-qt3</parameter>: This parameter disables the
    building of <application>Qt3</application> mainloop integration.</para>

    <para><parameter>--disable-qt4</parameter>: This parameter disables the
    building of <application>Qt4Core</application> mainloop integration.</para>

    <para><parameter>--disable-gtk</parameter>: This parameter disables the use
    of <application>GTK+</application>.</para>

    <para><parameter>--disable-dbus</parameter>: This parameter disables the use
    of <application>D-Bus</application>.</para>

    <para><parameter>--disable-libdaemon</parameter>: This parameter disables
    the use of libdaemon.</para>

    <para><parameter>--disable-python</parameter>: This parameter disables the
    scripts that depends on <application>Python</application>.</para>

    <para><parameter>--disable-mono</parameter>: This parameter disables the
    <application>Mono</application> bindings.</para>

    <para><parameter>--disable-monodoc</parameter>: This parameter disables
    documentation for the <application>Mono</application> bindings.</para>

    <para><parameter>--enable-core-docs</parameter>: This parameter enables the
    building of documentation.</para>

    <para><option>--enable-tests</option>: This option enables the building of
    tests and examples.</para>

    <para><option>--enable-compat-libdns_sd</option>: This option enables the
    compatibility layer for <application>libdns_sd</application>.</para>

    <para><option>--enable-compat-howl</option>: This option enables the
    compatibility layer for <application>HOWL</application>.</para>

  </sect2>

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

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

      <seglistitem>
        <seg>avahi-autoipd, avahi-bookmarks, avahi-browse, avahi-daemon,
        avahi-discover, avahi-discover-standalone, avahi-dnsconfd,
        avahi-publish, avahi-resolve, avahi-set-host-name, and bssh</seg>
        <seg>libavahi-client.{so,a}, libavahi-common.{so,a},
        libavahi-core.{so,a}, libavahi-glib.{so,a}, libavahi-gobject.{so,a}, and
        libavahi-ui.{so,a}</seg>
        <seg>/etc/avahi/services,/usr/{include/avahi-{client,common,core,glib,
        gobject,ui},lib/{avahi,python&python2-majorver;/site-packages/{avahi,avahi_discover}},
        share/avahi/{interfaces,introspection}}</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="avahi-autoipd">
        <term><command>avahi-autoipd</command></term>
        <listitem>
          <para>is a IPv4LL network address configuration daemon.</para>
          <indexterm zone="avahi avahi-autoipd">
            <primary sortas="b-avahi-autoipd">avahi-autoipd</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="avahi-bookmarks">
        <term><command>avahi-bookmarks</command></term>
        <listitem>
          <para>is a Web service showing mDNS/DNS-SD announced HTTP services
          using the <application>Avahi</application> daemon.</para>
          <indexterm zone="avahi avahi-bookmarks">
            <primary sortas="b-avahi-bookmarks">avahi-bookmarks</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="avahi-browse">
        <term><command>avahi-browse</command></term>
        <listitem>
          <para>browses for mDNS/DNS-SD services using the
          <application>Avahi</application> daemon.</para>
          <indexterm zone="avahi avahi-browse">
            <primary sortas="b-avahi-browse">avahi-browse</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="avahi-daemon">
        <term><command>avahi-daemon</command></term>
        <listitem>
          <para>is the <application>Avahi</application> mDNS/DNS-SD
          daemon.</para>
          <indexterm zone="avahi avahi-daemon">
            <primary sortas="b-avahi-daemon">avahi-daemon</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="avahi-discover">
        <term><command>avahi-discover</command></term>
        <listitem>
          <para>browses for mDNS/DNS-SD services using the
          <application>Avahi</application> daemon.</para>
          <indexterm zone="avahi avahi-discover">
            <primary sortas="b-avahi-discover">avahi-discover</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="avahi-discover-standalone">
        <term><command>avahi-discover-standalone</command></term>
        <listitem>
          <para>does this .....</para>
          <indexterm zone="avahi avahi-discover-standalone">
            <primary sortas="b-avahi-discover-standalone">avahi-discover-standalone</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="avahi-dnsconfd">
        <term><command>avahi-dnsconfd</command></term>
        <listitem>
          <para>is a Unicast DNS server from mDNS/DNS-SD configuration
          daemon.</para>
          <indexterm zone="avahi avahi-dnsconfd">
            <primary sortas="b-avahi-dnsconfd">avahi-dnsconfd</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="avahi-publish">
        <term><command>avahi-publish</command></term>
        <listitem>
          <para>registers a mDNS/DNS-SD service or host name or address mapping
          using the <application>Avahi</application> daemon.</para>
          <indexterm zone="avahi avahi-publish">
            <primary sortas="b-avahi-publish">avahi-publish</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="avahi-resolve">
        <term><command>avahi-resolve</command></term>
        <listitem>
          <para>resolves one or more mDNS/DNS host name(s) to IP address(es)
          (and vice versa) using the <application>Avahi</application>
          daemon.</para>
          <indexterm zone="avahi avahi-resolve">
            <primary sortas="b-avahi-resolve">avahi-resolve</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="avahi-set-host-name">
        <term><command>avahi-set-host-name</command></term>
        <listitem>
          <para>changes the mDNS host name.</para>
          <indexterm zone="avahi avahi-set-host-name">
            <primary sortas="b-avahi-set-host-name">avahi-set-host-name</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="bssh">
        <term><command>bssh</command></term>
        <listitem>
          <para>browses for SSH/VNC servers on the local network.</para>
          <indexterm zone="avahi bssh">
            <primary sortas="b-bssh">bssh</primary>
          </indexterm>
        </listitem>
      </varlistentry>


      <!--<varlistentry id="libavahi-client">
        <term><filename class='libraryfile'>libavahi-client.{so,a}</filename></term>
        <listitem>
          <para>contains functions that .....</para>
          <indexterm zone="avahi libavahi-client">
            <primary sortas="c-libavahi-client">libavahi-client.{so,a}</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libavahi-common">
        <term><filename class='libraryfile'>libavahi-common.{so,a}</filename></term>
        <listitem>
          <para>contains functions that .....</para>
          <indexterm zone="avahi libavahi-common">
            <primary sortas="c-libavahi-common">libavahi-common.{so,a}</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libavahi-core">
        <term><filename class='libraryfile'>libavahi-core.{so,a}</filename></term>
        <listitem>
          <para>contains functions that .....</para>
          <indexterm zone="avahi libavahi-core">
            <primary sortas="c-libavahi-core">libavahi-core.{so,a}</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libavahi-glib">
        <term><filename class='libraryfile'>libavahi-glib.{so,a}</filename></term>
        <listitem>
          <para>contains functions that .....</para>
          <indexterm zone="avahi libavahi-glib">
            <primary sortas="c-libavahi-glib">libavahi-glib.{so,a}</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libavahi-gobject">
        <term><filename class='libraryfile'>libavahi-gobject.{so,a}</filename></term>
        <listitem>
          <para>contains functions that .....</para>
          <indexterm zone="avahi libavahi-gobject">
            <primary sortas="c-libavahi-gobject">libavahi-gobject.{so,a}</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libavahi-ui">
        <term><filename class='libraryfile'>libavahi-ui.{so,a}</filename></term>
        <listitem>
          <para>contains functions that .....</para>
          <indexterm zone="avahi libavahi-ui">
            <primary sortas="c-libavahi-ui">libavahi-ui.{so,a}</primary>
          </indexterm>
        </listitem>
      </varlistentry>-->

    </variablelist>

  </sect2>

</sect1>