Warning, /frameworks/extra-cmake-modules/docs/manual/ecm-modules.7.rst is written in an unsupported language. File is not indexed.
0001 .. ecm-manual-description: ECM Modules Reference
0002
0003 ecm-modules(7)
0004 **************
0005
0006 .. only:: html or latex
0007
0008 .. contents::
0009
0010 Introduction
0011 ============
0012
0013 Extra CMake Modules (ECM) provides various modules that provide useful functions
0014 for CMake scripts. ECM actually provides three types of modules that can be
0015 used from CMake scripts: those that extend the functionality of the
0016 ``find_package`` command are documented in :manual:`ecm-find-modules(7)`; those
0017 that provide standard settings for software produced by the KDE community are
0018 documented in :manual:`ecm-kde-modules(7)`. The rest provide macros and
0019 functions for general use by CMake scripts and are documented here.
0020
0021 To use these modules, you need to tell CMake to find the ECM package, and
0022 then add either ``${ECM_MODULE_PATH}`` or ``${ECM_MODULE_DIR}`` to the
0023 ``CMAKE_MODULE_PATH`` variable:
0024
0025 .. code-block:: cmake
0026
0027 find_package(ECM REQUIRED NO_MODULE)
0028 set(CMAKE_MODULE_PATH ${ECM_MODULE_DIR})
0029
0030 Using ``${ECM_MODULE_PATH}`` will also make the find modules and KDE modules
0031 available.
0032
0033 Note that there are also toolchain modules, documented in
0034 :manual:`ecm-toolchains(7)`, but these are used by users building the software
0035 rather than developers writing CMake scripts.
0036
0037
0038 All Modules
0039 ===========
0040
0041 .. toctree::
0042 :maxdepth: 1
0043 :glob:
0044
0045 /module/*
0046
0047 .. only:: man
0048
0049 See Also
0050 ========
0051
0052 :manual:`ecm(7)`, :manual:`ecm-find-modules(7)`, :manual:`ecm-kde-modules(7)`
0053