Linux.pl
Opcje wyszukiwania podręcznika man:
Lista stron man zaczynających się od znaku:
A   B   C   D   E   F   G   H   I   J   K   L   M   N   O   P   Q   R   S   T   U   V   W   X   Y   Z   ALPHA   NUM   OTHER   ALL
CMAKE(1)                             CMake                            CMAKE(1)

NAME
       cmake - CMake Command-Line Reference

SYNOPSIS
          Generate a Project Buildsystem
           cmake [<options>] <path-to-source>
           cmake [<options>] <path-to-existing-build>
           cmake [<options>] -S <path-to-source> -B <path-to-build>

          Build a Project
           cmake --build <dir> [<options>] [-- <build-tool-options>]

          Install a Project
           cmake --install <dir> [<options>]

          Open a Project
           cmake --open <dir>

          Run a Script
           cmake [{-D <var>=<value>}...] -P <cmake-script-file>

          Run a Command-Line Tool
           cmake -E <command> [<options>]

          Run the Find-Package Tool
           cmake --find-package [<options>]

          View Help
           cmake --help[-<topic>]

DESCRIPTION
       The  cmake  executable is the command-line interface of the cross-plat-
       form buildsystem generator CMake.  The above Synopsis lists various ac-
       tions the tool can perform as described in sections below.

       To build a software project with CMake, Generate a Project Buildsystem.
       Optionally use cmake to Build a Project, Install a Project or just  run
       the  corresponding  build tool (e.g. make) directly.  cmake can also be
       used to View Help.

       The other actions are meant for  use  by  software  developers  writing
       scripts in the CMake language to support their builds.

       For  graphical  user interfaces that may be used in place of cmake, see
       ccmake and cmake-gui.  For command-line interfaces to the CMake testing
       and packaging facilities, see ctest and cpack.

       For  more  information on CMake at large, see also the links at the end
       of this manual.

INTRODUCTION TO CMAKE BUILDSYSTEMS
       A buildsystem describes how to build a  projects  executables  and  li-
       braries  from  its  source  code  using  a  build  tool to automate the
       process.  For example, a buildsystem may be a Makefile for use  with  a
       command-line  make tool or a project file for an Integrated Development
       Environment  (IDE).   In  order  to  avoid  maintaining  multiple  such
       buildsystems,  a  project  may specify its buildsystem abstractly using
       files written in the CMake language.  From these files CMake  generates
       a  preferred buildsystem locally for each user through a backend called
       a generator.

       To generate a buildsystem with CMake, the following must be selected:

       Source Tree
              The top-level directory containing source files provided by  the
              project.   The  project specifies its buildsystem using files as
              described in  the  cmake-language(7)  manual,  starting  with  a
              top-level  file named CMakeLists.txt.  These files specify build
              targets   and   their   dependencies   as   described   in   the
              cmake-buildsystem(7) manual.

       Build Tree
              The  top-level  directory  in  which buildsystem files and build
              output artifacts (e.g. executables  and  libraries)  are  to  be
              stored.   CMake will write a CMakeCache.txt file to identify the
              directory as a build tree and store persistent information  such
              as buildsystem configuration options.

              To  maintain  a  pristine  source tree, perform an out-of-source
              build by using a separate dedicated build  tree.   An  in-source
              build in which the build tree is placed in the same directory as
              the source tree is also supported, but discouraged.

       Generator
              This chooses the kind  of  buildsystem  to  generate.   See  the
              cmake-generators(7)  manual for documentation of all generators.
              Run cmake --help to see a list of generators available  locally.
              Optionally  use  the  -G option below to specify a generator, or
              simply accept the default CMake chooses for  the  current  plat-
              form.

              When  using  one of the Command-Line Build Tool Generators CMake
              expects that the environment needed by the compiler toolchain is
              already  configured  in  the  shell.   When using one of the IDE
              Build Tool Generators, no particular environment is needed.

