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 appstream-download-http "https://www.freedesktop.org/software/appstream/releases/AppStream-&appstream-version;.tar.xz">
|
---|
8 | <!ENTITY appstream-download-ftp " ">
|
---|
9 | <!ENTITY appstream-md5sum "8db15579a7b25acca99677ddc6a12b68">
|
---|
10 | <!ENTITY appstream-size "2.5 MB">
|
---|
11 | <!ENTITY appstream-buildsize "30 MB">
|
---|
12 | <!ENTITY appstream-time "0.5 SBU (With tests; both using parallelism=4)">
|
---|
13 |
|
---|
14 | ]>
|
---|
15 |
|
---|
16 | <sect1 id="appstream" xreflabel="AppStream-&appstream-version;">
|
---|
17 | <?dbhtml filename="appstream.html"?>
|
---|
18 |
|
---|
19 | <title>AppStream-&appstream-version;</title>
|
---|
20 |
|
---|
21 | <indexterm zone="appstream">
|
---|
22 | <primary sortas="a-appstream">AppStream</primary>
|
---|
23 | </indexterm>
|
---|
24 |
|
---|
25 | <sect2 role="package">
|
---|
26 | <title>Introduction to AppStream</title>
|
---|
27 |
|
---|
28 | <para>
|
---|
29 | The <application>AppStream</application> package contains a library and
|
---|
30 | tool that is useful for retrieving software metadata and making it
|
---|
31 | easily accessible to programs which need it.
|
---|
32 | </para>
|
---|
33 |
|
---|
34 | &lfs122_checked;
|
---|
35 |
|
---|
36 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
37 | <itemizedlist spacing="compact">
|
---|
38 | <listitem>
|
---|
39 | <para>
|
---|
40 | Download (HTTP): <ulink url="&appstream-download-http;"/>
|
---|
41 | </para>
|
---|
42 | </listitem>
|
---|
43 | <listitem>
|
---|
44 | <para>
|
---|
45 | Download (FTP): <ulink url="&appstream-download-ftp;"/>
|
---|
46 | </para>
|
---|
47 | </listitem>
|
---|
48 | <listitem>
|
---|
49 | <para>
|
---|
50 | Download MD5 sum: &appstream-md5sum;
|
---|
51 | </para>
|
---|
52 | </listitem>
|
---|
53 | <listitem>
|
---|
54 | <para>
|
---|
55 | Download size: &appstream-size;
|
---|
56 | </para>
|
---|
57 | </listitem>
|
---|
58 | <listitem>
|
---|
59 | <para>
|
---|
60 | Estimated disk space required: &appstream-buildsize;
|
---|
61 | </para>
|
---|
62 | </listitem>
|
---|
63 | <listitem>
|
---|
64 | <para>
|
---|
65 | Estimated build time: &appstream-time;
|
---|
66 | </para>
|
---|
67 | </listitem>
|
---|
68 | </itemizedlist>
|
---|
69 |
|
---|
70 | <bridgehead renderas="sect3">AppStream Dependencies</bridgehead>
|
---|
71 |
|
---|
72 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
73 | <para role="required">
|
---|
74 | <xref linkend="curl"/>,
|
---|
75 | <phrase revision="sysv"><xref linkend="elogind"/>,</phrase>
|
---|
76 | <xref linkend="itstool"/>,
|
---|
77 | <xref linkend="libxml2"/>,
|
---|
78 | <xref linkend="libxmlb"/>, and
|
---|
79 | <xref linkend="libyaml"/>
|
---|
80 | </para>
|
---|
81 |
|
---|
82 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
83 | <para role="optional">
|
---|
84 | <xref linkend="gi-docgen"/>,
|
---|
85 | <xref linkend="qt6"/>,
|
---|
86 | <ulink url="https://github.com/openSUSE/daps">DAPS</ulink>, and
|
---|
87 | <ulink url="https://github.com/zvelo/libstemmer">libstemmer</ulink>
|
---|
88 | </para>
|
---|
89 |
|
---|
90 | <!-- Only use this if you want to note something in the wiki
|
---|
91 | <para condition="html" role="usernotes">
|
---|
92 | Editor Notes: <ulink url="&blfs-wiki;/TEMPLATE"/>
|
---|
93 | </para>
|
---|
94 | -->
|
---|
95 | </sect2>
|
---|
96 |
|
---|
97 | <sect2 role="installation">
|
---|
98 | <title>Installation of AppStream</title>
|
---|
99 |
|
---|
100 | <para>
|
---|
101 | Install <application>AppStream</application> by running the following
|
---|
102 | commands:
|
---|
103 | </para>
|
---|
104 |
|
---|
105 | <screen><userinput>mkdir build &&
|
---|
106 | cd build &&
|
---|
107 |
|
---|
108 | meson setup --prefix=/usr \
|
---|
109 | --buildtype=release \
|
---|
110 | -D apidocs=false \
|
---|
111 | -D stemming=false .. &&
|
---|
112 | ninja</userinput></screen>
|
---|
113 |
|
---|
114 | <para>
|
---|
115 | To test the results, issue: <command>ninja test</command>.
|
---|
116 | </para>
|
---|
117 |
|
---|
118 | <para>
|
---|
119 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
120 | </para>
|
---|
121 |
|
---|
122 | <screen role="root"><userinput>ninja install &&
|
---|
123 | mv -v /usr/share/doc/appstream{,-&appstream-version;}</userinput></screen>
|
---|
124 |
|
---|
125 | </sect2>
|
---|
126 |
|
---|
127 | <sect2 role="commands">
|
---|
128 | <title>Command Explanations</title>
|
---|
129 |
|
---|
130 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
131 | href="../../xincludes/meson-buildtype-release.xml"/>
|
---|
132 |
|
---|
133 | <para>
|
---|
134 | <parameter>-D apidocs=false</parameter>: This switch disables building the
|
---|
135 | API documentation. Remove it if you have
|
---|
136 | <xref linkend="gi-docgen" role="nodep"/> installed and wish to
|
---|
137 | regenerate the API documentation. When the API documentation is
|
---|
138 | not regenerated, a pre-built copy is installed anyway.
|
---|
139 | </para>
|
---|
140 |
|
---|
141 | <para>
|
---|
142 | <parameter>-D stemming=false</parameter>: This switch disables stemming
|
---|
143 | support. Remove this switch if you have
|
---|
144 | <ulink url="https://github.com/zvelo/libstemmer">libstemmer</ulink>
|
---|
145 | installed and want faster searches.
|
---|
146 | </para>
|
---|
147 |
|
---|
148 | <para>
|
---|
149 | <option>-D qt=true</option>: Use this option if you have
|
---|
150 | <xref linkend="qt6" role="nodep"/> installed and you want to build support
|
---|
151 | for Qt6 applications into this package.
|
---|
152 | </para>
|
---|
153 |
|
---|
154 | </sect2>
|
---|
155 |
|
---|
156 | <sect2 role="configuration">
|
---|
157 | <title>Configuring AppStream</title>
|
---|
158 |
|
---|
159 | <sect3 id="appstream-config">
|
---|
160 | <title>Config Files</title>
|
---|
161 |
|
---|
162 | <para>
|
---|
163 | <filename>/usr/share/metainfo/org.linuxfromscratch.lfs.xml</filename>
|
---|
164 | </para>
|
---|
165 | </sect3>
|
---|
166 |
|
---|
167 | <sect3>
|
---|
168 | <title>Configuration Information</title>
|
---|
169 |
|
---|
170 | <para>
|
---|
171 | <application>AppStream</application> expects an operating system
|
---|
172 | metainfo file describing the GNU/Linux distribution. As the
|
---|
173 | &root; user, create the file describing LFS:
|
---|
174 | </para>
|
---|
175 |
|
---|
176 | <indexterm zone="appstream appstream-config">
|
---|
177 | <primary sortas="e-usr-share-metainfo-org-linuxfromscratch-lfs-xml">
|
---|
178 | /usr/share/metainfo/org.linuxfromscratch.lfs.xml
|
---|
179 | </primary>
|
---|
180 | </indexterm>
|
---|
181 |
|
---|
182 | <screen role="root"><userinput>install -vdm755 /usr/share/metainfo &&
|
---|
183 | cat > /usr/share/metainfo/org.linuxfromscratch.lfs.xml << EOF
|
---|
184 | <literal><?xml version="1.0" encoding="UTF-8"?>
|
---|
185 | <component type="operating-system">
|
---|
186 | <id>org.linuxfromscratch.lfs</id>
|
---|
187 | <name>Linux From Scratch</name>
|
---|
188 | <summary>A customized Linux system built entirely from source</summary>
|
---|
189 | <description>
|
---|
190 | <p>
|
---|
191 | Linux From Scratch (LFS) is a project that provides you with
|
---|
192 | step-by-step instructions for building your own customized Linux
|
---|
193 | system entirely from source.
|
---|
194 | </p>
|
---|
195 | </description>
|
---|
196 | <url type="homepage">https://www.linuxfromscratch.org/lfs/</url>
|
---|
197 | <metadata_license>MIT</metadata_license>
|
---|
198 | <developer id='linuxfromscratch.org'>
|
---|
199 | <name>The Linux From Scratch Editors</name>
|
---|
200 | </developer>
|
---|
201 |
|
---|
202 | <releases>
|
---|
203 | <release version="&lfs-appstream-meta-ver;" type="&lfs-appstream-meta-type;" date="&lfs-appstream-meta-date;">
|
---|
204 | <description>
|
---|
205 | <p>The development snapshot of the next LFS version.</p>
|
---|
206 | </description>
|
---|
207 | </release>
|
---|
208 |
|
---|
209 | <release version="12.2" type="stable" date="2024-09-01">
|
---|
210 | <description>
|
---|
211 | <p>Now contains Binutils 2.43.1, GCC-14.2.0, Glibc-2.40,
|
---|
212 | and Linux kernel 6.10.</p>
|
---|
213 | </description>
|
---|
214 | </release>
|
---|
215 | </releases>
|
---|
216 | </component></literal>
|
---|
217 | EOF</userinput></screen>
|
---|
218 |
|
---|
219 | </sect3>
|
---|
220 | </sect2>
|
---|
221 |
|
---|
222 | <sect2 role="content">
|
---|
223 | <title>Contents</title>
|
---|
224 |
|
---|
225 | <segmentedlist>
|
---|
226 | <segtitle>Installed Programs</segtitle>
|
---|
227 | <segtitle>Installed Libraries</segtitle>
|
---|
228 | <segtitle>Installed Directories</segtitle>
|
---|
229 |
|
---|
230 | <seglistitem>
|
---|
231 | <seg>
|
---|
232 | appstreamcli
|
---|
233 | </seg>
|
---|
234 | <seg>
|
---|
235 | libappstream.so
|
---|
236 | </seg>
|
---|
237 | <seg>
|
---|
238 | /usr/include/appstream,
|
---|
239 | /usr/share/doc/appstream-&appstream-version;, and
|
---|
240 | /usr/share/installed-tests/appstream
|
---|
241 | </seg>
|
---|
242 | </seglistitem>
|
---|
243 | </segmentedlist>
|
---|
244 |
|
---|
245 | <variablelist>
|
---|
246 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
247 | <?dbfo list-presentation="list"?>
|
---|
248 | <?dbhtml list-presentation="table"?>
|
---|
249 |
|
---|
250 | <varlistentry id="appstreamcli">
|
---|
251 | <term><command>appstreamcli</command></term>
|
---|
252 | <listitem>
|
---|
253 | <para>
|
---|
254 | queries information from AppStream metadata and from the AppStream
|
---|
255 | component index
|
---|
256 | </para>
|
---|
257 | <indexterm zone="appstream appstreamcli">
|
---|
258 | <primary sortas="b-appstreamcli">appstreamcli</primary>
|
---|
259 | </indexterm>
|
---|
260 | </listitem>
|
---|
261 | </varlistentry>
|
---|
262 |
|
---|
263 | <varlistentry id="libappstream">
|
---|
264 | <term><filename class="libraryfile">libappstream.so</filename></term>
|
---|
265 | <listitem>
|
---|
266 | <para>
|
---|
267 | contains functions that handle AppStream metadata queries and
|
---|
268 | request information from the AppStream component index
|
---|
269 | </para>
|
---|
270 | <indexterm zone="appstream libappstream">
|
---|
271 | <primary sortas="c-libappstream">libappstream.so</primary>
|
---|
272 | </indexterm>
|
---|
273 | </listitem>
|
---|
274 | </varlistentry>
|
---|
275 | </variablelist>
|
---|
276 | </sect2>
|
---|
277 | </sect1>
|
---|