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