OXIESEC PANEL

Name	Size	Modified	Perms
📁 ..	-	04/04/2023 07:10:48 PM	rwxr-xr-x
📄 add_compile_definitions.html	8.97 KB	04/04/2023 07:04:57 PM	rw-r--r--
📄 add_compile_options.html	13.11 KB	04/04/2023 07:04:57 PM	rw-r--r--
📄 add_custom_command.html	67.2 KB	04/04/2023 07:04:58 PM	rw-r--r--
📄 add_custom_target.html	26.7 KB	04/04/2023 07:04:58 PM	rw-r--r--
📄 add_definitions.html	9.72 KB	04/04/2023 07:04:58 PM	rw-r--r--
📄 add_dependencies.html	8.79 KB	04/04/2023 07:04:58 PM	rw-r--r--
📄 add_executable.html	20.23 KB	04/04/2023 07:04:58 PM	rw-r--r--
📄 add_library.html	43.25 KB	04/04/2023 07:04:58 PM	rw-r--r--
📄 add_link_options.html	17.79 KB	04/04/2023 07:04:58 PM	rw-r--r--
📄 add_subdirectory.html	8.85 KB	04/04/2023 07:04:58 PM	rw-r--r--
📄 add_test.html	17.09 KB	04/04/2023 07:04:58 PM	rw-r--r--
📄 aux_source_directory.html	6.45 KB	04/04/2023 07:04:58 PM	rw-r--r--
📄 block.html	13.15 KB	04/04/2023 07:04:58 PM	rw-r--r--
📄 break.html	5.97 KB	04/04/2023 07:04:58 PM	rw-r--r--
📄 build_command.html	10.66 KB	04/04/2023 07:04:58 PM	rw-r--r--
📄 build_name.html	6.43 KB	04/04/2023 07:04:59 PM	rw-r--r--
📄 cmake_host_system_information.html	38.46 KB	04/04/2023 07:04:59 PM	rw-r--r--
📄 cmake_language.html	59.74 KB	04/04/2023 07:04:59 PM	rw-r--r--
📄 cmake_minimum_required.html	13.56 KB	04/04/2023 07:04:59 PM	rw-r--r--
📄 cmake_parse_arguments.html	18.62 KB	04/04/2023 07:04:59 PM	rw-r--r--
📄 cmake_path.html	80.45 KB	04/04/2023 07:04:59 PM	rw-r--r--
📄 cmake_policy.html	23.14 KB	04/04/2023 07:04:59 PM	rw-r--r--
📄 configure_file.html	20.36 KB	04/04/2023 07:04:59 PM	rw-r--r--
📄 continue.html	6.15 KB	04/04/2023 07:04:59 PM	rw-r--r--
📄 create_test_sourcelist.html	7.61 KB	04/04/2023 07:04:59 PM	rw-r--r--
📄 ctest_build.html	14.87 KB	04/04/2023 07:04:59 PM	rw-r--r--
📄 ctest_configure.html	10.28 KB	04/04/2023 07:04:59 PM	rw-r--r--
📄 ctest_coverage.html	9.93 KB	04/04/2023 07:04:59 PM	rw-r--r--
📄 ctest_empty_binary_directory.html	5.54 KB	04/04/2023 07:04:59 PM	rw-r--r--
📄 ctest_memcheck.html	11.73 KB	04/04/2023 07:04:59 PM	rw-r--r--
📄 ctest_read_custom_files.html	5.78 KB	04/04/2023 07:04:59 PM	rw-r--r--
📄 ctest_run_script.html	6.72 KB	04/04/2023 07:04:59 PM	rw-r--r--
📄 ctest_sleep.html	5.66 KB	04/04/2023 07:04:59 PM	rw-r--r--
📄 ctest_start.html	14.68 KB	04/04/2023 07:04:59 PM	rw-r--r--
📄 ctest_submit.html	16.18 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 ctest_test.html	38.64 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 ctest_update.html	8.79 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 ctest_upload.html	6.7 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 define_property.html	15.53 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 else.html	5.35 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 elseif.html	5.44 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 enable_language.html	10.08 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 enable_testing.html	6.04 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 endblock.html	5.66 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 endforeach.html	5.88 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 endfunction.html	5.85 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 endif.html	5.71 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 endmacro.html	5.79 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 endwhile.html	5.79 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 exec_program.html	7.52 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 execute_process.html	20.95 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 export.html	19.49 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 export_library_dependencies.html	8.01 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 file.html	128.25 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 find_file.html	39.65 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 find_library.html	46.52 KB	04/04/2023 07:05:01 PM	rw-r--r--
📄 find_package.html	91.29 KB	04/04/2023 07:05:01 PM	rw-r--r--
📄 find_path.html	40.22 KB	04/04/2023 07:05:01 PM	rw-r--r--
📄 find_program.html	37.17 KB	04/04/2023 07:05:01 PM	rw-r--r--
📄 fltk_wrap_ui.html	5.8 KB	04/04/2023 07:05:01 PM	rw-r--r--
📄 foreach.html	18.65 KB	04/04/2023 07:05:01 PM	rw-r--r--
📄 function.html	12.42 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 get_cmake_property.html	8.05 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 get_directory_property.html	9.08 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 get_filename_component.html	12.57 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 get_property.html	15.95 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 get_source_file_property.html	11.47 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 get_target_property.html	9.1 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 get_test_property.html	8.06 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 if.html	41.89 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 include.html	8.04 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 include_directories.html	10.54 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 include_external_msproject.html	8.14 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 include_guard.html	8.85 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 include_regular_expression.html	6.14 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 install.html	126.44 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 install_files.html	9.13 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 install_programs.html	9.09 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 install_targets.html	7 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 link_directories.html	11.99 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 link_libraries.html	7.36 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 list.html	35.79 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 load_cache.html	6.78 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 load_command.html	6.61 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 macro.html	20.49 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 make_directory.html	5.77 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 mark_as_advanced.html	6.73 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 math.html	9.01 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 message.html	27.67 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 option.html	6.48 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 output_required_files.html	6.59 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 project.html	30.84 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 qt_wrap_cpp.html	7.2 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 qt_wrap_ui.html	7.43 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 remove.html	6 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 remove_definitions.html	6.15 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 return.html	16.06 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 separate_arguments.html	11.04 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 set.html	18.35 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 set_directory_properties.html	7.58 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 set_property.html	17.74 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 set_source_files_properties.html	10.63 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 set_target_properties.html	8.33 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 set_tests_properties.html	7.98 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 site_name.html	5.46 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 source_group.html	10.97 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 string.html	64.24 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 subdir_depends.html	5.69 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 subdirs.html	7.51 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 target_compile_definitions.html	16.09 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 target_compile_features.html	14.47 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 target_compile_options.html	18.02 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 target_include_directories.html	22.39 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 target_link_directories.html	16.03 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 target_link_libraries.html	60.83 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 target_link_options.html	23.66 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 target_precompile_headers.html	24.42 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 target_sources.html	38.35 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 try_compile.html	57.47 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 try_run.html	24.62 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 unset.html	9.21 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 use_mangled_mesa.html	5.91 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 utility_source.html	6.78 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 variable_requires.html	6.84 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 variable_watch.html	8.98 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 while.html	9.14 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 write_file.html	7.25 KB	04/04/2023 07:05:04 PM	rw-r--r--

Editing: file.html

<!DOCTYPE html>

<title>file &mdash; CMake 3.26.3 Documentation</title>

</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="find_file.html" title="find_file"
 accesskey="N">next</a> |</li>
 <li class="right" >
 <a href="execute_process.html" title="execute_process"
 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.26.3 Documentation</a> &#187;
 </li>

<li class="nav-item nav-item-1"><a href="../manual/cmake-commands.7.html" accesskey="U">cmake-commands(7)</a> &#187;</li>
 <li class="nav-item nav-item-this"><a href="">file</a></li> 
 </ul>
 </div>

<div class="document">
 <div class="documentwrapper">
 <div class="bodywrapper">
 <div class="body" role="main">
 
 <section id="file">
<h1>file<a class="headerlink" href="#file" title="Permalink to this heading">¶</a></h1>
File manipulation command.
This command is dedicated to file and path manipulation requiring access to the
filesystem.
For other path manipulation, handling only syntactic aspects, have a look at
<a class="reference internal" href="cmake_path.html#command:cmake_path" title="cmake_path"><code class="xref cmake cmake-command docutils literal notranslate">cmake_path()</code></a> command.
<div class="admonition note">
Note
The sub-commands <a class="reference internal" href="#relative-path">RELATIVE_PATH</a>, <a class="reference internal" href="#to-cmake-path">TO_CMAKE_PATH</a> and <a class="reference internal" href="#to-native-path">TO_NATIVE_PATH</a> has
been superseded, respectively, by sub-commands
<a class="reference internal" href="cmake_path.html#cmake-path-relative-path">RELATIVE_PATH</a>,
<a class="reference internal" href="cmake_path.html#cmake-path-to-cmake-path-list">CONVERT ... TO_CMAKE_PATH_LIST</a> and
<a class="reference internal" href="cmake_path.html#cmake-path-to-native-path-list">CONVERT ... TO_NATIVE_PATH_LIST</a> of
<a class="reference internal" href="cmake_path.html#command:cmake_path" title="cmake_path"><code class="xref cmake cmake-command docutils literal notranslate">cmake_path()</code></a> command.
</div>
<section id="synopsis">
<h2>Synopsis<a class="headerlink" href="#synopsis" title="Permalink to this heading">¶</a></h2>
<pre class="literal-block"><a class="reference internal" href="#reading">Reading</a>
 file(<a class="reference internal" href="#read">READ</a> &lt;filename&gt; &lt;out-var&gt; [...])
 file(<a class="reference internal" href="#strings">STRINGS</a> &lt;filename&gt; &lt;out-var&gt; [...])
 file(<a class="reference internal" href="#hash">&lt;HASH&gt;</a> &lt;filename&gt; &lt;out-var&gt;)
 file(<a class="reference internal" href="#timestamp">TIMESTAMP</a> &lt;filename&gt; &lt;out-var&gt; [...])
 file(<a class="reference internal" href="#get-runtime-dependencies">GET_RUNTIME_DEPENDENCIES</a> [...])

<a class="reference internal" href="#writing">Writing</a>
 file({<a class="reference internal" href="#write">WRITE</a> | <a class="reference internal" href="#append">APPEND</a>} &lt;filename&gt; &lt;content&gt;...)
 file({<a class="reference internal" href="#touch">TOUCH</a> | <a class="reference internal" href="#touch-nocreate">TOUCH_NOCREATE</a>} [&lt;file&gt;...])
 file(<a class="reference internal" href="#generate">GENERATE</a> OUTPUT &lt;output-file&gt; [...])
 file(<a class="reference internal" href="#configure">CONFIGURE</a> OUTPUT &lt;output-file&gt; CONTENT &lt;content&gt; [...])

