[9371753] | 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 | <!-- Place this in the packages.ent file
|
---|
| 8 | <!ENTITY TEMPLATE-version "">
|
---|
| 9 | -->
|
---|
[f3429309] | 10 |
|
---|
| 11 | <!ENTITY appstream-glib-download-http
|
---|
[9371753] | 12 | "http://people.freedesktop.org/~hughsient/appstream-glib/releases/appstream-glib-&appstream-glib-version;.tar.xz">
|
---|
| 13 | <!ENTITY appstream-glib-download-ftp " ">
|
---|
[0a76c13] | 14 | <!ENTITY appstream-glib-md5sum "25f261265b71a4a9944028d4304ebc0d">
|
---|
[8af694bb] | 15 | <!ENTITY appstream-glib-size "1.8 MB">
|
---|
| 16 | <!ENTITY appstream-glib-buildsize "17 MB (with tests)">
|
---|
| 17 | <!ENTITY appstream-glib-time "0.1 SBU (with tests)">
|
---|
[9371753] | 18 | ]>
|
---|
| 19 |
|
---|
| 20 | <!-- Try to keep the indentation used in this file-->
|
---|
| 21 | <sect1 id="appstream-glib" xreflabel="appstream-glib-&appstream-glib-version;">
|
---|
| 22 | <?dbhtml filename="appstream-glib.html"?>
|
---|
| 23 |
|
---|
| 24 |
|
---|
| 25 | <!-- No other tags inside any title.
|
---|
| 26 | Use Title Case in All Titles -->
|
---|
| 27 | <title>appstream-glib-&appstream-glib-version;</title>
|
---|
| 28 |
|
---|
| 29 | <indexterm zone="appstream-glib">
|
---|
| 30 | <primary sortas="a-appstream-glib">appstream-glib</primary>
|
---|
| 31 | </indexterm>
|
---|
| 32 |
|
---|
| 33 | <!--Required section-->
|
---|
| 34 | <sect2 role="package">
|
---|
| 35 | <title>Introduction to appstream-glib</title>
|
---|
| 36 |
|
---|
| 37 | <para>
|
---|
[f3429309] | 38 | The <application>appstream-glib</application> provides GObjects and
|
---|
| 39 | helper methods to make it easy to read and write AppStream metadata.
|
---|
| 40 | It also provides a simple DOM implementation that makes it easy to
|
---|
[9371753] | 41 | edit nodes and convert to and from the standardized XML representation.
|
---|
| 42 | </para>
|
---|
[f3429309] | 43 |
|
---|
| 44 | &lfs77_checked;
|
---|
[9371753] | 45 |
|
---|
| 46 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 47 | <itemizedlist spacing="compact">
|
---|
| 48 | <listitem>
|
---|
| 49 | <para>
|
---|
| 50 | Download (HTTP): <ulink url="&appstream-glib-download-http;"/>
|
---|
| 51 | </para>
|
---|
| 52 | </listitem>
|
---|
| 53 | <listitem>
|
---|
| 54 | <para>
|
---|
| 55 | Download (FTP): <ulink url="&appstream-glib-download-ftp;"/>
|
---|
| 56 | </para>
|
---|
| 57 | </listitem>
|
---|
| 58 | <listitem>
|
---|
| 59 | <para>
|
---|
| 60 | Download MD5 sum: &appstream-glib-md5sum;
|
---|
| 61 | </para>
|
---|
| 62 | </listitem>
|
---|
| 63 | <listitem>
|
---|
| 64 | <para>
|
---|
| 65 | Download size: &appstream-glib-size;
|
---|
| 66 | </para>
|
---|
| 67 | </listitem>
|
---|
| 68 | <listitem>
|
---|
| 69 | <para>
|
---|
| 70 | Estimated disk space required: &appstream-glib-buildsize;
|
---|
| 71 | </para>
|
---|
| 72 | </listitem>
|
---|
| 73 | <listitem>
|
---|
| 74 | <para>
|
---|
| 75 | Estimated build time: &appstream-glib-time;
|
---|
| 76 | </para>
|
---|
| 77 | </listitem>
|
---|
| 78 | </itemizedlist>
|
---|
| 79 |
|
---|
| 80 | <bridgehead renderas="sect3">appstream-glib Dependencies</bridgehead>
|
---|
| 81 |
|
---|
| 82 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
| 83 | <para role="required">
|
---|
| 84 | <xref linkend="gdk-pixbuf"/>,
|
---|
| 85 | <xref linkend="libarchive"/>
|
---|
| 86 | <xref linkend="libsoup"/>, and
|
---|
[f3429309] | 87 | <xref linkend="pango"/>
|
---|
[9371753] | 88 | </para>
|
---|
| 89 |
|
---|
| 90 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
| 91 | <para role="recommended">
|
---|
| 92 | <xref linkend="gobject-introspection"/>
|
---|
| 93 | </para>
|
---|
| 94 |
|
---|
| 95 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
| 96 | <para role="optional">
|
---|
| 97 | <xref linkend="DocBook"/>,
|
---|
| 98 | <xref linkend="docbook-xsl"/>,
|
---|
[f3979ba] | 99 | <xref linkend="gtk-doc"/>,
|
---|
[8af694bb] | 100 | <xref linkend="libxslt"/>,
|
---|
| 101 | <ulink url="http://ftp.gnome.org/pub/GNOME/sources/gcab/">gcab</ulink>, and
|
---|
[f3979ba] | 102 | <ulink url="http://pyyaml.org/download/libyaml/">yaml</ulink>
|
---|
[9371753] | 103 | </para>
|
---|
| 104 |
|
---|
| 105 | <para condition="html" role="usernotes">
|
---|
| 106 | User Notes: <ulink url="&blfs-wiki;/appstream-glib"/>
|
---|
| 107 | </para>
|
---|
| 108 | </sect2>
|
---|
| 109 |
|
---|
| 110 | <sect2 role="installation">
|
---|
| 111 | <title>Installation of appstream-glib</title>
|
---|
| 112 |
|
---|
| 113 | <para>
|
---|
| 114 | Install <application>appstream-glib</application> by running the following
|
---|
| 115 | commands:
|
---|
| 116 | </para>
|
---|
| 117 |
|
---|
| 118 |
|
---|
[8af694bb] | 119 | <screen><userinput>./configure --prefix=/usr \
|
---|
| 120 | --disable-dep11 \
|
---|
| 121 | --disable-builder \
|
---|
| 122 | --disable-static &&
|
---|
| 123 |
|
---|
[9371753] | 124 | make</userinput></screen>
|
---|
| 125 |
|
---|
| 126 | <para>
|
---|
[f3979ba] | 127 | To test the results, issue: <command>make -k check</command>. One test
|
---|
| 128 | fails, if <ulink url="http://pyyaml.org/download/libyaml/">yaml</ulink>
|
---|
| 129 | is not installed.
|
---|
[9371753] | 130 | </para>
|
---|
| 131 |
|
---|
| 132 | <para>
|
---|
| 133 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 134 | </para>
|
---|
| 135 |
|
---|
| 136 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
| 137 | </sect2>
|
---|
| 138 |
|
---|
| 139 | <!--Optional section-->
|
---|
| 140 | <sect2 role="commands">
|
---|
| 141 | <title>Command Explanations</title>
|
---|
| 142 |
|
---|
| 143 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 144 | href="../../xincludes/static-libraries.xml"/>
|
---|
| 145 |
|
---|
| 146 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 147 | href="../../xincludes/gtk-doc-rebuild.xml"/>
|
---|
| 148 |
|
---|
[f3979ba] | 149 | <para>
|
---|
[8af694bb] | 150 | <parameter>--disable-builder</parameter>: Remove this switch, if you have
|
---|
| 151 | <ulink url="http://ftp.gnome.org/pub/GNOME/sources/gcab/">gcab</ulink> installed.
|
---|
| 152 | </para>
|
---|
| 153 |
|
---|
| 154 | <para>
|
---|
| 155 | <parameter>--disable-dep11</parameter>: Remove this switch, if you have
|
---|
[f3979ba] | 156 | <ulink url="http://pyyaml.org/download/libyaml/">yaml</ulink> installed.
|
---|
| 157 | </para>
|
---|
| 158 |
|
---|
[9371753] | 159 | </sect2>
|
---|
| 160 |
|
---|
| 161 | <sect2 role="content">
|
---|
| 162 | <title>Contents</title>
|
---|
| 163 |
|
---|
| 164 | <segmentedlist>
|
---|
| 165 | <segtitle>Installed Programs</segtitle>
|
---|
| 166 | <segtitle>Installed Libraries</segtitle>
|
---|
| 167 | <segtitle>Installed Directories</segtitle>
|
---|
| 168 |
|
---|
| 169 | <!-- If there were no programs, libraries, or directories created, then
|
---|
| 170 | we would list the section as "None". However, a decision must have
|
---|
| 171 | been made to change the "None" to just removing the whole section
|
---|
| 172 | because I've noticed that many packages have had the "None"
|
---|
| 173 | removed and the section completely removed as well. The reasoning
|
---|
| 174 | was that by putting "None", it appears as we know there are none.
|
---|
| 175 | Without anything it appears as we are not sure. -->
|
---|
| 176 |
|
---|
| 177 | <seglistitem>
|
---|
| 178 | <seg>
|
---|
[0a76c13] | 179 | appdata-validate and appstream-util
|
---|
[9371753] | 180 | </seg>
|
---|
| 181 | <seg>
|
---|
[0a76c13] | 182 | libappstream-glib.so
|
---|
[9371753] | 183 | </seg>
|
---|
| 184 | <seg>
|
---|
[0a76c13] | 185 | /usr/include/libappstream-glib,
|
---|
| 186 | /usr/share/gtk-doc/html/appstream-glib and
|
---|
[9371753] | 187 | /usr/share/installed-tests/appstream-glib
|
---|
| 188 | </seg>
|
---|
| 189 | </seglistitem>
|
---|
| 190 | </segmentedlist>
|
---|
| 191 |
|
---|
| 192 | <variablelist>
|
---|
| 193 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 194 | <?dbfo list-presentation="list"?>
|
---|
| 195 | <?dbhtml list-presentation="table"?>
|
---|
| 196 |
|
---|
| 197 | <!-- If the program or library name conflicts (is the same) as the
|
---|
| 198 | package name, add -prog or -lib to the varlistentry entity id
|
---|
| 199 | and the 2nd entry of the indexterm zone entity -->
|
---|
| 200 |
|
---|
[0a76c13] | 201 | <!-- <varlistentry id="appstream-builder">
|
---|
[9371753] | 202 | <term><command>appstream-builder</command></term>
|
---|
| 203 | <listitem>
|
---|
| 204 | <para>
|
---|
| 205 | Is a developers tool to build metadata.
|
---|
| 206 | </para>
|
---|
| 207 | <indexterm zone="appstream-glib appstream-builder">
|
---|
| 208 | <primary sortas="b-appstream-builder">appstream-builder</primary>
|
---|
| 209 | </indexterm>
|
---|
| 210 | </listitem>
|
---|
[0a76c13] | 211 | </varlistentry>-->
|
---|
| 212 |
|
---|
| 213 | <varlistentry id="appdata-validate">
|
---|
| 214 | <term><command>appdata-validate</command></term>
|
---|
| 215 | <listitem>
|
---|
| 216 | <para>
|
---|
| 217 | validates AppData metadata.
|
---|
| 218 | </para>
|
---|
| 219 | <indexterm zone="appstream-glib appdata-validate">
|
---|
| 220 | <primary sortas="b-appdata-validate">appdata-validate</primary>
|
---|
| 221 | </indexterm>
|
---|
| 222 | </listitem>
|
---|
[9371753] | 223 | </varlistentry>
|
---|
| 224 |
|
---|
| 225 | <varlistentry id="appstream-util">
|
---|
| 226 | <term><command>appstream-util</command></term>
|
---|
| 227 | <listitem>
|
---|
| 228 | <para>
|
---|
| 229 | Is a management tool for appstream-builder.
|
---|
| 230 | </para>
|
---|
| 231 | <indexterm zone="appstream-glib appstream-util">
|
---|
| 232 | <primary sortas="b-appstream-util">appstream-util</primary>
|
---|
| 233 | </indexterm>
|
---|
| 234 | </listitem>
|
---|
| 235 | </varlistentry>
|
---|
| 236 |
|
---|
[0a76c13] | 237 | <!-- <varlistentry id="libappstream-builder">
|
---|
[9371753] | 238 | <term><filename class="libraryfile">libappstream-builder.so</filename></term>
|
---|
| 239 | <listitem>
|
---|
| 240 | <para>
|
---|
| 241 | contains functions that aid the developers tool appstream-builder.
|
---|
| 242 | </para>
|
---|
| 243 | <indexterm zone="appstream-glib libappstream-builder">
|
---|
| 244 | <primary sortas="c-libappstream-builder">libappstream-builder.so</primary>
|
---|
| 245 | </indexterm>
|
---|
| 246 | </listitem>
|
---|
[0a76c13] | 247 | </varlistentry>-->
|
---|
| 248 |
|
---|
[9371753] | 249 | <varlistentry id="libappstream-glib">
|
---|
| 250 | <term><filename class="libraryfile">libappstream-glib.so</filename></term>
|
---|
| 251 | <listitem>
|
---|
| 252 | <para>
|
---|
| 253 | contains the api functions.
|
---|
| 254 | </para>
|
---|
| 255 | <indexterm zone="appstream-glib libappstream-glib">
|
---|
| 256 | <primary sortas="c-libappstream-glib">libappstream-glib.so</primary>
|
---|
| 257 | </indexterm>
|
---|
| 258 | </listitem>
|
---|
| 259 | </varlistentry>
|
---|
| 260 | </variablelist>
|
---|
| 261 | </sect2>
|
---|
| 262 | </sect1>
|
---|