source: general/genlib/libxmlb.xml@ fa559f1

12.1 ken/TL2024 ken/tuningfonts lazarus plabs/newcss python3.11 rahul/power-profiles-daemon renodr/vulkan-addition trunk xry111/llvm18
Last change on this file since fa559f1 was 97cecf5, checked in by Douglas R. Reno <renodr@…>, 9 months ago

Add libxmlb to the book in support of appstream.

This will be needed for libadwaita-1.4. See Ticket #18573 for more
details.

  • Property mode set to 100644
File size: 5.8 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 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 "c2e2af788950f3c73e078f89d56ef6ed">
10 <!ENTITY libxmlb-size "100 KB">
11 <!ENTITY libxmlb-buildsize "7.3 MB">
12 <!ENTITY libxmlb-time "0.2 SBU">
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 &lfs120_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"/>
73 </para>
74
75 <bridgehead renderas="sect4">Recommended</bridgehead>
76 <para role="recommended">
77 <xref linkend="gobject-introspection"/>
78 </para>
79
80 <bridgehead renderas="sect4">Optional</bridgehead>
81 <para role="optional">
82 <xref linkend="gtk-doc"/> and
83 <ulink url="https://github.com/zvelo/libstemmer">libstemmer</ulink>
84 </para>
85
86 <!-- Only use this if you want to note something in the wiki
87 <para condition="html" role="usernotes">
88 Editor Notes: <ulink url="&blfs-wiki;/libxmlb"/>
89 </para>
90 -->
91 </sect2>
92
93 <sect2 role="installation">
94 <title>Installation of libxmlb</title>
95
96 <para>
97 Install <application>libxmlb</application> by running the following
98 commands:
99 </para>
100
101<screen><userinput>mkdir build &amp;&amp;
102cd build &amp;&amp;
103
104meson setup --prefix=/usr --buildtype=release -Dgtkdoc=false .. &amp;&amp;
105ninja</userinput></screen>
106
107 <para>
108 To test the results, issue: <command>ninja test</command>.
109 </para>
110
111 <para>
112 Now, as the <systemitem class="username">root</systemitem> user:
113 </para>
114
115<screen role="root"><userinput>ninja install</userinput></screen>
116
117 </sect2>
118
119 <sect2 role="commands">
120 <title>Command Explanations</title>
121
122 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
123 href="../../xincludes/meson-buildtype-release.xml"/>
124
125<!-- Over in meson_options.txt, gtkdoc is set to 'true' by default. This would
126 introduce a dependency on gtk-doc, so let's set it as 'false' and let the
127 user enable it if they want the documentation. -renodr -->
128 <para>
129 <option>-Dgtkdoc=true</option>: Use this switch if you have
130 <xref linkend="gtk-doc" role="nodep"/> installed and you want to generate
131 the API documentation.
132 </para>
133
134 <para>
135 <option>-Dintrospection=false</option>: Use this switch if you do not
136 have <xref linkend="gobject-introspection" role="nodep"/> installed.
137 </para>
138
139 <para>
140 <option>-Dstemmer=true</option>: use this switch if you have
141 <ulink url="https://github.com/zvelo/libstemmer">libstemmer</ulink>
142 installed and wish to build stemmer support.
143 </para>
144
145 </sect2>
146
147 <sect2 role="content">
148 <title>Contents</title>
149
150 <segmentedlist>
151 <segtitle>Installed Programs</segtitle>
152 <segtitle>Installed Libraries</segtitle>
153 <segtitle>Installed Directories</segtitle>
154
155 <seglistitem>
156 <seg>
157 xb-tool
158 </seg>
159 <seg>
160 libxmlb.so
161 </seg>
162 <seg>
163 /usr/include/libxmlb-2,
164 /usr/libexec/installed-tests/libxmlb, and
165 /usr/share/gtk-doc/html/libxmlb (if gtk-doc was enabled)
166 </seg>
167 </seglistitem>
168 </segmentedlist>
169
170 <variablelist>
171 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
172 <?dbfo list-presentation="list"?>
173 <?dbhtml list-presentation="table"?>
174
175 <varlistentry id="xb-tool">
176 <term><command>xb-tool</command></term>
177 <listitem>
178 <para>
179 is a tool used to create, dump, or query a binary XML blob
180 </para>
181 <indexterm zone="libxmlb xb-tool">
182 <primary sortas="b-xb-tool">xb-tool</primary>
183 </indexterm>
184 </listitem>
185 </varlistentry>
186
187 <varlistentry id="libxmlb-lib">
188 <term><filename class="libraryfile">libxmlb.so</filename></term>
189 <listitem>
190 <para>
191 contains functions that allow for creating and querying binary XML
192 blobs
193 </para>
194 <indexterm zone="libxmlb libxmlb-lib">
195 <primary sortas="c-libxmlb">libxmlb.so</primary>
196 </indexterm>
197 </listitem>
198 </varlistentry>
199 </variablelist>
200 </sect2>
201</sect1>
Note: See TracBrowser for help on using the repository browser.