Add AppStream to the book in support of libadwaita.

See Tickets #18599 and #18573 for more details.
This commit is contained in:
Douglas R. Reno 2023-09-18 13:30:04 -05:00
parent 97cecf51ae
commit fa559f1cc8
5 changed files with 217 additions and 7 deletions

View File

@ -0,0 +1,208 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % general-entities SYSTEM "../../general.ent">
%general-entities;
<!ENTITY appstream-download-http "https://www.freedesktop.org/software/appstream/releases/AppStream-0.16.3.tar.xz">
<!ENTITY appstream-download-ftp " ">
<!ENTITY appstream-md5sum "d60cdc2c2641398c2fde38e6436d185b">
<!ENTITY appstream-size "2.4 MB">
<!ENTITY appstream-buildsize "31 MB">
<!ENTITY appstream-time "0.6 SBU">
]>
<sect1 id="appstream" xreflabel="AppStream-&appstream-version;">
<?dbhtml filename="appstream.html"?>
<title>AppStream-&appstream-version;</title>
<indexterm zone="appstream">
<primary sortas="a-appstream">AppStream</primary>
</indexterm>
<sect2 role="package">
<title>Introduction to AppStream</title>
<para>
The <application>AppStream</application> package contains a library and
tool that is useful for retrieving software metadata and making it
easily accessible to programs which need it.
</para>
&lfs120_checked;
<bridgehead renderas="sect3">Package Information</bridgehead>
<itemizedlist spacing="compact">
<listitem>
<para>
Download (HTTP): <ulink url="&appstream-download-http;"/>
</para>
</listitem>
<listitem>
<para>
Download (FTP): <ulink url="&appstream-download-ftp;"/>
</para>
</listitem>
<listitem>
<para>
Download MD5 sum: &appstream-md5sum;
</para>
</listitem>
<listitem>
<para>
Download size: &appstream-size;
</para>
</listitem>
<listitem>
<para>
Estimated disk space required: &appstream-buildsize;
</para>
</listitem>
<listitem>
<para>
Estimated build time: &appstream-time;
</para>
</listitem>
</itemizedlist>
<bridgehead renderas="sect3">AppStream Dependencies</bridgehead>
<bridgehead renderas="sect4">Required</bridgehead>
<para role="required">
<xref linkend="curl"/>,
<phrase revision="sysv"><xref linkend="elogind"/>,</phrase>
<xref linkend="itstool"/>,
<xref linkend="libxml2"/>,
<xref linkend="libxmlb"/>, and
<xref linkend="libyaml"/>
</para>
<bridgehead renderas="sect4">Optional</bridgehead>
<para role="optional">
<xref linkend="gtk-doc"/>,
&qt5-deps;, and
<ulink url="https://github.com/zvelo/libstemmer">libstemmber</ulink>
</para>
<!-- Only use this if you want to note something in the wiki
<para condition="html" role="usernotes">
Editor Notes: <ulink url="&blfs-wiki;/TEMPLATE"/>
</para>
-->
</sect2>
<sect2 role="installation">
<title>Installation of AppStream</title>
<para>
Install <application>AppStream</application> by running the following
commands:
</para>
<screen><userinput>mkdir build &amp;&amp;
cd build &amp;&amp;
meson setup --prefix=/usr \
--buildtype=release \
-Dapidocs=false \
-Dstemming=false .. &amp;&amp;
ninja</userinput></screen>
<para>
To test the results, issue: <command>ninja test</command>.
</para>
<para>
Now, as the <systemitem class="username">root</systemitem> user:
</para>
<screen role="root"><userinput>ninja install &amp;&amp;
mv -v /usr/share/doc/appstream{,-&appstream-version;}</userinput></screen>
</sect2>
<sect2 role="commands">
<title>Command Explanations</title>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
href="../../xincludes/meson-buildtype-release.xml"/>
<para>
<parameter>-Dapidocs=false</parameter>: This switch disables building the
API documentation. Remove it if you have
<xref linkend="gtk-doc" role="nodep"/> installed and wish to generate the
API documentation.
</para>
<para>
<parameter>-Dstemming=false</parameter>: This switch disables stemming
support. Remove this switch if you have
<ulink url="https://github.com/zvelo/libstemmer">libstemmer</ulink>
installed and want faster searches.
</para>
<para>
<option>-Dqt=true</option>: Use this option if you have &qt5-deps;
installed and you want to build support for Qt applications into this
package.
</para>
</sect2>
<sect2 role="content">
<title>Contents</title>
<segmentedlist>
<segtitle>Installed Programs</segtitle>
<segtitle>Installed Libraries</segtitle>
<segtitle>Installed Directories</segtitle>
<seglistitem>
<seg>
appstreamcli
</seg>
<seg>
libappstream.so
</seg>
<seg>
/usr/include/appstream,
/usr/share/doc/appstream-&version;, and
/usr/share/installed-tests/appstream
</seg>
</seglistitem>
</segmentedlist>
<variablelist>
<bridgehead renderas="sect3">Short Descriptions</bridgehead>
<?dbfo list-presentation="list"?>
<?dbhtml list-presentation="table"?>
<varlistentry id="appstreamcli">
<term><command>appstreamcli</command></term>
<listitem>
<para>
queries information from AppStream metadata and from the AppStream
component index
</para>
<indexterm zone="appstream appstreamcli">
<primary sortas="b-appstreamcli">appstreamcli</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="libappstream">
<term><filename class="libraryfile">libappstream.so</filename></term>
<listitem>
<para>
contains functions that handle AppStream metadata queries and
request information from the AppStream component index
</para>
<indexterm zone="appstream libappstream">
<primary sortas="c-libappstream">libappstream.so</primary>
</indexterm>
</listitem>
</varlistentry>
</variablelist>
</sect2>
</sect1>

