[[man_de_cmake]]

Différences

Ci-dessous, les différences entre deux révisions de la page.

Lien vers cette vue comparative

man_de_cmake [2016/03/30 15:33] (Version actuelle)
Ligne 1: Ligne 1:
 +==== Manuel de la commande "​cmake"​ ====
 +
 +<​code>​
 +CMAKE(1) ​                                                         CMake                                                         ​CMAKE(1)
 +
 +
 +
 +NAME
 +       cmake - CMake Command-Line Reference
 +
 +SYNOPSIS
 +          cmake [<​options>​] (<​path-to-source>​ | <​path-to-existing-build>​)
 +          cmake [(-D<​var>​=<​value>​)...] -P <​cmake-script-file>​
 +          cmake --build <dir> [<​options>​] [-- <​build-tool-options>​...]
 +          cmake -E <​command>​ [<​options>​]
 +          cmake --find-package <​options>​...
 +
 +DESCRIPTION
 +       The "​cmake"​ executable is the CMake command-line interface. ​ It may be used to configure projects in scripts. ​ Project configura‐
 +       tion settings may be specified on the command line with the -D option.
 +
 +       CMake is a cross-platform build system generator. ​ Projects specify their build process with platform-independent CMake listfiles
 +       ​included ​ in  each  directory ​ of a source tree with the name CMakeLists.txt. ​ Users build a project by using CMake to generate a
 +       build system for a native tool on their platform.
 +
 +OPTIONS
 +       -C <​initial-cache>​
 +              Pre-load a script to populate the cache.
 +
 +              When cmake is first run in an empty build tree, it creates a CMakeCache.txt file and populates it with  customizable ​ set‐
 +              tings  for  the project. ​ This option may be used to specify a file from which to load cache entries before the first pass
 +              through the project'​s cmake listfiles. ​ The loaded entries take priority over the project'​s ​ default ​ values. ​  ​The ​ given
 +              file should be a CMake script containing SET commands that use the CACHE option, not a cache-format file.
 +
 +       -D <​var>:<​type>​=<​value>​
 +              Create a cmake cache entry.
 +
 +              When  cmake  is first run in an empty build tree, it creates a CMakeCache.txt file and populates it with customizable set‐
 +              tings for the project. ​ This option may be used to specify a setting that takes priority over the project'​s default value.
 +              The option may be repeated for as many cache entries as desired.
 +
 +       -U <​globbing_expr>​
 +              Remove matching entries from CMake cache.
 +
 +              This  option ​ may be used to remove one or more variables from the CMakeCache.txt file, globbing expressions using * and ?
 +              are supported. ​ The option may be repeated for as many cache entries as desired.
 +
 +              Use with care, you can make your CMakeCache.txt non-working.
 +
 +       -G <​generator-name>​
 +              Specify a build system generator.
 +
 +              CMake may support multiple native build systems on certain platforms. ​ A generator is responsible for generating a partic‐
 +              ular build system. ​ Possible generator names are specified in the Generators section.
 +
 +       -T <​toolset-name>​
 +              Specify toolset name if supported by generator.
 +
 +              Some  CMake  generators ​ support a toolset name to be given to the native build system to choose a compiler. ​ This is sup‐
 +              ported only on specific generators:
 +
 +                 ​Visual Studio >= 10
 +                 Xcode >= 3.0
 +
 +              See native build system documentation for allowed toolset names.
 +
 +       ​-Wno-dev
 +              Suppress developer warnings.
 +
 +              Suppress warnings that are meant for the author of the CMakeLists.txt files.
 +
 +       ​-Wdev ​ Enable developer warnings.
 +
 +              Enable warnings that are meant for the author of the CMakeLists.txt files.
 +
 +       ​-E ​    CMake command mode.
 +
 +              For true platform independence,​ CMake provides a list of commands that can be used on all systems. ​ Run with -E  help  for
 +              the  usage  information. ​  ​Commands ​ available ​ are:  chdir, compare_files,​ copy, copy_directory,​ copy_if_different,​ echo,
 +              echo_append,​ environment,​ make_directory,​ md5sum, remove, remove_directory,​ rename, sleep, tar, time, touch, ​ touch_nocre‐
 +              ate.   ​In ​ addition, ​ some  platform specific commands are available. ​ On Windows: delete_regv,​ write_regv. ​ On UNIX: cre‐
 +              ate_symlink.
 +
 +       ​-L[A][H]
 +              List non-advanced cached variables.
 +
 +              List cache variables will run CMake and list all the variables from the CMake cache that are not  marked ​ as  INTERNAL ​ or
 +              ADVANCED. ​  This will effectively display current CMake settings, which can then be changed with -D option. ​ Changing some
 +              of the variables may result in more variables being created. ​ If A is specified, then it will display also advanced ​ vari‐
 +              ables. ​ If H is specified, it will also display help for each variable.
 +
 +       ​--build <dir>
 +              Build a CMake-generated project binary tree.
 +
 +              This abstracts a native build tool's command-line interface with the following options:
 +
 +                 <​dir> ​         = Project binary directory to be built.
 +                 ​--target <tgt> = Build <tgt> instead of default targets.
 +                 ​--config <cfg> = For multi-configuration tools, choose <​cfg>​.
 +                 ​--clean-first ​ = Build target '​clean'​ first, then build.
 +                                  (To clean only, use --target '​clean'​.)
 +                 ​--use-stderr ​  = Ignored. ​ Behavior is default in CMake >= 3.0.
 +                 ​-- ​            = Pass remaining options to the native tool.
 +
 +              Run cmake --build with no options for quick help.
 +
 +       ​-N ​    View mode only.
 +
 +              Only load the cache. ​ Do not actually run configure and generate steps.
 +
 +       -P <​file>​
 +              Process script mode.
 +
 +              Process ​ the  given  cmake file as a script written in the CMake language. ​ No configure or generate step is performed and
 +              the cache is not modified. ​ If variables are defined using -D, this must be done before the -P argument.
 +
 +       ​--find-package
 +              Run in pkg-config like mode.
 +
 +              Search a package using find_package() and print the resulting flags to stdout. ​ This can be used to use cmake  instead ​ of
 +              pkg-config ​ to  find  installed ​ libraries in plain Makefile-based projects or in autoconf-based projects (via share/​aclo‐
 +              cal/​cmake.m4).
 +
 +       ​--graphviz=[file]
 +              Generate graphviz of dependencies,​ see CMakeGraphVizOptions.cmake for more.
 +
 +              Generate a graphviz input file that will contain all the library and executable dependencies in the project. ​ See the doc‐
 +              umentation for CMakeGraphVizOptions.cmake for more details.
 +
 +       ​--system-information [file]
 +              Dump information about this system.
 +
 +              Dump  a  wide  range of information about the current system. ​ If run from the top of a binary tree for a CMake project it
 +              will dump additional information such as the cache, log files etc.
 +
 +       ​--debug-trycompile
 +              Do not delete the try_compile build tree. Only useful on one try_compile at a time.
 +
 +              Do not delete the files and directories created for try_compile calls. ​ This is useful in debugging ​ failed ​ try_compiles.
 +              It  may  however change the results of the try-compiles as old junk from a previous try-compile may cause a different test
 +              to either pass or fail incorrectly. ​ This option is best used for one try-compile at a time, and only when debugging.
 +
 +       ​--debug-output
 +              Put cmake in a debug mode.
 +
 +              Print extra stuff during the cmake run like stack traces with message(send_error ) calls.
 +
 +       ​--trace
 +              Put cmake in trace mode.
 +
 +              Print a trace of all calls made and from where with message(send_error ) calls.
 +
 +       ​--warn-uninitialized
 +              Warn about uninitialized values.
 +
 +              Print a warning when an uninitialized variable is used.
 +
 +       ​--warn-unused-vars
 +              Warn about unused variables.
 +
 +              Find variables that are declared or set, but not used.
 +
 +       ​--no-warn-unused-cli
 +              Don't warn about command line options.
 +
 +              Don't find variables that are declared on the command line, but not used.
 +
 +       ​--check-system-vars
 +              Find problems with variable usage in system files.
 +
 +              Normally, unused and uninitialized variables are searched for only in CMAKE_SOURCE_DIR and  CMAKE_BINARY_DIR. ​  ​This ​ flag
 +              tells CMake to warn about other files as well.
 +
 +       ​--help,​-help,​-usage,​-h,​-H,/?​
 +              Print usage information and exit.
 +
 +              Usage describes the basic command line interface and its options.
 +
 +       ​--version,​-version,/​V [<f>]
 +              Show program name/​version banner and exit.
 +
 +              If a file is specified, the version is written into it.  The help is printed to a named <​f>​ile if given.
 +
 +       ​--help-full [<f>]
 +              Print all help manuals and exit.
 +
 +              All manuals are printed in a human-readable text format. ​ The help is printed to a named <​f>​ile if given.
 +
 +       ​--help-manual <man> [<f>]
 +              Print one help manual and exit.
 +
 +              The specified manual is printed in a human-readable text format. ​ The help is printed to a named <​f>​ile if given.
 +
 +       ​--help-manual-list [<f>]
 +              List help manuals available and exit.
 +
 +              The  list contains all manuals for which help may be obtained by using the --help-manual option followed by a manual name.
 +              The help is printed to a named <​f>​ile if given.
 +
 +       ​--help-command <cmd> [<f>]
 +              Print help for one command and exit.
 +
 +              The cmake-commands(7) manual entry for <cmd> is printed in a human-readable text format. ​ The help is printed to  a  named
 +              <​f>​ile if given.
 +
 +       ​--help-command-list [<f>]
 +              List commands with help available and exit.
 +
 +              The  list  contains ​ all  commands for which help may be obtained by using the --help-command option followed by a command
 +              name.  The help is printed to a named <​f>​ile if given.
 +
 +       ​--help-commands [<f>]
 +              Print cmake-commands manual and exit.
 +
 +              The cmake-commands(7) manual is printed in a human-readable text format. ​ The help is printed to a named <​f>​ile if given.
 +
 +       ​--help-module <mod> [<f>]
 +              Print help for one module and exit.
 +
 +              The cmake-modules(7) manual entry for <mod> is printed in a human-readable text format. ​ The help is printed ​ to  a  named
 +              <​f>​ile if given.
 +
 +       ​--help-module-list [<f>]
 +              List modules with help available and exit.
 +
 +              The  list contains all modules for which help may be obtained by using the --help-module option followed by a module name.
 +              The help is printed to a named <​f>​ile if given.
 +
 +       ​--help-modules [<f>]
 +              Print cmake-modules manual and exit.
 +
 +              The cmake-modules(7) manual is printed in a human-readable text format. ​ The help is printed to a named <​f>​ile if given.
 +
 +       ​--help-policy <cmp> [<f>]
 +              Print help for one policy and exit.
 +
 +              The cmake-policies(7) manual entry for <cmp> is printed in a human-readable text format. ​ The help is printed to  a  named
 +              <​f>​ile if given.
 +
 +       ​--help-policy-list [<f>]
 +              List policies with help available and exit.
 +
 +              The list contains all policies for which help may be obtained by using the --help-policy option followed by a policy name.
 +              The help is printed to a named <​f>​ile if given.
 +
 +       ​--help-policies [<f>]
 +              Print cmake-policies manual and exit.
 +
 +              The cmake-policies(7) manual is printed in a human-readable text format. ​ The help is printed to a named <​f>​ile if given.
 +
 +       ​--help-property <​prop>​ [<f>]
 +              Print help for one property and exit.
 +
 +              The cmake-properties(7) manual entries for <​prop>​ are printed in a human-readable text format. ​ The help is printed ​ to  a
 +              named <​f>​ile if given.
 +
 +       ​--help-property-list [<f>]
 +              List properties with help available and exit.
 +
 +              The list contains all properties for which help may be obtained by using the --help-property option followed by a property
 +              name.  The help is printed to a named <​f>​ile if given.
 +
 +       ​--help-properties [<f>]
 +              Print cmake-properties manual and exit.
 +
 +              The cmake-properties(7) manual is printed in a human-readable text format. ​ The help is  printed ​ to  a  named  <​f>​ile ​ if
 +              given.
 +
 +       ​--help-variable <var> [<f>]
 +              Print help for one variable and exit.
 +
 +              The  cmake-variables(7) manual entry for <var> is printed in a human-readable text format. ​ The help is printed to a named
 +              <​f>​ile if given.
 +
 +       ​--help-variable-list [<f>]
 +              List variables with help available and exit.
 +
 +              The list contains all variables for which help may be obtained by using the --help-variable option followed by a  variable
 +              name.  The help is printed to a named <​f>​ile if given.
 +
 +       ​--help-variables [<f>]
 +              Print cmake-variables manual and exit.
 +
 +              The cmake-variables(7) manual is printed in a human-readable text format. ​ The help is printed to a named <​f>​ile if given.
 +
 +SEE ALSO
 +       The following resources are available to get help using CMake:
 +
 +       Home Page
 +              http://​www.cmake.org
 +
 +              The primary starting point for learning about CMake.
 +
 +       ​Frequently Asked Questions
 +              http://​www.cmake.org/​Wiki/​CMake_FAQ
 +
 +              A Wiki is provided containing answers to frequently asked questions.
 +
 +       ​Online Documentation
 +              http://​www.cmake.org/​HTML/​Documentation.html
 +
 +              Links to available documentation may be found on this web page.
 +
 +       ​Mailing List
 +              http://​www.cmake.org/​HTML/​MailingLists.html
 +
 +              For  help  and  discussion about using cmake, a mailing list is provided at cmake@cmake.org. ​ The list is member-post-only
 +              but one may sign up on the CMake web page.  Please first read the full documentation at http://​www.cmake.org before ​ post‐
 +              ing questions to the list.
 +
 +COPYRIGHT
 +       ​2000-2014 Kitware, Inc.
 +
 +
 +
 +
 +3.0.2                                                      September 14, 2014                                                   ​CMAKE(1)
 +
 +</​code>​
  
  • man_de_cmake.txt
  • Dernière modification: 2016/03/30 15:33
  • (modification externe)