Home Explore Help
Register Sign In
Apq
/
CMake
mirror of https://github.com/Kitware/CMake.git
1
0
Fork 0
Files Issues 0 Wiki
Tree: 6b5f2dbbfe
Branches Tags
CMake
/
Help
/
command
/
find_path.rst

find_path.rst 2.1 KB
History Raw

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950 
  1. find_path
    2. 

  2. ---------
    3. 

  3. 

  4. .. |FIND_XXX| replace:: find_path
    5. 

  5. .. |NAMES| replace:: NAMES name1 [name2 ...]
    6. 

  6. .. |SEARCH_XXX| replace:: file in a directory
    7. 

  7. .. |SEARCH_XXX_DESC| replace:: directory containing the named file
    8. 

  8. .. |prefix_XXX_SUBDIR| replace:: ``<prefix>/include``
    9. 

  9. .. |entry_XXX_SUBDIR| replace:: ``<entry>/include``
    10. 

  10. 

  11. .. |FIND_XXX_REGISTRY_VIEW_DEFAULT| replace:: ``TARGET``
    12. 

  12. 

  13. .. |FIND_PACKAGE_ROOT_PREFIX_PATH_XXX| replace::
    14. 

  14.    ``<prefix>/include/<arch>`` if :variable:`CMAKE_LIBRARY_ARCHITECTURE`
    15. 

  15.    is set, and |FIND_PACKAGE_ROOT_PREFIX_PATH_XXX_SUBDIR|
    16. 

  16. .. |CMAKE_PREFIX_PATH_XXX| replace::
    17. 

  17.    ``<prefix>/include/<arch>`` if :variable:`CMAKE_LIBRARY_ARCHITECTURE`
    18. 

  18.    is set, and |CMAKE_PREFIX_PATH_XXX_SUBDIR|
    19. 

  19. .. |CMAKE_XXX_PATH| replace:: :variable:`CMAKE_INCLUDE_PATH`
    20. 

  20. .. |CMAKE_XXX_MAC_PATH| replace:: :variable:`CMAKE_FRAMEWORK_PATH`
    21. 

  21. 

  22. .. |ENV_CMAKE_PREFIX_PATH_XXX| replace::
    23. 

  23.    ``<prefix>/include/<arch>`` if :variable:`CMAKE_LIBRARY_ARCHITECTURE` is set,
    24. 

  24.    and |ENV_CMAKE_PREFIX_PATH_XXX_SUBDIR|
    25. 

  25. .. |ENV_CMAKE_XXX_PATH| replace:: :envvar:`CMAKE_INCLUDE_PATH`
    26. 

  26. .. |ENV_CMAKE_XXX_MAC_PATH| replace:: :envvar:`CMAKE_FRAMEWORK_PATH`
    27. 

  27. 

  28. .. |SYSTEM_ENVIRONMENT_PATH_XXX| replace:: The directories in ``INCLUDE``
    29. 

  29.    and ``PATH``.
    30. 

  30. .. |SYSTEM_ENVIRONMENT_PATH_WINDOWS_XXX| replace:: On Windows hosts:
    31. 

  31.       ``<prefix>/include/<arch>`` if :variable:`CMAKE_LIBRARY_ARCHITECTURE`
    32. 

  32.       is set, and |SYSTEM_ENVIRONMENT_PREFIX_PATH_XXX_SUBDIR|.
    33. 

  33. 

  34. .. |CMAKE_SYSTEM_PREFIX_PATH_XXX| replace::
    35. 

  35.    ``<prefix>/include/<arch>`` if :variable:`CMAKE_LIBRARY_ARCHITECTURE`
    36. 

  36.    is set, and |CMAKE_SYSTEM_PREFIX_PATH_XXX_SUBDIR|
    37. 

  37. .. |CMAKE_SYSTEM_XXX_PATH| replace::
    38. 

  38.    :variable:`CMAKE_SYSTEM_INCLUDE_PATH`
    39. 

  39. .. |CMAKE_SYSTEM_XXX_MAC_PATH| replace::
    40. 

  40.    :variable:`CMAKE_SYSTEM_FRAMEWORK_PATH`
    41. 

  41. 

  42. .. |CMAKE_FIND_ROOT_PATH_MODE_XXX| replace::
    43. 

  43.    :variable:`CMAKE_FIND_ROOT_PATH_MODE_INCLUDE`
    44. 

  44. 

  45. .. include:: FIND_XXX.txt
    46. 

  46. 

  47. When searching for frameworks, if the file is specified as ``A/b.h``, then
    48. 

  48. the framework search will look for ``A.framework/Headers/b.h``.  If that
    49. 

  49. is found the path will be set to the path to the framework.  CMake
    50. 

  50. will convert this to the correct ``-F`` option to include the file.
    51.