blob: 681d93f37e4ea019800b6e7586cd71f42b568f42 [file] [log] [blame]
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>SOVERSION &mdash; CMake 3.23.1 Documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../_static/cmake.css" />
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<link rel="shortcut icon" href="../_static/cmake-favicon.ico"/>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="STATIC_LIBRARY_FLAGS" href="STATIC_LIBRARY_FLAGS.html" />
<link rel="prev" title="SOURCES" href="SOURCES.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="STATIC_LIBRARY_FLAGS.html" title="STATIC_LIBRARY_FLAGS"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="SOURCES.html" title="SOURCES"
accesskey="P">previous</a> |</li>
<li>
<img src="../_static/cmake-logo-16.png" alt=""
style="vertical-align: middle; margin-top: -2px" />
</li>
<li>
<a href="https://cmake.org/">CMake</a> &#187;
</li>
<li>
<a href="../index.html">3.23.1 Documentation</a> &#187;
</li>
<li class="nav-item nav-item-1"><a href="../manual/cmake-properties.7.html" accesskey="U">cmake-properties(7)</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">SOVERSION</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="soversion">
<span id="prop_tgt:SOVERSION"></span><h1>SOVERSION<a class="headerlink" href="#soversion" title="Permalink to this headline"></a></h1>
<p>What version number is this target.</p>
<p>For shared libraries <span class="target" id="index-0-prop_tgt:VERSION"></span><a class="reference internal" href="VERSION.html#prop_tgt:VERSION" title="VERSION"><code class="xref cmake cmake-prop_tgt docutils literal notranslate"><span class="pre">VERSION</span></code></a> and <code class="docutils literal notranslate"><span class="pre">SOVERSION</span></code> can be used to
specify the build version and API version respectively. When building or
installing appropriate symlinks are created if the platform supports
symlinks and the linker supports so-names. If only one of both is
specified the missing is assumed to have the same version number.
<code class="docutils literal notranslate"><span class="pre">SOVERSION</span></code> is ignored if <span class="target" id="index-0-prop_tgt:NO_SONAME"></span><a class="reference internal" href="NO_SONAME.html#prop_tgt:NO_SONAME" title="NO_SONAME"><code class="xref cmake cmake-prop_tgt docutils literal notranslate"><span class="pre">NO_SONAME</span></code></a> property is set.</p>
<div class="section" id="windows-versions">
<h2>Windows Versions<a class="headerlink" href="#windows-versions" title="Permalink to this headline"></a></h2>
<p>For shared libraries and executables on Windows the <span class="target" id="index-1-prop_tgt:VERSION"></span><a class="reference internal" href="VERSION.html#prop_tgt:VERSION" title="VERSION"><code class="xref cmake cmake-prop_tgt docutils literal notranslate"><span class="pre">VERSION</span></code></a>
attribute is parsed to extract a <code class="docutils literal notranslate"><span class="pre">&lt;major&gt;.&lt;minor&gt;</span></code> version number.
These numbers are used as the image version of the binary.</p>
</div>
<div class="section" id="mach-o-versions">
<h2>Mach-O Versions<a class="headerlink" href="#mach-o-versions" title="Permalink to this headline"></a></h2>
<p>For shared libraries and executables on Mach-O systems (e.g. macOS, iOS),
the <code class="docutils literal notranslate"><span class="pre">SOVERSION</span></code> property corresponds to the <em>compatibility version</em> and
<span class="target" id="index-2-prop_tgt:VERSION"></span><a class="reference internal" href="VERSION.html#prop_tgt:VERSION" title="VERSION"><code class="xref cmake cmake-prop_tgt docutils literal notranslate"><span class="pre">VERSION</span></code></a> corresponds to the <em>current version</em> (unless Mach-O
specific overrides are provided, as discussed below).
See the <span class="target" id="index-0-prop_tgt:FRAMEWORK"></span><a class="reference internal" href="FRAMEWORK.html#prop_tgt:FRAMEWORK" title="FRAMEWORK"><code class="xref cmake cmake-prop_tgt docutils literal notranslate"><span class="pre">FRAMEWORK</span></code></a> target property for an example.</p>
<p>For shared libraries, the <span class="target" id="index-0-prop_tgt:MACHO_COMPATIBILITY_VERSION"></span><a class="reference internal" href="MACHO_COMPATIBILITY_VERSION.html#prop_tgt:MACHO_COMPATIBILITY_VERSION" title="MACHO_COMPATIBILITY_VERSION"><code class="xref cmake cmake-prop_tgt docutils literal notranslate"><span class="pre">MACHO_COMPATIBILITY_VERSION</span></code></a> and
<span class="target" id="index-0-prop_tgt:MACHO_CURRENT_VERSION"></span><a class="reference internal" href="MACHO_CURRENT_VERSION.html#prop_tgt:MACHO_CURRENT_VERSION" title="MACHO_CURRENT_VERSION"><code class="xref cmake cmake-prop_tgt docutils literal notranslate"><span class="pre">MACHO_CURRENT_VERSION</span></code></a> properties can be used to
override the <em>compatibility version</em> and <em>current version</em> respectively.
Note that <code class="docutils literal notranslate"><span class="pre">SOVERSION</span></code> will still be used to form the <code class="docutils literal notranslate"><span class="pre">install_name</span></code>
and both <code class="docutils literal notranslate"><span class="pre">SOVERSION</span></code> and <span class="target" id="index-3-prop_tgt:VERSION"></span><a class="reference internal" href="VERSION.html#prop_tgt:VERSION" title="VERSION"><code class="xref cmake cmake-prop_tgt docutils literal notranslate"><span class="pre">VERSION</span></code></a> may also affect the file
and symlink names.</p>
<p>Versions of Mach-O binaries may be checked with the <code class="docutils literal notranslate"><span class="pre">otool</span> <span class="pre">-L</span> <span class="pre">&lt;binary&gt;</span></code>
command.</p>
</div>
</div>
<div class="clearer"></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">SOVERSION</a><ul>
<li><a class="reference internal" href="#windows-versions">Windows Versions</a></li>
<li><a class="reference internal" href="#mach-o-versions">Mach-O Versions</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="SOURCES.html"
title="previous chapter">SOURCES</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="STATIC_LIBRARY_FLAGS.html"
title="next chapter">STATIC_LIBRARY_FLAGS</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/prop_tgt/SOVERSION.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>$('#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="STATIC_LIBRARY_FLAGS.html" title="STATIC_LIBRARY_FLAGS"
>next</a> |</li>
<li class="right" >
<a href="SOURCES.html" title="SOURCES"
>previous</a> |</li>
<li>
<img src="../_static/cmake-logo-16.png" alt=""
style="vertical-align: middle; margin-top: -2px" />
</li>
<li>
<a href="https://cmake.org/">CMake</a> &#187;
</li>
<li>
<a href="../index.html">3.23.1 Documentation</a> &#187;
</li>
<li class="nav-item nav-item-1"><a href="../manual/cmake-properties.7.html" >cmake-properties(7)</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">SOVERSION</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2000-2022 Kitware, Inc. and Contributors.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.1.2.
</div>
</body>
</html>