| <!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="Content-Type" content="text/html; charset=utf-8" /> |
| |
| <title>CPackWIX — CMake 3.8.2 Documentation</title> |
| |
| |
| <link rel="stylesheet" href="../_static/cmake.css" type="text/css" /> |
| <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> |
| |
| <script type="text/javascript"> |
| var DOCUMENTATION_OPTIONS = { |
| URL_ROOT: '../', |
| VERSION: '3.8.2', |
| COLLAPSE_INDEX: false, |
| FILE_SUFFIX: '.html', |
| HAS_SOURCE: true, |
| SOURCELINK_SUFFIX: '.txt' |
| }; |
| </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> |
| <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="CSharpUtilities" href="CSharpUtilities.html" /> |
| <link rel="prev" title="CPack" href="CPack.html" /> |
| </head> |
| <body role="document"> |
| <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="CSharpUtilities.html" title="CSharpUtilities" |
| accesskey="N">next</a> |</li> |
| <li class="right" > |
| <a href="CPack.html" title="CPack" |
| 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> » |
| </li> |
| <li> |
| <a href="../index.html">3.8.2 Documentation</a> » |
| </li> |
| |
| <li class="nav-item nav-item-1"><a href="../manual/cmake-modules.7.html" accesskey="U">cmake-modules(7)</a> »</li> |
| </ul> |
| </div> |
| |
| <div class="document"> |
| <div class="documentwrapper"> |
| <div class="bodywrapper"> |
| <div class="body" role="main"> |
| |
| <div class="section" id="cpackwix"> |
| <span id="module:CPackWIX"></span><h1>CPackWIX<a class="headerlink" href="#cpackwix" title="Permalink to this headline">¶</a></h1> |
| <p>CPack WiX generator specific options</p> |
| <div class="section" id="variables-specific-to-cpack-wix-generator"> |
| <h2>Variables specific to CPack WiX generator<a class="headerlink" href="#variables-specific-to-cpack-wix-generator" title="Permalink to this headline">¶</a></h2> |
| <p>The following variables are specific to the installers built on |
| Windows using WiX.</p> |
| <dl class="variable"> |
| <dt id="variable:CPACK_WIX_UPGRADE_GUID"> |
| <code class="descname">CPACK_WIX_UPGRADE_GUID</code><a class="headerlink" href="#variable:CPACK_WIX_UPGRADE_GUID" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Upgrade GUID (<code class="docutils literal"><span class="pre">Product/@UpgradeCode</span></code>)</p> |
| <p>Will be automatically generated unless explicitly provided.</p> |
| <p>It should be explicitly set to a constant generated globally unique |
| identifier (GUID) to allow your installers to replace existing |
| installations that use the same GUID.</p> |
| <p>You may for example explicitly set this variable in your |
| CMakeLists.txt to the value that has been generated per default. You |
| should not use GUIDs that you did not generate yourself or which may |
| belong to other projects.</p> |
| <p>A GUID shall have the following fixed length syntax:</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">XXXXXXXX</span><span class="o">-</span><span class="n">XXXX</span><span class="o">-</span><span class="n">XXXX</span><span class="o">-</span><span class="n">XXXX</span><span class="o">-</span><span class="n">XXXXXXXXXXXX</span> |
| </pre></div> |
| </div> |
| <p>(each X represents an uppercase hexadecimal digit)</p> |
| </dd></dl> |
| |
| <dl class="variable"> |
| <dt id="variable:CPACK_WIX_PRODUCT_GUID"> |
| <code class="descname">CPACK_WIX_PRODUCT_GUID</code><a class="headerlink" href="#variable:CPACK_WIX_PRODUCT_GUID" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Product GUID (<code class="docutils literal"><span class="pre">Product/@Id</span></code>)</p> |
| <p>Will be automatically generated unless explicitly provided.</p> |
| <p>If explicitly provided this will set the Product Id of your installer.</p> |
| <p>The installer will abort if it detects a pre-existing installation that |
| uses the same GUID.</p> |
| <p>The GUID shall use the syntax described for CPACK_WIX_UPGRADE_GUID.</p> |
| </dd></dl> |
| |
| <dl class="variable"> |
| <dt id="variable:CPACK_WIX_LICENSE_RTF"> |
| <code class="descname">CPACK_WIX_LICENSE_RTF</code><a class="headerlink" href="#variable:CPACK_WIX_LICENSE_RTF" title="Permalink to this definition">¶</a></dt> |
| <dd><p>RTF License File</p> |
| <p>If CPACK_RESOURCE_FILE_LICENSE has an .rtf extension it is used as-is.</p> |
| <p>If CPACK_RESOURCE_FILE_LICENSE has an .txt extension it is implicitly |
| converted to RTF by the WiX Generator. |
| The expected encoding of the .txt file is UTF-8.</p> |
| <p>With CPACK_WIX_LICENSE_RTF you can override the license file used by the |
| WiX Generator in case CPACK_RESOURCE_FILE_LICENSE is in an unsupported |
| format or the .txt -> .rtf conversion does not work as expected.</p> |
| </dd></dl> |
| |
| <dl class="variable"> |
| <dt id="variable:CPACK_WIX_PRODUCT_ICON"> |
| <code class="descname">CPACK_WIX_PRODUCT_ICON</code><a class="headerlink" href="#variable:CPACK_WIX_PRODUCT_ICON" title="Permalink to this definition">¶</a></dt> |
| <dd><p>The Icon shown next to the program name in Add/Remove programs.</p> |
| <p>If set, this icon is used in place of the default icon.</p> |
| </dd></dl> |
| |
| <dl class="variable"> |
| <dt id="variable:CPACK_WIX_UI_REF"> |
| <code class="descname">CPACK_WIX_UI_REF</code><a class="headerlink" href="#variable:CPACK_WIX_UI_REF" title="Permalink to this definition">¶</a></dt> |
| <dd><p>This variable allows you to override the Id of the <code class="docutils literal"><span class="pre"><UIRef></span></code> element |
| in the WiX template.</p> |
| <p>The default is <code class="docutils literal"><span class="pre">WixUI_InstallDir</span></code> in case no CPack components have |
| been defined and <code class="docutils literal"><span class="pre">WixUI_FeatureTree</span></code> otherwise.</p> |
| </dd></dl> |
| |
| <dl class="variable"> |
| <dt id="variable:CPACK_WIX_UI_BANNER"> |
| <code class="descname">CPACK_WIX_UI_BANNER</code><a class="headerlink" href="#variable:CPACK_WIX_UI_BANNER" title="Permalink to this definition">¶</a></dt> |
| <dd><p>The bitmap will appear at the top of all installer pages other than the |
| welcome and completion dialogs.</p> |
| <p>If set, this image will replace the default banner image.</p> |
| <p>This image must be 493 by 58 pixels.</p> |
| </dd></dl> |
| |
| <dl class="variable"> |
| <dt id="variable:CPACK_WIX_UI_DIALOG"> |
| <code class="descname">CPACK_WIX_UI_DIALOG</code><a class="headerlink" href="#variable:CPACK_WIX_UI_DIALOG" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Background bitmap used on the welcome and completion dialogs.</p> |
| <p>If this variable is set, the installer will replace the default dialog |
| image.</p> |
| <p>This image must be 493 by 312 pixels.</p> |
| </dd></dl> |
| |
| <dl class="variable"> |
| <dt id="variable:CPACK_WIX_PROGRAM_MENU_FOLDER"> |
| <code class="descname">CPACK_WIX_PROGRAM_MENU_FOLDER</code><a class="headerlink" href="#variable:CPACK_WIX_PROGRAM_MENU_FOLDER" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Start menu folder name for launcher.</p> |
| <p>If this variable is not set, it will be initialized with CPACK_PACKAGE_NAME</p> |
| </dd></dl> |
| |
| <dl class="variable"> |
| <dt id="variable:CPACK_WIX_CULTURES"> |
| <code class="descname">CPACK_WIX_CULTURES</code><a class="headerlink" href="#variable:CPACK_WIX_CULTURES" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Language(s) of the installer</p> |
| <p>Languages are compiled into the WixUI extension library. To use them, |
| simply provide the name of the culture. If you specify more than one |
| culture identifier in a comma or semicolon delimited list, the first one |
| that is found will be used. You can find a list of supported languages at: |
| <a class="reference external" href="http://wix.sourceforge.net/manual-wix3/WixUI_localization.htm">http://wix.sourceforge.net/manual-wix3/WixUI_localization.htm</a></p> |
| </dd></dl> |
| |
| <dl class="variable"> |
| <dt id="variable:CPACK_WIX_TEMPLATE"> |
| <code class="descname">CPACK_WIX_TEMPLATE</code><a class="headerlink" href="#variable:CPACK_WIX_TEMPLATE" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Template file for WiX generation</p> |
| <p>If this variable is set, the specified template will be used to generate |
| the WiX wxs file. This should be used if further customization of the |
| output is required.</p> |
| <p>If this variable is not set, the default MSI template included with CMake |
| will be used.</p> |
| </dd></dl> |
| |
| <dl class="variable"> |
| <dt id="variable:CPACK_WIX_PATCH_FILE"> |
| <code class="descname">CPACK_WIX_PATCH_FILE</code><a class="headerlink" href="#variable:CPACK_WIX_PATCH_FILE" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Optional list of XML files with fragments to be inserted into |
| generated WiX sources</p> |
| <p>This optional variable can be used to specify an XML file that the |
| WiX generator will use to inject fragments into its generated |
| source files.</p> |
| <p>Patch files understood by the CPack WiX generator |
| roughly follow this RELAX NG compact schema:</p> |
| <div class="highlight-none"><div class="highlight"><pre><span></span>start = CPackWiXPatch |
| |
| CPackWiXPatch = element CPackWiXPatch { CPackWiXFragment* } |
| |
| CPackWiXFragment = element CPackWiXFragment |
| { |
| attribute Id { string }, |
| fragmentContent* |
| } |
| |
| fragmentContent = element * - CPackWiXFragment |
| { |
| (attribute * { text } | text | fragmentContent)* |
| } |
| </pre></div> |
| </div> |
| <p>Currently fragments can be injected into most |
| Component, File, Directory and Feature elements.</p> |
| <p>The following additional special Ids can be used:</p> |
| <ul class="simple"> |
| <li><code class="docutils literal"><span class="pre">#PRODUCT</span></code> for the <code class="docutils literal"><span class="pre"><Product></span></code> element.</li> |
| <li><code class="docutils literal"><span class="pre">#PRODUCTFEATURE</span></code> for the root <code class="docutils literal"><span class="pre"><Feature></span></code> element.</li> |
| </ul> |
| <p>The following example illustrates how this works.</p> |
| <p>Given that the WiX generator creates the following XML element:</p> |
| <div class="highlight-xml"><div class="highlight"><pre><span></span><span class="nt"><Component</span> <span class="na">Id=</span><span class="s">"CM_CP_applications.bin.my_libapp.exe"</span> <span class="na">Guid=</span><span class="s">"*"</span><span class="nt">/></span> |
| </pre></div> |
| </div> |
| <p>The following XML patch file may be used to inject an Environment element |
| into it:</p> |
| <div class="highlight-xml"><div class="highlight"><pre><span></span><span class="nt"><CPackWiXPatch></span> |
| <span class="nt"><CPackWiXFragment</span> <span class="na">Id=</span><span class="s">"CM_CP_applications.bin.my_libapp.exe"</span><span class="nt">></span> |
| <span class="nt"><Environment</span> <span class="na">Id=</span><span class="s">"MyEnvironment"</span> <span class="na">Action=</span><span class="s">"set"</span> |
| <span class="na">Name=</span><span class="s">"MyVariableName"</span> <span class="na">Value=</span><span class="s">"MyVariableValue"</span><span class="nt">/></span> |
| <span class="nt"></CPackWiXFragment></span> |
| <span class="nt"></CPackWiXPatch></span> |
| </pre></div> |
| </div> |
| </dd></dl> |
| |
| <dl class="variable"> |
| <dt id="variable:CPACK_WIX_EXTRA_SOURCES"> |
| <code class="descname">CPACK_WIX_EXTRA_SOURCES</code><a class="headerlink" href="#variable:CPACK_WIX_EXTRA_SOURCES" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Extra WiX source files</p> |
| <p>This variable provides an optional list of extra WiX source files (.wxs) |
| that should be compiled and linked. The full path to source files is |
| required.</p> |
| </dd></dl> |
| |
| <dl class="variable"> |
| <dt id="variable:CPACK_WIX_EXTRA_OBJECTS"> |
| <code class="descname">CPACK_WIX_EXTRA_OBJECTS</code><a class="headerlink" href="#variable:CPACK_WIX_EXTRA_OBJECTS" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Extra WiX object files or libraries</p> |
| <p>This variable provides an optional list of extra WiX object (.wixobj) |
| and/or WiX library (.wixlib) files. The full path to objects and libraries |
| is required.</p> |
| </dd></dl> |
| |
| <dl class="variable"> |
| <dt id="variable:CPACK_WIX_EXTENSIONS"> |
| <code class="descname">CPACK_WIX_EXTENSIONS</code><a class="headerlink" href="#variable:CPACK_WIX_EXTENSIONS" title="Permalink to this definition">¶</a></dt> |
| <dd><p>This variable provides a list of additional extensions for the WiX |
| tools light and candle.</p> |
| </dd></dl> |
| |
| <dl class="variable"> |
| <dt id="variable:CPACK_WIX_<TOOL>_EXTENSIONS"> |
| <code class="descname">CPACK_WIX_<TOOL>_EXTENSIONS</code><a class="headerlink" href="#variable:CPACK_WIX_<TOOL>_EXTENSIONS" title="Permalink to this definition">¶</a></dt> |
| <dd><p>This is the tool specific version of CPACK_WIX_EXTENSIONS. |
| <code class="docutils literal"><span class="pre"><TOOL></span></code> can be either LIGHT or CANDLE.</p> |
| </dd></dl> |
| |
| <dl class="variable"> |
| <dt id="variable:CPACK_WIX_<TOOL>_EXTRA_FLAGS"> |
| <code class="descname">CPACK_WIX_<TOOL>_EXTRA_FLAGS</code><a class="headerlink" href="#variable:CPACK_WIX_<TOOL>_EXTRA_FLAGS" title="Permalink to this definition">¶</a></dt> |
| <dd><p>This list variable allows you to pass additional |
| flags to the WiX tool <code class="docutils literal"><span class="pre"><TOOL></span></code>.</p> |
| <p>Use it at your own risk. |
| Future versions of CPack may generate flags which may be in conflict |
| with your own flags.</p> |
| <p><code class="docutils literal"><span class="pre"><TOOL></span></code> can be either LIGHT or CANDLE.</p> |
| </dd></dl> |
| |
| <dl class="variable"> |
| <dt id="variable:CPACK_WIX_CMAKE_PACKAGE_REGISTRY"> |
| <code class="descname">CPACK_WIX_CMAKE_PACKAGE_REGISTRY</code><a class="headerlink" href="#variable:CPACK_WIX_CMAKE_PACKAGE_REGISTRY" title="Permalink to this definition">¶</a></dt> |
| <dd><p>If this variable is set the generated installer will create |
| an entry in the windows registry key |
| <code class="docutils literal"><span class="pre">HKEY_LOCAL_MACHINE\Software\Kitware\CMake\Packages\<package></span></code> |
| The value for <code class="docutils literal"><span class="pre"><package></span></code> is provided by this variable.</p> |
| <p>Assuming you also install a CMake configuration file this will |
| allow other CMake projects to find your package with |
| the <span class="target" id="index-0-command:find_package"></span><a class="reference internal" href="../command/find_package.html#command:find_package" title="find_package"><code class="xref cmake cmake-command docutils literal"><span class="pre">find_package()</span></code></a> command.</p> |
| </dd></dl> |
| |
| <dl class="variable"> |
| <dt id="variable:CPACK_WIX_PROPERTY_<PROPERTY>"> |
| <code class="descname">CPACK_WIX_PROPERTY_<PROPERTY></code><a class="headerlink" href="#variable:CPACK_WIX_PROPERTY_<PROPERTY>" title="Permalink to this definition">¶</a></dt> |
| <dd><p>This variable can be used to provide a value for |
| the Windows Installer property <code class="docutils literal"><span class="pre"><PROPERTY></span></code></p> |
| <p>The following list contains some example properties that can be used to |
| customize information under |
| “Programs and Features” (also known as “Add or Remove Programs”)</p> |
| <ul class="simple"> |
| <li>ARPCOMMENTS - Comments</li> |
| <li>ARPHELPLINK - Help and support information URL</li> |
| <li>ARPURLINFOABOUT - General information URL</li> |
| <li>ARPURLUPDATEINFO - Update information URL</li> |
| <li>ARPHELPTELEPHONE - Help and support telephone number</li> |
| <li>ARPSIZE - Size (in kilobytes) of the application</li> |
| </ul> |
| </dd></dl> |
| |
| <dl class="variable"> |
| <dt id="variable:CPACK_WIX_ROOT_FEATURE_TITLE"> |
| <code class="descname">CPACK_WIX_ROOT_FEATURE_TITLE</code><a class="headerlink" href="#variable:CPACK_WIX_ROOT_FEATURE_TITLE" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <p>Sets the name of the root install feature in the WIX installer. Same as |
| CPACK_COMPONENT_<compName>_DISPLAY_NAME for components.</p> |
| <dl class="variable"> |
| <dt id="variable:CPACK_WIX_ROOT_FEATURE_DESCRIPTION"> |
| <code class="descname">CPACK_WIX_ROOT_FEATURE_DESCRIPTION</code><a class="headerlink" href="#variable:CPACK_WIX_ROOT_FEATURE_DESCRIPTION" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <p>Sets the description of the root install feature in the WIX installer. Same as |
| CPACK_COMPONENT_<compName>_DESCRIPTION for components.</p> |
| <dl class="variable"> |
| <dt id="variable:CPACK_WIX_SKIP_PROGRAM_FOLDER"> |
| <code class="descname">CPACK_WIX_SKIP_PROGRAM_FOLDER</code><a class="headerlink" href="#variable:CPACK_WIX_SKIP_PROGRAM_FOLDER" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <p>If this variable is set to true, the default install location |
| of the generated package will be CPACK_PACKAGE_INSTALL_DIRECTORY directly. |
| The install location will not be located relatively below |
| ProgramFiles or ProgramFiles64.</p> |
| <blockquote> |
| <div><div class="admonition note"> |
| <p class="first admonition-title">Note</p> |
| <p>Installers created with this feature do not take differences |
| between the system on which the installer is created |
| and the system on which the installer might be used into account.</p> |
| <p class="last">It is therefor possible that the installer e.g. might try to install |
| onto a drive that is unavailable or unintended or a path that does not |
| follow the localization or convention of the system on which the |
| installation is performed.</p> |
| </div> |
| </div></blockquote> |
| </div> |
| </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="#">CPackWIX</a><ul> |
| <li><a class="reference internal" href="#variables-specific-to-cpack-wix-generator">Variables specific to CPack WiX generator</a></li> |
| </ul> |
| </li> |
| </ul> |
| |
| <h4>Previous topic</h4> |
| <p class="topless"><a href="CPack.html" |
| title="previous chapter">CPack</a></p> |
| <h4>Next topic</h4> |
| <p class="topless"><a href="CSharpUtilities.html" |
| title="next chapter">CSharpUtilities</a></p> |
| <div role="note" aria-label="source link"> |
| <h3>This Page</h3> |
| <ul class="this-page-menu"> |
| <li><a href="../_sources/module/CPackWIX.rst.txt" |
| rel="nofollow">Show Source</a></li> |
| </ul> |
| </div> |
| <div id="searchbox" style="display: none" role="search"> |
| <h3>Quick search</h3> |
| <form class="search" action="../search.html" method="get"> |
| <div><input type="text" name="q" /></div> |
| <div><input type="submit" value="Go" /></div> |
| <input type="hidden" name="check_keywords" value="yes" /> |
| <input type="hidden" name="area" value="default" /> |
| </form> |
| </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="CSharpUtilities.html" title="CSharpUtilities" |
| >next</a> |</li> |
| <li class="right" > |
| <a href="CPack.html" title="CPack" |
| >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> » |
| </li> |
| <li> |
| <a href="../index.html">3.8.2 Documentation</a> » |
| </li> |
| |
| <li class="nav-item nav-item-1"><a href="../manual/cmake-modules.7.html" >cmake-modules(7)</a> »</li> |
| </ul> |
| </div> |
| <div class="footer" role="contentinfo"> |
| © Copyright 2000-2017 Kitware, Inc. and Contributors. |
| Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.2. |
| </div> |
| </body> |
| </html> |
