[bed59e0] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
| 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
| 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
[de24c7a5] | 7 | <!ENTITY openobex-download-http "&sourceforge-repo;/openobex/openobex-&openobex-version;-Source.tar.gz">
|
---|
[bed59e0] | 8 | <!ENTITY openobex-download-ftp " ">
|
---|
[96316eb] | 9 | <!ENTITY openobex-md5sum "3181bfed9cb7db591605391068cb0085">
|
---|
| 10 | <!ENTITY openobex-size "136 KB">
|
---|
| 11 | <!ENTITY openobex-buildsize "3.6 MB">
|
---|
| 12 | <!ENTITY openobex-time "less than 0.1 SBU">
|
---|
[bed59e0] | 13 | ]>
|
---|
| 14 |
|
---|
| 15 | <sect1 id="openobex" xreflabel="OpenOBEX-&openobex-version;">
|
---|
| 16 | <?dbhtml filename="openobex.html"?>
|
---|
| 17 |
|
---|
| 18 | <sect1info>
|
---|
| 19 | <othername>$LastChangedBy$</othername>
|
---|
| 20 | <date>$Date$</date>
|
---|
| 21 | </sect1info>
|
---|
| 22 |
|
---|
| 23 | <title>OpenOBEX-&openobex-version;</title>
|
---|
| 24 |
|
---|
| 25 | <indexterm zone="openobex">
|
---|
| 26 | <primary sortas="a-OpenOBEX">OpenOBEX</primary>
|
---|
| 27 | </indexterm>
|
---|
| 28 |
|
---|
| 29 | <sect2 role="package">
|
---|
| 30 | <title>Introduction to OpenOBEX</title>
|
---|
| 31 |
|
---|
| 32 | <para>
|
---|
| 33 | The <application>OpenOBEX</application> package contains a
|
---|
| 34 | library that implements Object Exchange Protocol used for
|
---|
| 35 | binary file transfers between devices.
|
---|
| 36 | </para>
|
---|
| 37 |
|
---|
[60d53ec3] | 38 | &lfs78_checked;
|
---|
[bed59e0] | 39 |
|
---|
| 40 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 41 | <itemizedlist spacing="compact">
|
---|
| 42 | <listitem>
|
---|
| 43 | <para>
|
---|
| 44 | Download (HTTP): <ulink url="&openobex-download-http;"/>
|
---|
| 45 | </para>
|
---|
| 46 | </listitem>
|
---|
| 47 | <listitem>
|
---|
| 48 | <para>
|
---|
| 49 | Download (FTP): <ulink url="&openobex-download-ftp;"/>
|
---|
| 50 | </para>
|
---|
| 51 | </listitem>
|
---|
| 52 | <listitem>
|
---|
| 53 | <para>
|
---|
| 54 | Download MD5 sum: &openobex-md5sum;
|
---|
| 55 | </para>
|
---|
| 56 | </listitem>
|
---|
| 57 | <listitem>
|
---|
| 58 | <para>
|
---|
| 59 | Download size: &openobex-size;
|
---|
| 60 | </para>
|
---|
| 61 | </listitem>
|
---|
| 62 | <listitem>
|
---|
| 63 | <para>
|
---|
| 64 | Estimated disk space required: &openobex-buildsize;
|
---|
| 65 | </para>
|
---|
| 66 | </listitem>
|
---|
| 67 | <listitem>
|
---|
| 68 | <para>
|
---|
| 69 | Estimated build time: &openobex-time;
|
---|
| 70 | </para>
|
---|
| 71 | </listitem>
|
---|
| 72 | </itemizedlist>
|
---|
| 73 |
|
---|
| 74 | <bridgehead renderas="sect3">OpenOBEX Dependencies</bridgehead>
|
---|
| 75 |
|
---|
| 76 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
| 77 | <para role="required">
|
---|
[4049d110] | 78 | <xref linkend="cmake"/> and
|
---|
| 79 | <xref linkend="libusb"/>
|
---|
[bed59e0] | 80 | </para>
|
---|
| 81 |
|
---|
[ed81325] | 82 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
| 83 | <para role="recommended">
|
---|
| 84 | <xref linkend="bluez"/>
|
---|
| 85 | </para>
|
---|
| 86 |
|
---|
[bed59e0] | 87 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
| 88 | <para role="optional">
|
---|
[4049d110] | 89 | <xref linkend="doxygen"/>,
|
---|
| 90 | <xref linkend="libxslt"/>,
|
---|
[8f29aa2] | 91 | <xref linkend="openjdk"/>, and
|
---|
[bed59e0] | 92 | <xref linkend="xmlto"/>
|
---|
| 93 | </para>
|
---|
| 94 |
|
---|
| 95 | <para condition="html" role="usernotes">
|
---|
| 96 | User Notes: <ulink url="&blfs-wiki;/openobex"/>
|
---|
| 97 | </para>
|
---|
| 98 | </sect2>
|
---|
| 99 |
|
---|
| 100 | <sect2 role="installation">
|
---|
| 101 | <title>Installation of OpenOBEX</title>
|
---|
| 102 |
|
---|
[8e8cfd9b] | 103 | <para><application>OpenOBEX</application> installs a udev rule that
|
---|
[8da658ba] | 104 | requires a group named plugdev. Create that group as the
|
---|
[8e8cfd9b] | 105 | <systemitem class="username">root</systemitem> user:</para>
|
---|
| 106 |
|
---|
| 107 | <screen role="root"><userinput>groupadd -g 90 plugdev</userinput></screen>
|
---|
| 108 |
|
---|
[bed59e0] | 109 | <para>
|
---|
| 110 | Install <application>OpenOBEX</application> by running the following
|
---|
| 111 | commands:
|
---|
| 112 | </para>
|
---|
| 113 |
|
---|
[4049d110] | 114 | <screen><userinput>mkdir build &&
|
---|
[8f29aa2] | 115 | cd build &&
|
---|
| 116 |
|
---|
[8da658ba] | 117 | cmake -DCMAKE_INSTALL_PREFIX=/usr \
|
---|
| 118 | -DCMAKE_INSTALL_LIBDIR=/usr/lib \
|
---|
| 119 | -DCMAKE_BUILD_TYPE=Release \
|
---|
| 120 | -Wno-dev \
|
---|
[4049d110] | 121 | .. &&
|
---|
[bed59e0] | 122 | make</userinput></screen>
|
---|
| 123 |
|
---|
| 124 | <para>
|
---|
| 125 | This package does not come with a test suite.
|
---|
| 126 | </para>
|
---|
| 127 |
|
---|
| 128 | <para>
|
---|
| 129 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 130 | </para>
|
---|
| 131 |
|
---|
[e8a3404] | 132 | <screen role="root"><userinput>make install &&
|
---|
[8da658ba] | 133 | mv -fv /usr/share/doc/openobex{,-&openobex-version;}</userinput></screen>
|
---|
[bed59e0] | 134 | </sect2>
|
---|
| 135 |
|
---|
| 136 | <sect2 role="commands">
|
---|
| 137 | <title>Command Explanations</title>
|
---|
| 138 |
|
---|
[4049d110] | 139 | <para>
|
---|
| 140 | <parameter>-DCMAKE_BUILD_TYPE=Release</parameter>: This switch is used
|
---|
| 141 | to apply higher level of the compiler optimizations.
|
---|
| 142 | </para>
|
---|
[bed59e0] | 143 |
|
---|
[8da658ba] | 144 | <para>
|
---|
| 145 | <parameter>-Wno-dev</parameter>: This switch is used to suppress warnings
|
---|
| 146 | that are meant for the author of the CMakeLists.txt files.
|
---|
| 147 | </para>
|
---|
| 148 |
|
---|
[e8a3404] | 149 | <para>
|
---|
| 150 | <command>mv -fv ...</command>: Move the documention to a versioned
|
---|
| 151 | directory.
|
---|
| 152 | </para>
|
---|
| 153 |
|
---|
[bed59e0] | 154 | </sect2>
|
---|
| 155 |
|
---|
| 156 | <sect2 role="content">
|
---|
| 157 | <title>Contents</title>
|
---|
| 158 |
|
---|
| 159 | <segmentedlist>
|
---|
| 160 | <segtitle>Installed Program</segtitle>
|
---|
| 161 | <segtitle>Installed Library</segtitle>
|
---|
| 162 | <segtitle>Installed Directory</segtitle>
|
---|
| 163 |
|
---|
| 164 | <seglistitem>
|
---|
| 165 | <seg>
|
---|
| 166 | obex-check-device
|
---|
| 167 | </seg>
|
---|
| 168 | <seg>
|
---|
| 169 | libopenobex.so
|
---|
| 170 | </seg>
|
---|
| 171 | <seg>
|
---|
[e8a3404] | 172 | /usr/include/openobex,
|
---|
| 173 | /usr/lib/cmake/OpenObex-1.7.1, and
|
---|
| 174 | /usr/share/doc/openobex-1.7.1
|
---|
[bed59e0] | 175 | </seg>
|
---|
| 176 | </seglistitem>
|
---|
| 177 | </segmentedlist>
|
---|
| 178 |
|
---|
| 179 | <variablelist>
|
---|
| 180 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 181 | <?dbfo list-presentation="list"?>
|
---|
| 182 | <?dbhtml list-presentation="table"?>
|
---|
| 183 |
|
---|
[e23d8fcb] | 184 | <varlistentry id="obex-check-device">
|
---|
| 185 | <term><command>obex-check-device</command></term>
|
---|
| 186 | <listitem>
|
---|
| 187 | <para>
|
---|
| 188 | is a tool that help <application>udev</application> to find connectable OBEX USB devices.
|
---|
| 189 | </para>
|
---|
| 190 | <indexterm zone="openobex obex-check-device">
|
---|
| 191 | <primary sortas="b-obex-check-device">obex-check-device</primary>
|
---|
| 192 | </indexterm>
|
---|
| 193 | </listitem>
|
---|
| 194 | </varlistentry>
|
---|
| 195 |
|
---|
[bed59e0] | 196 | <varlistentry id="libopenobex">
|
---|
| 197 | <term><filename class="libraryfile">libopenobex.so</filename></term>
|
---|
| 198 | <listitem>
|
---|
| 199 | <para>
|
---|
| 200 | contains the <application>OpenOBEX</application> API functions.
|
---|
| 201 | </para>
|
---|
| 202 | <indexterm zone="openobex libopenobex">
|
---|
| 203 | <primary sortas="c-libopenobex">libopenobex.so</primary>
|
---|
| 204 | </indexterm>
|
---|
| 205 | </listitem>
|
---|
| 206 | </varlistentry>
|
---|
| 207 |
|
---|
| 208 | </variablelist>
|
---|
| 209 |
|
---|
| 210 | </sect2>
|
---|
| 211 |
|
---|
| 212 | </sect1>
|
---|