[ab4fdfc] | 1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
[99498cb4] | 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 kconfig-download-http "&kf5-download-http;/kconfig-&kf5-version;.tar.xz">
|
---|
| 8 | <!ENTITY kconfig-download-ftp " ">
|
---|
[c6d0653] | 9 | <!ENTITY kconfig-md5sum "fcb77cb2d9349b33e9e085ca4d2ebe7f">
|
---|
[99498cb4] | 10 | <!ENTITY kconfig-size "288 KB">
|
---|
[d02ddc6] | 11 | <!ENTITY kconfig-buildsize "20 MB">
|
---|
| 12 | <!ENTITY kconfig-time "0.1 SBU (Using parallelism=4)">
|
---|
[99498cb4] | 13 | ]>
|
---|
| 14 |
|
---|
[96375df] | 15 | <sect1 id="lxqt-kconfig" xreflabel="kconfig-&kf5-version; for lxqt">
|
---|
[99498cb4] | 16 | <?dbhtml filename="lxqt-kconfig.html"?>
|
---|
| 17 |
|
---|
| 18 |
|
---|
| 19 | <title>kconfig-&kf5-version; for lxqt</title>
|
---|
| 20 |
|
---|
| 21 | <indexterm zone="lxqt-kconfig">
|
---|
| 22 | <primary sortas="a-kconfig">kconfig</primary>
|
---|
| 23 | </indexterm>
|
---|
| 24 |
|
---|
| 25 | <sect2 role="package">
|
---|
| 26 | <title>Introduction to kconfig</title>
|
---|
| 27 |
|
---|
| 28 | <para>
|
---|
[e440af5] | 29 | The <application>kconfig</application> package provides access to
|
---|
[99498cb4] | 30 | configuration files.
|
---|
| 31 | </para>
|
---|
| 32 |
|
---|
[e7c667c7] | 33 | &lfs121_checked;
|
---|
[5bfcd23e] | 34 | <!--
|
---|
[4c5147b] | 35 | <important>
|
---|
[99498cb4] | 36 | <para>
|
---|
[4c5147b] | 37 | This package is extracted from the KF5 set of packages.
|
---|
[5bfcd23e] | 38 | If <xref linkend="kf5- frameworks"/> is built, do <emphasis
|
---|
[4c5147b] | 39 | role="bold">NOT</emphasis> also build this package as presented
|
---|
| 40 | here.
|
---|
[99498cb4] | 41 | </para>
|
---|
[4c5147b] | 42 | </important>
|
---|
[5bfcd23e] | 43 | -->
|
---|
[99498cb4] | 44 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 45 | <itemizedlist spacing="compact">
|
---|
| 46 | <listitem>
|
---|
| 47 | <para>
|
---|
| 48 | Download (HTTP): <ulink url="&kconfig-download-http;"/>
|
---|
| 49 | </para>
|
---|
| 50 | </listitem>
|
---|
| 51 | <listitem>
|
---|
| 52 | <para>
|
---|
| 53 | Download (FTP): <ulink url="&kconfig-download-ftp;"/>
|
---|
| 54 | </para>
|
---|
| 55 | </listitem>
|
---|
| 56 | <listitem>
|
---|
| 57 | <para>
|
---|
| 58 | Download MD5 sum: &kconfig-md5sum;
|
---|
| 59 | </para>
|
---|
| 60 | </listitem>
|
---|
| 61 | <listitem>
|
---|
| 62 | <para>
|
---|
| 63 | Download size: &kconfig-size;
|
---|
| 64 | </para>
|
---|
| 65 | </listitem>
|
---|
| 66 | <listitem>
|
---|
| 67 | <para>
|
---|
| 68 | Estimated disk space required: &kconfig-buildsize;
|
---|
| 69 | </para>
|
---|
| 70 | </listitem>
|
---|
| 71 | <listitem>
|
---|
| 72 | <para>
|
---|
| 73 | Estimated build time: &kconfig-time;
|
---|
| 74 | </para>
|
---|
| 75 | </listitem>
|
---|
| 76 | </itemizedlist>
|
---|
| 77 |
|
---|
[84bb91ef] | 78 | <bridgehead renderas="sect3">kconfig Dependencies</bridgehead>
|
---|
[99498cb4] | 79 |
|
---|
| 80 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
| 81 | <para role="required">
|
---|
| 82 | <xref linkend="extra-cmake-modules"/> and
|
---|
[b3867c5] | 83 | &qt5-deps;
|
---|
[99498cb4] | 84 | </para>
|
---|
| 85 |
|
---|
| 86 | </sect2>
|
---|
| 87 |
|
---|
| 88 | <sect2 role="installation">
|
---|
| 89 | <title>Installation of kconfig</title>
|
---|
| 90 |
|
---|
| 91 | <para>
|
---|
| 92 | Install <application>kconfig</application> by running the
|
---|
| 93 | following commands:
|
---|
| 94 | </para>
|
---|
| 95 |
|
---|
| 96 | <screen><userinput>mkdir -v build &&
|
---|
| 97 | cd build &&
|
---|
| 98 |
|
---|
[a9725cee] | 99 | cmake -DCMAKE_INSTALL_PREFIX=/usr \
|
---|
| 100 | -DCMAKE_BUILD_TYPE=Release \
|
---|
| 101 | -DCMAKE_INSTALL_LIBEXECDIR=libexec \
|
---|
| 102 | -DKDE_INSTALL_USE_QT_SYS_PATHS=ON \
|
---|
| 103 | -DBUILD_TESTING=OFF \
|
---|
| 104 | -Wno-dev .. &&
|
---|
[99498cb4] | 105 | make</userinput></screen>
|
---|
| 106 |
|
---|
| 107 | <para>
|
---|
| 108 | This package does not come with a test suite.
|
---|
| 109 | </para>
|
---|
| 110 |
|
---|
| 111 | <para>
|
---|
[5ecd157] | 112 | Now, as the &root; user:
|
---|
[99498cb4] | 113 | </para>
|
---|
| 114 |
|
---|
| 115 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
| 116 |
|
---|
[a9725cee] | 117 | </sect2>
|
---|
| 118 |
|
---|
| 119 | <sect2 role="commands">
|
---|
| 120 | <title>Command Explanations</title>
|
---|
| 121 |
|
---|
[48b40684] | 122 | <para>
|
---|
[a9725cee] | 123 | <parameter>-DCMAKE_INSTALL_LIBEXECDIR=libexec</parameter>: This overrides
|
---|
[fb4719b] | 124 | the default in extra-cmake-modules, which is <filename
|
---|
[a9725cee] | 125 | class="directory">/usr/lib/libexec</filename> and is not FHS compliant.
|
---|
[48b40684] | 126 | </para>
|
---|
| 127 |
|
---|
[a9725cee] | 128 | <para>
|
---|
| 129 | <parameter>-DKDE_INSTALL_USE_QT_SYS_PATHS=ON</parameter>: This forces
|
---|
| 130 | installation of Qt plugins in the same directory as <xref linkend="qt5"/>
|
---|
| 131 | itself. Otherwise they get installed into <filename
|
---|
| 132 | class="directory">/usr/mkspecs</filename>, which is not FHS compliant.
|
---|
| 133 | </para>
|
---|
[48b40684] | 134 |
|
---|
[99498cb4] | 135 | </sect2>
|
---|
| 136 |
|
---|
| 137 | <sect2 role="content">
|
---|
| 138 | <title>Contents</title>
|
---|
| 139 |
|
---|
| 140 | <segmentedlist>
|
---|
| 141 | <segtitle>Installed Programs</segtitle>
|
---|
| 142 | <segtitle>Installed Library</segtitle>
|
---|
| 143 | <segtitle>Installed Directories</segtitle>
|
---|
| 144 |
|
---|
| 145 | <seglistitem>
|
---|
| 146 | <seg>
|
---|
| 147 | kreadconfig5 and
|
---|
| 148 | kwriteconfig5
|
---|
| 149 | </seg>
|
---|
| 150 | <seg>
|
---|
| 151 | libKF5ConfigCore.so,
|
---|
| 152 | libKF5ConfigGui.so, and
|
---|
| 153 | libKF5ConfigQml.so
|
---|
| 154 | </seg>
|
---|
| 155 | <seg>
|
---|
[84bb91ef] | 156 | /usr/lib/cmake/KF5Config and
|
---|
[a16dff43] | 157 | /usr/include/KF5/{KConfigCore,KConfig,KConfigQml,KConfigGui}
|
---|
[99498cb4] | 158 | </seg>
|
---|
| 159 | </seglistitem>
|
---|
| 160 | </segmentedlist>
|
---|
| 161 |
|
---|
| 162 | <variablelist>
|
---|
| 163 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 164 | <?dbfo list-presentation="list"?>
|
---|
| 165 | <?dbhtml list-presentation="table"?>
|
---|
| 166 |
|
---|
[b60f1ce] | 167 | <!-- Conflicts with kf6
|
---|
[7b5a765] | 168 | <varlistentry id="lxqt-kconfig-kreadconfig5">
|
---|
| 169 | <term><command>kreadconfig5</command></term>
|
---|
[99498cb4] | 170 | <listitem>
|
---|
| 171 | <para>
|
---|
[7b5a765] | 172 | reads a configuration file using the KConfig interface
|
---|
[99498cb4] | 173 | </para>
|
---|
[7b5a765] | 174 | <indexterm zone="lxqt-kconfig kreadconfig5">
|
---|
| 175 | <primary sortas="b-kreadconfig5">kreadconfig5</primary>
|
---|
| 176 | </indexterm>
|
---|
| 177 | </listitem>
|
---|
| 178 | </varlistentry>
|
---|
| 179 |
|
---|
| 180 | <varlistentry id="lxqt-kconfig-kwriteconfig5">
|
---|
| 181 | <term><command>kwriteconfig5</command></term>
|
---|
| 182 | <listitem>
|
---|
| 183 | <para>
|
---|
| 184 | writes to a configuration file using the KConfig interface
|
---|
| 185 | </para>
|
---|
| 186 | <indexterm zone="lxqt-kconfig kwriteconfig5">
|
---|
| 187 | <primary sortas="b-kwriteconfig5">kwriteconfig5</primary>
|
---|
| 188 | </indexterm>
|
---|
| 189 | </listitem>
|
---|
| 190 | </varlistentry>
|
---|
[b60f1ce] | 191 | -->
|
---|
[7b5a765] | 192 | <varlistentry id="lxqt-kconfig-libKF5ConfigCore">
|
---|
| 193 | <term><filename class="libraryfile">libKF5ConfigCore.so</filename></term>
|
---|
| 194 | <listitem>
|
---|
| 195 | <para>
|
---|
| 196 | contains the core configuration library for KF5
|
---|
| 197 | </para>
|
---|
| 198 | <indexterm zone="lxqt-kconfig lxqt-kconfig-libKF5ConfigCore">
|
---|
| 199 | <primary sortas="c-libKF5ConfigCore">libKF5ConfigCore.so</primary>
|
---|
| 200 | </indexterm>
|
---|
| 201 | </listitem>
|
---|
| 202 | </varlistentry>
|
---|
| 203 |
|
---|
| 204 | <varlistentry id="lxqt-kconfig-libKF5ConfigGui">
|
---|
| 205 | <term><filename class="libraryfile">libKF5ConfigGui.so</filename></term>
|
---|
| 206 | <listitem>
|
---|
| 207 | <para>
|
---|
| 208 | contains functions for a GUI for KConfig
|
---|
| 209 | </para>
|
---|
| 210 | <indexterm zone="lxqt-kconfig lxqt-kconfig-libKF5ConfigGui">
|
---|
| 211 | <primary sortas="c-libKF5ConfigGui">libKF5ConfigGui.so</primary>
|
---|
| 212 | </indexterm>
|
---|
| 213 | </listitem>
|
---|
| 214 | </varlistentry>
|
---|
| 215 |
|
---|
| 216 | <varlistentry id="lxqt-kconfig-libKF5ConfigQml">
|
---|
| 217 | <term><filename class="libraryfile">libKF5ConfigQml.so</filename></term>
|
---|
| 218 | <listitem>
|
---|
| 219 | <para>
|
---|
| 220 | contains a QML interface to KConfig
|
---|
| 221 | </para>
|
---|
| 222 | <indexterm zone="lxqt-kconfig lxqt-kconfig-libKF5ConfigQml">
|
---|
| 223 | <primary sortas="c-libKF5ConfigQml">libKF5ConfigQml.so</primary>
|
---|
[99498cb4] | 224 | </indexterm>
|
---|
| 225 | </listitem>
|
---|
| 226 | </varlistentry>
|
---|
| 227 |
|
---|
| 228 | </variablelist>
|
---|
[7b5a765] | 229 |
|
---|
[99498cb4] | 230 | </sect2>
|
---|
| 231 |
|
---|
| 232 | </sect1>
|
---|