[ce9b131] | 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-glib-download-http
|
---|
[8dfc5c3] | 8 | "https://people.freedesktop.org/~hughsient/appstream-glib/releases/appstream-glib-&appstream-glib-version;.tar.xz">
|
---|
[ce9b131] | 9 | <!ENTITY appstream-glib-download-ftp " ">
|
---|
[43d3258] | 10 | <!ENTITY appstream-glib-md5sum "2122471fff15bb9421313d2110ce538a">
|
---|
[dd6246f] | 11 | <!ENTITY appstream-glib-size "1.9 MB">
|
---|
[43d3258] | 12 | <!ENTITY appstream-glib-buildsize "26 MB (with tests)">
|
---|
| 13 | <!ENTITY appstream-glib-time "0.4 SBU (with tests)">
|
---|
[ce9b131] | 14 | ]>
|
---|
| 15 |
|
---|
| 16 | <sect1 id="appstream-glib" xreflabel="Appstream-GLib-&appstream-glib-version;" revision="systemd">
|
---|
| 17 | <?dbhtml filename="appstream-glib.html"?>
|
---|
| 18 |
|
---|
| 19 | <sect1info>
|
---|
| 20 | <date>$Date$</date>
|
---|
| 21 | </sect1info>
|
---|
| 22 |
|
---|
| 23 | <title>Appstream-GLib-&appstream-glib-version;</title>
|
---|
| 24 |
|
---|
| 25 | <indexterm zone="appstream-glib">
|
---|
| 26 | <primary sortas="a-Appstream-GLib">Appstream-GLib</primary>
|
---|
| 27 | </indexterm>
|
---|
| 28 |
|
---|
| 29 | <sect2 role="package">
|
---|
| 30 | <title>Introduction to Appstream-GLib</title>
|
---|
| 31 |
|
---|
| 32 | <para>
|
---|
| 33 | The <application>Appstream-GLib</application> package contains a library
|
---|
| 34 | that provides GObjects and helper methods to make it easy to read and
|
---|
| 35 | write AppStream metadata. It also provides a simple DOM implementation
|
---|
| 36 | that makes it easy to edit nodes and convert to and from the
|
---|
| 37 | standardized XML representation.
|
---|
| 38 | </para>
|
---|
| 39 |
|
---|
[de414da] | 40 | &lfs80_checked;
|
---|
[ce9b131] | 41 |
|
---|
| 42 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 43 | <itemizedlist spacing="compact">
|
---|
| 44 | <listitem>
|
---|
| 45 | <para>
|
---|
| 46 | Download (HTTP): <ulink url="&appstream-glib-download-http;"/>
|
---|
| 47 | </para>
|
---|
| 48 | </listitem>
|
---|
| 49 | <listitem>
|
---|
| 50 | <para>
|
---|
| 51 | Download (FTP): <ulink url="&appstream-glib-download-ftp;"/>
|
---|
| 52 | </para>
|
---|
| 53 | </listitem>
|
---|
| 54 | <listitem>
|
---|
| 55 | <para>
|
---|
| 56 | Download MD5 sum: &appstream-glib-md5sum;
|
---|
| 57 | </para>
|
---|
| 58 | </listitem>
|
---|
| 59 | <listitem>
|
---|
| 60 | <para>
|
---|
| 61 | Download size: &appstream-glib-size;
|
---|
| 62 | </para>
|
---|
| 63 | </listitem>
|
---|
| 64 | <listitem>
|
---|
| 65 | <para>
|
---|
| 66 | Estimated disk space required: &appstream-glib-buildsize;
|
---|
| 67 | </para>
|
---|
| 68 | </listitem>
|
---|
| 69 | <listitem>
|
---|
| 70 | <para>
|
---|
| 71 | Estimated build time: &appstream-glib-time;
|
---|
| 72 | </para>
|
---|
| 73 | </listitem>
|
---|
| 74 | </itemizedlist>
|
---|
| 75 |
|
---|
| 76 | <bridgehead renderas="sect3">Appstream-GLib Dependencies</bridgehead>
|
---|
| 77 |
|
---|
| 78 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
| 79 | <para role="required">
|
---|
| 80 | <xref linkend="gdk-pixbuf"/>,
|
---|
[30712eb] | 81 | <xref linkend="json-glib"/>,
|
---|
[ce9b131] | 82 | <xref linkend="libarchive"/>,
|
---|
| 83 | <xref linkend="libsoup"/> and
|
---|
| 84 | <xref linkend="pango"/>
|
---|
| 85 | </para>
|
---|
| 86 |
|
---|
| 87 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
| 88 | <para role="recommended">
|
---|
| 89 | <xref linkend="gcab"/>,
|
---|
| 90 | <xref linkend="gobject-introspection"/>,
|
---|
| 91 | <xref linkend="gtk3"/> and
|
---|
| 92 | <xref linkend="yaml"/>
|
---|
| 93 | </para>
|
---|
| 94 |
|
---|
| 95 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
| 96 | <para role="optional">
|
---|
| 97 | <xref linkend="DocBook"/>,
|
---|
| 98 | <xref linkend="docbook-xsl"/> and
|
---|
| 99 | <xref linkend="libxslt"/> (to build manual pages) and
|
---|
| 100 | <xref linkend="gtk-doc"/>
|
---|
| 101 | </para>
|
---|
| 102 |
|
---|
| 103 | <para condition="html" role="usernotes">
|
---|
| 104 | User Notes: <ulink url="&blfs-wiki;/appstream-glib"/>
|
---|
| 105 | </para>
|
---|
| 106 | </sect2>
|
---|
| 107 |
|
---|
| 108 | <sect2 role="installation">
|
---|
| 109 | <title>Installation of Appstream-GLib</title>
|
---|
| 110 |
|
---|
| 111 | <para>
|
---|
| 112 | Install <application>Appstream-GLib</application> by running the following
|
---|
| 113 | commands:
|
---|
| 114 | </para>
|
---|
| 115 |
|
---|
| 116 | <screen><userinput>./configure --prefix=/usr --disable-static &&
|
---|
| 117 | make</userinput></screen>
|
---|
| 118 |
|
---|
| 119 | <para>
|
---|
| 120 | To test the results, issue: <command>make check</command>.
|
---|
| 121 | </para>
|
---|
| 122 |
|
---|
| 123 | <para>
|
---|
| 124 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 125 | </para>
|
---|
| 126 |
|
---|
| 127 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
| 128 |
|
---|
| 129 | </sect2>
|
---|
| 130 |
|
---|
| 131 | <sect2 role="commands">
|
---|
| 132 | <title>Command Explanations</title>
|
---|
| 133 |
|
---|
| 134 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 135 | href="../../xincludes/static-libraries.xml"/>
|
---|
| 136 |
|
---|
| 137 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 138 | href="../../xincludes/gtk-doc-rebuild.xml"/>
|
---|
| 139 |
|
---|
| 140 | <para>
|
---|
| 141 | <option>--disable-builder</option>: Use this switch if
|
---|
| 142 | you have not installed <xref linkend="gcab"/> and
|
---|
| 143 | <xref linkend="gtk3"/>.
|
---|
| 144 | </para>
|
---|
| 145 |
|
---|
| 146 | <para>
|
---|
| 147 | <option>--disable-dep11</option>: Use this switch if you
|
---|
| 148 | have not installed <xref linkend="yaml"/>.
|
---|
| 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>
|
---|
[30712eb] | 163 | appstream-builder, appstream-compose, and appstream-util
|
---|
[ce9b131] | 164 | </seg>
|
---|
| 165 | <seg>
|
---|
| 166 | libappstream-builder.so and libappstream-glib.so
|
---|
| 167 | </seg>
|
---|
| 168 | <seg>
|
---|
| 169 | /usr/include/libappstream-builder,
|
---|
| 170 | /usr/include/libappstream-glib,
|
---|
[30712eb] | 171 | /usr/lib/asb-plugins-5,
|
---|
[ce9b131] | 172 | /usr/share/gtk-doc/html/appstream-glib, and
|
---|
| 173 | /usr/share/installed-tests/appstream-glib
|
---|
| 174 | </seg>
|
---|
| 175 | </seglistitem>
|
---|
| 176 | </segmentedlist>
|
---|
| 177 |
|
---|
| 178 | <variablelist>
|
---|
| 179 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 180 | <?dbfo list-presentation="list"?>
|
---|
| 181 | <?dbhtml list-presentation="table"?>
|
---|
| 182 |
|
---|
| 183 | <varlistentry id="appdata-validate">
|
---|
| 184 | <term><command>appdata-validate</command></term>
|
---|
| 185 | <listitem>
|
---|
| 186 | <para>
|
---|
| 187 | is used to validate AppData for formatting and style guidelines.
|
---|
| 188 | </para>
|
---|
| 189 | <indexterm zone="appstream-glib appdata-validate">
|
---|
| 190 | <primary sortas="b-appdata-validate">appdata-validate</primary>
|
---|
| 191 | </indexterm>
|
---|
| 192 | </listitem>
|
---|
| 193 | </varlistentry>
|
---|
| 194 |
|
---|
| 195 | <varlistentry id="appstream-builder">
|
---|
| 196 | <term><command>appstream-builder</command></term>
|
---|
| 197 | <listitem>
|
---|
| 198 | <para>
|
---|
| 199 | is a developers tool to build metadata.
|
---|
| 200 | </para>
|
---|
| 201 | <indexterm zone="appstream-glib appstream-builder">
|
---|
| 202 | <primary sortas="b-appstream-builder">appstream-builder</primary>
|
---|
| 203 | </indexterm>
|
---|
| 204 | </listitem>
|
---|
| 205 | </varlistentry>
|
---|
| 206 |
|
---|
| 207 | <varlistentry id="appstream-util">
|
---|
| 208 | <term><command>appstream-util</command></term>
|
---|
| 209 | <listitem>
|
---|
| 210 | <para>
|
---|
| 211 | is a management tool for <command>appstream-builder</command>.
|
---|
| 212 | </para>
|
---|
| 213 | <indexterm zone="appstream-glib appstream-util">
|
---|
| 214 | <primary sortas="b-appstream-util">appstream-util</primary>
|
---|
| 215 | </indexterm>
|
---|
| 216 | </listitem>
|
---|
| 217 | </varlistentry>
|
---|
| 218 |
|
---|
| 219 | <varlistentry id="libappstream-glib">
|
---|
| 220 | <term><filename class="libraryfile">libappstream-glib.so</filename></term>
|
---|
| 221 | <listitem>
|
---|
| 222 | <para>
|
---|
[30712eb] | 223 | contains objects and helper methods to help with reading and writing
|
---|
[ce9b131] | 224 | AppStream metadata.
|
---|
| 225 | </para>
|
---|
| 226 | <indexterm zone="appstream-glib libappstream-glib">
|
---|
| 227 | <primary sortas="c-libappstream-glib">libappstream-glib.so</primary>
|
---|
| 228 | </indexterm>
|
---|
| 229 | </listitem>
|
---|
| 230 | </varlistentry>
|
---|
| 231 |
|
---|
| 232 | </variablelist>
|
---|
| 233 |
|
---|
| 234 | </sect2>
|
---|
| 235 |
|
---|
| 236 | </sect1>
|
---|