Convert builtin help to reStructuredText source files

Run the convert-help.bash script to convert documentation:

 ./convert-help.bash "/path/to/CMake-build/bin"

Then remove it.

Help/variable/APPLE.rst

@@ -0,0 +1,6 @@
+APPLE
+-----
+
+True if running on Mac OS X.
+
+Set to true on Mac OS X.

Help/variable/BORLAND.rst

@@ -0,0 +1,6 @@
+BORLAND
+-------
+
+True if the Borland compiler is being used.
+
+This is set to true if the Borland compiler is being used.

Help/variable/BUILD_SHARED_LIBS.rst

@@ -0,0 +1,10 @@
+BUILD_SHARED_LIBS
+-----------------
+
+Global flag to cause add_library to create shared libraries if on.
+
+If present and true, this will cause all libraries to be built shared
+unless the library was explicitly added as a static library.  This
+variable is often added to projects as an OPTION so that each user of
+a project can decide if they want to build the project using shared or
+static libraries.

Help/variable/CMAKE_ABSOLUTE_DESTINATION_FILES.rst

@@ -0,0 +1,9 @@
+CMAKE_ABSOLUTE_DESTINATION_FILES
+--------------------------------
+
+List of files which have been installed using  an ABSOLUTE DESTINATION path.
+
+This variable is defined by CMake-generated cmake_install.cmake
+scripts.  It can be used (read-only) by programs or scripts that
+source those install scripts.  This is used by some CPack generators
+(e.g.  RPM).

Help/variable/CMAKE_AR.rst

@@ -0,0 +1,7 @@
+CMAKE_AR
+--------
+
+Name of archiving tool for static libraries.
+
+This specifies the name of the program that creates archive or static
+libraries.

Help/variable/CMAKE_ARCHIVE_OUTPUT_DIRECTORY.rst

@@ -0,0 +1,8 @@
+CMAKE_ARCHIVE_OUTPUT_DIRECTORY
+------------------------------
+
+Where to put all the ARCHIVE targets when built.
+
+This variable is used to initialize the ARCHIVE_OUTPUT_DIRECTORY
+property on all the targets.  See that target property for additional
+information.

Help/variable/CMAKE_ARGC.rst

@@ -0,0 +1,7 @@
+CMAKE_ARGC
+----------
+
+Number of command line arguments passed to CMake in script mode.
+
+When run in -P script mode, CMake sets this variable to the number of
+command line arguments.  See also CMAKE_ARGV0, 1, 2 ...

Help/variable/CMAKE_ARGV0.rst

@@ -0,0 +1,9 @@
+CMAKE_ARGV0
+-----------
+
+Command line argument passed to CMake in script mode.
+
+When run in -P script mode, CMake sets this variable to the first
+command line argument.  It then also sets CMAKE_ARGV1, CMAKE_ARGV2,
+...  and so on, up to the number of command line arguments given.  See
+also CMAKE_ARGC.

Help/variable/CMAKE_AUTOMOC.rst

@@ -0,0 +1,7 @@
+CMAKE_AUTOMOC
+-------------
+
+Whether to handle moc automatically for Qt targets.
+
+This variable is used to initialize the AUTOMOC property on all the
+targets.  See that target property for additional information.

Help/variable/CMAKE_AUTOMOC_MOC_OPTIONS.rst

@@ -0,0 +1,8 @@
+CMAKE_AUTOMOC_MOC_OPTIONS
+-------------------------
+
+Additional options for moc when using automoc (see CMAKE_AUTOMOC).
+
+This variable is used to initialize the AUTOMOC_MOC_OPTIONS property
+on all the targets.  See that target property for additional
+information.

Help/variable/CMAKE_AUTOMOC_RELAXED_MODE.rst

@@ -0,0 +1,13 @@
+CMAKE_AUTOMOC_RELAXED_MODE
+--------------------------
+
+Switch between strict and relaxed automoc mode.
+
+By default, automoc behaves exactly as described in the documentation
+of the AUTOMOC target property.  When set to TRUE, it accepts more
+input and tries to find the correct input file for moc even if it
+differs from the documented behaviour.  In this mode it e.g.  also
+checks whether a header file is intended to be processed by moc when a
+"foo.moc" file has been included.
+
+Relaxed mode has to be enabled for KDE4 compatibility.

Help/variable/CMAKE_BACKWARDS_COMPATIBILITY.rst

@@ -0,0 +1,11 @@
+CMAKE_BACKWARDS_COMPATIBILITY
+-----------------------------
+
+Version of cmake required to build project
+
+From the point of view of backwards compatibility, this specifies what
+version of CMake should be supported.  By default this value is the
+version number of CMake that you are running.  You can set this to an
+older version of CMake to support deprecated commands of CMake in
+projects that were written to use older versions of CMake.  This can
+be set by the user or set at the beginning of a CMakeLists file.

Help/variable/CMAKE_BINARY_DIR.rst

@@ -0,0 +1,8 @@
+CMAKE_BINARY_DIR
+----------------
+
+The path to the top level of the build tree.
+
+This is the full path to the top level of the current CMake build
+tree.  For an in-source build, this would be the same as
+CMAKE_SOURCE_DIR.

Help/variable/CMAKE_BUILD_TOOL.rst

@@ -0,0 +1,11 @@
+CMAKE_BUILD_TOOL
+----------------
+
+Tool used for the actual build process.
+
+This variable is set to the program that will be needed to build the
+output of CMake.  If the generator selected was Visual Studio 6, the
+CMAKE_BUILD_TOOL will be set to msdev, for Unix Makefiles it will be
+set to make or gmake, and for Visual Studio 7 it set to devenv.  For
+NMake Makefiles the value is nmake.  This can be useful for adding
+special flags and commands based on the final build environment.

Help/variable/CMAKE_BUILD_TYPE.rst

