source: archive/openobex.xml@ fa91d2e

11.0 qt5new trunk
Last change on this file since fa91d2e was 45ab6c7, checked in by Xi Ruoyao <xry111@…>, 5 months ago

more SVN prop clean up

Remove "$LastChanged$" everywhere, and also some unused $Date$

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