GENERATE A PROJECT BUILDSYSTEM
       Run CMake with one of the following command signatures to  specify  the
       source and build trees and generate a buildsystem:

       cmake [<options>] <path-to-source>
              Uses  the  current  working  directory  as  the  build tree, and
              <path-to-source> as the source tree.  The specified path may  be
              absolute  or  relative  to  the  current working directory.  The
              source tree must contain a CMakeLists.txt file and must not con-
              tain  a CMakeCache.txt file because the latter identifies an ex-
              isting build tree.  For example:

                 $ mkdir build ; cd build
                 $ cmake ../src

       cmake [<options>] <path-to-existing-build>
              Uses <path-to-existing-build> as the build tree, and  loads  the
              path to the source tree from its CMakeCache.txt file, which must
              have already been generated by a previous  run  of  CMake.   The
              specified  path may be absolute or relative to the current work-
              ing directory.  For example:

                 $ cd build
                 $ cmake .

       cmake [<options>] -S <path-to-source> -B <path-to-build>
              Uses <path-to-build> as the build tree and  <path-to-source>  as
              the  source  tree.  The specified paths may be absolute or rela-
              tive to the current working directory.   The  source  tree  must
              contain  a  CMakeLists.txt file.  The build tree will be created
              automatically if it does not already exist.  For example:

                 $ cmake -S src -B build

       In all cases the <options> may be zero or more of the Options below.

       After generating a buildsystem one may  use  the  corresponding  native
       build  tool  to  build  the project.  For example, after using the Unix
       Makefiles generator one may run make directly:

              $ make
              $ make install

       Alternatively, one may use cmake to Build a  Project  by  automatically
       choosing and invoking the appropriate native build tool.

   Options
       -S <path-to-source>
              Path to root directory of the CMake project to build.

       -B <path-to-build>
              Path  to directory which CMake will use as the root of build di-
              rectory.

              If the directory doesnt already exist CMake will make it.

       -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 settings
              for the project.  This option may be used to specify a file from
              which  to  load  cache entries before the first pass through the
              projects CMake listfiles.  The loaded entries take priority over
              the  projects  default values.  The given file should be a CMake
              script containing set() commands that use the CACHE option,  not
              a cache-format file.

              References  to  CMAKE_SOURCE_DIR and CMAKE_BINARY_DIR within the
              script evaluate to the top-level source and build tree.

       -D <var>:<type>=<value>, -D <var>=<value>
              Create or update a CMake CACHE entry.

              When CMake is first run in an empty build  tree,  it  creates  a
              CMak.

CMAKE(1)                             CMake                            CMAKE(1)

NAME
       cmake - CMake Command-Line Reference

SYNOPSIS
          Generate a Project Buildsystem
           cmake [<options>] <path-to-source>
           cmake [<options>] <path-to-existing-build>
           cmake [<options>] -S <path-to-source> -B <path-to-build>

          Build a Project
           cmake --build <dir> [<options>] [-- <build-tool-options>]

          Install a Project
           cmake --install <dir> [<options>]

          Open a Project
           cmake --open <dir>

          Run a Script
           cmake [{-D <var>=<value>}...] -P <cmake-script-file>

          Run a Command-Line Tool
           cmake -E <command> [<options>]

          Run the Find-Package Tool
           cmake --find-package [<options>]

          View Help
           cmake --help[-<topic>]

DESCRIPTION
       The  cmake  executable is the command-line interface of the cross-plat-
       form buildsystem generator CMake.  The above Synopsis lists various ac-
       tions the tool can perform as described in sections below.

       To build a software project with CMake, Generate a Project Buildsystem.
       Optionally use cmake to Build a Project, Install a Project or just  run
       the  corresponding  build tool (e.g. make) directly.  cmake can also be
       used to View Help.

       The other actions are meant for  use  by  software  developers  writing
       scripts in the CMake language to support their builds.

       For  graphical  user interfaces that may be used in place of cmake, see
       ccmake and cmake-gui.  For command-line interfaces to the CMake testing
       and packaging facilities, see ctest and cpack.

       For  more  information on CMake at large, see also the links at the end
       of this manual.

