source: archive/openobex.xml@ 48b59802

<?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 openobex-download-http "&sourceforge-dl;/openobex/openobex-&openobex-version;-Source.tar.gz">
  <!ENTITY openobex-download-ftp  " ">
  <!ENTITY openobex-md5sum        "f6e0b6cb7dcfd731460a7e9a91429a3a">
  <!ENTITY openobex-size          "128 KB">
  <!ENTITY openobex-buildsize     "3.1 MB">
  <!ENTITY openobex-time          "less than 0.1 SBU">
]>

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

  <sect1info>
    <date>$Date$</date>
  </sect1info>

  <title>OpenOBEX-&openobex-version;</title>

  <indexterm zone="openobex">
    <primary sortas="a-OpenOBEX">OpenOBEX</primary>
  </indexterm>

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

    <para>
      The <application>OpenOBEX</application> package contains a
      library that implements Object Exchange Protocol used for
      binary file transfers between devices.
    </para>

    &lfs82_checked;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="cmake"/> and
      <xref linkend="libusb"/>
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="bluez"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="doxygen"/>,
      <xref linkend="libxslt"/>,
      <xref linkend="openjdk"/>, and
      <xref linkend="xmlto"/>
    </para>

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

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

    <para><application>OpenOBEX</application> installs a udev rule that
    requires a group named plugdev.  Create that group as the
    <systemitem class="username">root</systemitem> user:</para>

<screen role="root"><userinput>groupadd -g 90 plugdev</userinput></screen>

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

<screen><userinput>mkdir build &amp;&amp;
cd    build &amp;&amp;

cmake -DCMAKE_INSTALL_PREFIX=/usr      \
      -DCMAKE_INSTALL_LIBDIR=/usr/lib  \
      -DCMAKE_BUILD_TYPE=Release       \
      -Wno-dev                         \
      .. &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>

    <!-- /usr/share/doc/openobex is not created if doxygen is not found -->
<screen role="root"><userinput>make install &amp;&amp;
if [ -d /usr/share/doc/openobex ]; then
  mv -fv /usr/share/doc/{openobex,openobex-&openobex-version;}
fi</userinput></screen>
  </sect2>

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

    <para>
      <parameter>-DCMAKE_BUILD_TYPE=Release</parameter>: This switch is used
      to apply higher level of the compiler optimizations.
    </para>

    <para>
      <parameter>-Wno-dev</parameter>: This switch is used to suppress warnings
      that are meant for the author of the CMakeLists.txt files.
    </para>

    <para>
      <command>mv -fv ...</command>: Moves the documentation to a versioned
      directory, if it has been created.
    </para>

  </sect2>

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

    <segmentedlist>
      <segtitle>Installed Program</segtitle>
      <segtitle>Installed Library</segtitle>
      <segtitle>Installed Directory</segtitle>

      <seglistitem>
        <seg>
          obex-check-device
        </seg>
        <seg>
          libopenobex.so
        </seg>
        <seg>
          /usr/include/openobex,
          /usr/lib/cmake/OpenObex-1.7.1, and
          /usr/share/doc/openobex-1.7.1
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="obex-check-device">
        <term><command>obex-check-device</command></term>
        <listitem>
          <para>
            is a tool that helps <application>udev</application> find connectable OBEX USB devices.
          </para>
          <indexterm zone="openobex obex-check-device">
            <primary sortas="b-obex-check-device">obex-check-device</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libopenobex">
        <term><filename class="libraryfile">libopenobex.so</filename></term>
        <listitem>
          <para>
            contains the <application>OpenOBEX</application> API functions.
          </para>
          <indexterm zone="openobex libopenobex">
            <primary sortas="c-libopenobex">libopenobex.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>