1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
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 libxmlb-download-http "https://github.com/hughsie/libxmlb/releases/download/&libxmlb-version;/libxmlb-&libxmlb-version;.tar.xz">
|
---|
8 | <!ENTITY libxmlb-download-ftp " ">
|
---|
9 | <!ENTITY libxmlb-md5sum "6f83ad887ffacaa1f393650845eb8a1b">
|
---|
10 | <!ENTITY libxmlb-size "104 KB">
|
---|
11 | <!ENTITY libxmlb-buildsize "4.0 MB (with tests)">
|
---|
12 | <!ENTITY libxmlb-time "0.1 SBU (With tests)">
|
---|
13 | ]>
|
---|
14 |
|
---|
15 | <sect1 id="libxmlb" xreflabel="libxmlb-&libxmlb-version;">
|
---|
16 | <?dbhtml filename="libxmlb.html"?>
|
---|
17 |
|
---|
18 | <title>libxmlb-&libxmlb-version;</title>
|
---|
19 |
|
---|
20 | <indexterm zone="libxmlb">
|
---|
21 | <primary sortas="a-libxmlb">libxmlb</primary>
|
---|
22 | </indexterm>
|
---|
23 |
|
---|
24 | <sect2 role="package">
|
---|
25 | <title>Introduction to libxmlb</title>
|
---|
26 |
|
---|
27 | <para>
|
---|
28 | The <application>libxmlb</application> package contains a library and
|
---|
29 | a tool which help create and query binary XML blobs.
|
---|
30 | </para>
|
---|
31 |
|
---|
32 | &lfs122_checked;
|
---|
33 |
|
---|
34 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
35 | <itemizedlist spacing="compact">
|
---|
36 | <listitem>
|
---|
37 | <para>
|
---|
38 | Download (HTTP): <ulink url="&libxmlb-download-http;"/>
|
---|
39 | </para>
|
---|
40 | </listitem>
|
---|
41 | <listitem>
|
---|
42 | <para>
|
---|
43 | Download (FTP): <ulink url="&libxmlb-download-ftp;"/>
|
---|
44 | </para>
|
---|
45 | </listitem>
|
---|
46 | <listitem>
|
---|
47 | <para>
|
---|
48 | Download MD5 sum: &libxmlb-md5sum;
|
---|
49 | </para>
|
---|
50 | </listitem>
|
---|
51 | <listitem>
|
---|
52 | <para>
|
---|
53 | Download size: &libxmlb-size;
|
---|
54 | </para>
|
---|
55 | </listitem>
|
---|
56 | <listitem>
|
---|
57 | <para>
|
---|
58 | Estimated disk space required: &libxmlb-buildsize;
|
---|
59 | </para>
|
---|
60 | </listitem>
|
---|
61 | <listitem>
|
---|
62 | <para>
|
---|
63 | Estimated build time: &libxmlb-time;
|
---|
64 | </para>
|
---|
65 | </listitem>
|
---|
66 | </itemizedlist>
|
---|
67 |
|
---|
68 | <bridgehead renderas="sect3">libxmlb Dependencies</bridgehead>
|
---|
69 |
|
---|
70 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
71 | <para role="required">
|
---|
72 | <xref linkend="glib2"/> (GObject Introspection recommended)
|
---|
73 | </para>
|
---|
74 |
|
---|
75 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
76 | <para role="optional">
|
---|
77 | <xref linkend="gtk-doc"/> and
|
---|
78 | <ulink url="https://github.com/zvelo/libstemmer">libstemmer</ulink>
|
---|
79 | </para>
|
---|
80 |
|
---|
81 | <!-- Only use this if you want to note something in the wiki
|
---|
82 | <para condition="html" role="usernotes">
|
---|
83 | Editor Notes: <ulink url="&blfs-wiki;/libxmlb"/>
|
---|
84 | </para>
|
---|
85 | -->
|
---|
86 | </sect2>
|
---|
87 |
|
---|
88 | <sect2 role="installation">
|
---|
89 | <title>Installation of libxmlb</title>
|
---|
90 |
|
---|
91 | <para>
|
---|
92 | Install <application>libxmlb</application> by running the following
|
---|
93 | commands:
|
---|
94 | </para>
|
---|
95 |
|
---|
96 | <screen><userinput>mkdir build &&
|
---|
97 | cd build &&
|
---|
98 |
|
---|
99 | meson setup --prefix=/usr --buildtype=release -D gtkdoc=false .. &&
|
---|
100 | ninja</userinput></screen>
|
---|
101 |
|
---|
102 | <para>
|
---|
103 | To test the results, issue: <command>ninja test</command>.
|
---|
104 | </para>
|
---|
105 |
|
---|
106 | <para>
|
---|
107 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
108 | </para>
|
---|
109 |
|
---|
110 | <screen role="root"><userinput>ninja install</userinput></screen>
|
---|
111 |
|
---|
112 | </sect2>
|
---|
113 |
|
---|
114 | <sect2 role="commands">
|
---|
115 | <title>Command Explanations</title>
|
---|
116 |
|
---|
117 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
118 | href="../../xincludes/meson-buildtype-release.xml"/>
|
---|
119 |
|
---|
120 | <!-- Over in meson_options.txt, gtkdoc is set to 'true' by default. This would
|
---|
121 | introduce a dependency on gtk-doc, so let's set it as 'false' and let the
|
---|
122 | user enable it if they want the documentation. -renodr -->
|
---|
123 | <para>
|
---|
124 | <parameter>-D gtkdoc=false</parameter>: This switch disables building the
|
---|
125 | API documentation. Remove it if you have
|
---|
126 | <xref linkend="gtk-doc" role="nodep"/> installed and wish to build the
|
---|
127 | API documentation.
|
---|
128 | </para>
|
---|
129 |
|
---|
130 | <para>
|
---|
131 | <option>-D introspection=false</option>: Use this switch if you do not
|
---|
132 | have built <xref linkend='glib2'/> with GObject Introspection.
|
---|
133 | </para>
|
---|
134 |
|
---|
135 | <para>
|
---|
136 | <option>-D stemmer=true</option>: Use this switch if you have
|
---|
137 | <ulink url="https://github.com/zvelo/libstemmer">libstemmer</ulink>
|
---|
138 | installed and wish to build stemmer support.
|
---|
139 | </para>
|
---|
140 |
|
---|
141 | </sect2>
|
---|
142 |
|
---|
143 | <sect2 role="content">
|
---|
144 | <title>Contents</title>
|
---|
145 |
|
---|
146 | <segmentedlist>
|
---|
147 | <segtitle>Installed Programs</segtitle>
|
---|
148 | <segtitle>Installed Libraries</segtitle>
|
---|
149 | <segtitle>Installed Directories</segtitle>
|
---|
150 |
|
---|
151 | <seglistitem>
|
---|
152 | <seg>
|
---|
153 | xb-tool
|
---|
154 | </seg>
|
---|
155 | <seg>
|
---|
156 | libxmlb.so
|
---|
157 | </seg>
|
---|
158 | <seg>
|
---|
159 | /usr/include/libxmlb-2,
|
---|
160 | /usr/libexec/installed-tests/libxmlb, and
|
---|
161 | /usr/share/gtk-doc/html/libxmlb (if gtk-doc was enabled)
|
---|
162 | </seg>
|
---|
163 | </seglistitem>
|
---|
164 | </segmentedlist>
|
---|
165 |
|
---|
166 | <variablelist>
|
---|
167 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
168 | <?dbfo list-presentation="list"?>
|
---|
169 | <?dbhtml list-presentation="table"?>
|
---|
170 |
|
---|
171 | <varlistentry id="xb-tool">
|
---|
172 | <term><command>xb-tool</command></term>
|
---|
173 | <listitem>
|
---|
174 | <para>
|
---|
175 | is a tool used to create, dump, or query a binary XML blob
|
---|
176 | </para>
|
---|
177 | <indexterm zone="libxmlb xb-tool">
|
---|
178 | <primary sortas="b-xb-tool">xb-tool</primary>
|
---|
179 | </indexterm>
|
---|
180 | </listitem>
|
---|
181 | </varlistentry>
|
---|
182 |
|
---|
183 | <varlistentry id="libxmlb-lib">
|
---|
184 | <term><filename class="libraryfile">libxmlb.so</filename></term>
|
---|
185 | <listitem>
|
---|
186 | <para>
|
---|
187 | contains functions that allow for creating and querying binary XML
|
---|
188 | blobs
|
---|
189 | </para>
|
---|
190 | <indexterm zone="libxmlb libxmlb-lib">
|
---|
191 | <primary sortas="c-libxmlb">libxmlb.so</primary>
|
---|
192 | </indexterm>
|
---|
193 | </listitem>
|
---|
194 | </varlistentry>
|
---|
195 | </variablelist>
|
---|
196 | </sect2>
|
---|
197 | </sect1>
|
---|