source: archive/appstream-glib.xml@ fa91d2e

11.0 qt5new trunk
Last change on this file since fa91d2e was 45ab6c7, checked in by Xi Ruoyao <xry111@…>, 5 months ago

more SVN prop clean up

Remove "$LastChanged$" everywhere, and also some unused $Date$

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