@@ -0,0 +1,19 @@
+CMAKE_BUILD_TYPE
+----------------
+
+Specifies the build type on single-configuration generators.
+
+This statically specifies what build type (configuration) will be
+built in this build tree.  Possible values are empty, Debug, Release,
+RelWithDebInfo and MinSizeRel.  This variable is only meaningful to
+single-configuration generators (such as make and Ninja) i.e.  those
+which choose a single configuration when CMake runs to generate a
+build tree as opposed to multi-configuration generators which offer
+selection of the build configuration within the generated build
+environment.  There are many per-config properties and variables
+(usually following clean SOME_VAR_<CONFIG> order conventions), such as
+CMAKE_C_FLAGS_<CONFIG>, specified as uppercase:
+CMAKE_C_FLAGS_[DEBUG|RELEASE|RELWITHDEBINFO|MINSIZEREL].  For example,
+in a build tree configured to build type Debug, CMake will see to
+having CMAKE_C_FLAGS_DEBUG settings get added to the CMAKE_C_FLAGS
+settings.  See also CMAKE_CONFIGURATION_TYPES.

Help/variable/CMAKE_BUILD_WITH_INSTALL_RPATH.rst

@@ -0,0 +1,11 @@
+CMAKE_BUILD_WITH_INSTALL_RPATH
+------------------------------
+
+Use the install path for the RPATH
+
+Normally CMake uses the build tree for the RPATH when building
+executables etc on systems that use RPATH.  When the software is
+installed the executables etc are relinked by CMake to have the
+install RPATH.  If this variable is set to true then the software is
+always built with the install path for the RPATH and does not need to
+be relinked when installed.

Help/variable/CMAKE_CACHEFILE_DIR.rst

@@ -0,0 +1,7 @@
+CMAKE_CACHEFILE_DIR
+-------------------
+
+The directory with the CMakeCache.txt file.
+
+This is the full path to the directory that has the CMakeCache.txt
+file in it.  This is the same as CMAKE_BINARY_DIR.

Help/variable/CMAKE_CACHE_MAJOR_VERSION.rst

@@ -0,0 +1,8 @@
+CMAKE_CACHE_MAJOR_VERSION
+-------------------------
+
+Major version of CMake used to create the CMakeCache.txt file
+
+This stores the major version of CMake used to write a CMake cache
+file.  It is only different when a different version of CMake is run
+on a previously created cache file.

Help/variable/CMAKE_CACHE_MINOR_VERSION.rst

@@ -0,0 +1,8 @@
+CMAKE_CACHE_MINOR_VERSION
+-------------------------
+
+Minor version of CMake used to create the CMakeCache.txt file
+
+This stores the minor version of CMake used to write a CMake cache
+file.  It is only different when a different version of CMake is run
+on a previously created cache file.

Help/variable/CMAKE_CACHE_PATCH_VERSION.rst

@@ -0,0 +1,8 @@
+CMAKE_CACHE_PATCH_VERSION
+-------------------------
+
+Patch version of CMake used to create the CMakeCache.txt file
+
+This stores the patch version of CMake used to write a CMake cache
+file.  It is only different when a different version of CMake is run
+on a previously created cache file.

Help/variable/CMAKE_CFG_INTDIR.rst

@@ -0,0 +1,45 @@
+CMAKE_CFG_INTDIR
+----------------
+
+Build-time reference to per-configuration output subdirectory.
+
+For native build systems supporting multiple configurations in the
+build tree (such as Visual Studio and Xcode), the value is a reference
+to a build-time variable specifying the name of the per-configuration
+output subdirectory.  On Makefile generators this evaluates to "."
+because there is only one configuration in a build tree.  Example
+values:
+
+::
+
+  $(IntDir)        = Visual Studio 6
+  $(OutDir)        = Visual Studio 7, 8, 9
+  $(Configuration) = Visual Studio 10
+  $(CONFIGURATION) = Xcode
+  .                = Make-based tools
+
+Since these values are evaluated by the native build system, this
+variable is suitable only for use in command lines that will be
+evaluated at build time.  Example of intended usage:
+
+::
+
+  add_executable(mytool mytool.c)
+  add_custom_command(
+    OUTPUT out.txt
+    COMMAND ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_CFG_INTDIR}/mytool
+            ${CMAKE_CURRENT_SOURCE_DIR}/in.txt out.txt
+    DEPENDS mytool in.txt
+    )
+  add_custom_target(drive ALL DEPENDS out.txt)
+
+Note that CMAKE_CFG_INTDIR is no longer necessary for this purpose but
+has been left for compatibility with existing projects.  Instead
+add_custom_command() recognizes executable target names in its COMMAND
+option, so "${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_CFG_INTDIR}/mytool"
+can be replaced by just "mytool".
+
+This variable is read-only.  Setting it is undefined behavior.  In
+multi-configuration build systems the value of this variable is passed
+as the value of preprocessor symbol "CMAKE_INTDIR" to the compilation
+of all source files.

Help/variable/CMAKE_CL_64.rst

@@ -0,0 +1,6 @@
+CMAKE_CL_64
+-----------
+
+Using the 64 bit compiler from Microsoft
+
+Set to true when using the 64 bit cl compiler from Microsoft.

Help/variable/CMAKE_COLOR_MAKEFILE.rst

@@ -0,0 +1,7 @@
+CMAKE_COLOR_MAKEFILE
+--------------------
+
+Enables color output when using the Makefile generator.
+
+When enabled, the generated Makefiles will produce colored output.
+Default is ON.

Help/variable/CMAKE_COMMAND.rst

