<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>ECMGeneratePkgConfigFile — Extra CMake Modules 5.57.0 documentation</title>
<link rel="stylesheet" href="../_static/ecm.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" src="../_static/language_data.js"></script>
<link rel="shortcut icon" href="../_static/kde-favicon.ico"/>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="ECMGeneratePriFile" href="ECMGeneratePriFile.html" />
<link rel="prev" title="ECMGenerateHeaders" href="ECMGenerateHeaders.html" />
</head><body>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="ECMGeneratePriFile.html" title="ECMGeneratePriFile"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="ECMGenerateHeaders.html" title="ECMGenerateHeaders"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">ECM 5.57 documentation</a> »</li>
<li class="nav-item nav-item-1"><a href="../manual/ecm-modules.7.html" accesskey="U">ecm-modules(7)</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="ecmgeneratepkgconfigfile">
<span id="module:ECMGeneratePkgConfigFile"></span><h1>ECMGeneratePkgConfigFile<a class="headerlink" href="#ecmgeneratepkgconfigfile" title="Permalink to this headline">¶</a></h1>
<p>Generate a <a class="reference external" href="https://www.freedesktop.org/wiki/Software/pkg-config/">pkg-config</a>
file for the benefit of
<a class="reference external" href="https://www.gnu.org/software/automake/manual/html_node/Autotools-Introduction.html">autotools</a>-based
projects.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">ecm_generate_pkgconfig_file</span><span class="p">(</span><span class="n">BASE_NAME</span> <span class="o"><</span><span class="n">baseName</span><span class="o">></span>
<span class="p">[</span><span class="n">LIB_NAME</span> <span class="o"><</span><span class="n">libName</span><span class="o">></span><span class="p">]</span>
<span class="p">[</span><span class="n">DEPS</span> <span class="s2">"<dep> [<dep> [...]]"</span><span class="p">]</span>
<span class="p">[</span><span class="n">FILENAME_VAR</span> <span class="o"><</span><span class="n">filename_variable</span><span class="o">></span><span class="p">]</span>
<span class="p">[</span><span class="n">INCLUDE_INSTALL_DIR</span> <span class="o"><</span><span class="nb">dir</span><span class="o">></span><span class="p">]</span>
<span class="p">[</span><span class="n">LIB_INSTALL_DIR</span> <span class="o"><</span><span class="nb">dir</span><span class="o">></span><span class="p">]</span>
<span class="p">[</span><span class="n">DEFINES</span> <span class="o">-</span><span class="n">D</span><span class="o"><</span><span class="n">variable</span><span class="o">=</span><span class="n">value</span><span class="o">>...</span><span class="p">]</span>
<span class="p">[</span><span class="n">DESCRIPTION</span> <span class="o"><</span><span class="n">library</span> <span class="n">description</span><span class="o">></span><span class="p">]</span> <span class="c1"># since 5.41.0</span>
<span class="p">[</span><span class="n">INSTALL</span><span class="p">])</span>
</pre></div>
</div>
<p><code class="docutils literal notranslate"><span class="pre">BASE_NAME</span></code> is the name of the module. It’s the name projects will use to
find the module.</p>
<p><code class="docutils literal notranslate"><span class="pre">LIB_NAME</span></code> is the name of the library that is being exported. If undefined,
it will default to the <code class="docutils literal notranslate"><span class="pre">BASE_NAME</span></code>. That means the <code class="docutils literal notranslate"><span class="pre">LIB_NAME</span></code> will be set
as the name field as well as the library to link to.</p>
<p><code class="docutils literal notranslate"><span class="pre">FILENAME_VAR</span></code> is specified with a variable name. This variable will
receive the location of the generated file will be set, within the build
directory. This way it can be used in case some processing is required. See
also <code class="docutils literal notranslate"><span class="pre">INSTALL</span></code>.</p>
<p><code class="docutils literal notranslate"><span class="pre">INCLUDE_INSTALL_DIR</span></code> specifies where the includes will be installed. If
it’s not specified, it will default to <code class="docutils literal notranslate"><span class="pre">INSTALL_INCLUDEDIR</span></code>,
<code class="docutils literal notranslate"><span class="pre">CMAKE_INSTALL_INCLUDEDIR</span></code> or just “include/” in case they are specified,
with the BASE_NAME postfixed.</p>
<p><code class="docutils literal notranslate"><span class="pre">LIB_INSTALL_DIR</span></code> specifies where the library is being installed. If it’s
not specified, it will default to <code class="docutils literal notranslate"><span class="pre">LIB_INSTALL_DIR</span></code>,
<code class="docutils literal notranslate"><span class="pre">CMAKE_INSTALL_LIBDIR</span></code> or just “lib/” in case they are specified.</p>
<p><code class="docutils literal notranslate"><span class="pre">DEFINES</span></code> is a list of preprocessor defines that it is recommended users of
the library pass to the compiler when using it.</p>
<p><code class="docutils literal notranslate"><span class="pre">DESCRIPTION</span></code> describes what this library is. If it’s not specified, CMake
will first try to get the description from the metainfo.yaml file or will
create one based on <code class="docutils literal notranslate"><span class="pre">LIB_NAME</span></code>. Since 5.41.0.</p>
<p><code class="docutils literal notranslate"><span class="pre">INSTALL</span></code> will cause the module to be installed to the <code class="docutils literal notranslate"><span class="pre">pkgconfig</span></code>
subdirectory of <code class="docutils literal notranslate"><span class="pre">LIB_INSTALL_DIR</span></code>, unless the <code class="docutils literal notranslate"><span class="pre">ECM_PKGCONFIG_INSTALL_DIR</span></code>
cache variable is set to something different. Note that the first call to
ecm_generate_pkgconfig_file with the <code class="docutils literal notranslate"><span class="pre">INSTALL</span></code> argument will cause
<code class="docutils literal notranslate"><span class="pre">ECM_PKGCONFIG_INSTALL_DIR</span></code> to be set to the cache, and will be used in any
subsequent calls.</p>
<p>To properly use this macro a version needs to be set. To retrieve it,
<code class="docutils literal notranslate"><span class="pre">ECM_PKGCONFIG_INSTALL_DIR</span></code> uses <code class="docutils literal notranslate"><span class="pre">PROJECT_VERSION</span></code>. To set it, use the
project() command (only available since CMake 3.0) or the ecm_setup_version()
macro.</p>
<p>Example usage:</p>
<div class="highlight-cmake notranslate"><div class="highlight"><pre><span></span><span class="nb">ecm_generate_pkgconfig_file</span><span class="p">(</span>
<span class="s">BASE_NAME</span> <span class="s">KF5Archive</span>
<span class="s">DEPS</span> <span class="s">Qt5Core</span>
<span class="s">FILENAME_VAR</span> <span class="s">pkgconfig_filename</span>
<span class="s">INSTALL</span>
<span class="p">)</span>
</pre></div>
</div>
<p>Since 1.3.0.</p>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h4>Previous topic</h4>
<p class="topless"><a href="ECMGenerateHeaders.html"
title="previous chapter">ECMGenerateHeaders</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="ECMGeneratePriFile.html"
title="next chapter">ECMGeneratePriFile</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/module/ECMGeneratePkgConfigFile.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="ECMGeneratePriFile.html" title="ECMGeneratePriFile"
>next</a> |</li>
<li class="right" >
<a href="ECMGenerateHeaders.html" title="ECMGenerateHeaders"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">ECM 5.57 documentation</a> »</li>
<li class="nav-item nav-item-1"><a href="../manual/ecm-modules.7.html" >ecm-modules(7)</a> »</li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright KDE Developers.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.4.
</div>
</body>
</html>
