glfs/gnome/platform/grilo.xml
Pierre Labastie 4c24eb0a40 Remove period at the end of short descriptions.
In the process, some attributes in single quotes have been changed to double
quotes, and a few attribute lists have been written on one line instead of
several lines.

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@24236 af4574ff-66df-0310-9fd7-8a98e5e911e0
2021-02-19 15:20:16 +00:00

248 lines
7.1 KiB
XML

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % general-entities SYSTEM "../../general.ent">
%general-entities;
<!ENTITY grilo-download-http "&gnome-download-http;/grilo/0.3/grilo-&grilo-version;.tar.xz">
<!ENTITY grilo-download-ftp "&gnome-download-ftp;/grilo/0.3/grilo-&grilo-version;.tar.xz">
<!ENTITY grilo-md5sum "737b76fc194878eac2ca45a78175aa9f">
<!ENTITY grilo-size "232 KB">
<!ENTITY grilo-buildsize "16 MB (with tests)">
<!ENTITY grilo-time "0.3 SBU (with tests)">
]>
<sect1 id="grilo" xreflabel="Grilo-&grilo-version;">
<?dbhtml filename="grilo.html"?>
<sect1info>
<othername>$LastChangedBy$</othername>
<date>$Date$</date>
</sect1info>
<title>Grilo-&grilo-version;</title>
<indexterm zone="grilo">
<primary sortas="a-Grilo">Grilo</primary>
</indexterm>
<sect2 role="package">
<title>Introduction to Grilo</title>
<para>
<application>Grilo</application> is a framework focused on making
media discovery and browsing easy for applications and application
developers.
</para>
&lfs10_checked;
<bridgehead renderas="sect3">Package Information</bridgehead>
<itemizedlist spacing="compact">
<listitem>
<para>
Download (HTTP): <ulink url="&grilo-download-http;"/>
</para>
</listitem>
<listitem>
<para>
Download (FTP): <ulink url="&grilo-download-ftp;"/>
</para>
</listitem>
<listitem>
<para>
Download MD5 sum: &grilo-md5sum;
</para>
</listitem>
<listitem>
<para>
Download size: &grilo-size;
</para>
</listitem>
<listitem>
<para>
Estimated disk space required: &grilo-buildsize;
</para>
</listitem>
<listitem>
<para>
Estimated build time: &grilo-time;
</para>
</listitem>
</itemizedlist>
<bridgehead renderas="sect3">Grilo Dependencies</bridgehead>
<bridgehead renderas="sect4">Required</bridgehead>
<para role="required">
<xref linkend="glib2"/> and
<xref linkend="libxml2"/>
</para>
<bridgehead renderas="sect4">Recommended</bridgehead>
<para role="recommended">
<xref linkend="gobject-introspection"/>,
<xref linkend="gtk3"/>,
<xref linkend="libsoup"/>,
<xref linkend="totem-pl-parser"/>, and
<xref linkend="vala"/>
</para>
<bridgehead renderas="sect4">Optional</bridgehead>
<para role="optional">
<xref linkend="avahi"/>,
<xref linkend="docbook-utils"/>,
<xref linkend="liboauth"/>, and
<xref linkend="gtk-doc"/>
</para>
<para condition="html" role="usernotes">User Notes:
<ulink url="&blfs-wiki;/grilo"/></para>
</sect2>
<sect2 role="installation">
<title>Installation of Grilo</title>
<!--
<para>
First, fix a build failure introduced by an API change in
<application>totem-pl-parser</application>:
</para>
<screen><userinput remap="pre">sed -i 's/TOTEM_IS_PL_PARSER/TOTEM_PL_IS_PARSER/' libs/pls/grl-pls.c</userinput></screen>
-->
<para>
Install <application>Grilo</application> by running the
following commands:
</para>
<screen><userinput>mkdir build &amp;&amp;
cd build &amp;&amp;
meson --prefix=/usr \
-Denable-gtk-doc=false .. &amp;&amp;
ninja</userinput></screen>
<para>
To test the results, issue: <command>ninja test</command>.
</para>
<para>
Now, as the <systemitem class="username">root</systemitem> user:
</para>
<screen role="root"><userinput>ninja install</userinput></screen>
</sect2>
<sect2 role="commands">
<title>Command Explanations</title>
<para>
<parameter>-Denable-gtk-doc=false</parameter>: This option disables
generating documentation. If you have <xref linkend="gtk-doc"/>
installed and wish to generate documentation, remove this option.
</para>
</sect2>
<sect2 role="content">
<title>Contents</title>
<segmentedlist>
<segtitle>Installed Programs</segtitle>
<segtitle>Installed Libraries</segtitle>
<segtitle>Installed Directories</segtitle>
<seglistitem>
<seg>grilo-test-ui-0.3, grl-inspect-0.3 and grl-launch-0.3</seg>
<seg>libgrilo-0.3.so, libgrlnet-0.3.so and libgrlpls-0.3.so</seg>
<seg>/usr/include/grilo-0.3</seg>
</seglistitem>
</segmentedlist>
<variablelist>
<bridgehead renderas="sect3">Short Descriptions</bridgehead>
<?dbfo list-presentation="list"?>
<?dbhtml list-presentation="table"?>
<varlistentry id="grilo-test-ui">
<term><command>grilo-test-ui-0.3</command></term>
<listitem>
<para>
is a simple playground application that you can use to test the
framework and its plugins
</para>
<indexterm zone="grilo grilo-test-ui">
<primary sortas="b-grilo-test-ui">grilo-test-ui</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="grl-inspect">
<term><command>grl-inspect-0.3</command></term>
<listitem>
<para>
is a tool that prints out information on available Grilo sources
</para>
<indexterm zone="grilo grl-inspect">
<primary sortas="b-grl-inspect">grl-inspect</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="grl-launch">
<term><command>grl-launch-0.3</command></term>
<listitem>
<para>
is a tool to run <application>Grilo</application> operations
from command line
</para>
<indexterm zone="grilo grl-launch">
<primary sortas="b-grl-launch">grl-launch</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="libgrilo">
<term><filename class="libraryfile">libgrilo.so</filename></term>
<listitem>
<para>
provides the Grilo framework
</para>
<indexterm zone="grilo libgrilo">
<primary sortas="c-libgrilo">libgrilo.so</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="libgrlnet">
<term><filename class="libraryfile">libgrlnet.so</filename></term>
<listitem>
<para>
provides Grilo networking helpers for plug-ins
</para>
<indexterm zone="grilo libgrilo">
<primary sortas="c-libgrlnet">libgrlnet.so</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="libgrlpls">
<term><filename class="libraryfile">libgrlpls.so</filename></term>
<listitem>
<para>
provides playlist handling functions
</para>
<indexterm zone="grilo libgrilo">
<primary sortas="c-libgrlpls">libgrlpls.so</primary>
</indexterm>
</listitem>
</varlistentry>
</variablelist>
</sect2>
</sect1>