<a class="reference internal" href="#filesystem">Filesystem</a>
 file({<a class="reference internal" href="#glob">GLOB</a> | <a class="reference internal" href="#glob-recurse">GLOB_RECURSE</a>} &lt;out-var&gt; [...] [&lt;globbing-expr&gt;...])
 file(<a class="reference internal" href="#make-directory">MAKE_DIRECTORY</a> [&lt;dir&gt;...])
 file({<a class="reference internal" href="#remove">REMOVE</a> | <a class="reference internal" href="#remove-recurse">REMOVE_RECURSE</a> } [&lt;files&gt;...])
 file(<a class="reference internal" href="#rename">RENAME</a> &lt;oldname&gt; &lt;newname&gt; [...])
 file(<a class="reference internal" href="#copy-file">COPY_FILE</a> &lt;oldname&gt; &lt;newname&gt; [...])
 file({<a class="reference internal" href="#copy">COPY</a> | <a class="reference internal" href="#install">INSTALL</a>} &lt;file&gt;... DESTINATION &lt;dir&gt; [...])
 file(<a class="reference internal" href="#size">SIZE</a> &lt;filename&gt; &lt;out-var&gt;)
 file(<a class="reference internal" href="#read-symlink">READ_SYMLINK</a> &lt;linkname&gt; &lt;out-var&gt;)
 file(<a class="reference internal" href="#create-link">CREATE_LINK</a> &lt;original&gt; &lt;linkname&gt; [...])
 file(<a class="reference internal" href="#chmod">CHMOD</a> &lt;files&gt;... &lt;directories&gt;... PERMISSIONS &lt;permissions&gt;... [...])
 file(<a class="reference internal" href="#chmod-recurse">CHMOD_RECURSE</a> &lt;files&gt;... &lt;directories&gt;... PERMISSIONS &lt;permissions&gt;... [...])

<a class="reference internal" href="#path-conversion">Path Conversion</a>
 file(<a class="reference internal" href="#real-path">REAL_PATH</a> &lt;path&gt; &lt;out-var&gt; [BASE_DIRECTORY &lt;dir&gt;] [EXPAND_TILDE])
 file(<a class="reference internal" href="#relative-path">RELATIVE_PATH</a> &lt;out-var&gt; &lt;directory&gt; &lt;file&gt;)
 file({<a class="reference internal" href="#to-cmake-path">TO_CMAKE_PATH</a> | <a class="reference internal" href="#to-native-path">TO_NATIVE_PATH</a>} &lt;path&gt; &lt;out-var&gt;)

<a class="reference internal" href="#transfer">Transfer</a>
 file(<a class="reference internal" href="#download">DOWNLOAD</a> &lt;url&gt; [&lt;file&gt;] [...])
 file(<a class="reference internal" href="#upload">UPLOAD</a> &lt;file&gt; &lt;url&gt; [...])

<a class="reference internal" href="#locking">Locking</a>
 file(<a class="reference internal" href="#lock">LOCK</a> &lt;path&gt; [...])

<a class="reference internal" href="#archiving">Archiving</a>
 file(<a class="reference internal" href="#archive-create">ARCHIVE_CREATE</a> OUTPUT &lt;archive&gt; PATHS &lt;paths&gt;... [...])
 file(<a class="reference internal" href="#archive-extract">ARCHIVE_EXTRACT</a> INPUT &lt;archive&gt; [...])</pre>
</section>
<section id="reading">
<h2>Reading<a class="headerlink" href="#reading" title="Permalink to this heading">¶</a></h2>
<div class="highlight-cmake notranslate" id="read"><div class="highlight"><pre>file(READ &lt;filename&gt; &lt;variable&gt;
 [OFFSET &lt;offset&gt;] [LIMIT &lt;max-in&gt;] [HEX])
</pre></div>
</div>
Read content from a file called <code class="docutils literal notranslate">&lt;filename&gt;</code> and store it in a
<code class="docutils literal notranslate">&lt;variable&gt;</code>. Optionally start from the given <code class="docutils literal notranslate">&lt;offset&gt;</code> and
read at most <code class="docutils literal notranslate">&lt;max-in&gt;</code> bytes. The <code class="docutils literal notranslate">HEX</code> option causes data to
be converted to a hexadecimal representation (useful for binary data). If the
<code class="docutils literal notranslate">HEX</code> option is specified, letters in the output (<code class="docutils literal notranslate">a</code> through <code class="docutils literal notranslate">f</code>) are in
lowercase.
<div class="highlight-cmake notranslate" id="strings"><div class="highlight"><pre>file(STRINGS &lt;filename&gt; &lt;variable&gt; [&lt;options&gt;...])
</pre></div>
</div>
Parse a list of ASCII strings from <code class="docutils literal notranslate">&lt;filename&gt;</code> and store it in
<code class="docutils literal notranslate">&lt;variable&gt;</code>. Binary data in the file are ignored. Carriage return
(<code class="docutils literal notranslate">\r</code>, CR) characters are ignored. The options are:
<dl>
<dt><code class="docutils literal notranslate">LENGTH_MAXIMUM &lt;max-len&gt;</code></dt><dd>Consider only strings of at most a given length.
</dd>
<dt><code class="docutils literal notranslate">LENGTH_MINIMUM &lt;min-len&gt;</code></dt><dd>Consider only strings of at least a given length.
</dd>
<dt><code class="docutils literal notranslate">LIMIT_COUNT &lt;max-num&gt;</code></dt><dd>Limit the number of distinct strings to be extracted.
</dd>
<dt><code class="docutils literal notranslate">LIMIT_INPUT &lt;max-in&gt;</code></dt><dd>Limit the number of input bytes to read from the file.
</dd>
<dt><code class="docutils literal notranslate">LIMIT_OUTPUT &lt;max-out&gt;</code></dt><dd>Limit the number of total bytes to store in the <code class="docutils literal notranslate">&lt;variable&gt;</code>.
</dd>
<dt><code class="docutils literal notranslate">NEWLINE_CONSUME</code></dt><dd>Treat newline characters (<code class="docutils literal notranslate">\n</code>, LF) as part of string content
instead of terminating at them.
</dd>
<dt><code class="docutils literal notranslate">NO_HEX_CONVERSION</code></dt><dd>Intel Hex and Motorola S-record files are automatically converted to
binary while reading unless this option is given.
</dd>
<dt><code class="docutils literal notranslate">REGEX &lt;regex&gt;</code></dt><dd>Consider only strings that match the given regular expression,
as described under <a class="reference internal" href="string.html#regex-specification">string(REGEX)</a>.
</dd>
<dt><code class="docutils literal notranslate">ENCODING &lt;encoding-type&gt;</code></dt><dd><div class="versionadded">
New in version 3.1.
</div>
Consider strings of a given encoding. Currently supported encodings are:
<code class="docutils literal notranslate">UTF-8</code>, <code class="docutils literal notranslate">UTF-16LE</code>, <code class="docutils literal notranslate">UTF-16BE</code>, <code class="docutils literal notranslate">UTF-32LE</code>, <code class="docutils literal notranslate">UTF-32BE</code>.
If the <code class="docutils literal notranslate">ENCODING</code> option is not provided and the file has a Byte Order Mark,
the <code class="docutils literal notranslate">ENCODING</code> option will be defaulted to respect the Byte Order Mark.
<div class="versionadded">
New in version 3.2: Added the <code class="docutils literal notranslate">UTF-16LE</code>, <code class="docutils literal notranslate">UTF-16BE</code>, <code class="docutils literal notranslate">UTF-32LE</code>, <code class="docutils literal notranslate">UTF-32BE</code> encodings.
</div>
</dd>
</dl>
For example, the code
<div class="highlight-cmake notranslate"><div class="highlight"><pre>file(STRINGS myfile.txt myfile)
</pre></div>
</div>
stores a list in the variable <code class="docutils literal notranslate">myfile</code> in which each item is a line
from the input file.
<div class="highlight-cmake notranslate" id="hash"><div class="highlight"><pre>file(&lt;HASH&gt; &lt;filename&gt; &lt;variable&gt;)
</pre></div>
</div>
Compute a cryptographic hash of the content of <code class="docutils literal notranslate">&lt;filename&gt;</code> and
store it in a <code class="docutils literal notranslate">&lt;variable&gt;</code>. The supported <code class="docutils literal notranslate">&lt;HASH&gt;</code> algorithm names
are those listed by the <a class="reference internal" href="string.html#supported-hash-algorithms">string(&lt;HASH&gt;)</a>
command.
<div class="highlight-cmake notranslate" id="timestamp"><div class="highlight"><pre>file(TIMESTAMP &lt;filename&gt; &lt;variable&gt; [&lt;format&gt;] [UTC])
</pre></div>
</div>
Compute a string representation of the modification time of <code class="docutils literal notranslate">&lt;filename&gt;</code>
and store it in <code class="docutils literal notranslate">&lt;variable&gt;</code>. Should the command be unable to obtain a
timestamp variable will be set to the empty string (&quot;&quot;).
See the <a class="reference internal" href="string.html#command:string" title="string"><code class="xref cmake cmake-command docutils literal notranslate">string(TIMESTAMP)</code></a> command for documentation of
the <code class="docutils literal notranslate">&lt;format&gt;</code> and <code class="docutils literal notranslate">UTC</code> options.
<div class="highlight-cmake notranslate" id="get-runtime-dependencies"><div class="highlight"><pre>file(GET_RUNTIME_DEPENDENCIES
 [RESOLVED_DEPENDENCIES_VAR &lt;deps_var&gt;]
 [UNRESOLVED_DEPENDENCIES_VAR &lt;unresolved_deps_var&gt;]
 [CONFLICTING_DEPENDENCIES_PREFIX &lt;conflicting_deps_prefix&gt;]
 [EXECUTABLES [&lt;executable_files&gt;...]]
 [LIBRARIES [&lt;library_files&gt;...]]
 [MODULES [&lt;module_files&gt;...]]
 [DIRECTORIES [&lt;directories&gt;...]]
 [BUNDLE_EXECUTABLE &lt;bundle_executable_file&gt;]
 [PRE_INCLUDE_REGEXES [&lt;regexes&gt;...]]
 [PRE_EXCLUDE_REGEXES [&lt;regexes&gt;...]]
 [POST_INCLUDE_REGEXES [&lt;regexes&gt;...]]
 [POST_EXCLUDE_REGEXES [&lt;regexes&gt;...]]
 [POST_INCLUDE_FILES [&lt;files&gt;...]]
 [POST_EXCLUDE_FILES [&lt;files&gt;...]]
 )
</pre></div>
</div>
<div class="versionadded">
New in version 3.16.
</div>
Recursively get the list of libraries depended on by the given files.
Please note that this sub-command is not intended to be used in project mode.
It is intended for use at install time, either from code generated by the
<a class="reference internal" href="install.html#command:install" title="install"><code class="xref cmake cmake-command docutils literal notranslate">install(RUNTIME_DEPENDENCY_SET)</code></a> command, or from code provided by
the project via <a class="reference internal" href="install.html#command:install" title="install"><code class="xref cmake cmake-command docutils literal notranslate">install(CODE)</code></a> or <a class="reference internal" href="install.html#command:install" title="install"><code class="xref cmake cmake-command docutils literal notranslate">install(SCRIPT)</code></a>.
For example:
<div class="highlight-cmake notranslate"><div class="highlight"><pre>install(CODE [[
 file(GET_RUNTIME_DEPENDENCIES
 # ...
 )
 ]])