INTRODUCTION TO CMAKE BUILDSYSTEMS
       A buildsystem describes how to build a  projects  executables  and  li-
       braries  from  its  source  code  using  a  build  tool to automate the
       process.  For example, a buildsystem may be a Makefile for use  with  a
       command-line  make tool or a project file for an Integrated Development
       Environment  (IDE).   In  order  to  avoid  maintaining  multiple  such
       buildsystems,  a  project  may specify its buildsystem abstractly using
       files written in the CMake language.  From these files CMake  generates
       a  preferred buildsystem locally for each user through a backend called
       a generator.

       To generate a buildsystem with CMake, the following must be selected:

       Source Tree
              The top-level directory containing source files provided by  the
              project.   The  project specifies its buildsystem using files as
              described in  the  cmake-language(7)  manual,  starting  with  a
              top-level  file named CMakeLists.txt.  These files specify build
              targets   and   their   dependencies   as   described   in   the
              cmake-buildsystem(7) manual.

       Build Tree
              The  top-level  directory  in  which buildsystem files and build
              output artifacts (e.g. executables  and  libraries)  are  to  be
              stored.   CMake will write a CMakeCache.txt file to identify the
              directory as a build tree and store persistent information  such
              as buildsystem configuration options.

              To  maintain  a  pristine  source tree, perform an out-of-source
              build by using a separate dedicated build  tree.   An  in-source
              build in which the build tree is placed in the same directory as
              the source tree is also supported, but discouraged.

       Generator
              This chooses the kind  of  buildsystem  to  generate.   See  the
              cmake-generators(7)  manual for documentation of all generators.
              Run cmake --help to see a list of generators available  locally.
              Optionally  use  the  -G option below to specify a generator, or
              simply accept the default CMake chooses for  the  current  plat-
              form.

              When  using  one of the Command-Line Build Tool Generators CMake
              expects that the environment needed by the compiler toolchain is
              already  configured  in  the  shell.   When using one of the IDE
              Build Tool Generators, no particular environment is needed.

GENERATE A PROJECT BUILDSYSTEM
       Run CMake with one of the following command signatures to  specify  the
       source and build trees and generate a buildsystem:

       cmake [<options>] <path-to-source>
              Uses  the  current  working  directory  as  the  build tree, and
              <path-to-source> as the source tree.  The specified path may  be
              absolute  or  relative  to  the  current working directory.  The
              source tree must contain a CMakeLists.txt file and must not con-
              tain  a CMakeCache.txt file because the latter identifies an ex-
              isting build tree.  For example:

                 $ mkdir build ; cd build
                 $ cmake ../src

       cmake [<options>] <path-to-existing-build>
              Uses <path-to-existing-build> as the build tree, and  loads  the
              path to the source tree from its CMakeCache.txt file, which must
              have already been generated by a previous  run  of  CMake.   The
              specified  path may be absolute or relative to the current work-
              ing directory.  For example:

                 $ cd build
                 $ cmake .

       cmake [<options>] -S <path-to-source> -B <path-to-build>
              Uses <path-to-build> as the build tree and  <path-to-source>  as
              the  source  tree.  The specified paths may be absolute or rela-
              tive to the current working directory.   The  source  tree  must
              contain  a  CMakeLists.txt file.  The build tree will be created
              automatically if it does not already exist.  For example:

                 $ cmake -S src -B build

       In all cases the <options> may be zero or more of the Options below.

       After generating a buildsystem one may  use  the  corresponding  native
       build  tool  to  build  the project.  For example, after using the Unix
       Makefiles generator one may run make directly:

              $ make
              $ make install

       Alternatively, one may use cmake to Build a  Project  by  automatically
       choosing and invoking the appropriate native build tool.

   Options
       -S <path-to-source>
              Path to root directory of the CMake project to build.

       -B <path-to-build>
              Path  to directory which CMake will use as the root of build di-
              rectory.

              If the directory doesnt already exist CMake will make it.

       -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 settings
              for the project.  This option may be used to specify a file from
              which  to  load  cache entries before the first pass through the
              projects CMake listfiles.  The loaded entries take priority over
              the  projects  default values.  The given file should be a CMake
              script containing set() commands that use the CACHE option,  not
              a cache-format file.

              References  to  CMAKE_SOURCE_DIR and CMAKE_BINARY_DIR within the
              script evaluate to the top-level source and build tree.

       -D <var>:<type>=<value>, -D <var>=<value>
              Create or update a CMake CACHE entry.

              When CMake is first run in an empty build  tree,  it  creates  a
              CMak.

CMAKE(1)                             CMake                            CMAKE(1)

NAME
       cmake - CMake Command-Line Reference

