source: lxqt/desktop/lxqt-kconfig.xml@ ab4fdfc

<?xml version="1.0" encoding="UTF-8"?>
<!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 kconfig-download-http "&kf5-download-http;/kconfig-&kf5-version;.tar.xz">
  <!ENTITY kconfig-download-ftp  " ">
  <!ENTITY kconfig-md5sum        "d9d231a843e344bfb69361eeff1df5dd">
  <!ENTITY kconfig-size          "288 KB">
  <!ENTITY kconfig-buildsize     "20 MB">
  <!ENTITY kconfig-time          "0.1 SBU (Using parallelism=4)">
]>

<sect1 id="lxqt-kconfig" xreflabel="kconfig-&kf5-version; for lxqt">
  <?dbhtml filename="lxqt-kconfig.html"?>


  <title>kconfig-&kf5-version; for lxqt</title>

  <indexterm zone="lxqt-kconfig">
    <primary sortas="a-kconfig">kconfig</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to kconfig</title>

    <para>
      The <application>kconfig</application> package provides access to
      configuration files.
    </para>

    &lfs120_checked;

    <important>
      <para>
        This package is extracted from the KF5 set of packages.
        If <xref linkend="kf5-frameworks"/> is built, do <emphasis
        role="bold">NOT</emphasis> also build this package as presented
        here.
      </para>
    </important>

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Download (HTTP): <ulink url="&kconfig-download-http;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download (FTP): <ulink url="&kconfig-download-ftp;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download MD5 sum: &kconfig-md5sum;
        </para>
      </listitem>
      <listitem>
        <para>
          Download size: &kconfig-size;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated disk space required: &kconfig-buildsize;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated build time: &kconfig-time;
        </para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">kconfig Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="extra-cmake-modules"/> and
      &qt5-deps;
    </para>

  </sect2>

  <sect2 role="installation">
    <title>Installation of kconfig</title>

    <para>
      Install <application>kconfig</application> by running the
      following commands:
    </para>

<screen><userinput>mkdir -v build &amp;&amp;
cd       build &amp;&amp;

cmake -DCMAKE_INSTALL_PREFIX=/usr        \
      -DCMAKE_BUILD_TYPE=Release         \
      -DCMAKE_INSTALL_LIBEXECDIR=libexec \
      -DKDE_INSTALL_USE_QT_SYS_PATHS=ON  \
      -DBUILD_TESTING=OFF                \
      -Wno-dev ..                        &amp;&amp;
make</userinput></screen>

    <para>
      This package does not come with a test suite.
    </para>

    <para>
      Now, as the &root; user:
    </para>

<screen role="root"><userinput>make install</userinput></screen>

  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

    <para>
      <parameter>-DCMAKE_INSTALL_LIBEXECDIR=libexec</parameter>: This overrides
      the default in extra-cmake-modules, which is <filename
      class="directory">/usr/lib/libexec</filename> and is not FHS compliant.
    </para>

    <para>
      <parameter>-DKDE_INSTALL_USE_QT_SYS_PATHS=ON</parameter>: This forces
      installation of Qt plugins in the same directory as <xref linkend="qt5"/>
      itself. Otherwise they get installed into <filename
      class="directory">/usr/mkspecs</filename>, which is not FHS compliant.
    </para>

  </sect2>

  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Library</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>
          kreadconfig5 and
          kwriteconfig5
        </seg>
        <seg>
          libKF5ConfigCore.so,
          libKF5ConfigGui.so, and
          libKF5ConfigQml.so
        </seg>
        <seg>
          /usr/lib/cmake/KF5Config and
          /usr/include/KF5/{KConfigCore,KConfig,KConfigQml,KConfigGui}
        </seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="lxqt-kconfig-kreadconfig5">
        <term><command>kreadconfig5</command></term>
        <listitem>
          <para>
            reads a configuration file using the KConfig interface
          </para>
          <indexterm zone="lxqt-kconfig kreadconfig5">
            <primary sortas="b-kreadconfig5">kreadconfig5</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="lxqt-kconfig-kwriteconfig5">
        <term><command>kwriteconfig5</command></term>
        <listitem>
          <para>
            writes to a configuration file using the KConfig interface
          </para>
          <indexterm zone="lxqt-kconfig kwriteconfig5">
            <primary sortas="b-kwriteconfig5">kwriteconfig5</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="lxqt-kconfig-libKF5ConfigCore">
        <term><filename class="libraryfile">libKF5ConfigCore.so</filename></term>
        <listitem>
          <para>
            contains the core configuration library for KF5
          </para>
          <indexterm zone="lxqt-kconfig lxqt-kconfig-libKF5ConfigCore">
            <primary sortas="c-libKF5ConfigCore">libKF5ConfigCore.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="lxqt-kconfig-libKF5ConfigGui">
        <term><filename class="libraryfile">libKF5ConfigGui.so</filename></term>
        <listitem>
          <para>
            contains functions for a GUI for KConfig
          </para>
          <indexterm zone="lxqt-kconfig lxqt-kconfig-libKF5ConfigGui">
            <primary sortas="c-libKF5ConfigGui">libKF5ConfigGui.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

       <varlistentry id="lxqt-kconfig-libKF5ConfigQml">
        <term><filename class="libraryfile">libKF5ConfigQml.so</filename></term>
        <listitem>
          <para>
            contains a QML interface to KConfig
          </para>
          <indexterm zone="lxqt-kconfig lxqt-kconfig-libKF5ConfigQml">
            <primary sortas="c-libKF5ConfigQml">libKF5ConfigQml.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>