</pre></div>
</div>
The arguments are as follows:
<dl class="simple">
<dt><code class="docutils literal notranslate">RESOLVED_DEPENDENCIES_VAR &lt;deps_var&gt;</code></dt><dd>Name of the variable in which to store the list of resolved dependencies.
</dd>
<dt><code class="docutils literal notranslate">UNRESOLVED_DEPENDENCIES_VAR &lt;unresolved_deps_var&gt;</code></dt><dd>Name of the variable in which to store the list of unresolved dependencies.
If this variable is not specified, and there are any unresolved dependencies,
an error is issued.
</dd>
<dt><code class="docutils literal notranslate">CONFLICTING_DEPENDENCIES_PREFIX &lt;conflicting_deps_prefix&gt;</code></dt><dd>Variable prefix in which to store conflicting dependency information.
Dependencies are conflicting if two files with the same name are found in
two different directories. The list of filenames that conflict are stored in
<code class="docutils literal notranslate">&lt;conflicting_deps_prefix&gt;_FILENAMES</code>. For each filename, the list of paths
that were found for that filename are stored in
<code class="docutils literal notranslate">&lt;conflicting_deps_prefix&gt;_&lt;filename&gt;</code>.
</dd>
<dt><code class="docutils literal notranslate">EXECUTABLES &lt;executable_files&gt;</code></dt><dd>List of executable files to read for dependencies. These are executables that
are typically created with <a class="reference internal" href="add_executable.html#command:add_executable" title="add_executable"><code class="xref cmake cmake-command docutils literal notranslate">add_executable()</code></a>, but they do not have to
be created by CMake. On Apple platforms, the paths to these files determine
the value of <code class="docutils literal notranslate">&#64;executable_path</code> when recursively resolving the libraries.
Specifying any kind of library (<code class="docutils literal notranslate">STATIC</code>, <code class="docutils literal notranslate">MODULE</code>, or <code class="docutils literal notranslate">SHARED</code>) here
will result in undefined behavior.
</dd>
<dt><code class="docutils literal notranslate">LIBRARIES &lt;library_files&gt;</code></dt><dd>List of library files to read for dependencies. These are libraries that are
typically created with <a class="reference internal" href="add_library.html#command:add_library" title="add_library"><code class="xref cmake cmake-command docutils literal notranslate">add_library(SHARED)</code></a>, but they do not have
to be created by CMake. Specifying <code class="docutils literal notranslate">STATIC</code> libraries, <code class="docutils literal notranslate">MODULE</code>
libraries, or executables here will result in undefined behavior.
</dd>
<dt><code class="docutils literal notranslate">MODULES &lt;module_files&gt;</code></dt><dd>List of loadable module files to read for dependencies. These are modules
that are typically created with <a class="reference internal" href="add_library.html#command:add_library" title="add_library"><code class="xref cmake cmake-command docutils literal notranslate">add_library(MODULE)</code></a>, but they do
not have to be created by CMake. They are typically used by calling
<code class="docutils literal notranslate">dlopen()</code> at runtime rather than linked at link time with <code class="docutils literal notranslate">ld -l</code>.
Specifying <code class="docutils literal notranslate">STATIC</code> libraries, <code class="docutils literal notranslate">SHARED</code> libraries, or executables here
will result in undefined behavior.
</dd>
<dt><code class="docutils literal notranslate">DIRECTORIES &lt;directories&gt;</code></dt><dd>List of additional directories to search for dependencies. On Linux
platforms, these directories are searched if the dependency is not found in
any of the other usual paths. If it is found in such a directory, a warning
is issued, because it means that the file is incomplete (it does not list all
of the directories that contain its dependencies). On Windows platforms,
these directories are searched if the dependency is not found in any of the
other search paths, but no warning is issued, because searching other paths
is a normal part of Windows dependency resolution. On Apple platforms, this
argument has no effect.
</dd>
<dt><code class="docutils literal notranslate">BUNDLE_EXECUTABLE &lt;bundle_executable_file&gt;</code></dt><dd>Executable to treat as the &quot;bundle executable&quot; when resolving libraries. On
Apple platforms, this argument determines the value of <code class="docutils literal notranslate">&#64;executable_path</code>
when recursively resolving libraries for <code class="docutils literal notranslate">LIBRARIES</code> and <code class="docutils literal notranslate">MODULES</code> files.
It has no effect on <code class="docutils literal notranslate">EXECUTABLES</code> files. On other platforms, it has no
effect. This is typically (but not always) one of the executables in the
<code class="docutils literal notranslate">EXECUTABLES</code> argument which designates the &quot;main&quot; executable of the
package.
</dd>
</dl>
The following arguments specify filters for including or excluding libraries to
be resolved. See below for a full description of how they work.
<dl>
<dt><code class="docutils literal notranslate">PRE_INCLUDE_REGEXES &lt;regexes&gt;</code></dt><dd>List of pre-include regexes through which to filter the names of
not-yet-resolved dependencies.
</dd>
<dt><code class="docutils literal notranslate">PRE_EXCLUDE_REGEXES &lt;regexes&gt;</code></dt><dd>List of pre-exclude regexes through which to filter the names of
not-yet-resolved dependencies.
</dd>
<dt><code class="docutils literal notranslate">POST_INCLUDE_REGEXES &lt;regexes&gt;</code></dt><dd>List of post-include regexes through which to filter the names of resolved
dependencies.
</dd>
<dt><code class="docutils literal notranslate">POST_EXCLUDE_REGEXES &lt;regexes&gt;</code></dt><dd>List of post-exclude regexes through which to filter the names of resolved
dependencies.
</dd>
<dt><code class="docutils literal notranslate">POST_INCLUDE_FILES &lt;files&gt;</code></dt><dd><div class="versionadded">
New in version 3.21.
</div>
List of post-include filenames through which to filter the names of resolved
dependencies. Symlinks are resolved when attempting to match these filenames.
</dd>
<dt><code class="docutils literal notranslate">POST_EXCLUDE_FILES &lt;files&gt;</code></dt><dd><div class="versionadded">
New in version 3.21.
</div>
List of post-exclude filenames through which to filter the names of resolved
dependencies. Symlinks are resolved when attempting to match these filenames.
</dd>
</dl>
These arguments can be used to exclude unwanted system libraries when
resolving the dependencies, or to include libraries from a specific
directory. The filtering works as follows:
<ol class="arabic simple">
<li>If the not-yet-resolved dependency matches any of the
<code class="docutils literal notranslate">PRE_INCLUDE_REGEXES</code>, steps 2 and 3 are skipped, and the dependency
resolution proceeds to step 4.</li>
<li>If the not-yet-resolved dependency matches any of the
<code class="docutils literal notranslate">PRE_EXCLUDE_REGEXES</code>, dependency resolution stops for that dependency.</li>
<li>Otherwise, dependency resolution proceeds.</li>
<li><code class="docutils literal notranslate">file(GET_RUNTIME_DEPENDENCIES)</code> searches for the dependency according to
the linking rules of the platform (see below).</li>
<li>If the dependency is found, and its full path matches one of the
<code class="docutils literal notranslate">POST_INCLUDE_REGEXES</code> or <code class="docutils literal notranslate">POST_INCLUDE_FILES</code>, the full path is added
to the resolved dependencies, and <code class="docutils literal notranslate">file(GET_RUNTIME_DEPENDENCIES)</code>
recursively resolves that library's own dependencies. Otherwise, resolution
proceeds to step 6.</li>
<li>If the dependency is found, but its full path matches one of the
<code class="docutils literal notranslate">POST_EXCLUDE_REGEXES</code> or <code class="docutils literal notranslate">POST_EXCLUDE_FILES</code>, it is not added to the
resolved dependencies, and dependency resolution stops for that dependency.</li>
<li>If the dependency is found, and its full path does not match either
<code class="docutils literal notranslate">POST_INCLUDE_REGEXES</code>, <code class="docutils literal notranslate">POST_INCLUDE_FILES</code>, <code class="docutils literal notranslate">POST_EXCLUDE_REGEXES</code>,
or <code class="docutils literal notranslate">POST_EXCLUDE_FILES</code>, the full path is added to the resolved
dependencies, and <code class="docutils literal notranslate">file(GET_RUNTIME_DEPENDENCIES)</code> recursively resolves
that library's own dependencies.</li>
</ol>
Different platforms have different rules for how dependencies are resolved.
These specifics are described here.
On Linux platforms, library resolution works as follows:
<ol class="arabic simple">
<li>If the depending file does not have any <code class="docutils literal notranslate">RUNPATH</code> entries, and the library
exists in one of the depending file's <code class="docutils literal notranslate">RPATH</code> entries, or its parents', in
that order, the dependency is resolved to that file.</li>
<li>Otherwise, if the depending file has any <code class="docutils literal notranslate">RUNPATH</code> entries, and the
library exists in one of those entries, the dependency is resolved to that
file.</li>
<li>Otherwise, if the library exists in one of the directories listed by
<code class="docutils literal notranslate">ldconfig</code>, the dependency is resolved to that file.</li>
<li>Otherwise, if the library exists in one of the <code class="docutils literal notranslate">DIRECTORIES</code> entries, the
dependency is resolved to that file. In this case, a warning is issued,
because finding a file in one of the <code class="docutils literal notranslate">DIRECTORIES</code> means that the
depending file is not complete (it does not list all the directories from
which it pulls dependencies).</li>
<li>Otherwise, the dependency is unresolved.</li>
</ol>
On Windows platforms, library resolution works as follows:
<ol class="arabic">
<li>The dependent DLL name is converted to lowercase. Windows DLL names are
case-insensitive, and some linkers mangle the case of the DLL dependency
names. However, this makes it more difficult for <code class="docutils literal notranslate">PRE_INCLUDE_REGEXES</code>,
<code class="docutils literal notranslate">PRE_EXCLUDE_REGEXES</code>, <code class="docutils literal notranslate">POST_INCLUDE_REGEXES</code>, and
<code class="docutils literal notranslate">POST_EXCLUDE_REGEXES</code> to properly filter DLL names - every regex would
have to check for both uppercase and lowercase letters. For example:
<div class="highlight-cmake notranslate"><div class="highlight"><pre>file(GET_RUNTIME_DEPENDENCIES
 # ...
 PRE_INCLUDE_REGEXES &quot;^[Mm][Yy][Ll][Ii][Bb][Rr][Aa][Rr][Yy]\\.[Dd][Ll][Ll]$&quot;
 )
</pre></div>
</div>
Converting the DLL name to lowercase allows the regexes to only match
lowercase names, thus simplifying the regex. For example:
<div class="highlight-cmake notranslate"><div class="highlight"><pre>file(GET_RUNTIME_DEPENDENCIES
 # ...
 PRE_INCLUDE_REGEXES &quot;^mylibrary\\.dll$&quot;
 )