SYNOPSIS
          Generate a Project Buildsystem
           cmake [<options>] <path-to-source>
           cmake [<options>] <path-to-existing-build>
           cmake [<options>] -S <path-to-source> -B <path-to-build>

          Build a Project
           cmake --build <dir> [<options>] [-- <build-tool-options>]

          Install a Project
           cmake --install <dir> [<options>]

          Open a Project
           cmake --open <dir>

          Run a Script
           cmake [{-D <var>=<value>}...] -P <cmake-script-file>

          Run a Command-Line Tool
           cmake -E <command> [<options>]

          Run the Find-Package Tool
           cmake --find-package [<options>]

          View Help
           cmake --help[-<topic>]

DESCRIPTION
       The  cmake  executable is the command-line interface of the cross-plat-
       form buildsystem generator CMake.  The above Synopsis lists various ac-
       tions the tool can perform as described in sections below.

       To build a software project with CMake, Generate a Project Buildsystem.
       Optionally use cmake to Build a Project, Install a Project or just  run
       the  corresponding  build tool (e.g. make) directly.  cmake can also be
       used to View Help.

       The other actions are meant for  use  by  software  developers  writing
       scripts in the CMake language to support their builds.

       For  graphical  user interfaces that may be used in place of cmake, see
       ccmake and cmake-gui.  For command-line interfaces to the CMake testing
       and packaging facilities, see ctest and cpack.

       For  more  information on CMake at large, see also the links at the end
       of this manual.

INTRODUCTION TO CMAKE BUILDSYSTEMS
       A buildsystem describes how to build a  projects  executables  and  li-
       braries  from  its  source  code  using  a  build  tool to automate the
       process.  For example, a buildsystem may be a Makefile for use  with  a
       command-line  make tool or a project file for an Integrated Development
       Environment  (IDE).   In  order  to  avoid  maintaining  multiple  such
       buildsystems,  a  project  may specify its buildsystem abstractly using
       files written in the CMake language.  From these files CMake  generates
       a  preferred buildsystem locally for each user through a backend called
       a generator.

       To generate a buildsystem with CMake, the following must be selected:

       Source Tree
              The top-level directory containing source files provided by  the
              project.   The  project specifies its buildsystem using files as
              described in  the  cmake-language(7)  manual,  starting  with  a
              top-level  file named CMakeLists.txt.  These files specify build
              targets   and   their   dependencies   as   described   in   the
              cmake-buildsystem(7) manual.

       Build Tree
              The  top-level  directory  in  which buildsystem files and build
              output artifacts (e.g. executables  and  libraries)  are  to  be
              stored.   CMake will write a CMakeCache.txt file to identify the
              directory as a build tree and store persistent information  such
              as buildsystem configuration options.

              To  maintain  a  pristine  source tree, perform an out-of-source
              build by using a separate dedicated build  tree.   An  in-source
              build in which the build tree is placed in the same directory as
              the source tree is also supported, but discouraged.

       Generator
              This chooses the kind  of  buildsystem  to  generate.   See  the
              cmake-generators(7)  manual for documentation of all generators.
              Run cmake --help to see a list of generators available  locally.
              Optionally  use  the  -G option below to specify a generator, or
              simply accept the default CMake chooses for  the  current  plat-
              form.

              When  using  one of the Command-Line Build Tool Generators CMake
              expects that the environment needed by the compiler toolchain is
              already  configured  in  the  shell.   When using one of the IDE
              Build Tool Generators, no particular environment is needed.

