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