View File

@ -46,9 +46,7 @@
it is explained why you may want to install them.
</para>
<!-- systemd only -->
<!--<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="appstream-glib.xml"/>-->
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="appstream.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="apr.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="apr-util.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="aspell.xml"/>

View File

@ -41,6 +41,10 @@
<listitem>
<para>September 18th, 2023</para>
<itemizedlist>
<listitem>
<para>[renodr] - Add appstream to the book in support of libadwaita.
Fixes <ulink url="&blfs-ticket-root;18573">#18573</ulink>.</para>
</listitem>
<listitem>
<para>[renodr] - Add libxmlb to the book in support of appstream.
Fixes <ulink url="&blfs-ticket-root;18600">#18600</ulink>.</para>

View File

@ -112,11 +112,11 @@
<bridgehead renderas="sect4">Optional</bridgehead>
<para role="optional">
<xref linkend="appstream"/> (build with -qt=true),
<xref linkend="glu"/>,
<xref linkend='ibus'/>,
<xref linkend='qtwebengine'/>,
<xref linkend="xorg-synaptics-driver"/>,
<ulink url="https://distributions.freedesktop.org/wiki/AppStream">appstream-qt</ulink>,
<ulink url="https://www.kdevelop.org/">KDevPlatform</ulink>,
<ulink url="https://gpsd.gitlab.io/gpsd/">libgps</ulink>,
<ulink url="https://github.com/libhybris/libhybris">libhybris</ulink>,
@ -247,9 +247,8 @@ EOF</userinput></screen>
The plasma-nano package is used for embedded systems and
plasma-mobile provides phone functionality for Plasma.
The aura-browser package requires <xref linkend="qtwebengine"/>.
The discover package requires the external package
<ulink url="https://distributions.freedesktop.org/wiki/AppStream">
appstream-qt</ulink>.
The discover package requires <xref linkend="appstream"/> to be built
with the -Dqt=true switch.
The plasma-welcome package requires the external package
<ulink url="https://download.kde.org/stable/release-service/&kf5apps-version;/src/">
kaccounts-integration</ulink>.

View File

@ -82,6 +82,7 @@
<!-- Part III -->
<!-- Chapter 9 -->
<!ENTITY appstream-version "0.16.3">
<!ENTITY apr-version "1.7.4">
<!ENTITY apr-util-version "1.6.3">
<!ENTITY aspell-version "0.60.8">