GENERATE A PROJECT BUILDSYSTEM
       Run CMake with one of the following command signatures to  specify  the
       source and build trees and generate a buildsystem:

       cmake [<options>] <path-to-source>
              Uses  the  current  working  directory  as  the  build tree, and
              <path-to-source> as the source tree.  The specified path may  be
              absolute  or  relative  to  the  current working directory.  The
              source tree must contain a CMakeLists.txt file and must not con-
              tain  a CMakeCache.txt file because the latter identifies an ex-
              isting build tree.  For example:

                 $ mkdir build ; cd build
                 $ cmake ../src

       cmake [<options>] <path-to-existing-build>
              Uses <path-to-existing-build> as the build tree, and  loads  the
              path to the source tree from its CMakeCache.txt file, which must
              have already been generated by a previous  run  of  CMake.   The
              specified  path may be absolute or relative to the current work-
              ing directory.  For example:

                 $ cd build
                 $ cmake .

       cmake [<options>] -S <path-to-source> -B <path-to-build>
              Uses <path-to-build> as the build tree and  <path-to-source>  as
              the  source  tree.  The specified paths may be absolute or rela-
              tive to the current working directory.   The  source  tree  must
              contain  a  CMakeLists.txt file.  The build tree will be created
              automatically if it does not already exist.  For example:

                 $ cmake -S src -B build

       In all cases the <options> may be zero or more of the Options below.

       After generating a buildsystem one may  use  the  corresponding  native
       build  tool  to  build  the project.  For example, after using the Unix
       Makefiles generator one may run make directly:

              $ make
              $ make install

       Alternatively, one may use cmake to Build a  Project  by  automatically
       choosing and invoking the appropriate native build tool.

   Options
       -S <path-to-source>
              Path to root directory of the CMake project to build.

       -B <path-to-build>
              Path  to directory which CMake will use as the root of build di-
              rectory.

              If the directory doesnt already exist CMake will make it.

       -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 settings
              for the project.  This option may be used to specify a file from
              which  to  load  cache entries before the first pass through the
              projects CMake listfiles.  The loaded entries take priority over
              the  projects  default values.  The given file should be a CMake
              script containing set() commands that use the CACHE option,  not
              a cache-format file.

              References  to  CMAKE_SOURCE_DIR and CMAKE_BINARY_DIR within the
              script evaluate to the top-level source and build tree.

       -D <var>:<type>=<value>, -D <var>=<value>
              Create or update a CMake CACHE entry.

              When CMake is first run in an empty build  tree,  it  creates  a
              CMak.

CMAKE(1)                             CMake                            CMAKE(1)

NAME
       cmake - CMake Command-Line Reference

SYNOPSIS
          Generate a Project Buildsystem
           cmake [<options>] <path-to-source>
           cmake [<options>] <path-to-existing-build>
           cmake [<options>] -S <path-to-source> -B <path-to-build>

          Build a Project
           cmake --build <dir> [<options>] [-- <build-tool-options>]

          Install a Project
           cmake --install <dir> [<options>]

          Open a Project
           cmake --open <dir>

          Run a Script
           cmake [{-D <var>=<value>}...] -P <cmake-script-file>

          Run a Command-Line Tool
           cmake -E <command> [<options>]

          Run the Find-Package Tool
           cmake --find-package [<options>]

          View Help
           cmake --help[-<topic>]

DESCRIPTION
       The  cmake  executable is the command-line interface of the cross-plat-
       form buildsystem generator CMake.  The above Synopsis lists various ac-
       tions the tool can perform as described in sections below.

       To build a software project with CMake, Generate a Project Buildsystem.
       Optionally use cmake to Build a Project, Install a Project or just  run
       the  corresponding  build tool (e.g. make) directly.  cmake can also be
       used to View Help.

       The other actions are meant for  use  by  software  developers  writing
       scripts in the CMake language to support their builds.

       For  graphical  user interfaces that may be used in place of cmake, see
       ccmake and cmake-gui.  For command-line interfaces to the CMake testing
       and packaging facilities, see ctest and cpack.

       For  more  information on CMake at large, see also the links at the end
       of this manual.

INTRODUCTION TO CMAKE BUILDSYSTEMS
       A buildsystem describes how to build a  projects  executables  and  li-
       braries  from  its  source  code  using  a  build  tool to automate the
       process.  For example, a buildsystem may be a Makefile for use  with  a
       command-line  make tool or a project file for an Integrated Development
       Environment  (IDE).   In  order  to  avoid  maintaining  multiple  such
       buildsystems,  a  project  may specify its buildsystem abstractly using
       files written in the CMake language.  From these files CMake  generates
       a  preferred buildsystem locally for each user through a backend called
       a generator.

       To generate a buildsystem with CMake, the following must be selected:

       Source Tree
              The top-level directory containing source files provided by  the
              project.   The  project specifies its buildsystem using files as
              described in  the  cmake-language(7)  manual,  starting  with  a
              top-level  file named CMakeLists.txt.  These files specify build
              targets   and   their   dependencies   as   described   in   the
              cmake-buildsystem(7) manual.

       Build Tree
              The  top-level  directory  in  which buildsystem files and build
              output artifacts (e.g. executables  and  libraries)  are  to  be
              stored.   CMake will write a CMakeCache.txt file to identify the
              directory as a build tree and store persistent information  such
              as buildsystem configuration options.

              To  maintain  a  pristine  source tree, perform an out-of-source
              build by using a separate dedicated build  tree.   An  in-source
              build in which the build tree is placed in the same directory as
              the source tree is also supported, but discouraged.

       Generator
              This chooses the kind  of  buildsystem  to  generate.   See  the
              cmake-generators(7)  manual for documentation of all generators.
              Run cmake --help to see a list of generators available  locally.
              Optionally  use  the  -G option below to specify a generator, or
              simply accept the default CMake chooses for  the  current  plat-
              form.

              When  using  one of the Command-Line Build Tool Generators CMake
              expects that the environment needed by the compiler toolchain is
              already  configured  in  the  shell.   When using one of the IDE
              Build Tool Generators, no particular environment is needed.

