[69a16457] | 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">
|
---|
[6729290] | 9 | <!ENTITY grilo-md5sum "df4e68e2bba461f0aed61874d8e4e05a">
|
---|
| 10 | <!ENTITY grilo-size "236 KB">
|
---|
[5d5c2107] | 11 | <!ENTITY grilo-buildsize "16 MB (with tests)">
|
---|
[6729290] | 12 | <!ENTITY grilo-time "0.5 SBU (with tests)">
|
---|
[69a16457] | 13 | ]>
|
---|
| 14 |
|
---|
[51dfb3e] | 15 | <sect1 id="grilo" xreflabel="Grilo-&grilo-version;">
|
---|
[69a16457] | 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 |
|
---|
[82192a18] | 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>
|
---|
[69a16457] | 36 |
|
---|
[b410868] | 37 | &lfs111_checked;
|
---|
[69a16457] | 38 |
|
---|
| 39 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 40 | <itemizedlist spacing="compact">
|
---|
| 41 | <listitem>
|
---|
[82192a18] | 42 | <para>
|
---|
| 43 | Download (HTTP): <ulink url="&grilo-download-http;"/>
|
---|
| 44 | </para>
|
---|
[69a16457] | 45 | </listitem>
|
---|
| 46 | <listitem>
|
---|
[82192a18] | 47 | <para>
|
---|
| 48 | Download (FTP): <ulink url="&grilo-download-ftp;"/>
|
---|
| 49 | </para>
|
---|
[69a16457] | 50 | </listitem>
|
---|
| 51 | <listitem>
|
---|
[82192a18] | 52 | <para>
|
---|
| 53 | Download MD5 sum: &grilo-md5sum;
|
---|
| 54 | </para>
|
---|
[69a16457] | 55 | </listitem>
|
---|
| 56 | <listitem>
|
---|
[82192a18] | 57 | <para>
|
---|
| 58 | Download size: &grilo-size;
|
---|
| 59 | </para>
|
---|
[69a16457] | 60 | </listitem>
|
---|
| 61 | <listitem>
|
---|
[82192a18] | 62 | <para>
|
---|
| 63 | Estimated disk space required: &grilo-buildsize;
|
---|
| 64 | </para>
|
---|
[69a16457] | 65 | </listitem>
|
---|
| 66 | <listitem>
|
---|
[82192a18] | 67 | <para>
|
---|
| 68 | Estimated build time: &grilo-time;
|
---|
| 69 | </para>
|
---|
[69a16457] | 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>
|
---|
[819213e] | 105 | <!--
|
---|
[82192a18] | 106 | <para>
|
---|
| 107 | First, fix a build failure introduced by an API change in
|
---|
| 108 | <application>totem-pl-parser</application>:
|
---|
| 109 | </para>
|
---|
[a91774f] | 110 |
|
---|
| 111 | <screen><userinput remap="pre">sed -i 's/TOTEM_IS_PL_PARSER/TOTEM_PL_IS_PARSER/' libs/pls/grl-pls.c</userinput></screen>
|
---|
[819213e] | 112 | -->
|
---|
[82192a18] | 113 | <para>
|
---|
| 114 | Install <application>Grilo</application> by running the
|
---|
| 115 | following commands:
|
---|
| 116 | </para>
|
---|
[69a16457] | 117 |
|
---|
[e130fead] | 118 | <screen><userinput>mkdir build &&
|
---|
[25b7f55] | 119 | cd build &&
|
---|
| 120 |
|
---|
[adf17153] | 121 | meson --prefix=/usr \
|
---|
| 122 | --buildtype=release \
|
---|
[8f38e174] | 123 | -Denable-gtk-doc=false .. &&
|
---|
[e130fead] | 124 | ninja</userinput></screen>
|
---|
[69a16457] | 125 |
|
---|
[82192a18] | 126 | <para>
|
---|
| 127 | To test the results, issue: <command>ninja test</command>.
|
---|
| 128 | </para>
|
---|
[69a16457] | 129 |
|
---|
[82192a18] | 130 | <para>
|
---|
| 131 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 132 | </para>
|
---|
[69a16457] | 133 |
|
---|
[e130fead] | 134 | <screen role="root"><userinput>ninja install</userinput></screen>
|
---|
[69a16457] | 135 |
|
---|
| 136 | </sect2>
|
---|
| 137 |
|
---|
| 138 | <sect2 role="commands">
|
---|
| 139 | <title>Command Explanations</title>
|
---|
| 140 |
|
---|
[adf17153] | 141 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 142 | href="../../xincludes/meson-buildtype-release.xml"/>
|
---|
| 143 |
|
---|
[e130fead] | 144 | <para>
|
---|
[aa41434] | 145 | <parameter>-Denable-gtk-doc=false</parameter>: This option disables
|
---|
| 146 | generating documentation. If you have <xref linkend="gtk-doc"/>
|
---|
| 147 | installed and wish to generate documentation, remove this option.
|
---|
[5a82b26f] | 148 | <!--Note that building the documentation is currently broken due to
|
---|
| 149 | an incompatibility with gtk-doc.-->
|
---|
[e130fead] | 150 | </para>
|
---|
[69a16457] | 151 |
|
---|
| 152 | </sect2>
|
---|
| 153 |
|
---|
| 154 | <sect2 role="content">
|
---|
| 155 | <title>Contents</title>
|
---|
| 156 |
|
---|
| 157 | <segmentedlist>
|
---|
| 158 | <segtitle>Installed Programs</segtitle>
|
---|
| 159 | <segtitle>Installed Libraries</segtitle>
|
---|
| 160 | <segtitle>Installed Directories</segtitle>
|
---|
| 161 |
|
---|
| 162 | <seglistitem>
|
---|
| 163 | <seg>grilo-test-ui-0.3, grl-inspect-0.3 and grl-launch-0.3</seg>
|
---|
| 164 | <seg>libgrilo-0.3.so, libgrlnet-0.3.so and libgrlpls-0.3.so</seg>
|
---|
| 165 | <seg>/usr/include/grilo-0.3</seg>
|
---|
| 166 | </seglistitem>
|
---|
| 167 | </segmentedlist>
|
---|
| 168 |
|
---|
| 169 | <variablelist>
|
---|
| 170 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 171 | <?dbfo list-presentation="list"?>
|
---|
| 172 | <?dbhtml list-presentation="table"?>
|
---|
| 173 |
|
---|
| 174 | <varlistentry id="grilo-test-ui">
|
---|
| 175 | <term><command>grilo-test-ui-0.3</command></term>
|
---|
| 176 | <listitem>
|
---|
[82192a18] | 177 | <para>
|
---|
| 178 | is a simple playground application that you can use to test the
|
---|
[4c24eb0a] | 179 | framework and its plugins
|
---|
[82192a18] | 180 | </para>
|
---|
[69a16457] | 181 | <indexterm zone="grilo grilo-test-ui">
|
---|
| 182 | <primary sortas="b-grilo-test-ui">grilo-test-ui</primary>
|
---|
| 183 | </indexterm>
|
---|
| 184 | </listitem>
|
---|
| 185 | </varlistentry>
|
---|
| 186 |
|
---|
| 187 | <varlistentry id="grl-inspect">
|
---|
| 188 | <term><command>grl-inspect-0.3</command></term>
|
---|
| 189 | <listitem>
|
---|
[82192a18] | 190 | <para>
|
---|
[4c24eb0a] | 191 | is a tool that prints out information on available Grilo sources
|
---|
[82192a18] | 192 | </para>
|
---|
[69a16457] | 193 | <indexterm zone="grilo grl-inspect">
|
---|
| 194 | <primary sortas="b-grl-inspect">grl-inspect</primary>
|
---|
| 195 | </indexterm>
|
---|
| 196 | </listitem>
|
---|
| 197 | </varlistentry>
|
---|
| 198 |
|
---|
| 199 | <varlistentry id="grl-launch">
|
---|
| 200 | <term><command>grl-launch-0.3</command></term>
|
---|
| 201 | <listitem>
|
---|
[82192a18] | 202 | <para>
|
---|
| 203 | is a tool to run <application>Grilo</application> operations
|
---|
[4c24eb0a] | 204 | from command line
|
---|
[82192a18] | 205 | </para>
|
---|
[69a16457] | 206 | <indexterm zone="grilo grl-launch">
|
---|
| 207 | <primary sortas="b-grl-launch">grl-launch</primary>
|
---|
| 208 | </indexterm>
|
---|
| 209 | </listitem>
|
---|
| 210 | </varlistentry>
|
---|
| 211 |
|
---|
| 212 | <varlistentry id="libgrilo">
|
---|
[4c24eb0a] | 213 | <term><filename class="libraryfile">libgrilo.so</filename></term>
|
---|
[69a16457] | 214 | <listitem>
|
---|
[82192a18] | 215 | <para>
|
---|
[4c24eb0a] | 216 | provides the Grilo framework
|
---|
[82192a18] | 217 | </para>
|
---|
[69a16457] | 218 | <indexterm zone="grilo libgrilo">
|
---|
| 219 | <primary sortas="c-libgrilo">libgrilo.so</primary>
|
---|
| 220 | </indexterm>
|
---|
| 221 | </listitem>
|
---|
| 222 | </varlistentry>
|
---|
| 223 |
|
---|
| 224 | <varlistentry id="libgrlnet">
|
---|
[4c24eb0a] | 225 | <term><filename class="libraryfile">libgrlnet.so</filename></term>
|
---|
[69a16457] | 226 | <listitem>
|
---|
[82192a18] | 227 | <para>
|
---|
[4c24eb0a] | 228 | provides Grilo networking helpers for plug-ins
|
---|
[82192a18] | 229 | </para>
|
---|
[69a16457] | 230 | <indexterm zone="grilo libgrilo">
|
---|
| 231 | <primary sortas="c-libgrlnet">libgrlnet.so</primary>
|
---|
| 232 | </indexterm>
|
---|
| 233 | </listitem>
|
---|
| 234 | </varlistentry>
|
---|
| 235 |
|
---|
| 236 | <varlistentry id="libgrlpls">
|
---|
[4c24eb0a] | 237 | <term><filename class="libraryfile">libgrlpls.so</filename></term>
|
---|
[69a16457] | 238 | <listitem>
|
---|
[82192a18] | 239 | <para>
|
---|
[4c24eb0a] | 240 | provides playlist handling functions
|
---|
[82192a18] | 241 | </para>
|
---|
[69a16457] | 242 | <indexterm zone="grilo libgrilo">
|
---|
| 243 | <primary sortas="c-libgrlpls">libgrlpls.so</primary>
|
---|
| 244 | </indexterm>
|
---|
| 245 | </listitem>
|
---|
| 246 | </varlistentry>
|
---|
| 247 |
|
---|
| 248 | </variablelist>
|
---|
| 249 |
|
---|
| 250 | </sect2>
|
---|
| 251 |
|
---|
| 252 | </sect1>
|
---|