[fa559f1] | 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 appstream-download-http "https://www.freedesktop.org/software/appstream/releases/AppStream-0.16.3.tar.xz">
|
---|
| 8 | <!ENTITY appstream-download-ftp " ">
|
---|
| 9 | <!ENTITY appstream-md5sum "d60cdc2c2641398c2fde38e6436d185b">
|
---|
| 10 | <!ENTITY appstream-size "2.4 MB">
|
---|
| 11 | <!ENTITY appstream-buildsize "31 MB">
|
---|
| 12 | <!ENTITY appstream-time "0.6 SBU">
|
---|
| 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 |
|
---|
[bccf5d0c] | 33 | <!-- Remember to update the org.linuxfromscratch.lfs.xml file in
|
---|
| 34 | configuration section when tagging this. -->
|
---|
[fa559f1] | 35 | &lfs120_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="gtk-doc"/>,
|
---|
| 86 | &qt5-deps;, and
|
---|
[8cc537fe] | 87 | <ulink url="https://github.com/zvelo/libstemmer">libstemmer</ulink>
|
---|
[fa559f1] | 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 | -Dapidocs=false \
|
---|
| 111 | -Dstemming=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>-Dapidocs=false</parameter>: This switch disables building the
|
---|
| 135 | API documentation. Remove it if you have
|
---|
| 136 | <xref linkend="gtk-doc" role="nodep"/> installed and wish to generate the
|
---|
| 137 | API documentation.
|
---|
| 138 | </para>
|
---|
| 139 |
|
---|
| 140 | <para>
|
---|
| 141 | <parameter>-Dstemming=false</parameter>: This switch disables stemming
|
---|
| 142 | support. Remove this switch if you have
|
---|
| 143 | <ulink url="https://github.com/zvelo/libstemmer">libstemmer</ulink>
|
---|
| 144 | installed and want faster searches.
|
---|
| 145 | </para>
|
---|
| 146 |
|
---|
| 147 | <para>
|
---|
| 148 | <option>-Dqt=true</option>: Use this option if you have &qt5-deps;
|
---|
| 149 | installed and you want to build support for Qt applications into this
|
---|
| 150 | package.
|
---|
| 151 | </para>
|
---|
| 152 |
|
---|
| 153 | </sect2>
|
---|
| 154 |
|
---|
[69553e9] | 155 | <sect2 role="configuration">
|
---|
| 156 | <title>Configuring AppStream</title>
|
---|
| 157 |
|
---|
| 158 | <sect3 id="appstream-config">
|
---|
| 159 | <title>Config Files</title>
|
---|
| 160 |
|
---|
| 161 | <para>
|
---|
| 162 | <filename>/usr/share/metainfo/org.linuxfromscratch.lfs.xml</filename>
|
---|
| 163 | </para>
|
---|
| 164 | </sect3>
|
---|
| 165 |
|
---|
| 166 | <sect3>
|
---|
| 167 | <title>Configuration Information</title>
|
---|
| 168 |
|
---|
| 169 | <para>
|
---|
[075fb2e] | 170 | <application>AppStream</application> expects an operating system
|
---|
| 171 | metainfo file describing the GNU/Linux distribution. As the
|
---|
[69553e9] | 172 | &root; user, create the file describing LFS:
|
---|
| 173 | </para>
|
---|
| 174 |
|
---|
| 175 | <indexterm zone="appstream appstream-config">
|
---|
| 176 | <primary sortas="e-usr-share-metainfo-org-linuxfromscratch-lfs-xml">
|
---|
| 177 | /usr/share/metainfo/org.linuxfromscratch.lfs.xml
|
---|
| 178 | </primary>
|
---|
| 179 | </indexterm>
|
---|
| 180 |
|
---|
| 181 | <screen role="root"><userinput>install -vdm755 /usr/share/metainfo &&
|
---|
| 182 | cat > /usr/share/metainfo/org.linuxfromscratch.lfs.xml << EOF
|
---|
| 183 | <literal><?xml version="1.0" encoding="UTF-8"?>
|
---|
| 184 | <component type="operating-system">
|
---|
| 185 | <id>org.linuxfromscratch.lfs</id>
|
---|
| 186 | <name>Linux From Scratch</name>
|
---|
| 187 | <summary>A customized Linux system built entirely from source.</summary>
|
---|
| 188 | <description>
|
---|
| 189 | <p>
|
---|
| 190 | Linux From Scratch (LFS) is a project that provides you with
|
---|
| 191 | step-by-step instructions for building your own customized Linux
|
---|
| 192 | system entirely from source.
|
---|
| 193 | </p>
|
---|
| 194 | </description>
|
---|
| 195 | <url type="homepage">https://www.linuxfromscratch.org/lfs/</url>
|
---|
| 196 | <metadata_license>MIT</metadata_license>
|
---|
| 197 | <developer_name>The Linux From Scratch Editors</developer_name>
|
---|
| 198 |
|
---|
| 199 | <releases>
|
---|
| 200 | <release version="12.1" type="development">
|
---|
| 201 | <description>
|
---|
| 202 | <p>The next release of Linux From Scratch.</p>
|
---|
| 203 | </description>
|
---|
| 204 | </release>
|
---|
| 205 |
|
---|
| 206 | <release version="12.0" type="stable" date="2023-09-01">
|
---|
| 207 | <description>
|
---|
| 208 | <p>Now contains Binutils 2.41, GCC-13.2.0, Glibc-2.38, and Linux
|
---|
| 209 | kernel 6.4.</p>
|
---|
| 210 | </description>
|
---|
| 211 | </release>
|
---|
| 212 | </releases>
|
---|
| 213 | </component></literal>
|
---|
| 214 | EOF</userinput></screen>
|
---|
| 215 |
|
---|
| 216 | </sect3>
|
---|
| 217 | </sect2>
|
---|
| 218 |
|
---|
[fa559f1] | 219 | <sect2 role="content">
|
---|
| 220 | <title>Contents</title>
|
---|
| 221 |
|
---|
| 222 | <segmentedlist>
|
---|
| 223 | <segtitle>Installed Programs</segtitle>
|
---|
| 224 | <segtitle>Installed Libraries</segtitle>
|
---|
| 225 | <segtitle>Installed Directories</segtitle>
|
---|
| 226 |
|
---|
| 227 | <seglistitem>
|
---|
| 228 | <seg>
|
---|
| 229 | appstreamcli
|
---|
| 230 | </seg>
|
---|
| 231 | <seg>
|
---|
| 232 | libappstream.so
|
---|
| 233 | </seg>
|
---|
| 234 | <seg>
|
---|
| 235 | /usr/include/appstream,
|
---|
| 236 | /usr/share/doc/appstream-&version;, and
|
---|
| 237 | /usr/share/installed-tests/appstream
|
---|
| 238 | </seg>
|
---|
| 239 | </seglistitem>
|
---|
| 240 | </segmentedlist>
|
---|
| 241 |
|
---|
| 242 | <variablelist>
|
---|
| 243 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 244 | <?dbfo list-presentation="list"?>
|
---|
| 245 | <?dbhtml list-presentation="table"?>
|
---|
| 246 |
|
---|
| 247 | <varlistentry id="appstreamcli">
|
---|
| 248 | <term><command>appstreamcli</command></term>
|
---|
| 249 | <listitem>
|
---|
| 250 | <para>
|
---|
| 251 | queries information from AppStream metadata and from the AppStream
|
---|
| 252 | component index
|
---|
| 253 | </para>
|
---|
| 254 | <indexterm zone="appstream appstreamcli">
|
---|
| 255 | <primary sortas="b-appstreamcli">appstreamcli</primary>
|
---|
| 256 | </indexterm>
|
---|
| 257 | </listitem>
|
---|
| 258 | </varlistentry>
|
---|
| 259 |
|
---|
| 260 | <varlistentry id="libappstream">
|
---|
| 261 | <term><filename class="libraryfile">libappstream.so</filename></term>
|
---|
| 262 | <listitem>
|
---|
| 263 | <para>
|
---|
| 264 | contains functions that handle AppStream metadata queries and
|
---|
| 265 | request information from the AppStream component index
|
---|
| 266 | </para>
|
---|
| 267 | <indexterm zone="appstream libappstream">
|
---|
| 268 | <primary sortas="c-libappstream">libappstream.so</primary>
|
---|
| 269 | </indexterm>
|
---|
| 270 | </listitem>
|
---|
| 271 | </varlistentry>
|
---|
| 272 | </variablelist>
|
---|
| 273 | </sect2>
|
---|
| 274 | </sect1>
|
---|