docs/manual/ecm-kde-modules.7.rst

0001 .. ecm-manual-description: ECM KDE Modules Reference
0002
0003 ecm-kde-modules(7)
0004 ******************
0005
0006 .. only:: html or latex
0007
0008    .. contents::
0009
0010 Introduction
0011 ============
0012
0013 Extra CMake Modules (ECM) provides several modules that provide default settings
0014 (like installation directories, compiler flags and other CMake options) aimed at
0015 software produced by the KDE modules; these are documented here. ECM also
0016 provides modules with more general functionality, documented in
0017 :manual:`ecm-modules(7)`, and ones that extend the functionality of the
0018 ``find_package`` command, documented in :manual:`ecm-find-modules(7)`.
0019
0020 To use these modules, you need to tell CMake to find the ECM package, and
0021 then add either ``${ECM_MODULE_PATH}`` or ``${ECM_KDE_MODULE_DIR}`` to the
0022 ``CMAKE_MODULE_PATH`` variable:
0023
0024 .. code-block:: cmake
0025
0026   find_package(ECM REQUIRED NO_MODULE)
0027   set(CMAKE_MODULE_PATH ${ECM_MODULE_DIR})
0028
0029 Using ``${ECM_MODULE_PATH}`` will also make the other types of modules
0030 available.
0031
0032 All KDE Modules
0033 ===============
0034
0035 .. toctree::
0036    :maxdepth: 1
0037    :glob:
0038
0039    /kde-module/*
0040
0041 .. only:: man
0042
0043   See Also
0044   ========
0045
0046   :manual:`ecm(7)`, :manual:`ecm-modules(7)`, :manual:`ecm-find-modules(7)`
0047