@@ -0,0 +1,8 @@
+CMAKE_COMMAND
+-------------
+
+The full path to the cmake executable.
+
+This is the full path to the CMake executable cmake which is useful
+from custom commands that want to use the cmake -E option for portable
+system commands.  (e.g.  /usr/local/bin/cmake

Help/variable/CMAKE_COMPILER_2005.rst

@@ -0,0 +1,6 @@
+CMAKE_COMPILER_2005
+-------------------
+
+Using the Visual Studio 2005 compiler from Microsoft
+
+Set to true when using the Visual Studio 2005 compiler from Microsoft.

Help/variable/CMAKE_COMPILER_IS_GNULANG.rst

@@ -0,0 +1,15 @@
+CMAKE_COMPILER_IS_GNU<LANG>
+---------------------------
+
+True if the compiler is GNU.
+
+If the selected <LANG> compiler is the GNU compiler then this is TRUE,
+if not it is FALSE.  Unlike the other per-language variables, this
+uses the GNU syntax for identifying languages instead of the CMake
+syntax.  Recognized values of the <LANG> suffix are:
+
+::
+
+  CC = C compiler
+  CXX = C++ compiler
+  G77 = Fortran compiler

Help/variable/CMAKE_CONFIGURATION_TYPES.rst

@@ -0,0 +1,10 @@
+CMAKE_CONFIGURATION_TYPES
+-------------------------
+
+Specifies the available build types on multi-config generators.
+
+This specifies what build types (configurations) will be available
+such as Debug, Release, RelWithDebInfo etc.  This has reasonable
+defaults on most platforms, but can be extended to provide other build
+types.  See also CMAKE_BUILD_TYPE for details of managing
+configuration data, and CMAKE_CFG_INTDIR.

Help/variable/CMAKE_CONFIG_POSTFIX.rst

@@ -0,0 +1,7 @@
+CMAKE_<CONFIG>_POSTFIX
+----------------------
+
+Default filename postfix for libraries under configuration <CONFIG>.
+
+When a non-executable target is created its <CONFIG>_POSTFIX target
+property is initialized with the value of this variable if it is set.

Help/variable/CMAKE_CROSSCOMPILING.rst

@@ -0,0 +1,8 @@
+CMAKE_CROSSCOMPILING
+--------------------
+
+Is CMake currently cross compiling.
+
+This variable will be set to true by CMake if CMake is cross
+compiling.  Specifically if the build platform is different from the
+target platform.

Help/variable/CMAKE_CTEST_COMMAND.rst

@@ -0,0 +1,8 @@
+CMAKE_CTEST_COMMAND
+-------------------
+
+Full path to ctest command installed with cmake.
+
+This is the full path to the CTest executable ctest which is useful
+from custom commands that want to use the cmake -E option for portable
+system commands.

Help/variable/CMAKE_CURRENT_BINARY_DIR.rst

@@ -0,0 +1,10 @@
+CMAKE_CURRENT_BINARY_DIR
+------------------------
+
+The path to the binary directory currently being processed.
+
+This the full path to the build directory that is currently being
+processed by cmake.  Each directory added by add_subdirectory will
+create a binary directory in the build tree, and as it is being
+processed this variable will be set.  For in-source builds this is the
+current source directory being processed.

Help/variable/CMAKE_CURRENT_LIST_DIR.rst

@@ -0,0 +1,17 @@
+CMAKE_CURRENT_LIST_DIR
+----------------------
+
+Full directory of the listfile currently being processed.
+
+As CMake processes the listfiles in your project this variable will
+always be set to the directory where the listfile which is currently
+being processed (CMAKE_CURRENT_LIST_FILE) is located.  The value has
+dynamic scope.  When CMake starts processing commands in a source file
+it sets this variable to the directory where this file is located.
+When CMake finishes processing commands from the file it restores the
+previous value.  Therefore the value of the variable inside a macro or
+function is the directory of the file invoking the bottom-most entry
+on the call stack, not the directory of the file containing the macro
+or function definition.
+
+See also CMAKE_CURRENT_LIST_FILE.

Help/variable/CMAKE_CURRENT_LIST_FILE.rst

@@ -0,0 +1,15 @@
+CMAKE_CURRENT_LIST_FILE
+-----------------------
+
+Full path to the listfile currently being processed.
+
+As CMake processes the listfiles in your project this variable will
+always be set to the one currently being processed.  The value has
+dynamic scope.  When CMake starts processing commands in a source file
+it sets this variable to the location of the file.  When CMake
+finishes processing commands from the file it restores the previous
+value.  Therefore the value of the variable inside a macro or function
+is the file invoking the bottom-most entry on the call stack, not the
+file containing the macro or function definition.
+
+See also CMAKE_PARENT_LIST_FILE.

Help/variable/CMAKE_CURRENT_LIST_LINE.rst

@@ -0,0 +1,7 @@
+CMAKE_CURRENT_LIST_LINE
+-----------------------
+
+The line number of the current file being processed.
+
+This is the line number of the file currently being processed by
+cmake.

Help/variable/CMAKE_CURRENT_SOURCE_DIR.rst

@@ -0,0 +1,7 @@
+CMAKE_CURRENT_SOURCE_DIR
+------------------------
+
+The path to the source directory currently being processed.
+
+This the full path to the source directory that is currently being
+processed by cmake.

Help/variable/CMAKE_DEBUG_POSTFIX.rst

@@ -0,0 +1,7 @@
+CMAKE_DEBUG_POSTFIX
+-------------------
+
+See variable CMAKE_<CONFIG>_POSTFIX.
+
+This variable is a special case of the more-general
+CMAKE_<CONFIG>_POSTFIX variable for the DEBUG configuration.

Help/variable/CMAKE_DEBUG_TARGET_PROPERTIES.rst

@@ -0,0 +1,11 @@
+CMAKE_DEBUG_TARGET_PROPERTIES
+-----------------------------
+
+Enables tracing output for target properties.
+
+This variable can be populated with a list of properties to generate
+debug output for when evaluating target properties.  Currently it can
+only be used when evaluating the INCLUDE_DIRECTORIES,
+COMPILE_DEFINITIONS and COMPILE_OPTIONS target properties.  In that
+case, it outputs a backtrace for each entry in the target property.
+Default is unset.

Help/variable/CMAKE_DISABLE_FIND_PACKAGE_PackageName.rst

@@ -0,0 +1,15 @@
+CMAKE_DISABLE_FIND_PACKAGE_<PackageName>
+----------------------------------------
+
+Variable for disabling find_package() calls.
+
+Every non-REQUIRED find_package() call in a project can be disabled by
+setting the variable CMAKE_DISABLE_FIND_PACKAGE_<PackageName> to TRUE.
+This can be used to build a project without an optional package,
+although that package is installed.
+
+This switch should be used during the initial CMake run.  Otherwise if
+the package has already been found in a previous CMake run, the
+variables which have been stored in the cache will still be there.  In
+that case it is recommended to remove the cache variables for this
+package from the cache using the cache editor or cmake -U

Help/variable/CMAKE_DL_LIBS.rst

@@ -0,0 +1,7 @@
+CMAKE_DL_LIBS
+-------------
+
+Name of library containing dlopen and dlcose.
+
+The name of the library that has dlopen and dlclose in it, usually
+-ldl on most UNIX machines.

Help/variable/CMAKE_EDIT_COMMAND.rst

@@ -0,0 +1,7 @@
+CMAKE_EDIT_COMMAND
+------------------
+
+Full path to cmake-gui or ccmake.
+
+This is the full path to the CMake executable that can graphically
+edit the cache.  For example, cmake-gui, ccmake, or cmake -i.

Help/variable/CMAKE_ERROR_DEPRECATED.rst

@@ -0,0 +1,8 @@
+CMAKE_ERROR_DEPRECATED
+----------------------
+
+Whether to issue deprecation errors for macros and functions.
+
+If TRUE, this can be used by macros and functions to issue fatal
+errors when deprecated macros or functions are used.  This variable is
+FALSE by default.

Help/variable/CMAKE_ERROR_ON_ABSOLUTE_INSTALL_DESTINATION.rst

@@ -0,0 +1,9 @@
+CMAKE_ERROR_ON_ABSOLUTE_INSTALL_DESTINATION
+-------------------------------------------
+
+Ask cmake_install.cmake script to error out as soon as a file with absolute INSTALL DESTINATION is encountered.
+
+The fatal error is emitted before the installation of the offending
+file takes place.  This variable is used by CMake-generated
+cmake_install.cmake scripts.  If one sets this variable to ON while
+running the script, it may get fatal error messages from the script.

Help/variable/CMAKE_EXECUTABLE_SUFFIX.rst

@@ -0,0 +1,9 @@
+CMAKE_EXECUTABLE_SUFFIX
+-----------------------
+
+The suffix for executables on this platform.
+
+The suffix to use for the end of an executable filename if any, .exe
+on Windows.
+
+CMAKE_EXECUTABLE_SUFFIX_<LANG> overrides this for language <LANG>.

Help/variable/CMAKE_EXE_LINKER_FLAGS.rst

@@ -0,0 +1,6 @@
+CMAKE_EXE_LINKER_FLAGS
+----------------------
+
+Linker flags to be used to create executables.
+
+These flags will be used by the linker when creating an executable.

Help/variable/CMAKE_EXE_LINKER_FLAGS_CONFIG.rst

@@ -0,0 +1,7 @@
+CMAKE_EXE_LINKER_FLAGS_<CONFIG>
+-------------------------------
+
+Flags to be used when linking an executable.
+
+Same as CMAKE_C_FLAGS_* but used by the linker when creating
+executables.

Help/variable/CMAKE_EXTRA_GENERATOR.rst

@@ -0,0 +1,9 @@
+CMAKE_EXTRA_GENERATOR
+---------------------
+
+The extra generator used to build the project.
+
+When using the Eclipse, CodeBlocks or KDevelop generators, CMake
+generates Makefiles (CMAKE_GENERATOR) and additionally project files
+for the respective IDE.  This IDE project file generator is stored in
+CMAKE_EXTRA_GENERATOR (e.g.  "Eclipse CDT4").

Help/variable/CMAKE_EXTRA_SHARED_LIBRARY_SUFFIXES.rst

@@ -0,0 +1,9 @@
+CMAKE_EXTRA_SHARED_LIBRARY_SUFFIXES
+-----------------------------------
+
+Additional suffixes for shared libraries.
+
+Extensions for shared libraries other than that specified by
+CMAKE_SHARED_LIBRARY_SUFFIX, if any.  CMake uses this to recognize
+external shared library files during analysis of libraries linked by a
+target.

Help/variable/CMAKE_FIND_LIBRARY_PREFIXES.rst

@@ -0,0 +1,9 @@
+CMAKE_FIND_LIBRARY_PREFIXES
+---------------------------
+
+Prefixes to prepend when looking for libraries.
+
+This specifies what prefixes to add to library names when the
+find_library command looks for libraries.  On UNIX systems this is
+typically lib, meaning that when trying to find the foo library it
+will look for libfoo.

Help/variable/CMAKE_FIND_LIBRARY_SUFFIXES.rst

@@ -0,0 +1,9 @@
+CMAKE_FIND_LIBRARY_SUFFIXES
+---------------------------
+
+Suffixes to append when looking for libraries.
+
+This specifies what suffixes to add to library names when the
+find_library command looks for libraries.  On Windows systems this is
+typically .lib and .dll, meaning that when trying to find the foo
+library it will look for foo.dll etc.

Help/variable/CMAKE_FIND_PACKAGE_WARN_NO_MODULE.rst

@@ -0,0 +1,19 @@
+CMAKE_FIND_PACKAGE_WARN_NO_MODULE
+---------------------------------
+
+Tell find_package to warn if called without an explicit mode.
+
+If find_package is called without an explicit mode option (MODULE,
+CONFIG or NO_MODULE) and no Find<pkg>.cmake module is in
+CMAKE_MODULE_PATH then CMake implicitly assumes that the caller
+intends to search for a package configuration file.  If no package
+configuration file is found then the wording of the failure message
+must account for both the case that the package is really missing and
+the case that the project has a bug and failed to provide the intended
+Find module.  If instead the caller specifies an explicit mode option
+then the failure message can be more specific.
+
+Set CMAKE_FIND_PACKAGE_WARN_NO_MODULE to TRUE to tell find_package to
+warn when it implicitly assumes Config mode.  This helps developers
+enforce use of an explicit mode in all calls to find_package within a
+project.

Help/variable/CMAKE_Fortran_FORMAT.rst

@@ -0,0 +1,7 @@
+CMAKE_Fortran_FORMAT
+--------------------
+
+Set to FIXED or FREE to indicate the Fortran source layout.
+
+This variable is used to initialize the Fortran_FORMAT property on all
+the targets.  See that target property for additional information.

Help/variable/CMAKE_Fortran_MODDIR_DEFAULT.rst

@@ -0,0 +1,8 @@
+CMAKE_Fortran_MODDIR_DEFAULT
+----------------------------
+
+Fortran default module output directory.
+
+Most Fortran compilers write .mod files to the current working
+directory.  For those that do not, this is set to "." and used when
+the Fortran_MODULE_DIRECTORY target property is not set.

Help/variable/CMAKE_Fortran_MODDIR_FLAG.rst

@@ -0,0 +1,7 @@
+CMAKE_Fortran_MODDIR_FLAG
+-------------------------
+
+Fortran flag for module output directory.
+
+This stores the flag needed to pass the value of the
+Fortran_MODULE_DIRECTORY target property to the compiler.

Help/variable/CMAKE_Fortran_MODOUT_FLAG.rst

@@ -0,0 +1,7 @@
+CMAKE_Fortran_MODOUT_FLAG
+-------------------------
+
+Fortran flag to enable module output.
+
+Most Fortran compilers write .mod files out by default.  For others,
+this stores the flag needed to enable module output.

Help/variable/CMAKE_Fortran_MODULE_DIRECTORY.rst

@@ -0,0 +1,8 @@
+CMAKE_Fortran_MODULE_DIRECTORY
+------------------------------
+
+Fortran module output directory.
+
+This variable is used to initialize the Fortran_MODULE_DIRECTORY
+property on all the targets.  See that target property for additional
+information.

Help/variable/CMAKE_GENERATOR.rst

@@ -0,0 +1,7 @@
+CMAKE_GENERATOR
+---------------
+
+The generator used to build the project.
+
+The name of the generator that is being used to generate the build
+files.  (e.g.  "Unix Makefiles", "Visual Studio 6", etc.)

Help/variable/CMAKE_GENERATOR_TOOLSET.rst

@@ -0,0 +1,9 @@
+CMAKE_GENERATOR_TOOLSET
+-----------------------
+
+Native build system toolset name specified by user.
+
+Some CMake generators support a toolset name to be given to the native
+build system to choose a compiler.  If the user specifies a toolset
+name (e.g.  via the cmake -T option) the value will be available in
+this variable.

Help/variable/CMAKE_GNUtoMS.rst

@@ -0,0 +1,8 @@
+CMAKE_GNUtoMS
+-------------
+
+Convert GNU import libraries (.dll.a) to MS format (.lib).
+
+This variable is used to initialize the GNUtoMS property on targets
+when they are created.  See that target property for additional
+information.

Help/variable/CMAKE_HOME_DIRECTORY.rst

@@ -0,0 +1,6 @@
+CMAKE_HOME_DIRECTORY
+--------------------
+
+Path to top of source tree.
+
+This is the path to the top level of the source tree.

Help/variable/CMAKE_HOST_APPLE.rst

@@ -0,0 +1,6 @@
+CMAKE_HOST_APPLE
+----------------
+
+True for Apple OS X operating systems.
+
+Set to true when the host system is Apple OS X.

Help/variable/CMAKE_HOST_SYSTEM.rst

@@ -0,0 +1,7 @@
+CMAKE_HOST_SYSTEM
+-----------------
+
+Name of system cmake is being run on.
+
+The same as CMAKE_SYSTEM but for the host system instead of the target
+system when cross compiling.

Help/variable/CMAKE_HOST_SYSTEM_NAME.rst

@@ -0,0 +1,7 @@
+CMAKE_HOST_SYSTEM_NAME
+----------------------
+
+Name of the OS CMake is running on.
+
+The same as CMAKE_SYSTEM_NAME but for the host system instead of the
+target system when cross compiling.

Help/variable/CMAKE_HOST_SYSTEM_PROCESSOR.rst

@@ -0,0 +1,7 @@
+CMAKE_HOST_SYSTEM_PROCESSOR
+---------------------------
+
+The name of the CPU CMake is running on.
+
+The same as CMAKE_SYSTEM_PROCESSOR but for the host system instead of
+the target system when cross compiling.

Help/variable/CMAKE_HOST_SYSTEM_VERSION.rst

@@ -0,0 +1,7 @@
+CMAKE_HOST_SYSTEM_VERSION
+-------------------------
+
+OS version CMake is running on.
+
+The same as CMAKE_SYSTEM_VERSION but for the host system instead of
+the target system when cross compiling.

Help/variable/CMAKE_HOST_UNIX.rst

@@ -0,0 +1,7 @@
+CMAKE_HOST_UNIX
+---------------
+
+True for UNIX and UNIX like operating systems.
+
+Set to true when the host system is UNIX or UNIX like (i.e.  APPLE and
+CYGWIN).

Help/variable/CMAKE_HOST_WIN32.rst

@@ -0,0 +1,6 @@
+CMAKE_HOST_WIN32
+----------------
+
+True on windows systems, including win64.
+
+Set to true when the host system is Windows and on Cygwin.

Help/variable/CMAKE_IGNORE_PATH.rst

@@ -0,0 +1,17 @@
+CMAKE_IGNORE_PATH
+-----------------
+
+Path to be ignored by FIND_XXX() commands.
+
+Specifies directories to be ignored by searches in FIND_XXX()
+commands.  This is useful in cross-compiled environments where some
+system directories contain incompatible but possibly linkable
+libraries.  For example, on cross-compiled cluster environments, this
+allows a user to ignore directories containing libraries meant for the
+front-end machine that modules like FindX11 (and others) would
+normally search.  By default this is empty; it is intended to be set
+by the project.  Note that CMAKE_IGNORE_PATH takes a list of directory
+names, NOT a list of prefixes.  If you want to ignore paths under
+prefixes (bin, include, lib, etc.), you'll need to specify them
+explicitly.  See also CMAKE_PREFIX_PATH, CMAKE_LIBRARY_PATH,
+CMAKE_INCLUDE_PATH, CMAKE_PROGRAM_PATH.

Help/variable/CMAKE_IMPORT_LIBRARY_PREFIX.rst

@@ -0,0 +1,9 @@
+CMAKE_IMPORT_LIBRARY_PREFIX
+---------------------------
+
+The prefix for import libraries that you link to.
+
+The prefix to use for the name of an import library if used on this
+platform.
+
+CMAKE_IMPORT_LIBRARY_PREFIX_<LANG> overrides this for language <LANG>.

Help/variable/CMAKE_IMPORT_LIBRARY_SUFFIX.rst

@@ -0,0 +1,9 @@
+CMAKE_IMPORT_LIBRARY_SUFFIX
+---------------------------
+
+The suffix for import libraries that you link to.
+
+The suffix to use for the end of an import library filename if used on
+this platform.
+
+CMAKE_IMPORT_LIBRARY_SUFFIX_<LANG> overrides this for language <LANG>.

Help/variable/CMAKE_INCLUDE_CURRENT_DIR.rst

@@ -0,0 +1,13 @@
+CMAKE_INCLUDE_CURRENT_DIR
+-------------------------
+
+Automatically add the current source- and build directories to the include path.
+
+If this variable is enabled, CMake automatically adds in each
+directory ${CMAKE_CURRENT_SOURCE_DIR} and ${CMAKE_CURRENT_BINARY_DIR}
+to the include path for this directory.  These additional include
+directories do not propagate down to subdirectories.  This is useful
+mainly for out-of-source builds, where files generated into the build
+tree are included by files located in the source tree.
+
+By default CMAKE_INCLUDE_CURRENT_DIR is OFF.

Help/variable/CMAKE_INCLUDE_CURRENT_DIR_IN_INTERFACE.rst

@@ -0,0 +1,10 @@
+CMAKE_INCLUDE_CURRENT_DIR_IN_INTERFACE
+--------------------------------------
+
+Automatically add the current source- and build directories to the INTERFACE_INCLUDE_DIRECTORIES.
+
+If this variable is enabled, CMake automatically adds for each shared
+library target, static library target, module target and executable
+target, ${CMAKE_CURRENT_SOURCE_DIR} and ${CMAKE_CURRENT_BINARY_DIR} to
+the INTERFACE_INCLUDE_DIRECTORIES.By default
+CMAKE_INCLUDE_CURRENT_DIR_IN_INTERFACE is OFF.

Help/variable/CMAKE_INCLUDE_PATH.rst

@@ -0,0 +1,10 @@
+CMAKE_INCLUDE_PATH
+------------------
+
+Path used for searching by FIND_FILE() and FIND_PATH().
+
+Specifies a path which will be used both by FIND_FILE() and
+FIND_PATH().  Both commands will check each of the contained
+directories for the existence of the file which is currently searched.
+By default it is empty, it is intended to be set by the project.  See
+also CMAKE_SYSTEM_INCLUDE_PATH, CMAKE_PREFIX_PATH.

Help/variable/CMAKE_INSTALL_DEFAULT_COMPONENT_NAME.rst

@@ -0,0 +1,9 @@
+CMAKE_INSTALL_DEFAULT_COMPONENT_NAME
+------------------------------------
+
+Default component used in install() commands.
+
+If an install() command is used without the COMPONENT argument, these
+files will be grouped into a default component.  The name of this
+default install component will be taken from this variable.  It
+defaults to "Unspecified".

Help/variable/CMAKE_INSTALL_NAME_DIR.rst

@@ -0,0 +1,8 @@
+CMAKE_INSTALL_NAME_DIR
+----------------------
+
+Mac OS X directory name for installed targets.
+
+CMAKE_INSTALL_NAME_DIR is used to initialize the INSTALL_NAME_DIR
+property on all targets.  See that target property for more
+information.

Help/variable/CMAKE_INSTALL_PREFIX.rst

@@ -0,0 +1,29 @@
+CMAKE_INSTALL_PREFIX
+--------------------
+
+Install directory used by install.
+
+If "make install" is invoked or INSTALL is built, this directory is
+prepended onto all install directories.  This variable defaults to
+/usr/local on UNIX and c:/Program Files on Windows.
+
+On UNIX one can use the DESTDIR mechanism in order to relocate the
+whole installation.  DESTDIR means DESTination DIRectory.  It is
+commonly used by makefile users in order to install software at
+non-default location.  It is usually invoked like this:
+
+::
+
+ make DESTDIR=/home/john install
+
+which will install the concerned software using the installation
+prefix, e.g.  "/usr/local" prepended with the DESTDIR value which
+finally gives "/home/john/usr/local".
+
+WARNING: DESTDIR may not be used on Windows because installation
+prefix usually contains a drive letter like in "C:/Program Files"
+which cannot be prepended with some other prefix.
+
+The installation prefix is also added to CMAKE_SYSTEM_PREFIX_PATH so
+that find_package, find_program, find_library, find_path, and
+find_file will search the prefix for other software.

Help/variable/CMAKE_INSTALL_RPATH.rst

@@ -0,0 +1,8 @@
+CMAKE_INSTALL_RPATH
+-------------------
+
+The rpath to use for installed targets.
+
+A semicolon-separated list specifying the rpath to use in installed
+targets (for platforms that support it).  This is used to initialize
+the target property INSTALL_RPATH for all targets.

Help/variable/CMAKE_INSTALL_RPATH_USE_LINK_PATH.rst

@@ -0,0 +1,9 @@
+CMAKE_INSTALL_RPATH_USE_LINK_PATH
+---------------------------------
+
+Add paths to linker search and installed rpath.
+
+CMAKE_INSTALL_RPATH_USE_LINK_PATH is a boolean that if set to true
+will append directories in the linker search path and outside the
+project to the INSTALL_RPATH.  This is used to initialize the target
+property INSTALL_RPATH_USE_LINK_PATH for all targets.

Help/variable/CMAKE_INTERNAL_PLATFORM_ABI.rst

@@ -0,0 +1,6 @@
+CMAKE_INTERNAL_PLATFORM_ABI
+---------------------------
+
+An internal variable subject to change.
+
+This is used in determining the compiler ABI and is subject to change.

Help/variable/CMAKE_LANG_ARCHIVE_APPEND.rst

@@ -0,0 +1,9 @@
+CMAKE_<LANG>_ARCHIVE_APPEND
+---------------------------
+
+Rule variable to append to a static archive.
+
+This is a rule variable that tells CMake how to append to a static
+archive.  It is used in place of CMAKE_<LANG>_CREATE_STATIC_LIBRARY on
+some platforms in order to support large object counts.  See also
+CMAKE_<LANG>_ARCHIVE_CREATE and CMAKE_<LANG>_ARCHIVE_FINISH.

Help/variable/CMAKE_LANG_ARCHIVE_CREATE.rst

@@ -0,0 +1,9 @@
+CMAKE_<LANG>_ARCHIVE_CREATE
+---------------------------
+
+Rule variable to create a new static archive.
+
+This is a rule variable that tells CMake how to create a static
+archive.  It is used in place of CMAKE_<LANG>_CREATE_STATIC_LIBRARY on
+some platforms in order to support large object counts.  See also
+CMAKE_<LANG>_ARCHIVE_APPEND and CMAKE_<LANG>_ARCHIVE_FINISH.

Help/variable/CMAKE_LANG_ARCHIVE_FINISH.rst

@@ -0,0 +1,9 @@
+CMAKE_<LANG>_ARCHIVE_FINISH
+---------------------------
+
+Rule variable to finish an existing static archive.
+
+This is a rule variable that tells CMake how to finish a static
+archive.  It is used in place of CMAKE_<LANG>_CREATE_STATIC_LIBRARY on
+some platforms in order to support large object counts.  See also
+CMAKE_<LANG>_ARCHIVE_CREATE and CMAKE_<LANG>_ARCHIVE_APPEND.

Help/variable/CMAKE_LANG_COMPILER.rst

@@ -0,0 +1,7 @@
+CMAKE_<LANG>_COMPILER
+---------------------
+
+The full path to the compiler for LANG.
+
+This is the command that will be used as the <LANG> compiler.  Once
+set, you can not change this variable.

Help/variable/CMAKE_LANG_COMPILER_ABI.rst

@@ -0,0 +1,6 @@
+CMAKE_<LANG>_COMPILER_ABI
+-------------------------
+
+An internal variable subject to change.
+
+This is used in determining the compiler ABI and is subject to change.

Help/variable/CMAKE_LANG_COMPILER_ID.rst

@@ -0,0 +1,33 @@
+CMAKE_<LANG>_COMPILER_ID
+------------------------
+
+Compiler identification string.
+
+A short string unique to the compiler vendor.  Possible values
+include:
+
+::
+
+  Absoft = Absoft Fortran (absoft.com)
+  ADSP = Analog VisualDSP++ (analog.com)
+  AppleClang = Apple Clang (apple.com)
+  Clang = LLVM Clang (clang.llvm.org)
+  Cray = Cray Compiler (cray.com)
+  Embarcadero, Borland = Embarcadero (embarcadero.com)
+  G95 = G95 Fortran (g95.org)
+  GNU = GNU Compiler Collection (gcc.gnu.org)
+  HP = Hewlett-Packard Compiler (hp.com)
+  Intel = Intel Compiler (intel.com)
+  MIPSpro = SGI MIPSpro (sgi.com)
+  MSVC = Microsoft Visual Studio (microsoft.com)
+  PGI = The Portland Group (pgroup.com)
+  PathScale = PathScale (pathscale.com)
+  SDCC = Small Device C Compiler (sdcc.sourceforge.net)
+  SunPro = Oracle Solaris Studio (oracle.com)
+  TI = Texas Instruments (ti.com)
+  TinyCC = Tiny C Compiler (tinycc.org)
+  Watcom = Open Watcom (openwatcom.org)
+  XL, VisualAge, zOS = IBM XL (ibm.com)
+
+This variable is not guaranteed to be defined for all compilers or
+languages.

Help/variable/CMAKE_LANG_COMPILER_LOADED.rst

@@ -0,0 +1,7 @@
+CMAKE_<LANG>_COMPILER_LOADED
+----------------------------
+
+Defined to true if the language is enabled.
+
+When language <LANG> is enabled by project() or enable_language() this
+variable is defined to 1.

Help/variable/CMAKE_LANG_COMPILER_VERSION.rst

@@ -0,0 +1,8 @@
+CMAKE_<LANG>_COMPILER_VERSION
+-----------------------------
+
+Compiler version string.
+
+Compiler version in major[.minor[.patch[.tweak]]] format.  This
+variable is not guaranteed to be defined for all compilers or
+languages.

Help/variable/CMAKE_LANG_COMPILE_OBJECT.rst

@@ -0,0 +1,7 @@
+CMAKE_<LANG>_COMPILE_OBJECT
+---------------------------
+
+Rule variable to compile a single object file.
+
+This is a rule variable that tells CMake how to compile a single
+object file for the language <LANG>.

Help/variable/CMAKE_LANG_CREATE_SHARED_LIBRARY.rst

@@ -0,0 +1,7 @@
+CMAKE_<LANG>_CREATE_SHARED_LIBRARY
+----------------------------------
+
+Rule variable to create a shared library.
+
+This is a rule variable that tells CMake how to create a shared
+library for the language <LANG>.

Help/variable/CMAKE_LANG_CREATE_SHARED_MODULE.rst

@@ -0,0 +1,7 @@
+CMAKE_<LANG>_CREATE_SHARED_MODULE
+---------------------------------
+
+Rule variable to create a shared module.
+
+This is a rule variable that tells CMake how to create a shared
+library for the language <LANG>.

Help/variable/CMAKE_LANG_CREATE_STATIC_LIBRARY.rst

@@ -0,0 +1,7 @@
+CMAKE_<LANG>_CREATE_STATIC_LIBRARY
+----------------------------------
+
+Rule variable to create a static library.
+
+This is a rule variable that tells CMake how to create a static
+library for the language <LANG>.

Help/variable/CMAKE_LANG_FLAGS.rst

@@ -0,0 +1,6 @@
+CMAKE_<LANG>_FLAGS
+------------------
+
+Flags for all build types.
+
+<LANG> flags used regardless of the value of CMAKE_BUILD_TYPE.

Help/variable/CMAKE_LANG_FLAGS_DEBUG.rst

@@ -0,0 +1,6 @@
+CMAKE_<LANG>_FLAGS_DEBUG
+------------------------
+
+Flags for Debug build type or configuration.
+
+<LANG> flags used when CMAKE_BUILD_TYPE is Debug.

Help/variable/CMAKE_LANG_FLAGS_MINSIZEREL.rst

@@ -0,0 +1,7 @@
+CMAKE_<LANG>_FLAGS_MINSIZEREL
+-----------------------------
+
+Flags for MinSizeRel build type or configuration.
+
+<LANG> flags used when CMAKE_BUILD_TYPE is MinSizeRel.Short for
+minimum size release.

Help/variable/CMAKE_LANG_FLAGS_RELEASE.rst

@@ -0,0 +1,6 @@
+CMAKE_<LANG>_FLAGS_RELEASE
+--------------------------
+
+Flags for Release build type or configuration.
+
+<LANG> flags used when CMAKE_BUILD_TYPE is Release

Help/variable/CMAKE_LANG_FLAGS_RELWITHDEBINFO.rst

@@ -0,0 +1,7 @@
+CMAKE_<LANG>_FLAGS_RELWITHDEBINFO
+---------------------------------
+
+Flags for RelWithDebInfo type or configuration.
+
+<LANG> flags used when CMAKE_BUILD_TYPE is RelWithDebInfo.  Short for
+Release With Debug Information.

Help/variable/CMAKE_LANG_IGNORE_EXTENSIONS.rst

@@ -0,0 +1,7 @@
+CMAKE_<LANG>_IGNORE_EXTENSIONS
+------------------------------
+
+File extensions that should be ignored by the build.
+
+This is a list of file extensions that may be part of a project for a
+given language but are not compiled.

Help/variable/CMAKE_LANG_IMPLICIT_INCLUDE_DIRECTORIES.rst

@@ -0,0 +1,9 @@
+CMAKE_<LANG>_IMPLICIT_INCLUDE_DIRECTORIES
+-----------------------------------------
+
+Directories implicitly searched by the compiler for header files.
+
+CMake does not explicitly specify these directories on compiler
+command lines for language <LANG>.  This prevents system include
+directories from being treated as user include directories on some
+compilers.

Help/variable/CMAKE_LANG_IMPLICIT_LINK_DIRECTORIES.rst

@@ -0,0 +1,17 @@
+CMAKE_<LANG>_IMPLICIT_LINK_DIRECTORIES
+--------------------------------------
+
+Implicit linker search path detected for language <LANG>.
+
+Compilers typically pass directories containing language runtime
+libraries and default library search paths when they invoke a linker.
+These paths are implicit linker search directories for the compiler's
+language.  CMake automatically detects these directories for each
+language and reports the results in this variable.
+
+When a library in one of these directories is given by full path to
+target_link_libraries() CMake will generate the -l<name> form on link
+lines to ensure the linker searches its implicit directories for the
+library.  Note that some toolchains read implicit directories from an
+environment variable such as LIBRARY_PATH so keep its value consistent
+when operating in a given build tree.

Help/variable/CMAKE_LANG_IMPLICIT_LINK_FRAMEWORK_DIRECTORIES.rst

@@ -0,0 +1,8 @@
+CMAKE_<LANG>_IMPLICIT_LINK_FRAMEWORK_DIRECTORIES
+------------------------------------------------
+
+Implicit linker framework search path detected for language <LANG>.
+
+These paths are implicit linker framework search directories for the
+compiler's language.  CMake automatically detects these directories
+for each language and reports the results in this variable.

Help/variable/CMAKE_LANG_IMPLICIT_LINK_LIBRARIES.rst

@@ -0,0 +1,10 @@
+CMAKE_<LANG>_IMPLICIT_LINK_LIBRARIES
+------------------------------------
+
+Implicit link libraries and flags detected for language <LANG>.
+
+Compilers typically pass language runtime library names and other
+flags when they invoke a linker.  These flags are implicit link
+options for the compiler's language.  CMake automatically detects
+these libraries and flags for each language and reports the results in
+this variable.