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 libmcs-download-http "http://distfiles.atheme.org/libmcs-&libmcs-version;.tgz">
|
---|
8 | <!ENTITY libmcs-download-ftp " ">
|
---|
9 | <!ENTITY libmcs-md5sum "1611a7bd7e7b07df3d889012d133c440">
|
---|
10 | <!ENTITY libmcs-size "105 KB">
|
---|
11 | <!ENTITY libmcs-buildsize "1.7 MB">
|
---|
12 | <!ENTITY libmcs-time "less than 0.1 SBU">
|
---|
13 | ]>
|
---|
14 |
|
---|
15 | <sect1 id="libmcs" xreflabel="libmcs-&libmcs-version;">
|
---|
16 | <?dbhtml filename="mcs.html"?>
|
---|
17 |
|
---|
18 | <sect1info>
|
---|
19 | <othername>$LastChangedBy$</othername>
|
---|
20 | <date>$Date$</date>
|
---|
21 | </sect1info>
|
---|
22 |
|
---|
23 | <title>libmcs-&libmcs-version;</title>
|
---|
24 |
|
---|
25 | <indexterm zone="libmcs">
|
---|
26 | <primary sortas="a-libmcs">Libmcs</primary>
|
---|
27 | </indexterm>
|
---|
28 |
|
---|
29 | <sect2 role="package">
|
---|
30 | <title>Introduction to libmcs</title>
|
---|
31 |
|
---|
32 | <para>The <application>libmcs</application> package is a library and set of
|
---|
33 | tools which abstract the storage of configuration settings away from
|
---|
34 | userland applications. There are similar projects like this (such as
|
---|
35 | <application>GConf</application>), but unlike those projects,
|
---|
36 | <application>libmcs</application> strictly handles abstraction. It does not
|
---|
37 | impose any specific data storage requirement, nor is it tied to any
|
---|
38 | desktop environment or software suite.</para>
|
---|
39 |
|
---|
40 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
41 | <itemizedlist spacing="compact">
|
---|
42 | <listitem>
|
---|
43 | <para>Download (HTTP): <ulink url="&libmcs-download-http;"/></para>
|
---|
44 | </listitem>
|
---|
45 | <listitem>
|
---|
46 | <para>Download (FTP): <ulink url="&libmcs-download-ftp;"/></para>
|
---|
47 | </listitem>
|
---|
48 | <listitem>
|
---|
49 | <para>Download MD5 sum: &libmcs-md5sum;</para>
|
---|
50 | </listitem>
|
---|
51 | <listitem>
|
---|
52 | <para>Download size: &libmcs-size;</para>
|
---|
53 | </listitem>
|
---|
54 | <listitem>
|
---|
55 | <para>Estimated disk space required: &libmcs-buildsize;</para>
|
---|
56 | </listitem>
|
---|
57 | <listitem>
|
---|
58 | <para>Estimated build time: &libmcs-time;</para>
|
---|
59 | </listitem>
|
---|
60 | </itemizedlist>
|
---|
61 |
|
---|
62 | <bridgehead renderas="sect3">libmcs Dependencies</bridgehead>
|
---|
63 |
|
---|
64 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
65 | <para role="required"><xref linkend="libmowgli"/></para>
|
---|
66 |
|
---|
67 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
68 | <para role="optional"><xref linkend="GConf"/> and
|
---|
69 | <xref linkend="kdelibs"/></para>
|
---|
70 |
|
---|
71 | <para condition="html" role="usernotes">User Notes:
|
---|
72 | <ulink url="&blfs-wiki;/mcs"/></para>
|
---|
73 |
|
---|
74 | </sect2>
|
---|
75 |
|
---|
76 | <sect2 role="installation">
|
---|
77 | <title>Installation of libmcs</title>
|
---|
78 |
|
---|
79 | <para>Install <application>libmcs</application> by
|
---|
80 | running the following commands:</para>
|
---|
81 |
|
---|
82 | <screen><userinput>./configure --prefix=/usr &&
|
---|
83 | make</userinput></screen>
|
---|
84 |
|
---|
85 | <para>This package does not come with a test suite.</para>
|
---|
86 |
|
---|
87 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
88 |
|
---|
89 | <screen role="root"><userinput>make install &&
|
---|
90 | install -v -m644 -D README /usr/share/doc/libmcs-&libmcs-version;/README</userinput></screen>
|
---|
91 |
|
---|
92 | </sect2>
|
---|
93 |
|
---|
94 | <sect2 role="commands">
|
---|
95 | <title>Command Explanations</title>
|
---|
96 |
|
---|
97 | <para><option>--with-qt-path=/usr/share/qt</option>: If you have
|
---|
98 | <xref linkend="kdelibs"/> installed, you must pass
|
---|
99 | additional parameters to the <command>configure</command> script to
|
---|
100 | identify the location of Qt and, possibly, KDE libraries and interface
|
---|
101 | headers.</para>
|
---|
102 |
|
---|
103 | <para><option>--disable-kconfig</option>: If <filename>configure</filename>
|
---|
104 | finds <filename class="libraryfile">libkdecore</filename> from
|
---|
105 | <application>kdelibs</application>, it does not test to check it is indeed
|
---|
106 | the <application>kde3</application> version and will try to use it (and
|
---|
107 | fail if it is the <application>kde4</application> version). This switch will
|
---|
108 | prevent that.</para>
|
---|
109 |
|
---|
110 | <para>For additional information about the various storage backends
|
---|
111 | (including the default XDG-compliant backend), see the
|
---|
112 | <filename>README</filename> file in the source tree.</para>
|
---|
113 |
|
---|
114 | </sect2>
|
---|
115 |
|
---|
116 | <sect2 role="configuration">
|
---|
117 | <title>Configuring libmcs</title>
|
---|
118 |
|
---|
119 | <para>There are various ways to configure <application>libmcs</application>
|
---|
120 | to use a specific backend on a site-wide or individual user basis. If the
|
---|
121 | default file-based storage backend is suitable, no configuration steps are
|
---|
122 | required. See section 2 of the <filename>README</filename> file in the
|
---|
123 | source tree for details.</para>
|
---|
124 |
|
---|
125 | </sect2>
|
---|
126 |
|
---|
127 | <sect2 role="content">
|
---|
128 | <title>Contents</title>
|
---|
129 |
|
---|
130 | <segmentedlist>
|
---|
131 | <segtitle>Installed Programs</segtitle>
|
---|
132 | <segtitle>Installed Libraries</segtitle>
|
---|
133 | <segtitle>Installed Directories</segtitle>
|
---|
134 |
|
---|
135 | <seglistitem>
|
---|
136 | <seg>mcs-getconfval, mcs-info, mcs-query-backends and
|
---|
137 | mcs-setconfval</seg>
|
---|
138 | <seg>libmcs.so and backend storage modules</seg>
|
---|
139 | <seg>/usr/include/libmcs, /usr/lib/mcs and
|
---|
140 | /usr/share/doc/libmcs-&libmcs-version;</seg>
|
---|
141 | </seglistitem>
|
---|
142 | </segmentedlist>
|
---|
143 |
|
---|
144 | <variablelist>
|
---|
145 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
146 | <?dbfo list-presentation="list"?>
|
---|
147 | <?dbhtml list-presentation="table"?>
|
---|
148 |
|
---|
149 | <varlistentry id="mcs-getconfval">
|
---|
150 | <term><command>mcs-getconfval</command></term>
|
---|
151 | <listitem>
|
---|
152 | <para>queries <application>libmcs</application> for a configuration
|
---|
153 | value.</para>
|
---|
154 | <indexterm zone="libmcs mcs-getconfval">
|
---|
155 | <primary sortas="b-mcs-getconfval">mcs-getconfval</primary>
|
---|
156 | </indexterm>
|
---|
157 | </listitem>
|
---|
158 | </varlistentry>
|
---|
159 |
|
---|
160 | <varlistentry id="mcs-info">
|
---|
161 | <term><command>mcs-info</command></term>
|
---|
162 | <listitem>
|
---|
163 | <para>displays information about the current installation and
|
---|
164 | configuration of <application>libmcs</application>.</para>
|
---|
165 | <indexterm zone="libmcs mcs-info">
|
---|
166 | <primary sortas="b-mcs-info">mcs-info</primary>
|
---|
167 | </indexterm>
|
---|
168 | </listitem>
|
---|
169 | </varlistentry>
|
---|
170 |
|
---|
171 | <varlistentry id="mcs-query-backends">
|
---|
172 | <term><command>mcs-query-backends</command></term>
|
---|
173 | <listitem>
|
---|
174 | <para>queries <application>libmcs</application> to determine what
|
---|
175 | backends are available.</para>
|
---|
176 | <indexterm zone="libmcs mcs-query-backends">
|
---|
177 | <primary sortas="b-mcs-query-backends">mcs-query-backends</primary>
|
---|
178 | </indexterm>
|
---|
179 | </listitem>
|
---|
180 | </varlistentry>
|
---|
181 |
|
---|
182 | <varlistentry id="mcs-setconfval">
|
---|
183 | <term><command>mcs-setconfval</command></term>
|
---|
184 | <listitem>
|
---|
185 | <para>instructs <application>libmcs</application> to change a
|
---|
186 | configuration value.</para>
|
---|
187 | <indexterm zone="libmcs mcs-setconfval">
|
---|
188 | <primary sortas="b-mcs-setconfval">mcs-setconfval</primary>
|
---|
189 | </indexterm>
|
---|
190 | </listitem>
|
---|
191 | </varlistentry>
|
---|
192 |
|
---|
193 | <varlistentry id="libmcs.so">
|
---|
194 | <term><filename class='libraryfile'>libmcs.so</filename></term>
|
---|
195 | <listitem>
|
---|
196 | <para>contains the API functions required by the
|
---|
197 | <application>libmcs</application> userspace tools.</para>
|
---|
198 | <indexterm zone="libmcs libmcs.so">
|
---|
199 | <primary sortas="c-libmcs.so">libmcs.so</primary>
|
---|
200 | </indexterm>
|
---|
201 | </listitem>
|
---|
202 | </varlistentry>
|
---|
203 | </variablelist>
|
---|
204 |
|
---|
205 | </sect2>
|
---|
206 |
|
---|
207 | </sect1>
|
---|