</pre></div>
</div>
This regex will match <code class="docutils literal notranslate">mylibrary.dll</code> regardless of how it is cased,
either on disk or in the depending file. (For example, it will match
<code class="docutils literal notranslate">mylibrary.dll</code>, <code class="docutils literal notranslate">MyLibrary.dll</code>, and <code class="docutils literal notranslate">MYLIBRARY.DLL</code>.)
Please note that the directory portion of any resolved DLLs retains its
casing and is not converted to lowercase. Only the filename portion is
converted.
</li>
<li>(Not yet implemented) If the depending file is a Windows Store app, and
the dependency is listed as a dependency in the application's package
manifest, the dependency is resolved to that file.</li>
<li>Otherwise, if the library exists in the same directory as the depending
file, the dependency is resolved to that file.</li>
<li>Otherwise, if the library exists in either the operating system's
<code class="docutils literal notranslate">system32</code> directory or the <code class="docutils literal notranslate">Windows</code> directory, in that order, the
dependency is resolved to that file.</li>
<li>Otherwise, if the library exists in one of the directories specified by
<code class="docutils literal notranslate">DIRECTORIES</code>, in the order they are listed, the dependency is resolved to
that file. In this case, a warning is not issued, because searching other
directories is a normal part of Windows library resolution.</li>
<li>Otherwise, the dependency is unresolved.</li>
</ol>
On Apple platforms, library resolution works as follows:
<ol class="arabic simple">
<li>If the dependency starts with <code class="docutils literal notranslate">&#64;executable_path/</code>, and an <code class="docutils literal notranslate">EXECUTABLES</code>
argument is in the process of being resolved, and replacing
<code class="docutils literal notranslate">&#64;executable_path/</code> with the directory of the executable yields an
existing file, the dependency is resolved to that file.</li>
<li>Otherwise, if the dependency starts with <code class="docutils literal notranslate">&#64;executable_path/</code>, and there is
a <code class="docutils literal notranslate">BUNDLE_EXECUTABLE</code> argument, and replacing <code class="docutils literal notranslate">&#64;executable_path/</code> with
the directory of the bundle executable yields an existing file, the
dependency is resolved to that file.</li>
<li>Otherwise, if the dependency starts with <code class="docutils literal notranslate">&#64;loader_path/</code>, and replacing
<code class="docutils literal notranslate">&#64;loader_path/</code> with the directory of the depending file yields an
existing file, the dependency is resolved to that file.</li>
<li>Otherwise, if the dependency starts with <code class="docutils literal notranslate">&#64;rpath/</code>, and replacing
<code class="docutils literal notranslate">&#64;rpath/</code> with one of the <code class="docutils literal notranslate">RPATH</code> entries of the depending file yields
an existing file, the dependency is resolved to that file. Note that
<code class="docutils literal notranslate">RPATH</code> entries that start with <code class="docutils literal notranslate">&#64;executable_path/</code> or <code class="docutils literal notranslate">&#64;loader_path/</code>
also have these items replaced with the appropriate path.</li>
<li>Otherwise, if the dependency is an absolute file that exists, the dependency
is resolved to that file.</li>
<li>Otherwise, the dependency is unresolved.</li>
</ol>
This function accepts several variables that determine which tool is used for
dependency resolution:
<dl class="cmake variable">
<dt class="sig sig-object cmake" id="variable:CMAKE_GET_RUNTIME_DEPENDENCIES_PLATFORM">
CMAKE_GET_RUNTIME_DEPENDENCIES_PLATFORM<a class="headerlink" href="#variable:CMAKE_GET_RUNTIME_DEPENDENCIES_PLATFORM" title="Permalink to this definition">¶</a></dt>
<dd>Determines which operating system and executable format the files are built
for. This could be one of several values:
<ul class="simple">
<li><code class="docutils literal notranslate">linux+elf</code></li>
<li><code class="docutils literal notranslate">windows+pe</code></li>
<li><code class="docutils literal notranslate">macos+macho</code></li>
</ul>
If this variable is not specified, it is determined automatically by system
introspection.
</dd></dl>

<dl class="cmake variable">
<dt class="sig sig-object cmake" id="variable:CMAKE_GET_RUNTIME_DEPENDENCIES_TOOL">
CMAKE_GET_RUNTIME_DEPENDENCIES_TOOL<a class="headerlink" href="#variable:CMAKE_GET_RUNTIME_DEPENDENCIES_TOOL" title="Permalink to this definition">¶</a></dt>
<dd>Determines the tool to use for dependency resolution. It could be one of
several values, depending on the value of
<a class="reference internal" href="#variable:CMAKE_GET_RUNTIME_DEPENDENCIES_PLATFORM" title="CMAKE_GET_RUNTIME_DEPENDENCIES_PLATFORM"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_GET_RUNTIME_DEPENDENCIES_PLATFORM</code></a>:
<table class="docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><code class="docutils literal notranslate">CMAKE_GET_RUNTIME_DEPENDENCIES_PLATFORM</code></th>
<th class="head"><code class="docutils literal notranslate">CMAKE_GET_RUNTIME_DEPENDENCIES_TOOL</code></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><code class="docutils literal notranslate">linux+elf</code></td>
<td><code class="docutils literal notranslate">objdump</code></td>
</tr>
<tr class="row-odd"><td><code class="docutils literal notranslate">windows+pe</code></td>
<td><code class="docutils literal notranslate">dumpbin</code></td>
</tr>
<tr class="row-even"><td><code class="docutils literal notranslate">windows+pe</code></td>
<td><code class="docutils literal notranslate">objdump</code></td>
</tr>
<tr class="row-odd"><td><code class="docutils literal notranslate">macos+macho</code></td>
<td><code class="docutils literal notranslate">otool</code></td>
</tr>
</tbody>
</table>
If this variable is not specified, it is determined automatically by system
introspection.
</dd></dl>

<dl class="cmake variable">
<dt class="sig sig-object cmake" id="variable:CMAKE_GET_RUNTIME_DEPENDENCIES_COMMAND">
CMAKE_GET_RUNTIME_DEPENDENCIES_COMMAND<a class="headerlink" href="#variable:CMAKE_GET_RUNTIME_DEPENDENCIES_COMMAND" title="Permalink to this definition">¶</a></dt>
<dd>Determines the path to the tool to use for dependency resolution. This is the
actual path to <code class="docutils literal notranslate">objdump</code>, <code class="docutils literal notranslate">dumpbin</code>, or <code class="docutils literal notranslate">otool</code>.
If this variable is not specified, it is determined by the value of
<code class="docutils literal notranslate">CMAKE_OBJDUMP</code> if set, else by system introspection.
<div class="versionadded">
New in version 3.18: Use <code class="docutils literal notranslate">CMAKE_OBJDUMP</code> if set.
</div>
</dd></dl>

</section>
<section id="writing">
<h2>Writing<a class="headerlink" href="#writing" title="Permalink to this heading">¶</a></h2>
<div class="highlight-cmake notranslate" id="append"><div class="highlight"><pre>file(WRITE &lt;filename&gt; &lt;content&gt;...)
file(APPEND &lt;filename&gt; &lt;content&gt;...)
</pre></div>
</div>
Write <code class="docutils literal notranslate">&lt;content&gt;</code> into a file called <code class="docutils literal notranslate">&lt;filename&gt;</code>. If the file does
not exist, it will be created. If the file already exists, <code class="docutils literal notranslate">WRITE</code>
mode will overwrite it and <code class="docutils literal notranslate">APPEND</code> mode will append to the end.
Any directories in the path specified by <code class="docutils literal notranslate">&lt;filename&gt;</code> that do not
exist will be created.
If the file is a build input, use the <a class="reference internal" href="configure_file.html#command:configure_file" title="configure_file"><code class="xref cmake cmake-command docutils literal notranslate">configure_file()</code></a> command
to update the file only when its content changes.
<div class="highlight-cmake notranslate" id="touch-nocreate"><div class="highlight"><pre>file(TOUCH [&lt;files&gt;...])
file(TOUCH_NOCREATE [&lt;files&gt;...])
</pre></div>
</div>
<div class="versionadded">
New in version 3.12.
</div>
Create a file with no content if it does not yet exist. If the file already
exists, its access and/or modification will be updated to the time when the
function call is executed.
Use TOUCH_NOCREATE to touch a file if it exists but not create it. If a file
does not exist it will be silently ignored.
With TOUCH and TOUCH_NOCREATE the contents of an existing file will not be
modified.
<div class="highlight-cmake notranslate" id="generate"><div class="highlight"><pre>file(GENERATE OUTPUT output-file
 &lt;INPUT input-file|CONTENT content&gt;
 [CONDITION expression] [TARGET target]
 [NO_SOURCE_PERMISSIONS | USE_SOURCE_PERMISSIONS |
 FILE_PERMISSIONS &lt;permissions&gt;...]
 [NEWLINE_STYLE [UNIX|DOS|WIN32|LF|CRLF] ])
</pre></div>
</div>
Generate an output file for each build configuration supported by the current
<a class="reference internal" href="../manual/cmake-generators.7.html#manual:cmake-generators(7)" title="cmake-generators(7)"><code class="xref cmake cmake-manual docutils literal notranslate">CMake Generator</code></a>. Evaluate
<a class="reference internal" href="../manual/cmake-generator-expressions.7.html#manual:cmake-generator-expressions(7)" title="cmake-generator-expressions(7)"><code class="xref cmake cmake-manual docutils literal notranslate">generator expressions</code></a>
from the input content to produce the output content. The options are:
<dl>
<dt><code class="docutils literal notranslate">CONDITION &lt;condition&gt;</code></dt><dd>Generate the output file for a particular configuration only if
the condition is true. The condition must be either <code class="docutils literal notranslate">0</code> or <code class="docutils literal notranslate">1</code>
after evaluating generator expressions.
</dd>
<dt><code class="docutils literal notranslate">CONTENT &lt;content&gt;</code></dt><dd>Use the content given explicitly as input.
</dd>
<dt><code class="docutils literal notranslate">INPUT &lt;input-file&gt;</code></dt><dd>Use the content from a given file as input.
<div class="versionchanged">
Changed in version 3.10: A relative path is treated with respect to the value of
<a class="reference internal" href="../variable/CMAKE_CURRENT_SOURCE_DIR.html#variable:CMAKE_CURRENT_SOURCE_DIR" title="CMAKE_CURRENT_SOURCE_DIR"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_CURRENT_SOURCE_DIR</code></a>. See policy <a class="reference internal" href="../policy/CMP0070.html#policy:CMP0070" title="CMP0070"><code class="xref cmake cmake-policy docutils literal notranslate">CMP0070</code></a>.
</div>
</dd>
<dt><code class="docutils literal notranslate">OUTPUT &lt;output-file&gt;</code></dt><dd>Specify the output file name to generate. Use generator expressions
such as <a class="reference internal" href="../manual/cmake-generator-expressions.7.html#genex:CONFIG" title="CONFIG"><code class="xref cmake cmake-genex docutils literal notranslate">$&lt;CONFIG&gt;</code></a> to specify a configuration-specific
output file name. Multiple configurations may generate the same output
file only if the generated content is identical. Otherwise, the
<code class="docutils literal notranslate">&lt;output-file&gt;</code> must evaluate to an unique name for each configuration.
<div class="versionchanged">
Changed in version 3.10: A relative path (after evaluating generator expressions) is treated
with respect to the value of <a class="reference internal" href="../variable/CMAKE_CURRENT_BINARY_DIR.html#variable:CMAKE_CURRENT_BINARY_DIR" title="CMAKE_CURRENT_BINARY_DIR"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_CURRENT_BINARY_DIR</code></a>.
See policy <a class="reference internal" href="../policy/CMP0070.html#policy:CMP0070" title="CMP0070"><code class="xref cmake cmake-policy docutils literal notranslate">CMP0070</code></a>.
</div>
</dd>
<dt><code class="docutils literal notranslate">TARGET &lt;target&gt;</code></dt><dd><div class="versionadded">
New in version 3.19.
</div>
Specify which target to use when evaluating generator expressions that
require a target for evaluation (e.g.
<a class="reference internal" href="../manual/cmake-generator-expressions.7.html#genex:COMPILE_FEATURES" title="COMPILE_FEATURES"><code class="xref cmake cmake-genex docutils literal notranslate">$&lt;COMPILE_FEATURES:...&gt;</code></a>,
<a class="reference internal" href="../manual/cmake-generator-expressions.7.html#genex:TARGET_PROPERTY" title="TARGET_PROPERTY"><code class="xref cmake cmake-genex docutils literal notranslate">$&lt;TARGET_PROPERTY:prop&gt;</code></a>).
</dd>
<dt><code class="docutils literal notranslate">NO_SOURCE_PERMISSIONS</code></dt><dd><div class="versionadded">
New in version 3.20.
</div>
The generated file permissions default to the standard 644 value
(-rw-r--r--).
</dd>
<dt><code class="docutils literal notranslate">USE_SOURCE_PERMISSIONS</code></dt><dd><div class="versionadded">
New in version 3.20.
</div>
Transfer the file permissions of the <code class="docutils literal notranslate">INPUT</code> file to the generated file.
This is already the default behavior if none of the three permissions-related
keywords are given (<code class="docutils literal notranslate">NO_SOURCE_PERMISSIONS</code>, <code class="docutils literal notranslate">USE_SOURCE_PERMISSIONS</code>
or <code class="docutils literal notranslate">FILE_PERMISSIONS</code>). The <code class="docutils literal notranslate">USE_SOURCE_PERMISSIONS</code> keyword mostly
serves as a way of making the intended behavior clearer at the call site.
It is an error to specify this option without <code class="docutils literal notranslate">INPUT</code>.
</dd>
<dt><code class="docutils literal notranslate">FILE_PERMISSIONS &lt;permissions&gt;...</code></dt><dd><div class="versionadded">
New in version 3.20.
</div>
Use the specified permissions for the generated file.
</dd>
<dt><code class="docutils literal notranslate">NEWLINE_STYLE &lt;style&gt;</code></dt><dd><div class="versionadded">
New in version 3.20.
</div>
Specify the newline style for the generated file. Specify
<code class="docutils literal notranslate">UNIX</code> or <code class="docutils literal notranslate">LF</code> for <code class="docutils literal notranslate">\n</code> newlines, or specify
<code class="docutils literal notranslate">DOS</code>, <code class="docutils literal notranslate">WIN32</code>, or <code class="docutils literal notranslate">CRLF</code> for <code class="docutils literal notranslate">\r\n</code> newlines.
</dd>
</dl>
Exactly one <code class="docutils literal notranslate">CONTENT</code> or <code class="docutils literal notranslate">INPUT</code> option must be given. A specific
<code class="docutils literal notranslate">OUTPUT</code> file may be named by at most one invocation of <code class="docutils literal notranslate">file(GENERATE)</code>.
Generated files are modified and their timestamp updated on subsequent cmake
runs only if their content is changed.
Note also that <code class="docutils literal notranslate">file(GENERATE)</code> does not create the output file until the
generation phase. The output file will not yet have been written when the
<code class="docutils literal notranslate">file(GENERATE)</code> command returns, it is written only after processing all
of a project's <code class="docutils literal notranslate">CMakeLists.txt</code> files.
<div class="highlight-cmake notranslate" id="configure"><div class="highlight"><pre>file(CONFIGURE OUTPUT output-file
 CONTENT content
 [ESCAPE_QUOTES] [@ONLY]
 [NEWLINE_STYLE [UNIX|DOS|WIN32|LF|CRLF] ])