GENERATE A PROJECT BUILDSYSTEM
       Run CMake with one of the following command signatures to  specify  the
       source and build trees and generate a buildsystem:

       cmake [<options>] <path-to-source>
              Uses  the  current  working  directory  as  the  build tree, and
              <path-to-source> as the source tree.  The specified path may  be
              absolute  or  relative  to  the  current working directory.  The
              source tree must contain a CMakeLists.txt file and must not con-
              tain  a CMakeCache.txt file because the latter identifies an ex-
              isting build tree.  For example:

                 $ mkdir build ; cd build
                 $ cmake ../src

       cmake [<options>] <path-to-existing-build>
              Uses <path-to-existing-build> as the build tree, and  loads  the
              path to the source tree from its CMakeCache.txt file, which must
              have already been generated by a previous  run  of  CMake.   The
              specified  path may be absolute or relative to the current work-
              ing directory.  For example:

                 $ cd build
                 $ cmake .

       cmake [<options>] -S <path-to-source> -B <path-to-build>
              Uses <path-to-build> as the build tree and  <path-to-source>  as
              the  source  tree.  The specified paths may be absolute or rela-
              tive to the current working directory.   The  source  tree  must
              contain  a  CMakeLists.txt file.  The build tree will be created
              automatically if it does not already exist.  For example:

                 $ cmake -S src -B build

       In all cases the <options> may be zero or more of the Options below.

       After generating a buildsystem one may  use  the  corresponding  native
       build  tool  to  build  the project.  For example, after using the Unix
       Makefiles generator one may run make directly:

              $ make
              $ make install

       Alternatively, one may use cmake to Build a  Project  by  automatically
       choosing and invoking the appropriate native build tool.

   Options
       -S <path-to-source>
              Path to root directory of the CMake project to build.

       -B <path-to-build>
              Path  to directory which CMake will use as the root of build di-
              rectory.

              If the directory doesnt already exist CMake will make it.

       -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 settings
              for the project.  This option may be used to specify a file from
              which  to  load  cache entries before the first pass through the
              projects CMake listfiles.  The loaded entries take priority over
              the  projects  default values.  The given file should be a CMake
              script containing set() commands that use the CACHE option,  not
              a cache-format file.

              References  to  CMAKE_SOURCE_DIR and CMAKE_BINARY_DIR within the
              script evaluate to the top-level source and build tree.

       -D <var>:<type>=<value>, -D <var>=<value>
              Create or update a CMake CACHE entry.

              When CMake is first run in an empty build  tree,  it  creates  a
              CMak.

CMAKE(1)                             CMake                            CMAKE(1)

NAME
       cmake - CMake Command-Line Reference

SYNOPSIS
          Generate a Project Buildsystem
           cmake [<options>] <path-to-source>
           cmake [<options>] <path-to-existing-build>
           cmake [<options>] -S <path-to-source> -B <path-to-build>

          Build a Project
           cmake --build <dir> [<options>] [-- <build-tool-options>]

          Install a Project
           cmake --install <dir> [<options>]

          Open a Project
           cmake --open <dir>

          Run a Script
           cmake [{-D <var>=<value>}...] -P <cmake-script-file>

          Run a Command-Line Tool
           cmake -E <command> [<options>]

          Run the Find-Package Tool
           cmake --find-package [<options>]

          View Help
           cmake --help[-<topic>]

