source: gnome/platform/grilo.xml@ b747635

trunk
Last change on this file since b747635 was b747635, checked in by Douglas R. Reno <renodr@…>, 7 weeks ago

grilo: more GTK-Doc incompatibilities

  • Property mode set to 100644
File size: 7.2 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 <!ENTITY grilo-download-http "&gnome-download-http;/grilo/0.3/grilo-&grilo-version;.tar.xz">
8 <!ENTITY grilo-download-ftp "&gnome-download-ftp;/grilo/0.3/grilo-&grilo-version;.tar.xz">
9 <!ENTITY grilo-md5sum "737b76fc194878eac2ca45a78175aa9f">
10 <!ENTITY grilo-size "232 KB">
11 <!ENTITY grilo-buildsize "16 MB (with tests)">
12 <!ENTITY grilo-time "0.3 SBU (with tests)">
13]>
14
15<sect1 id="grilo" xreflabel="Grilo-&grilo-version;">
16 <?dbhtml filename="grilo.html"?>
17
18 <sect1info>
19 <date>$Date$</date>
20 </sect1info>
21
22 <title>Grilo-&grilo-version;</title>
23
24 <indexterm zone="grilo">
25 <primary sortas="a-Grilo">Grilo</primary>
26 </indexterm>
27
28 <sect2 role="package">
29 <title>Introduction to Grilo</title>
30
31 <para>
32 <application>Grilo</application> is a framework focused on making
33 media discovery and browsing easy for applications and application
34 developers.
35 </para>
36
37 &lfs101_checked;
38
39 <bridgehead renderas="sect3">Package Information</bridgehead>
40 <itemizedlist spacing="compact">
41 <listitem>
42 <para>
43 Download (HTTP): <ulink url="&grilo-download-http;"/>
44 </para>
45 </listitem>
46 <listitem>
47 <para>
48 Download (FTP): <ulink url="&grilo-download-ftp;"/>
49 </para>
50 </listitem>
51 <listitem>
52 <para>
53 Download MD5 sum: &grilo-md5sum;
54 </para>
55 </listitem>
56 <listitem>
57 <para>
58 Download size: &grilo-size;
59 </para>
60 </listitem>
61 <listitem>
62 <para>
63 Estimated disk space required: &grilo-buildsize;
64 </para>
65 </listitem>
66 <listitem>
67 <para>
68 Estimated build time: &grilo-time;
69 </para>
70 </listitem>
71 </itemizedlist>
72
73 <bridgehead renderas="sect3">Grilo Dependencies</bridgehead>
74
75 <bridgehead renderas="sect4">Required</bridgehead>
76 <para role="required">
77 <xref linkend="glib2"/> and
78 <xref linkend="libxml2"/>
79 </para>
80
81 <bridgehead renderas="sect4">Recommended</bridgehead>
82 <para role="recommended">
83 <xref linkend="gobject-introspection"/>,
84 <xref linkend="gtk3"/>,
85 <xref linkend="libsoup"/>,
86 <xref linkend="totem-pl-parser"/>, and
87 <xref linkend="vala"/>
88 </para>
89
90 <bridgehead renderas="sect4">Optional</bridgehead>
91 <para role="optional">
92 <xref linkend="avahi"/>,
93 <xref linkend="docbook-utils"/>,
94 <xref linkend="liboauth"/>, and
95 <xref linkend="gtk-doc"/>
96 </para>
97
98 <para condition="html" role="usernotes">User Notes:
99 <ulink url="&blfs-wiki;/grilo"/></para>
100
101 </sect2>
102
103 <sect2 role="installation">
104 <title>Installation of Grilo</title>
105<!--
106 <para>
107 First, fix a build failure introduced by an API change in
108 <application>totem-pl-parser</application>:
109 </para>
110
111<screen><userinput remap="pre">sed -i 's/TOTEM_IS_PL_PARSER/TOTEM_PL_IS_PARSER/' libs/pls/grl-pls.c</userinput></screen>
112-->
113 <para>
114 Install <application>Grilo</application> by running the
115 following commands:
116 </para>
117
118<screen><userinput>mkdir build &amp;&amp;
119cd build &amp;&amp;
120
121meson --prefix=/usr \
122 -Denable-gtk-doc=false .. &amp;&amp;
123ninja</userinput></screen>
124
125 <para>
126 To test the results, issue: <command>ninja test</command>.
127 </para>
128
129 <para>
130 Now, as the <systemitem class="username">root</systemitem> user:
131 </para>
132
133<screen role="root"><userinput>ninja install</userinput></screen>
134
135 </sect2>
136
137 <sect2 role="commands">
138 <title>Command Explanations</title>
139
140 <para>
141 <parameter>-Denable-gtk-doc=false</parameter>: This option disables
142 generating documentation. If you have <xref linkend="gtk-doc"/>
143 installed and wish to generate documentation, remove this option.
144 Note that building the documentation is currently broken due to
145 an incompatibility with gtk-doc.
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>grilo-test-ui-0.3, grl-inspect-0.3 and grl-launch-0.3</seg>
160 <seg>libgrilo-0.3.so, libgrlnet-0.3.so and libgrlpls-0.3.so</seg>
161 <seg>/usr/include/grilo-0.3</seg>
162 </seglistitem>
163 </segmentedlist>
164
165 <variablelist>
166 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
167 <?dbfo list-presentation="list"?>
168 <?dbhtml list-presentation="table"?>
169
170 <varlistentry id="grilo-test-ui">
171 <term><command>grilo-test-ui-0.3</command></term>
172 <listitem>
173 <para>
174 is a simple playground application that you can use to test the
175 framework and its plugins
176 </para>
177 <indexterm zone="grilo grilo-test-ui">
178 <primary sortas="b-grilo-test-ui">grilo-test-ui</primary>
179 </indexterm>
180 </listitem>
181 </varlistentry>
182
183 <varlistentry id="grl-inspect">
184 <term><command>grl-inspect-0.3</command></term>
185 <listitem>
186 <para>
187 is a tool that prints out information on available Grilo sources
188 </para>
189 <indexterm zone="grilo grl-inspect">
190 <primary sortas="b-grl-inspect">grl-inspect</primary>
191 </indexterm>
192 </listitem>
193 </varlistentry>
194
195 <varlistentry id="grl-launch">
196 <term><command>grl-launch-0.3</command></term>
197 <listitem>
198 <para>
199 is a tool to run <application>Grilo</application> operations
200 from command line
201 </para>
202 <indexterm zone="grilo grl-launch">
203 <primary sortas="b-grl-launch">grl-launch</primary>
204 </indexterm>
205 </listitem>
206 </varlistentry>
207
208 <varlistentry id="libgrilo">
209 <term><filename class="libraryfile">libgrilo.so</filename></term>
210 <listitem>
211 <para>
212 provides the Grilo framework
213 </para>
214 <indexterm zone="grilo libgrilo">
215 <primary sortas="c-libgrilo">libgrilo.so</primary>
216 </indexterm>
217 </listitem>
218 </varlistentry>
219
220 <varlistentry id="libgrlnet">
221 <term><filename class="libraryfile">libgrlnet.so</filename></term>
222 <listitem>
223 <para>
224 provides Grilo networking helpers for plug-ins
225 </para>
226 <indexterm zone="grilo libgrilo">
227 <primary sortas="c-libgrlnet">libgrlnet.so</primary>
228 </indexterm>
229 </listitem>
230 </varlistentry>
231
232 <varlistentry id="libgrlpls">
233 <term><filename class="libraryfile">libgrlpls.so</filename></term>
234 <listitem>
235 <para>
236 provides playlist handling functions
237 </para>
238 <indexterm zone="grilo libgrilo">
239 <primary sortas="c-libgrlpls">libgrlpls.so</primary>
240 </indexterm>
241 </listitem>
242 </varlistentry>
243
244 </variablelist>
245
246 </sect2>
247
248</sect1>
Note: See TracBrowser for help on using the repository browser.