source: general/genlib/openobex.xml@ 60d53ec3

10.0 10.1 11.0 7.10 7.8 7.9 8.0 8.1 8.2 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind ken/refactor-virt lazarus nosym perl-modules qt5new trunk xry111/git-date xry111/git-date-for-trunk xry111/git-date-test
Last change on this file since 60d53ec3 was 60d53ec3, checked in by Bruce Dubbs <bdubbs@…>, 6 years ago

Tags and some minor formatting

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@16435 af4574ff-66df-0310-9fd7-8a98e5e911e0

  • Property mode set to 100644
File size: 5.9 KB
Line 
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
7 <!ENTITY openobex-download-http "&sourceforge-repo;/openobex/openobex-&openobex-version;-Source.tar.gz">
8 <!ENTITY openobex-download-ftp " ">
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">
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
38 &lfs78_checked;
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">
78 <xref linkend="cmake"/> and
79 <xref linkend="libusb"/>
80 </para>
81
82 <bridgehead renderas="sect4">Recommended</bridgehead>
83 <para role="recommended">
84 <xref linkend="bluez"/>
85 </para>
86
87 <bridgehead renderas="sect4">Optional</bridgehead>
88 <para role="optional">
89 <xref linkend="doxygen"/>,
90 <xref linkend="libxslt"/>,
91 <xref linkend="openjdk"/>, and
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
103 <para><application>OpenOBEX</application> installs a udev rule that
104 requires a group named plugdev. Create that group as the
105 <systemitem class="username">root</systemitem> user:</para>
106
107<screen role="root"><userinput>groupadd -g 90 plugdev</userinput></screen>
108
109 <para>
110 Install <application>OpenOBEX</application> by running the following
111 commands:
112 </para>
113
114<screen><userinput>mkdir build &amp;&amp;
115cd build &amp;&amp;
116
117cmake -DCMAKE_INSTALL_PREFIX=/usr \
118 -DCMAKE_INSTALL_LIBDIR=/usr/lib \
119 -DCMAKE_BUILD_TYPE=Release \
120 -Wno-dev \
121 .. &amp;&amp;
122make</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
132<screen role="root"><userinput>make install &amp;&amp;
133mv -fv /usr/share/doc/openobex{,-&openobex-version;}</userinput></screen>
134 </sect2>
135
136 <sect2 role="commands">
137 <title>Command Explanations</title>
138
139 <para>
140 <parameter>-DCMAKE_BUILD_TYPE=Release</parameter>: This switch is used
141 to apply higher level of the compiler optimizations.
142 </para>
143
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
149 <para>
150 <command>mv -fv ...</command>: Move the documention to a versioned
151 directory.
152 </para>
153
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>
172 /usr/include/openobex,
173 /usr/lib/cmake/OpenObex-1.7.1, and
174 /usr/share/doc/openobex-1.7.1
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
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
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>
Note: See TracBrowser for help on using the repository browser.