DESCRIPTION
       The  cmake  executable is the command-line interface of the cross-plat-
       form buildsystem generator CMake.  The above Synopsis lists various ac-
       tions the tool can perform as described in sections below.

       To build a software project with CMake, Generate a Project Buildsystem.
       Optionally use cmake to Build a Project, Install a Project or just  run
       the  corresponding  build tool (e.g. make) directly.  cmake can also be
       used to View Help.

       The other actions are meant for  use  by  software  developers  writing
       scripts in the CMake language to support their builds.

       For  graphical  user interfaces that may be used in place of cmake, see
       ccmake and cmake-gui.  For command-line interfaces to the CMake testing
       and packaging facilities, see ctest and cpack.

       For  more  information on CMake at large, see also the links at the end
       of this manual.

INTRODUCTION TO CMAKE BUILDSYSTEMS
       A buildsystem describes how to build a  projects  executables  and  li-
       braries  from  its  source  code  using  a  build  tool to automate the
       process.  For example, a buildsystem may be a Makefile for use  with  a
       command-line  make tool or a project file for an Integrated Development
       Environment  (IDE).   In  order  to  avoid  maintaining  multiple  such
       buildsystems,  a  project  may specify its buildsystem abstractly using
       files written in the CMake language.  From these files CMake  generates
       a  preferred buildsystem locally for each user through a backend called
       a generator.

       To generate a buildsystem with CMake, the following must be selected:

       Source Tree
              The top-level directory containing source files provided by  the
              project.   The  project specifies its buildsystem using files as
              described in  the  cmake-language(7)  manual,  starting  with  a
              top-level  file named CMakeLists.txt.  These files specify build
              targets   and   their   dependencies   as   described   in   the
              cmake-buildsystem(7) manual.

       Build Tree
              The  top-level  directory  in  which buildsystem files and build
              output artifacts (e.g. executables  and  libraries)  are  to  be
              stored.   CMake will write a CMakeCache.txt file to identify the
              directory as a build tree and store persistent information  such
              as buildsystem configuration options.

              To  maintain  a  pristine  source tree, perform an out-of-source
              build by using a separate dedicated build  tree.   An  in-source
              build in which the build tree is placed in the same directory as
              the source tree is also supported, but discouraged.

       Generator
              This chooses the kind  of  buildsystem  to  generate.   See  the
              cmake-generators(7)  manual for documentation of all generators.
              Run cmake --help to see a list of generators available  locally.
              Optionally  use  the  -G option below to specify a generator, or
              simply accept the default CMake chooses for  the  current  plat-
              form.

              When  using  one of the Command-Line Build Tool Generators CMake
              expects that the environment needed by the compiler toolchain is
              already  configured  in  the  shell.   When using one of the IDE
              Build Tool Generators, no particular environment is needed.

GENERATE A PROJECT BUILDSYSTEM
       Run CMake with one of the following command signatures to  specify  the
       source and build trees and generate a buildsystem:

       cmake [<options>] <path-to-source>
              Uses  the  current  working  directory  as  the  build tree, and
              <path-to-source> as the source tree.  The specified path may  be
              absolute  or  relative  to  the  current working directory.  The
              source tree must contain a CMakeLists.txt file and must not con-
              tain  a CMakeCache.txt file because the latter identifies an ex-
              isting build tree.  For example:

                 $ mkdir build ; cd build
                 $ cmake ../src

       cmake [<options>] <path-to-existing-build>
              Uses <path-to-existing-build> as the build tree, and  loads  the
              path to the source tree from its CMakeCache.txt file, which must
              have already been generated by a previous  run  of  CMake.   The
              specified  path may be absolute or relative to the current work-
              ing directory.  For example:

                 $ cd build
                 $ cmake .

       cmake [<options>] -S <path-to-source> -B <p

3.18.4                        September 13, 2021                      CMAKE(1)

Czas wygenerowania: 0.00039 sek.


Created with the man page lookup class by Andrew Collington.
Based on a C man page viewer by Vadim Pavlov
Unicode soft-hyphen fix (as used by RedHat) by Dan Edwards
Some optimisations by Eli Argon
Caching idea and code contribution by James Richardson

Copyright © 2003-2025 Linux.pl
Hosted by Hosting Linux.pl