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