glfs/general/sysutils/mcs.xml
Randy McMurchy 7c6f36c5d4 Added new package mcs-0.4.1 to support recent versions of Audacious
git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@7061 af4574ff-66df-0310-9fd7-8a98e5e911e0
2007-08-14 16:29:23 +00:00

209 lines
7.2 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 mcs-download-http "http://sacredspiral.co.uk/~nenolod/mcs/mcs-&mcs-version;.tgz">
<!ENTITY mcs-download-ftp " ">
<!ENTITY mcs-md5sum "d09b42e9d51ea32c6326f0bbcad86c9e">
<!ENTITY mcs-size "62 KB">
<!ENTITY mcs-buildsize "1.1 MB">
<!ENTITY mcs-time "less than 0.1 SBU">
]>
<sect1 id="mcs" xreflabel="mcs-&mcs-version;">
<?dbhtml filename="mcs.html"?>
<sect1info>
<othername>$LastChangedBy$</othername>
<date>$Date$</date>
</sect1info>
<title>mcs-&mcs-version;</title>
<indexterm zone="mcs">
<primary sortas="a-mcs">mcs</primary>
</indexterm>
<sect2 role="package">
<title>Introduction to mcs</title>
<para>The <application>mcs</application> package is a library and set of
tools which abstract the storage of configuration settings away from
userland applications. There are similar projects like this (such as
<application>GConf</application>), but unlike those projects,
<application>mcs</application> strictly handles abstraction. It does not
impose any specific data storage requirement, nor is it tied to any
desktop environment or software suite.</para>
<bridgehead renderas="sect3">Package Information</bridgehead>
<itemizedlist spacing="compact">
<listitem>
<para>Download (HTTP): <ulink url="&mcs-download-http;"/></para>
</listitem>
<listitem>
<para>Download (FTP): <ulink url="&mcs-download-ftp;"/></para>
</listitem>
<listitem>
<para>Download MD5 sum: &mcs-md5sum;</para>
</listitem>
<listitem>
<para>Download size: &mcs-size;</para>
</listitem>
<listitem>
<para>Estimated disk space required: &mcs-buildsize;</para>
</listitem>
<listitem>
<para>Estimated build time: &mcs-time;</para>
</listitem>
</itemizedlist>
<bridgehead renderas="sect3">mcs Dependencies</bridgehead>
<bridgehead renderas="sect4">Optional</bridgehead>
<para role="optional"><xref linkend="GConf"/> and
<xref linkend="kdelibs"/></para>
<para condition="html" role="usernotes">User Notes:
<ulink url="&blfs-wiki;/mcs"/></para>
</sect2>
<sect2 role="installation">
<title>Installation of mcs</title>
<para>Install <application>mcs</application> by
running the following commands:</para>
<screen><userinput>sed -i 's|libmcs|../../&amp;|' src/backends/kconfig/kconfig.cc &amp;&amp;
./configure --prefix=/usr &amp;&amp;
make</userinput></screen>
<para>This package does not come with a test suite.</para>
<para>Now, as the <systemitem class="username">root</systemitem> user:</para>
<screen role="root"><userinput>make install &amp;&amp;
install -v -m644 -D README /usr/share/doc/mcs-&mcs-version;/README</userinput></screen>
</sect2>
<sect2 role="commands">
<title>Command Explanations</title>
<para><option>--enable-gconf</option>: Use this option if you have
<application>GConf</application> installed and wish to build the
<application>GConf</application> backend.</para>
<para><option>--enable-kconfig</option>: Use this option if you have
<application>kdelibs</application> installed and wish to build the
<application>KConfig</application> backend. If KDE and/or
<application>Qt</application> are not installed in
<filename class='directory'>/usr</filename>, you must pass additional
parameters to the <command>configure</command> script to identify the
location of the libraries and interface headers (e.g.,
<option>LDFLAGS=-L/opt/kde/lib</option>
<option>CXXFLAGS="-I/opt/kde/include -I/opt/qt/include"</option>. It is
not necessary to identify the location of the
<application>Qt</application> libraries.</para>
<para>For additional information about the various storage backends
(including the default XDG-compliant backend), see the
<filename>README</filename> file in the source tree.</para>
</sect2>
<sect2 role="configuration">
<title>Configuring mcs</title>
<para>There are various ways to configure <application>mcs</application>
to use a specific backend on a site-wide or individual user basis. See
section 2 of the <filename>README</filename> file in the source tree for
details.</para>
</sect2>
<sect2 role="content">
<title>Contents</title>
<segmentedlist>
<segtitle>Installed Programs</segtitle>
<segtitle>Installed Libraries</segtitle>
<segtitle>Installed Directories</segtitle>
<seglistitem>
<seg>mcs-getconfval, mcs-info, mcs-query-backends and
mcs-setconfval</seg>
<seg>libmcs.so and backend storage modules</seg>
<seg>/usr/include/mcs, /usr/lib/mcs and
/usr/share/doc/mcs-&mcs-version;</seg>
</seglistitem>
</segmentedlist>
<variablelist>
<bridgehead renderas="sect3">Short Descriptions</bridgehead>
<?dbfo list-presentation="list"?>
<?dbhtml list-presentation="table"?>
<varlistentry id="mcs-getconfval">
<term><command>mcs-getconfval</command></term>
<listitem>
<para>queries <application>mcs</application> for a configuration
value.</para>
<indexterm zone="mcs mcs-getconfval">
<primary sortas="b-mcs-getconfval">mcs-getconfval</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="mcs-info">
<term><command>mcs-info</command></term>
<listitem>
<para>displays information about the current installation and
configuration of <application>mcs</application>.</para>
<indexterm zone="mcs mcs-info">
<primary sortas="b-mcs-info">mcs-info</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="mcs-query-backends">
<term><command>mcs-query-backends</command></term>
<listitem>
<para>queries <application>mcs</application> to determine what
backends are available.</para>
<indexterm zone="mcs mcs-query-backends">
<primary sortas="b-mcs-query-backends">mcs-query-backends</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="mcs-setconfval">
<term><command>mcs-setconfval</command></term>
<listitem>
<para>instructs <application>mcs</application> to change a
configuration value.</para>
<indexterm zone="mcs mcs-setconfval">
<primary sortas="b-mcs-setconfval">mcs-setconfval</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="libmcs">
<term><filename class='libraryfile'>libmcs.so</filename></term>
<listitem>
<para>contains the API functions required by the
<application>mcs</application> userspace tools.</para>
<indexterm zone="mcs libmcs">
<primary sortas="c-libmcs.so">libmcs.so</primary>
</indexterm>
</listitem>
</varlistentry>
</variablelist>
</sect2>
</sect1>