</pre></div>
</div>
<div class="versionadded">
New in version 3.18.
</div>
Generate an output file using the input given by <code class="docutils literal notranslate">CONTENT</code> and substitute
variable values referenced as <code class="docutils literal notranslate">&#64;VAR&#64;</code> or <code class="docutils literal notranslate">${VAR}</code> contained therein. The
substitution rules behave the same as the <a class="reference internal" href="configure_file.html#command:configure_file" title="configure_file"><code class="xref cmake cmake-command docutils literal notranslate">configure_file()</code></a> command.
In order to match <a class="reference internal" href="configure_file.html#command:configure_file" title="configure_file"><code class="xref cmake cmake-command docutils literal notranslate">configure_file()</code></a>'s behavior, generator expressions
are not supported for both <code class="docutils literal notranslate">OUTPUT</code> and <code class="docutils literal notranslate">CONTENT</code>.
The arguments are:
<dl class="simple">
<dt><code class="docutils literal notranslate">OUTPUT &lt;output-file&gt;</code></dt><dd>Specify the output file name to generate. A relative path is treated with
respect to the value of <a class="reference internal" href="../variable/CMAKE_CURRENT_BINARY_DIR.html#variable:CMAKE_CURRENT_BINARY_DIR" title="CMAKE_CURRENT_BINARY_DIR"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_CURRENT_BINARY_DIR</code></a>.
<code class="docutils literal notranslate">&lt;output-file&gt;</code> does not support generator expressions.
</dd>
<dt><code class="docutils literal notranslate">CONTENT &lt;content&gt;</code></dt><dd>Use the content given explicitly as input.
<code class="docutils literal notranslate">&lt;content&gt;</code> does not support generator expressions.
</dd>
<dt><code class="docutils literal notranslate">ESCAPE_QUOTES</code></dt><dd>Escape any substituted quotes with backslashes (C-style).
</dd>
<dt><code class="docutils literal notranslate">&#64;ONLY</code></dt><dd>Restrict variable replacement to references of the form <code class="docutils literal notranslate">&#64;VAR&#64;</code>.
This is useful for configuring scripts that use <code class="docutils literal notranslate">${VAR}</code> syntax.
</dd>
<dt><code class="docutils literal notranslate">NEWLINE_STYLE &lt;style&gt;</code></dt><dd>Specify the newline style for the output file. Specify
<code class="docutils literal notranslate">UNIX</code> or <code class="docutils literal notranslate">LF</code> for <code class="docutils literal notranslate">\n</code> newlines, or specify
<code class="docutils literal notranslate">DOS</code>, <code class="docutils literal notranslate">WIN32</code>, or <code class="docutils literal notranslate">CRLF</code> for <code class="docutils literal notranslate">\r\n</code> newlines.
</dd>
</dl>
</section>
<section id="filesystem">
<h2>Filesystem<a class="headerlink" href="#filesystem" title="Permalink to this heading">¶</a></h2>
<div class="highlight-cmake notranslate" id="glob-recurse"><div class="highlight"><pre>file(GLOB &lt;variable&gt;
 [LIST_DIRECTORIES true|false] [RELATIVE &lt;path&gt;] [CONFIGURE_DEPENDS]
 [&lt;globbing-expressions&gt;...])
file(GLOB_RECURSE &lt;variable&gt; [FOLLOW_SYMLINKS]
 [LIST_DIRECTORIES true|false] [RELATIVE &lt;path&gt;] [CONFIGURE_DEPENDS]
 [&lt;globbing-expressions&gt;...])
