1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
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 " ">
|
---|
9 | <!ENTITY grilo-md5sum "e81c4d7e182eb6448b9f0458f52511a3">
|
---|
10 | <!ENTITY grilo-size "236 KB">
|
---|
11 | <!ENTITY grilo-buildsize "13 MB (with tests)">
|
---|
12 | <!ENTITY grilo-time "0.2 SBU (with tests)">
|
---|
13 | ]>
|
---|
14 |
|
---|
15 | <sect1 id="grilo" xreflabel="Grilo-&grilo-version;">
|
---|
16 | <?dbhtml filename="grilo.html"?>
|
---|
17 |
|
---|
18 |
|
---|
19 | <title>Grilo-&grilo-version;</title>
|
---|
20 |
|
---|
21 | <indexterm zone="grilo">
|
---|
22 | <primary sortas="a-Grilo">Grilo</primary>
|
---|
23 | </indexterm>
|
---|
24 |
|
---|
25 | <sect2 role="package">
|
---|
26 | <title>Introduction to Grilo</title>
|
---|
27 |
|
---|
28 | <para>
|
---|
29 | <application>Grilo</application> is a framework focused on making
|
---|
30 | media discovery and browsing easy for applications and application
|
---|
31 | developers.
|
---|
32 | </para>
|
---|
33 |
|
---|
34 | &lfs122_checked;
|
---|
35 |
|
---|
36 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
37 | <itemizedlist spacing="compact">
|
---|
38 | <listitem>
|
---|
39 | <para>
|
---|
40 | Download (HTTP): <ulink url="&grilo-download-http;"/>
|
---|
41 | </para>
|
---|
42 | </listitem>
|
---|
43 | <listitem>
|
---|
44 | <para>
|
---|
45 | Download (FTP): <ulink url="&grilo-download-ftp;"/>
|
---|
46 | </para>
|
---|
47 | </listitem>
|
---|
48 | <listitem>
|
---|
49 | <para>
|
---|
50 | Download MD5 sum: &grilo-md5sum;
|
---|
51 | </para>
|
---|
52 | </listitem>
|
---|
53 | <listitem>
|
---|
54 | <para>
|
---|
55 | Download size: &grilo-size;
|
---|
56 | </para>
|
---|
57 | </listitem>
|
---|
58 | <listitem>
|
---|
59 | <para>
|
---|
60 | Estimated disk space required: &grilo-buildsize;
|
---|
61 | </para>
|
---|
62 | </listitem>
|
---|
63 | <listitem>
|
---|
64 | <para>
|
---|
65 | Estimated build time: &grilo-time;
|
---|
66 | </para>
|
---|
67 | </listitem>
|
---|
68 | </itemizedlist>
|
---|
69 |
|
---|
70 | <bridgehead renderas="sect3">Grilo Dependencies</bridgehead>
|
---|
71 |
|
---|
72 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
73 | <para role="required">
|
---|
74 | <xref linkend="glib2"/> (GObject Introspection recommended) and
|
---|
75 | <xref linkend="libxml2"/>
|
---|
76 | </para>
|
---|
77 |
|
---|
78 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
79 | <para role="recommended">
|
---|
80 | <xref linkend="gtk3"/>,
|
---|
81 | <xref linkend="libsoup3"/>,
|
---|
82 | <xref linkend="totem-pl-parser"/>, and
|
---|
83 | <xref linkend="vala"/>
|
---|
84 | </para>
|
---|
85 |
|
---|
86 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
87 | <para role="optional">
|
---|
88 | <xref linkend="liboauth"/> and
|
---|
89 | <xref linkend="gtk-doc"/>
|
---|
90 | </para>
|
---|
91 |
|
---|
92 | </sect2>
|
---|
93 |
|
---|
94 | <sect2 role="installation">
|
---|
95 | <title>Installation of Grilo</title>
|
---|
96 |
|
---|
97 | <para>
|
---|
98 | Install <application>Grilo</application> by running the
|
---|
99 | following commands:
|
---|
100 | </para>
|
---|
101 |
|
---|
102 | <screen><userinput>mkdir build &&
|
---|
103 | cd build &&
|
---|
104 |
|
---|
105 | meson setup --prefix=/usr \
|
---|
106 | --buildtype=release \
|
---|
107 | -D enable-gtk-doc=false \
|
---|
108 | .. &&
|
---|
109 | ninja</userinput></screen>
|
---|
110 |
|
---|
111 | <para>
|
---|
112 | To test the results, issue: <command>ninja test</command>.
|
---|
113 | </para>
|
---|
114 |
|
---|
115 | <para>
|
---|
116 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
117 | </para>
|
---|
118 |
|
---|
119 | <screen role="root"><userinput>ninja install</userinput></screen>
|
---|
120 |
|
---|
121 | </sect2>
|
---|
122 |
|
---|
123 | <sect2 role="commands">
|
---|
124 | <title>Command Explanations</title>
|
---|
125 |
|
---|
126 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
127 | href="../../xincludes/meson-buildtype-release.xml"/>
|
---|
128 |
|
---|
129 | <para>
|
---|
130 | <parameter>-D enable-gtk-doc=false</parameter>: This option disables
|
---|
131 | generating documentation. If you have <xref linkend="gtk-doc"/>
|
---|
132 | installed and wish to generate documentation, remove this option.
|
---|
133 | <!--Note that building the documentation is currently broken due to
|
---|
134 | an incompatibility with gtk-doc.-->
|
---|
135 | </para>
|
---|
136 |
|
---|
137 | </sect2>
|
---|
138 |
|
---|
139 | <sect2 role="content">
|
---|
140 | <title>Contents</title>
|
---|
141 |
|
---|
142 | <segmentedlist>
|
---|
143 | <segtitle>Installed Programs</segtitle>
|
---|
144 | <segtitle>Installed Libraries</segtitle>
|
---|
145 | <segtitle>Installed Directories</segtitle>
|
---|
146 |
|
---|
147 | <seglistitem>
|
---|
148 | <seg>grilo-test-ui-0.3, grl-inspect-0.3 and grl-launch-0.3</seg>
|
---|
149 | <seg>libgrilo-0.3.so, libgrlnet-0.3.so and libgrlpls-0.3.so</seg>
|
---|
150 | <seg>/usr/include/grilo-0.3</seg>
|
---|
151 | </seglistitem>
|
---|
152 | </segmentedlist>
|
---|
153 |
|
---|
154 | <variablelist>
|
---|
155 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
156 | <?dbfo list-presentation="list"?>
|
---|
157 | <?dbhtml list-presentation="table"?>
|
---|
158 |
|
---|
159 | <varlistentry id="grilo-test-ui">
|
---|
160 | <term><command>grilo-test-ui-0.3</command></term>
|
---|
161 | <listitem>
|
---|
162 | <para>
|
---|
163 | is a simple playground application that you can use to test the
|
---|
164 | framework and its plugins
|
---|
165 | </para>
|
---|
166 | <indexterm zone="grilo grilo-test-ui">
|
---|
167 | <primary sortas="b-grilo-test-ui">grilo-test-ui</primary>
|
---|
168 | </indexterm>
|
---|
169 | </listitem>
|
---|
170 | </varlistentry>
|
---|
171 |
|
---|
172 | <varlistentry id="grl-inspect">
|
---|
173 | <term><command>grl-inspect-0.3</command></term>
|
---|
174 | <listitem>
|
---|
175 | <para>
|
---|
176 | is a tool that prints out information on available Grilo sources
|
---|
177 | </para>
|
---|
178 | <indexterm zone="grilo grl-inspect">
|
---|
179 | <primary sortas="b-grl-inspect">grl-inspect</primary>
|
---|
180 | </indexterm>
|
---|
181 | </listitem>
|
---|
182 | </varlistentry>
|
---|
183 |
|
---|
184 | <varlistentry id="grl-launch">
|
---|
185 | <term><command>grl-launch-0.3</command></term>
|
---|
186 | <listitem>
|
---|
187 | <para>
|
---|
188 | is a tool to run <application>Grilo</application> operations
|
---|
189 | from command line
|
---|
190 | </para>
|
---|
191 | <indexterm zone="grilo grl-launch">
|
---|
192 | <primary sortas="b-grl-launch">grl-launch</primary>
|
---|
193 | </indexterm>
|
---|
194 | </listitem>
|
---|
195 | </varlistentry>
|
---|
196 |
|
---|
197 | <varlistentry id="libgrilo">
|
---|
198 | <term><filename class="libraryfile">libgrilo.so</filename></term>
|
---|
199 | <listitem>
|
---|
200 | <para>
|
---|
201 | provides the Grilo framework
|
---|
202 | </para>
|
---|
203 | <indexterm zone="grilo libgrilo">
|
---|
204 | <primary sortas="c-libgrilo">libgrilo.so</primary>
|
---|
205 | </indexterm>
|
---|
206 | </listitem>
|
---|
207 | </varlistentry>
|
---|
208 |
|
---|
209 | <varlistentry id="libgrlnet">
|
---|
210 | <term><filename class="libraryfile">libgrlnet.so</filename></term>
|
---|
211 | <listitem>
|
---|
212 | <para>
|
---|
213 | provides Grilo networking helpers for plug-ins
|
---|
214 | </para>
|
---|
215 | <indexterm zone="grilo libgrilo">
|
---|
216 | <primary sortas="c-libgrlnet">libgrlnet.so</primary>
|
---|
217 | </indexterm>
|
---|
218 | </listitem>
|
---|
219 | </varlistentry>
|
---|
220 |
|
---|
221 | <varlistentry id="libgrlpls">
|
---|
222 | <term><filename class="libraryfile">libgrlpls.so</filename></term>
|
---|
223 | <listitem>
|
---|
224 | <para>
|
---|
225 | provides playlist handling functions
|
---|
226 | </para>
|
---|
227 | <indexterm zone="grilo libgrilo">
|
---|
228 | <primary sortas="c-libgrlpls">libgrlpls.so</primary>
|
---|
229 | </indexterm>
|
---|
230 | </listitem>
|
---|
231 | </varlistentry>
|
---|
232 |
|
---|
233 | </variablelist>
|
---|
234 |
|
---|
235 | </sect2>
|
---|
236 |
|
---|
237 | </sect1>
|
---|