.. Generated by qibuild/doc/tools/gen_cmake_doc.py
.. DO NOT EDIT

.. highlight:: cmake

Installing
===========

See general documentation here :ref:`cmake-install`



.. _qi_install:

qi_install
----------

.. cmake:function:: qi_install([SUBFOLDER <subfolder>] [IF <if>] [KEEP_RELATIVE_PATHS])

    :arg SUBFOLDER: An optional subfolder in which to put the files.
    :arg IF: Condition that should be verified for the install rules to be active for example (IF WITH_ZEROMQ)
    :arg KEEP_RELATIVE_PATHS: If true, relative paths will be preserved during installation.

    Generic install function.



.. _qi_install_header:

qi_install_header
-----------------

.. cmake:function:: qi_install_header([<remaining args> ...] [SUBFOLDER <subfolder>] [IF <if>] [KEEP_RELATIVE_PATHS])

    :arg remaining args: A list of files : directories and globs on files are accepted.
    :arg SUBFOLDER: An optional subfolder in which to put the files.
    :arg IF: Condition that should be verified for the install rules to be active for example (IF WITH_ZEROMQ)
    :arg KEEP_RELATIVE_PATHS: If true, relative paths will be preserved during installation. (False by default because this is NOT the standard CMake behavior)

    Install application headers.
    The destination will be <prefix>/include/
    



.. _qi_install_data:

qi_install_data
---------------

.. cmake:function:: qi_install_data([<remaining args> ...] [SUBFOLDER <subfolder>] [IF <if>] [KEEP_RELATIVE_PATHS])

    :arg remaining args: A list of files : directories and globs on files are accepted.
    :arg SUBFOLDER: An optional subfolder in which to put the files.
    :arg IF: Condition that should be verified for the install rules to be active for example (IF WITH_ZEROMQ)
    :arg KEEP_RELATIVE_PATHS: If true, relative paths will be preserved during installation. (False by default because this is NOT the standard CMake behavior) 

    Install application data.
    The destination will be: <prefix>/share/
    



.. _qi_install_doc:

qi_install_doc
--------------

.. cmake:function:: qi_install_doc([<remaining args> ...] [SUBFOLDER <subfolder>] [IF <if>] [KEEP_RELATIVE_PATHS])

    :arg remaining args: A list of files : directories and globs on files are accepted.
    :arg SUBFOLDER: An optional subfolder in which to put the files.
    :arg IF: Condition that should be verified for the install rules to be active for example (IF WITH_ZEROMQ)
    :arg KEEP_RELATIVE_PATHS: If true, relative paths will be preserved during installation. (False by default because this is NOT the standard CMake behavior) 

    Install application doc.
    The destination will be: <prefix>/share/doc/
    



.. _qi_install_conf:

qi_install_conf
---------------

.. cmake:function:: qi_install_conf([<remaining args> ...] [SUBFOLDER <subfolder>] [IF <if>] [KEEP_RELATIVE_PATHS])

    :arg remaining args: A list of files : directories and globs on files are accepted.
    :arg SUBFOLDER: An optional subfolder in which to put the files.
    :arg IF: Condition that should be verified for the install rules to be active for example (IF WITH_ZEROMQ)
    :arg KEEP_RELATIVE_PATHS: If true, relative paths will be preserved during installation. (False by default because this is NOT the standard CMake behavior) 

    Install application configuration files.
    



.. _qi_install_cmake:

qi_install_cmake
----------------

.. cmake:function:: qi_install_cmake([<remaining args> ...] [SUBFOLDER <subfolder>] [IF <if>] [KEEP_RELATIVE_PATHS])

    :arg remaining args: A list of files : directories and globs on files are accepted.
    :arg SUBFOLDER: An optional subfolder in which to put the files.
    :arg IF: Condition that should be verified for the install rules to be active for example (IF WITH_ZEROMQ)
    :arg KEEP_RELATIVE_PATHS: If true, relative paths will be preserved during installation. (False by default because this is NOT the standard CMake behavior) 

    Install CMake module files.
    The destination will be: <prefix>/share/cmake/
    



.. _qi_install_target:

qi_install_target
-----------------

.. cmake:function:: qi_install_target([<remaining args> ...] [SUBFOLDER <subfolder>] [IF <if>])

    :arg remaining args: A list of targets to install
    :arg SUBFOLDER: An optional subfolder in which to put the files.
    :arg IF: Condition that should be verified for the install rules to be active for example (IF WITH_ZEROMQ)

    install a target, that could be a program or a library.
    



.. _qi_install_program:

qi_install_program
------------------

.. cmake:function:: qi_install_program([<remaining args> ...] [SUBFOLDER <subfolder>] [IF <if>])

    :arg remaining args: A list of programs to install
    :arg SUBFOLDER: An optional subfolder in which to put the files.
    :arg IF: Condition that should be verified for the install rules to be active for example (IF WITH_ZEROMQ)

    install program (mostly script or user provided program). Do not use this function
    to install a library or a program built by your project, prefer using qi_install_target.
    



.. _qi_install_library:

qi_install_library
------------------

.. cmake:function:: qi_install_library([<remaining args> ...] [SUBFOLDER <subfolder>] [IF <if>])

    :arg remaining args: A list of libraries to install
    :arg SUBFOLDER: An optional subfolder in which to put the files.
    :arg IF: Condition that should be verified for the install rules to be active for example (IF WITH_ZEROMQ)

    install external library. Do not use this function
    to install a library or a program built by your project,
    prefer using qi_install_target.