</pre></div>
</div>
Generate a list of files that match the <code class="docutils literal notranslate">&lt;globbing-expressions&gt;</code> and
store it into the <code class="docutils literal notranslate">&lt;variable&gt;</code>. Globbing expressions are similar to
regular expressions, but much simpler. If <code class="docutils literal notranslate">RELATIVE</code> flag is
specified, the results will be returned as relative paths to the given
path.
<div class="versionchanged">
Changed in version 3.6: The results will be ordered lexicographically.
</div>
On Windows and macOS, globbing is case-insensitive even if the underlying
filesystem is case-sensitive (both filenames and globbing expressions are
converted to lowercase before matching). On other platforms, globbing is
case-sensitive.
<div class="versionadded">
New in version 3.3: By default <code class="docutils literal notranslate">GLOB</code> lists directories - directories are omitted in result if
<code class="docutils literal notranslate">LIST_DIRECTORIES</code> is set to false.
</div>
<div class="versionadded">
New in version 3.12: If the <code class="docutils literal notranslate">CONFIGURE_DEPENDS</code> flag is specified, CMake will add logic
to the main build system check target to rerun the flagged <code class="docutils literal notranslate">GLOB</code> commands
at build time. If any of the outputs change, CMake will regenerate the build
system.
</div>
<div class="admonition note">
Note
We do not recommend using GLOB to collect a list of source files from
your source tree. If no CMakeLists.txt file changes when a source is
added or removed then the generated build system cannot know when to
ask CMake to regenerate.
The <code class="docutils literal notranslate">CONFIGURE_DEPENDS</code> flag may not work reliably on all generators, or if
a new generator is added in the future that cannot support it, projects using
it will be stuck. Even if <code class="docutils literal notranslate">CONFIGURE_DEPENDS</code> works reliably, there is
still a cost to perform the check on every rebuild.
</div>
Examples of globbing expressions include:
<div class="highlight-none notranslate"><div class="highlight"><pre>*.cxx - match all files with extension cxx
*.vt? - match all files with extension vta,...,vtz
f[3-5].txt - match files f3.txt, f4.txt, f5.txt
</pre></div>
</div>
The <code class="docutils literal notranslate">GLOB_RECURSE</code> mode will traverse all the subdirectories of the
matched directory and match the files. Subdirectories that are symlinks
are only traversed if <code class="docutils literal notranslate">FOLLOW_SYMLINKS</code> is given or policy
<a class="reference internal" href="../policy/CMP0009.html#policy:CMP0009" title="CMP0009"><code class="xref cmake cmake-policy docutils literal notranslate">CMP0009</code></a> is not set to <code class="docutils literal notranslate">NEW</code>.
<div class="versionadded">
New in version 3.3: By default <code class="docutils literal notranslate">GLOB_RECURSE</code> omits directories from result list - setting
<code class="docutils literal notranslate">LIST_DIRECTORIES</code> to true adds directories to result list.
If <code class="docutils literal notranslate">FOLLOW_SYMLINKS</code> is given or policy <a class="reference internal" href="../policy/CMP0009.html#policy:CMP0009" title="CMP0009"><code class="xref cmake cmake-policy docutils literal notranslate">CMP0009</code></a> is not set to
<code class="docutils literal notranslate">NEW</code> then <code class="docutils literal notranslate">LIST_DIRECTORIES</code> treats symlinks as directories.
</div>
Examples of recursive globbing include:
<div class="highlight-none notranslate"><div class="highlight"><pre>/dir/*.py - match all python files in /dir and subdirectories
</pre></div>
</div>
<div class="highlight-cmake notranslate" id="make-directory"><div class="highlight"><pre>file(MAKE_DIRECTORY [&lt;directories&gt;...])
</pre></div>
</div>
Create the given directories and their parents as needed.
<div class="highlight-cmake notranslate" id="remove-recurse"><div class="highlight"><pre>file(REMOVE [&lt;files&gt;...])
file(REMOVE_RECURSE [&lt;files&gt;...])
</pre></div>
</div>
Remove the given files. The <code class="docutils literal notranslate">REMOVE_RECURSE</code> mode will remove the given
files and directories, also non-empty directories. No error is emitted if a
given file does not exist. Relative input paths are evaluated with respect
to the current source directory.
<div class="versionchanged">
Changed in version 3.15: Empty input paths are ignored with a warning. Previous versions of CMake
interpreted empty strings as a relative path with respect to the current
directory and removed its contents.
</div>
<div class="highlight-cmake notranslate" id="rename"><div class="highlight"><pre>file(RENAME &lt;oldname&gt; &lt;newname&gt;
 [RESULT &lt;result&gt;]
 [NO_REPLACE])
</pre></div>
</div>
Move a file or directory within a filesystem from <code class="docutils literal notranslate">&lt;oldname&gt;</code> to
<code class="docutils literal notranslate">&lt;newname&gt;</code>, replacing the destination atomically.
The options are:
<dl>
<dt><code class="docutils literal notranslate">RESULT &lt;result&gt;</code></dt><dd><div class="versionadded">
New in version 3.21.
</div>
Set <code class="docutils literal notranslate">&lt;result&gt;</code> variable to <code class="docutils literal notranslate">0</code> on success or an error message otherwise.
If <code class="docutils literal notranslate">RESULT</code> is not specified and the operation fails, an error is emitted.
</dd>
<dt><code class="docutils literal notranslate">NO_REPLACE</code></dt><dd><div class="versionadded">
New in version 3.21.
</div>
If the <code class="docutils literal notranslate">&lt;newname&gt;</code> path already exists, do not replace it.
If <code class="docutils literal notranslate">RESULT &lt;result&gt;</code> is used, the result variable will be
set to <code class="docutils literal notranslate">NO_REPLACE</code>. Otherwise, an error is emitted.
</dd>
</dl>
<div class="highlight-cmake notranslate" id="copy-file"><div class="highlight"><pre>file(COPY_FILE &lt;oldname&gt; &lt;newname&gt;
 [RESULT &lt;result&gt;]
 [ONLY_IF_DIFFERENT]
 [INPUT_MAY_BE_RECENT])
</pre></div>
</div>
<div class="versionadded">
New in version 3.21.
</div>
Copy a file from <code class="docutils literal notranslate">&lt;oldname&gt;</code> to <code class="docutils literal notranslate">&lt;newname&gt;</code>. Directories are not
supported. Symlinks are ignored and <code class="docutils literal notranslate">&lt;oldfile&gt;</code>'s content is read and
written to <code class="docutils literal notranslate">&lt;newname&gt;</code> as a new file.
The options are:
<dl>
<dt><code class="docutils literal notranslate">RESULT &lt;result&gt;</code></dt><dd>Set <code class="docutils literal notranslate">&lt;result&gt;</code> variable to <code class="docutils literal notranslate">0</code> on success or an error message otherwise.
If <code class="docutils literal notranslate">RESULT</code> is not specified and the operation fails, an error is emitted.
</dd>
<dt><code class="docutils literal notranslate">ONLY_IF_DIFFERENT</code></dt><dd>If the <code class="docutils literal notranslate">&lt;newname&gt;</code> path already exists, do not replace it if the file's
contents are already the same as <code class="docutils literal notranslate">&lt;oldname&gt;</code> (this avoids updating
<code class="docutils literal notranslate">&lt;newname&gt;</code>'s timestamp).
</dd>
<dt><code class="docutils literal notranslate">INPUT_MAY_BE_RECENT</code></dt><dd><div class="versionadded">
New in version 3.26.
</div>
Tell CMake that the input file may have been recently created. This is
meaningful only on Windows, where files may be inaccessible for a short
time after they are created. With this option, if permission is denied,
CMake will retry reading the input a few times.
</dd>
</dl>
This sub-command has some similarities to <a class="reference internal" href="configure_file.html#command:configure_file" title="configure_file"><code class="xref cmake cmake-command docutils literal notranslate">configure_file()</code></a> with the
<code class="docutils literal notranslate">COPYONLY</code> option. An important difference is that <a class="reference internal" href="configure_file.html#command:configure_file" title="configure_file"><code class="xref cmake cmake-command docutils literal notranslate">configure_file()</code></a>
creates a dependency on the source file, so CMake will be re-run if it changes.
The <code class="docutils literal notranslate">file(COPY_FILE)</code> sub-command does not create such a dependency.
See also the <code class="docutils literal notranslate">file(COPY)</code> sub-command just below which provides
further file-copying capabilities.
<div class="highlight-cmake notranslate" id="install"><div class="highlight"><pre>file(&lt;COPY|INSTALL&gt; &lt;files&gt;... DESTINATION &lt;dir&gt;
 [NO_SOURCE_PERMISSIONS | USE_SOURCE_PERMISSIONS]
 [FILE_PERMISSIONS &lt;permissions&gt;...]
 [DIRECTORY_PERMISSIONS &lt;permissions&gt;...]
 [FOLLOW_SYMLINK_CHAIN]
 [FILES_MATCHING]
 [[PATTERN &lt;pattern&gt; | REGEX &lt;regex&gt;]
 [EXCLUDE] [PERMISSIONS &lt;permissions&gt;...]] [...])
</pre></div>
</div>
<div class="admonition note">
Note
For a simple file copying operation, the <code class="docutils literal notranslate">file(COPY_FILE)</code> sub-command
just above may be easier to use.
</div>
The <code class="docutils literal notranslate">COPY</code> signature copies files, directories, and symlinks to a
destination folder. Relative input paths are evaluated with respect
to the current source directory, and a relative destination is
evaluated with respect to the current build directory. Copying
preserves input file timestamps, and optimizes out a file if it exists
at the destination with the same timestamp. Copying preserves input
permissions unless explicit permissions or <code class="docutils literal notranslate">NO_SOURCE_PERMISSIONS</code>
are given (default is <code class="docutils literal notranslate">USE_SOURCE_PERMISSIONS</code>).
<div class="versionadded">
New in version 3.15: If <code class="docutils literal notranslate">FOLLOW_SYMLINK_CHAIN</code> is specified, <code class="docutils literal notranslate">COPY</code> will recursively resolve
the symlinks at the paths given until a real file is found, and install
a corresponding symlink in the destination for each symlink encountered. For
each symlink that is installed, the resolution is stripped of the directory,
leaving only the filename, meaning that the new symlink points to a file in
the same directory as the symlink. This feature is useful on some Unix systems,
where libraries are installed as a chain of symlinks with version numbers, with
less specific versions pointing to more specific versions.
<code class="docutils literal notranslate">FOLLOW_SYMLINK_CHAIN</code> will install all of these symlinks and the library
itself into the destination directory. For example, if you have the following
directory structure:
</div>
<ul class="simple">
<li><code class="docutils literal notranslate">/opt/foo/lib/libfoo.so.1.2.3</code></li>
<li><code class="docutils literal notranslate">/opt/foo/lib/libfoo.so.1.2 -&gt; libfoo.so.1.2.3</code></li>
<li><code class="docutils literal notranslate">/opt/foo/lib/libfoo.so.1 -&gt; libfoo.so.1.2</code></li>
<li><code class="docutils literal notranslate">/opt/foo/lib/libfoo.so -&gt; libfoo.so.1</code></li>
</ul>
and you do:
<div class="highlight-cmake notranslate"><div class="highlight"><pre>file(COPY /opt/foo/lib/libfoo.so DESTINATION lib FOLLOW_SYMLINK_CHAIN)
</pre></div>
</div>
This will install all of the symlinks and <code class="docutils literal notranslate">libfoo.so.1.2.3</code> itself into
<code class="docutils literal notranslate">lib</code>.
See the <a class="reference internal" href="install.html#command:install" title="install"><code class="xref cmake cmake-command docutils literal notranslate">install(DIRECTORY)</code></a> command for documentation of
permissions, <code class="docutils literal notranslate">FILES_MATCHING</code>, <code class="docutils literal notranslate">PATTERN</code>, <code class="docutils literal notranslate">REGEX</code>, and
<code class="docutils literal notranslate">EXCLUDE</code> options. Copying directories preserves the structure
of their content even if options are used to select a subset of
files.
The <code class="docutils literal notranslate">INSTALL</code> signature differs slightly from <code class="docutils literal notranslate">COPY</code>: it prints
status messages, and <code class="docutils literal notranslate">NO_SOURCE_PERMISSIONS</code> is default.
Installation scripts generated by the <a class="reference internal" href="install.html#command:install" title="install"><code class="xref cmake cmake-command docutils literal notranslate">install()</code></a> command
use this signature (with some undocumented options for internal use).
<div class="versionchanged">
Changed in version 3.22: The environment variable <a class="reference internal" href="../envvar/CMAKE_INSTALL_MODE.html#envvar:CMAKE_INSTALL_MODE" title="CMAKE_INSTALL_MODE"><code class="xref cmake cmake-envvar docutils literal notranslate">CMAKE_INSTALL_MODE</code></a> can override the
default copying behavior of <a class="reference internal" href="#command:file" title="file"><code class="xref cmake cmake-command docutils literal notranslate">file(INSTALL)</code></a>.
</div>
<div class="highlight-cmake notranslate" id="size"><div class="highlight"><pre>file(SIZE &lt;filename&gt; &lt;variable&gt;)
</pre></div>
</div>
<div class="versionadded">
New in version 3.14.
</div>
Determine the file size of the <code class="docutils literal notranslate">&lt;filename&gt;</code> and put the result in
<code class="docutils literal notranslate">&lt;variable&gt;</code> variable. Requires that <code class="docutils literal notranslate">&lt;filename&gt;</code> is a valid path
pointing to a file and is readable.
<div class="highlight-cmake notranslate" id="read-symlink"><div class="highlight"><pre>file(READ_SYMLINK &lt;linkname&gt; &lt;variable&gt;)
</pre></div>
</div>
<div class="versionadded">
New in version 3.14.
</div>
This subcommand queries the symlink <code class="docutils literal notranslate">&lt;linkname&gt;</code> and stores the path it
points to in the result <code class="docutils literal notranslate">&lt;variable&gt;</code>. If <code class="docutils literal notranslate">&lt;linkname&gt;</code> does not exist or
is not a symlink, CMake issues a fatal error.
Note that this command returns the raw symlink path and does not resolve
a relative path. The following is an example of how to ensure that an
absolute path is obtained:
<div class="highlight-cmake notranslate"><div class="highlight"><pre>set(linkname &quot;/path/to/foo.sym&quot;)
file(READ_SYMLINK &quot;${linkname}&quot; result)
if(NOT IS_ABSOLUTE &quot;${result}&quot;)
 get_filename_component(dir &quot;${linkname}&quot; DIRECTORY)
 set(result &quot;${dir}/${result}&quot;)
endif()
</pre></div>
</div>
<div class="highlight-cmake notranslate" id="create-link"><div class="highlight"><pre>file(CREATE_LINK &lt;original&gt; &lt;linkname&gt;
 [RESULT &lt;result&gt;] [COPY_ON_ERROR] [SYMBOLIC])
</pre></div>
</div>
<div class="versionadded">
New in version 3.14.
</div>
Create a link <code class="docutils literal notranslate">&lt;linkname&gt;</code> that points to <code class="docutils literal notranslate">&lt;original&gt;</code>.
It will be a hard link by default, but providing the <code class="docutils literal notranslate">SYMBOLIC</code> option
results in a symbolic link instead. Hard links require that <code class="docutils literal notranslate">original</code>
exists and is a file, not a directory. If <code class="docutils literal notranslate">&lt;linkname&gt;</code> already exists,
it will be overwritten.
The <code class="docutils literal notranslate">&lt;result&gt;</code> variable, if specified, receives the status of the operation.
It is set to <code class="docutils literal notranslate">0</code> upon success or an error message otherwise. If <code class="docutils literal notranslate">RESULT</code>
is not specified and the operation fails, a fatal error is emitted.
Specifying <code class="docutils literal notranslate">COPY_ON_ERROR</code> enables copying the file as a fallback if
creating the link fails. It can be useful for handling situations such as
<code class="docutils literal notranslate">&lt;original&gt;</code> and <code class="docutils literal notranslate">&lt;linkname&gt;</code> being on different drives or mount points,
which would make them unable to support a hard link.
<div class="highlight-cmake notranslate" id="chmod"><div class="highlight"><pre>file(CHMOD &lt;files&gt;... &lt;directories&gt;...
 [PERMISSIONS &lt;permissions&gt;...]
 [FILE_PERMISSIONS &lt;permissions&gt;...]
 [DIRECTORY_PERMISSIONS &lt;permissions&gt;...])
</pre></div>
</div>
<div class="versionadded">
New in version 3.19.
</div>
Set the permissions for the <code class="docutils literal notranslate">&lt;files&gt;...</code> and <code class="docutils literal notranslate">&lt;directories&gt;...</code> specified.
Valid permissions are <code class="docutils literal notranslate">OWNER_READ</code>, <code class="docutils literal notranslate">OWNER_WRITE</code>, <code class="docutils literal notranslate">OWNER_EXECUTE</code>,
<code class="docutils literal notranslate">GROUP_READ</code>, <code class="docutils literal notranslate">GROUP_WRITE</code>, <code class="docutils literal notranslate">GROUP_EXECUTE</code>, <code class="docutils literal notranslate">WORLD_READ</code>,
<code class="docutils literal notranslate">WORLD_WRITE</code>, <code class="docutils literal notranslate">WORLD_EXECUTE</code>, <code class="docutils literal notranslate">SETUID</code>, <code class="docutils literal notranslate">SETGID</code>.
Valid combination of keywords are:
<dl class="simple">
<dt><code class="docutils literal notranslate">PERMISSIONS</code></dt><dd>All items are changed.
</dd>
<dt><code class="docutils literal notranslate">FILE_PERMISSIONS</code></dt><dd>Only files are changed.
</dd>
<dt><code class="docutils literal notranslate">DIRECTORY_PERMISSIONS</code></dt><dd>Only directories are changed.
</dd>
<dt><code class="docutils literal notranslate">PERMISSIONS</code> and <code class="docutils literal notranslate">FILE_PERMISSIONS</code></dt><dd><code class="docutils literal notranslate">FILE_PERMISSIONS</code> overrides <code class="docutils literal notranslate">PERMISSIONS</code> for files.
</dd>
<dt><code class="docutils literal notranslate">PERMISSIONS</code> and <code class="docutils literal notranslate">DIRECTORY_PERMISSIONS</code></dt><dd><code class="docutils literal notranslate">DIRECTORY_PERMISSIONS</code> overrides <code class="docutils literal notranslate">PERMISSIONS</code> for directories.
</dd>
<dt><code class="docutils literal notranslate">FILE_PERMISSIONS</code> and <code class="docutils literal notranslate">DIRECTORY_PERMISSIONS</code></dt><dd>Use <code class="docutils literal notranslate">FILE_PERMISSIONS</code> for files and <code class="docutils literal notranslate">DIRECTORY_PERMISSIONS</code> for
directories.
</dd>
</dl>
<div class="highlight-cmake notranslate" id="chmod-recurse"><div class="highlight"><pre>file(CHMOD_RECURSE &lt;files&gt;... &lt;directories&gt;...
 [PERMISSIONS &lt;permissions&gt;...]
 [FILE_PERMISSIONS &lt;permissions&gt;...]
 [DIRECTORY_PERMISSIONS &lt;permissions&gt;...])
</pre></div>
</div>
<div class="versionadded">
New in version 3.19.
</div>
Same as <a class="reference internal" href="#chmod">CHMOD</a>, but change the permissions of files and directories present in
the <code class="docutils literal notranslate">&lt;directories&gt;...</code> recursively.
</section>
<section id="path-conversion">
<h2>Path Conversion<a class="headerlink" href="#path-conversion" title="Permalink to this heading">¶</a></h2>
<div class="highlight-cmake notranslate" id="real-path"><div class="highlight"><pre>file(REAL_PATH &lt;path&gt; &lt;out-var&gt; [BASE_DIRECTORY &lt;dir&gt;] [EXPAND_TILDE])
</pre></div>
</div>
<div class="versionadded">
New in version 3.19.
</div>
Compute the absolute path to an existing file or directory with symlinks
resolved.
<dl>
<dt><code class="docutils literal notranslate">BASE_DIRECTORY &lt;dir&gt;</code></dt><dd>If the provided <code class="docutils literal notranslate">&lt;path&gt;</code> is a relative path, it is evaluated relative to the
given base directory <code class="docutils literal notranslate">&lt;dir&gt;</code>. If no base directory is provided, the default
base directory will be <a class="reference internal" href="../variable/CMAKE_CURRENT_SOURCE_DIR.html#variable:CMAKE_CURRENT_SOURCE_DIR" title="CMAKE_CURRENT_SOURCE_DIR"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_CURRENT_SOURCE_DIR</code></a>.
</dd>
<dt><code class="docutils literal notranslate">EXPAND_TILDE</code></dt><dd><div class="versionadded">
New in version 3.21.
</div>
If the <code class="docutils literal notranslate">&lt;path&gt;</code> is <code class="docutils literal notranslate">~</code> or starts with <code class="docutils literal notranslate">~/</code>, the <code class="docutils literal notranslate">~</code> is replaced by
the user's home directory. The path to the home directory is obtained from
environment variables. On Windows, the <code class="docutils literal notranslate">USERPROFILE</code> environment variable
is used, falling back to the <code class="docutils literal notranslate">HOME</code> environment variable if <code class="docutils literal notranslate">USERPROFILE</code>
is not defined. On all other platforms, only <code class="docutils literal notranslate">HOME</code> is used.
</dd>
</dl>
<div class="highlight-cmake notranslate" id="relative-path"><div class="highlight"><pre>file(RELATIVE_PATH &lt;variable&gt; &lt;directory&gt; &lt;file&gt;)
</pre></div>
</div>
Compute the relative path from a <code class="docutils literal notranslate">&lt;directory&gt;</code> to a <code class="docutils literal notranslate">&lt;file&gt;</code> and
store it in the <code class="docutils literal notranslate">&lt;variable&gt;</code>.
<div class="highlight-cmake notranslate" id="to-native-path"><div class="highlight"><pre>file(TO_CMAKE_PATH &quot;&lt;path&gt;&quot; &lt;variable&gt;)
file(TO_NATIVE_PATH &quot;&lt;path&gt;&quot; &lt;variable&gt;)
</pre></div>
</div>
The <code class="docutils literal notranslate">TO_CMAKE_PATH</code> mode converts a native <code class="docutils literal notranslate">&lt;path&gt;</code> into a cmake-style
path with forward-slashes (<code class="docutils literal notranslate">/</code>). The input can be a single path or a
system search path like <code class="docutils literal notranslate">$ENV{PATH}</code>. A search path will be converted
to a cmake-style list separated by <code class="docutils literal notranslate">;</code> characters.
The <code class="docutils literal notranslate">TO_NATIVE_PATH</code> mode converts a cmake-style <code class="docutils literal notranslate">&lt;path&gt;</code> into a native
path with platform-specific slashes (<code class="docutils literal notranslate">\</code> on Windows hosts and <code class="docutils literal notranslate">/</code>
elsewhere).
Always use double quotes around the <code class="docutils literal notranslate">&lt;path&gt;</code> to be sure it is treated
as a single argument to this command.
</section>
<section id="transfer">
<h2>Transfer<a class="headerlink" href="#transfer" title="Permalink to this heading">¶</a></h2>
<div class="highlight-cmake notranslate" id="upload"><div class="highlight"><pre>file(DOWNLOAD &lt;url&gt; [&lt;file&gt;] [&lt;options&gt;...])
file(UPLOAD &lt;file&gt; &lt;url&gt; [&lt;options&gt;...])
</pre></div>
</div>
The <code class="docutils literal notranslate">DOWNLOAD</code> subcommand downloads the given <code class="docutils literal notranslate">&lt;url&gt;</code> to a local <code class="docutils literal notranslate">&lt;file&gt;</code>.
The <code class="docutils literal notranslate">UPLOAD</code> mode uploads a local <code class="docutils literal notranslate">&lt;file&gt;</code> to a given <code class="docutils literal notranslate">&lt;url&gt;</code>.
<div class="versionadded">
New in version 3.19: If <code class="docutils literal notranslate">&lt;file&gt;</code> is not specified for <code class="docutils literal notranslate">file(DOWNLOAD)</code>, the file is not saved.
This can be useful if you want to know if a file can be downloaded (for example,
to check that it exists) without actually saving it anywhere.
</div>
Options to both <code class="docutils literal notranslate">DOWNLOAD</code> and <code class="docutils literal notranslate">UPLOAD</code> are:
<dl>
<dt><code class="docutils literal notranslate">INACTIVITY_TIMEOUT &lt;seconds&gt;</code></dt><dd>Terminate the operation after a period of inactivity.
</dd>
<dt><code class="docutils literal notranslate">LOG &lt;variable&gt;</code></dt><dd>Store a human-readable log of the operation in a variable.
</dd>
<dt><code class="docutils literal notranslate">SHOW_PROGRESS</code></dt><dd>Print progress information as status messages until the operation is
complete.
</dd>
<dt><code class="docutils literal notranslate">STATUS &lt;variable&gt;</code></dt><dd>Store the resulting status of the operation in a variable.
The status is a <code class="docutils literal notranslate">;</code> separated list of length 2.
The first element is the numeric return value for the operation,
and the second element is a string value for the error.
A <code class="docutils literal notranslate">0</code> numeric error means no error in the operation.
</dd>
<dt><code class="docutils literal notranslate">TIMEOUT &lt;seconds&gt;</code></dt><dd>Terminate the operation after a given total time has elapsed.
</dd>
<dt><code class="docutils literal notranslate">USERPWD &lt;username&gt;:&lt;password&gt;</code></dt><dd><div class="versionadded">
New in version 3.7.
</div>
Set username and password for operation.
</dd>
<dt><code class="docutils literal notranslate">HTTPHEADER &lt;HTTP-header&gt;</code></dt><dd><div class="versionadded">
New in version 3.7.
</div>
HTTP header for operation. Suboption can be repeated several times.
</dd>
<dt><code class="docutils literal notranslate">NETRC &lt;level&gt;</code></dt><dd><div class="versionadded">
New in version 3.11.
</div>
Specify whether the .netrc file is to be used for operation. If this
option is not specified, the value of the <a class="reference internal" href="../variable/CMAKE_NETRC.html#variable:CMAKE_NETRC" title="CMAKE_NETRC"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_NETRC</code></a> variable
will be used instead.
Valid levels are:
<dl class="simple">
<dt><code class="docutils literal notranslate">IGNORED</code></dt><dd>The .netrc file is ignored.
This is the default.
</dd>
<dt><code class="docutils literal notranslate">OPTIONAL</code></dt><dd>The .netrc file is optional, and information in the URL is preferred.
The file will be scanned to find which ever information is not specified
in the URL.
</dd>
<dt><code class="docutils literal notranslate">REQUIRED</code></dt><dd>The .netrc file is required, and information in the URL is ignored.
</dd>
</dl>
</dd>
<dt><code class="docutils literal notranslate">NETRC_FILE &lt;file&gt;</code></dt><dd><div class="versionadded">
New in version 3.11.
</div>
Specify an alternative .netrc file to the one in your home directory,
if the <code class="docutils literal notranslate">NETRC</code> level is <code class="docutils literal notranslate">OPTIONAL</code> or <code class="docutils literal notranslate">REQUIRED</code>. If this option
is not specified, the value of the <a class="reference internal" href="../variable/CMAKE_NETRC_FILE.html#variable:CMAKE_NETRC_FILE" title="CMAKE_NETRC_FILE"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_NETRC_FILE</code></a> variable will
be used instead.
</dd>
<dt><code class="docutils literal notranslate">TLS_VERIFY &lt;ON|OFF&gt;</code></dt><dd>Specify whether to verify the server certificate for <code class="docutils literal notranslate">https://</code> URLs.
The default is to not verify. If this option is not specified, the value
of the <a class="reference internal" href="../variable/CMAKE_TLS_VERIFY.html#variable:CMAKE_TLS_VERIFY" title="CMAKE_TLS_VERIFY"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_TLS_VERIFY</code></a> variable will be used instead.
<div class="versionadded">
New in version 3.18: Added support to <code class="docutils literal notranslate">file(UPLOAD)</code>.
</div>
</dd>
<dt><code class="docutils literal notranslate">TLS_CAINFO &lt;file&gt;</code></dt><dd>Specify a custom Certificate Authority file for <code class="docutils literal notranslate">https://</code> URLs. If this
option is not specified, the value of the <a class="reference internal" href="../variable/CMAKE_TLS_CAINFO.html#variable:CMAKE_TLS_CAINFO" title="CMAKE_TLS_CAINFO"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_TLS_CAINFO</code></a>
variable will be used instead.
<div class="versionadded">
New in version 3.18: Added support to <code class="docutils literal notranslate">file(UPLOAD)</code>.
</div>
</dd>
</dl>
For <code class="docutils literal notranslate">https://</code> URLs CMake must be built with OpenSSL support. <code class="docutils literal notranslate">TLS/SSL</code>
certificates are not checked by default. Set <code class="docutils literal notranslate">TLS_VERIFY</code> to <code class="docutils literal notranslate">ON</code> to
check certificates.
Additional options to <code class="docutils literal notranslate">DOWNLOAD</code> are:
<code class="docutils literal notranslate">EXPECTED_HASH ALGO=&lt;value&gt;</code>
<blockquote>
<div>Verify that the downloaded content hash matches the expected value, where
<code class="docutils literal notranslate">ALGO</code> is one of the algorithms supported by <code class="docutils literal notranslate">file(&lt;HASH&gt;)</code>.
If the file already exists and matches the hash, the download is skipped.
If the file already exists and does not match the hash, the file is
downloaded again. If after download the file does not match the hash, the
operation fails with an error. It is an error to specify this option if
<code class="docutils literal notranslate">DOWNLOAD</code> is not given a <code class="docutils literal notranslate">&lt;file&gt;</code>.
</div></blockquote>
<dl>
<dt><code class="docutils literal notranslate">EXPECTED_MD5 &lt;value&gt;</code></dt><dd>Historical short-hand for <code class="docutils literal notranslate">EXPECTED_HASH MD5=&lt;value&gt;</code>. It is an error to
specify this if <code class="docutils literal notranslate">DOWNLOAD</code> is not given a <code class="docutils literal notranslate">&lt;file&gt;</code>.
</dd>
<dt><code class="docutils literal notranslate">RANGE_START &lt;value&gt;</code></dt><dd><div class="versionadded">
New in version 3.24.
</div>
Offset of the start of the range in file in bytes. Could be omitted to
download up to the specified <code class="docutils literal notranslate">RANGE_END</code>.
</dd>
<dt><code class="docutils literal notranslate">RANGE_END &lt;value&gt;</code></dt><dd><div class="versionadded">
New in version 3.24.
</div>
Offset of the end of the range in file in bytes. Could be omitted to
download everything from the specified <code class="docutils literal notranslate">RANGE_START</code> to the end of file.
</dd>
</dl>
</section>
<section id="locking">
<h2>Locking<a class="headerlink" href="#locking" title="Permalink to this heading">¶</a></h2>
<div class="highlight-cmake notranslate" id="lock"><div class="highlight"><pre>file(LOCK &lt;path&gt; [DIRECTORY] [RELEASE]
 [GUARD &lt;FUNCTION|FILE|PROCESS&gt;]
 [RESULT_VARIABLE &lt;variable&gt;]
 [TIMEOUT &lt;seconds&gt;])
</pre></div>
</div>
<div class="versionadded">
New in version 3.2.
</div>
Lock a file specified by <code class="docutils literal notranslate">&lt;path&gt;</code> if no <code class="docutils literal notranslate">DIRECTORY</code> option present and file
<code class="docutils literal notranslate">&lt;path&gt;/cmake.lock</code> otherwise. File will be locked for scope defined by
<code class="docutils literal notranslate">GUARD</code> option (default value is <code class="docutils literal notranslate">PROCESS</code>). <code class="docutils literal notranslate">RELEASE</code> option can be used
to unlock file explicitly. If option <code class="docutils literal notranslate">TIMEOUT</code> is not specified CMake will
wait until lock succeed or until fatal error occurs. If <code class="docutils literal notranslate">TIMEOUT</code> is set to
<code class="docutils literal notranslate">0</code> lock will be tried once and result will be reported immediately. If
<code class="docutils literal notranslate">TIMEOUT</code> is not <code class="docutils literal notranslate">0</code> CMake will try to lock file for the period specified
by <code class="docutils literal notranslate">&lt;seconds&gt;</code> value. Any errors will be interpreted as fatal if there is no
<code class="docutils literal notranslate">RESULT_VARIABLE</code> option. Otherwise result will be stored in <code class="docutils literal notranslate">&lt;variable&gt;</code>
and will be <code class="docutils literal notranslate">0</code> on success or error message on failure.
Note that lock is advisory - there is no guarantee that other processes will
respect this lock, i.e. lock synchronize two or more CMake instances sharing
some modifiable resources. Similar logic applied to <code class="docutils literal notranslate">DIRECTORY</code> option -
locking parent directory doesn't prevent other <code class="docutils literal notranslate">LOCK</code> commands to lock any
child directory or file.
Trying to lock file twice is not allowed. Any intermediate directories and
file itself will be created if they not exist. <code class="docutils literal notranslate">GUARD</code> and <code class="docutils literal notranslate">TIMEOUT</code>
options ignored on <code class="docutils literal notranslate">RELEASE</code> operation.
</section>
<section id="archiving">
<h2>Archiving<a class="headerlink" href="#archiving" title="Permalink to this heading">¶</a></h2>
<div class="highlight-cmake notranslate" id="archive-create"><div class="highlight"><pre>file(ARCHIVE_CREATE OUTPUT &lt;archive&gt;
 PATHS &lt;paths&gt;...
 [FORMAT &lt;format&gt;]
 [COMPRESSION &lt;compression&gt; [COMPRESSION_LEVEL &lt;compression-level&gt;]]
 [MTIME &lt;mtime&gt;]
 [VERBOSE])
</pre></div>
</div>
<div class="versionadded">
New in version 3.18.
</div>
Creates the specified <code class="docutils literal notranslate">&lt;archive&gt;</code> file with the files and directories
listed in <code class="docutils literal notranslate">&lt;paths&gt;</code>. Note that <code class="docutils literal notranslate">&lt;paths&gt;</code> must list actual files or
directories, wildcards are not supported.
Use the <code class="docutils literal notranslate">FORMAT</code> option to specify the archive format. Supported values
for <code class="docutils literal notranslate">&lt;format&gt;</code> are <code class="docutils literal notranslate">7zip</code>, <code class="docutils literal notranslate">gnutar</code>, <code class="docutils literal notranslate">pax</code>, <code class="docutils literal notranslate">paxr</code>, <code class="docutils literal notranslate">raw</code> and
<code class="docutils literal notranslate">zip</code>. If <code class="docutils literal notranslate">FORMAT</code> is not given, the default format is <code class="docutils literal notranslate">paxr</code>.
Some archive formats allow the type of compression to be specified.
The <code class="docutils literal notranslate">7zip</code> and <code class="docutils literal notranslate">zip</code> archive formats already imply a specific type of
compression. The other formats use no compression by default, but can be
directed to do so with the <code class="docutils literal notranslate">COMPRESSION</code> option. Valid values for
<code class="docutils literal notranslate">&lt;compression&gt;</code> are <code class="docutils literal notranslate">None</code>, <code class="docutils literal notranslate">BZip2</code>, <code class="docutils literal notranslate">GZip</code>, <code class="docutils literal notranslate">XZ</code>, and <code class="docutils literal notranslate">Zstd</code>.
<div class="versionadded">
New in version 3.19: The compression level can be specified with the <code class="docutils literal notranslate">COMPRESSION_LEVEL</code> option.
The <code class="docutils literal notranslate">&lt;compression-level&gt;</code> should be between 0-9, with the default being 0.
The <code class="docutils literal notranslate">COMPRESSION</code> option must be present when <code class="docutils literal notranslate">COMPRESSION_LEVEL</code> is given.
</div>
<div class="versionadded">
New in version 3.26: The <code class="docutils literal notranslate">&lt;compression-level&gt;</code> of the <code class="docutils literal notranslate">Zstd</code> algorithm can be set between 0-19.
</div>
<div class="admonition note">
Note
With <code class="docutils literal notranslate">FORMAT</code> set to <code class="docutils literal notranslate">raw</code> only one file will be compressed with the
compression type specified by <code class="docutils literal notranslate">COMPRESSION</code>.
</div>
The <code class="docutils literal notranslate">VERBOSE</code> option enables verbose output for the archive operation.
To specify the modification time recorded in tarball entries, use
the <code class="docutils literal notranslate">MTIME</code> option.
<div class="highlight-cmake notranslate" id="archive-extract"><div class="highlight"><pre>file(ARCHIVE_EXTRACT INPUT &lt;archive&gt;
 [DESTINATION &lt;dir&gt;]
 [PATTERNS &lt;patterns&gt;...]
 [LIST_ONLY]
 [VERBOSE]
 [TOUCH])
</pre></div>
</div>
<div class="versionadded">
New in version 3.18.
</div>
Extracts or lists the content of the specified <code class="docutils literal notranslate">&lt;archive&gt;</code>.
The directory where the content of the archive will be extracted to can
be specified using the <code class="docutils literal notranslate">DESTINATION</code> option. If the directory does not
exist, it will be created. If <code class="docutils literal notranslate">DESTINATION</code> is not given, the current
binary directory will be used.
If required, you may select which files and directories to list or extract
from the archive using the specified <code class="docutils literal notranslate">&lt;patterns&gt;</code>. Wildcards are supported.
If the <code class="docutils literal notranslate">PATTERNS</code> option is not given, the entire archive will be listed or
extracted.
<code class="docutils literal notranslate">LIST_ONLY</code> will list the files in the archive rather than extract them.
<div class="versionadded">
New in version 3.24: The <code class="docutils literal notranslate">TOUCH</code> option gives extracted files a current local
timestamp instead of extracting file timestamps from the archive.
</div>
With <code class="docutils literal notranslate">VERBOSE</code>, the command will produce verbose output.
</section>
</section>

<div class="clearer"></div>
 </div>
 </div>
 </div>
 <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
 <div class="sphinxsidebarwrapper">
 <div>
 <h3><a href="../index.html">Table of Contents</a></h3>
 <ul>
<li><a class="reference internal" href="#">file</a><ul>
<li><a class="reference internal" href="#synopsis">Synopsis</a></li>
<li><a class="reference internal" href="#reading">Reading</a></li>
<li><a class="reference internal" href="#writing">Writing</a></li>
<li><a class="reference internal" href="#filesystem">Filesystem</a></li>
<li><a class="reference internal" href="#path-conversion">Path Conversion</a></li>
<li><a class="reference internal" href="#transfer">Transfer</a></li>
<li><a class="reference internal" href="#locking">Locking</a></li>
<li><a class="reference internal" href="#archiving">Archiving</a></li>
</ul>
</li>
</ul>

</div>
 <div>
 <h4>Previous topic</h4>
 <a href="execute_process.html"
 title="previous chapter">execute_process</a>
 </div>
 <div>
 <h4>Next topic</h4>
 <a href="find_file.html"
 title="next chapter">find_file</a>
 </div>
 <div role="note" aria-label="source link">
 <h3>This Page</h3>
 <ul class="this-page-menu">
 <li><a href="../_sources/command/file.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>document.getElementById('searchbox').style.display = "block"</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="find_file.html" title="find_file"
 >next</a> |</li>
 <li class="right" >
 <a href="execute_process.html" title="execute_process"
 >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.26.3 Documentation</a> &#187;
 </li>

<li class="nav-item nav-item-1"><a href="../manual/cmake-commands.7.html" >cmake-commands(7)</a> &#187;</li>
 <li class="nav-item nav-item-this"><a href="">file</a></li> 
 </ul>
 </div>

<div class="footer" role="contentinfo">
 &#169; Copyright 2000-2023 Kitware, Inc. and Contributors.
 Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.0.2.
 </div>
 </body>
</html>