[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 |
|
---|
| 33 | &lfs120_checked;
|
---|
| 34 |
|
---|
| 35 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 36 | <itemizedlist spacing="compact">
|
---|
| 37 | <listitem>
|
---|
| 38 | <para>
|
---|
| 39 | Download (HTTP): <ulink url="&appstream-download-http;"/>
|
---|
| 40 | </para>
|
---|
| 41 | </listitem>
|
---|
| 42 | <listitem>
|
---|
| 43 | <para>
|
---|
| 44 | Download (FTP): <ulink url="&appstream-download-ftp;"/>
|
---|
| 45 | </para>
|
---|
| 46 | </listitem>
|
---|
| 47 | <listitem>
|
---|
| 48 | <para>
|
---|
| 49 | Download MD5 sum: &appstream-md5sum;
|
---|
| 50 | </para>
|
---|
| 51 | </listitem>
|
---|
| 52 | <listitem>
|
---|
| 53 | <para>
|
---|
| 54 | Download size: &appstream-size;
|
---|
| 55 | </para>
|
---|
| 56 | </listitem>
|
---|
| 57 | <listitem>
|
---|
| 58 | <para>
|
---|
| 59 | Estimated disk space required: &appstream-buildsize;
|
---|
| 60 | </para>
|
---|
| 61 | </listitem>
|
---|
| 62 | <listitem>
|
---|
| 63 | <para>
|
---|
| 64 | Estimated build time: &appstream-time;
|
---|
| 65 | </para>
|
---|
| 66 | </listitem>
|
---|
| 67 | </itemizedlist>
|
---|
| 68 |
|
---|
| 69 | <bridgehead renderas="sect3">AppStream Dependencies</bridgehead>
|
---|
| 70 |
|
---|
| 71 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
| 72 | <para role="required">
|
---|
| 73 | <xref linkend="curl"/>,
|
---|
| 74 | <phrase revision="sysv"><xref linkend="elogind"/>,</phrase>
|
---|
| 75 | <xref linkend="itstool"/>,
|
---|
| 76 | <xref linkend="libxml2"/>,
|
---|
| 77 | <xref linkend="libxmlb"/>, and
|
---|
| 78 | <xref linkend="libyaml"/>
|
---|
| 79 | </para>
|
---|
| 80 |
|
---|
| 81 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
| 82 | <para role="optional">
|
---|
| 83 | <xref linkend="gtk-doc"/>,
|
---|
| 84 | &qt5-deps;, and
|
---|
| 85 | <ulink url="https://github.com/zvelo/libstemmer">libstemmber</ulink>
|
---|
| 86 | </para>
|
---|
| 87 |
|
---|
| 88 | <!-- Only use this if you want to note something in the wiki
|
---|
| 89 | <para condition="html" role="usernotes">
|
---|
| 90 | Editor Notes: <ulink url="&blfs-wiki;/TEMPLATE"/>
|
---|
| 91 | </para>
|
---|
| 92 | -->
|
---|
| 93 | </sect2>
|
---|
| 94 |
|
---|
| 95 | <sect2 role="installation">
|
---|
| 96 | <title>Installation of AppStream</title>
|
---|
| 97 |
|
---|
| 98 | <para>
|
---|
| 99 | Install <application>AppStream</application> by running the following
|
---|
| 100 | commands:
|
---|
| 101 | </para>
|
---|
| 102 |
|
---|
| 103 | <screen><userinput>mkdir build &&
|
---|
| 104 | cd build &&
|
---|
| 105 |
|
---|
| 106 | meson setup --prefix=/usr \
|
---|
| 107 | --buildtype=release \
|
---|
| 108 | -Dapidocs=false \
|
---|
| 109 | -Dstemming=false .. &&
|
---|
| 110 | ninja</userinput></screen>
|
---|
| 111 |
|
---|
| 112 | <para>
|
---|
| 113 | To test the results, issue: <command>ninja test</command>.
|
---|
| 114 | </para>
|
---|
| 115 |
|
---|
| 116 | <para>
|
---|
| 117 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 118 | </para>
|
---|
| 119 |
|
---|
| 120 | <screen role="root"><userinput>ninja install &&
|
---|
| 121 | mv -v /usr/share/doc/appstream{,-&appstream-version;}</userinput></screen>
|
---|
| 122 |
|
---|
| 123 | </sect2>
|
---|
| 124 |
|
---|
| 125 | <sect2 role="commands">
|
---|
| 126 | <title>Command Explanations</title>
|
---|
| 127 |
|
---|
| 128 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 129 | href="../../xincludes/meson-buildtype-release.xml"/>
|
---|
| 130 |
|
---|
| 131 | <para>
|
---|
| 132 | <parameter>-Dapidocs=false</parameter>: This switch disables building the
|
---|
| 133 | API documentation. Remove it if you have
|
---|
| 134 | <xref linkend="gtk-doc" role="nodep"/> installed and wish to generate the
|
---|
| 135 | API documentation.
|
---|
| 136 | </para>
|
---|
| 137 |
|
---|
| 138 | <para>
|
---|
| 139 | <parameter>-Dstemming=false</parameter>: This switch disables stemming
|
---|
| 140 | support. Remove this switch if you have
|
---|
| 141 | <ulink url="https://github.com/zvelo/libstemmer">libstemmer</ulink>
|
---|
| 142 | installed and want faster searches.
|
---|
| 143 | </para>
|
---|
| 144 |
|
---|
| 145 | <para>
|
---|
| 146 | <option>-Dqt=true</option>: Use this option if you have &qt5-deps;
|
---|
| 147 | installed and you want to build support for Qt applications into this
|
---|
| 148 | package.
|
---|
| 149 | </para>
|
---|
| 150 |
|
---|
| 151 | </sect2>
|
---|
| 152 |
|
---|
| 153 | <sect2 role="content">
|
---|
| 154 | <title>Contents</title>
|
---|
| 155 |
|
---|
| 156 | <segmentedlist>
|
---|
| 157 | <segtitle>Installed Programs</segtitle>
|
---|
| 158 | <segtitle>Installed Libraries</segtitle>
|
---|
| 159 | <segtitle>Installed Directories</segtitle>
|
---|
| 160 |
|
---|
| 161 | <seglistitem>
|
---|
| 162 | <seg>
|
---|
| 163 | appstreamcli
|
---|
| 164 | </seg>
|
---|
| 165 | <seg>
|
---|
| 166 | libappstream.so
|
---|
| 167 | </seg>
|
---|
| 168 | <seg>
|
---|
| 169 | /usr/include/appstream,
|
---|
| 170 | /usr/share/doc/appstream-&version;, and
|
---|
| 171 | /usr/share/installed-tests/appstream
|
---|
| 172 | </seg>
|
---|
| 173 | </seglistitem>
|
---|
| 174 | </segmentedlist>
|
---|
| 175 |
|
---|
| 176 | <variablelist>
|
---|
| 177 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 178 | <?dbfo list-presentation="list"?>
|
---|
| 179 | <?dbhtml list-presentation="table"?>
|
---|
| 180 |
|
---|
| 181 | <varlistentry id="appstreamcli">
|
---|
| 182 | <term><command>appstreamcli</command></term>
|
---|
| 183 | <listitem>
|
---|
| 184 | <para>
|
---|
| 185 | queries information from AppStream metadata and from the AppStream
|
---|
| 186 | component index
|
---|
| 187 | </para>
|
---|
| 188 | <indexterm zone="appstream appstreamcli">
|
---|
| 189 | <primary sortas="b-appstreamcli">appstreamcli</primary>
|
---|
| 190 | </indexterm>
|
---|
| 191 | </listitem>
|
---|
| 192 | </varlistentry>
|
---|
| 193 |
|
---|
| 194 | <varlistentry id="libappstream">
|
---|
| 195 | <term><filename class="libraryfile">libappstream.so</filename></term>
|
---|
| 196 | <listitem>
|
---|
| 197 | <para>
|
---|
| 198 | contains functions that handle AppStream metadata queries and
|
---|
| 199 | request information from the AppStream component index
|
---|
| 200 | </para>
|
---|
| 201 | <indexterm zone="appstream libappstream">
|
---|
| 202 | <primary sortas="c-libappstream">libappstream.so</primary>
|
---|
| 203 | </indexterm>
|
---|
| 204 | </listitem>
|
---|
| 205 | </varlistentry>
|
---|
| 206 | </variablelist>
|
---|
| 207 | </sect2>
|
---|
| 208 | </sect1>
|
---|