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