source: general/genlib/openobex.xml@ 39a26d5

10.0 10.1 11.0 8.0 8.1 8.2 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind ken/refactor-virt lazarus perl-modules qt5new trunk upgradedb xry111/git-date xry111/git-date-for-trunk xry111/git-date-test
Last change on this file since 39a26d5 was 39a26d5, checked in by Douglas R. Reno <renodr@…>, 5 years ago

Tags for GNOME section

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

  • Property mode set to 100644
File size: 6.0 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 "f6e0b6cb7dcfd731460a7e9a91429a3a">
10 <!ENTITY openobex-size "128 KB">
11 <!ENTITY openobex-buildsize "3.1 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 &lfs80_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 <!-- /usr/share/doc/openobex is not created if doxygen is not found -->
133<screen role="root"><userinput>make install &amp;&amp;
134if [ -d /usr/share/doc/openobex ]; then
135 mv -fv /usr/share/doc/{openobex,openobex-&openobex-version;}
136fi</userinput></screen>
137 </sect2>
138
139 <sect2 role="commands">
140 <title>Command Explanations</title>
141
142 <para>
143 <parameter>-DCMAKE_BUILD_TYPE=Release</parameter>: This switch is used
144 to apply higher level of the compiler optimizations.
145 </para>
146
147 <para>
148 <parameter>-Wno-dev</parameter>: This switch is used to suppress warnings
149 that are meant for the author of the CMakeLists.txt files.
150 </para>
151
152 <para>
153 <command>mv -fv ...</command>: Moves the documentation to a versioned
154 directory, if it has been created.
155 </para>
156
157 </sect2>
158
159 <sect2 role="content">
160 <title>Contents</title>
161
162 <segmentedlist>
163 <segtitle>Installed Program</segtitle>
164 <segtitle>Installed Library</segtitle>
165 <segtitle>Installed Directory</segtitle>
166
167 <seglistitem>
168 <seg>
169 obex-check-device
170 </seg>
171 <seg>
172 libopenobex.so
173 </seg>
174 <seg>
175 /usr/include/openobex,
176 /usr/lib/cmake/OpenObex-1.7.1, and
177 /usr/share/doc/openobex-1.7.1
178 </seg>
179 </seglistitem>
180 </segmentedlist>
181
182 <variablelist>
183 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
184 <?dbfo list-presentation="list"?>
185 <?dbhtml list-presentation="table"?>
186
187 <varlistentry id="obex-check-device">
188 <term><command>obex-check-device</command></term>
189 <listitem>
190 <para>
191 is a tool that helps <application>udev</application> find connectable OBEX USB devices.
192 </para>
193 <indexterm zone="openobex obex-check-device">
194 <primary sortas="b-obex-check-device">obex-check-device</primary>
195 </indexterm>
196 </listitem>
197 </varlistentry>
198
199 <varlistentry id="libopenobex">
200 <term><filename class="libraryfile">libopenobex.so</filename></term>
201 <listitem>
202 <para>
203 contains the <application>OpenOBEX</application> API functions.
204 </para>
205 <indexterm zone="openobex libopenobex">
206 <primary sortas="c-libopenobex">libopenobex.so</primary>
207 </indexterm>
208 </listitem>
209 </varlistentry>
210
211 </variablelist>
212
213 </sect2>
214
215</sect1>
Note: See TracBrowser for help on using the repository browser.