INSTALL.cmake 4.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100
  1. _ _ ____ _
  2. ___| | | | _ \| |
  3. / __| | | | |_) | |
  4. | (__| |_| | _ <| |___
  5. \___|\___/|_| \_\_____|
  6. How To Compile with CMake
  7. Building with CMake
  8. ==========================
  9. This document describes how to compile, build and install curl and libcurl
  10. from source code using the CMake build tool. To build with CMake, you will
  11. of course have to first install CMake. The minimum required version of
  12. CMake is specified in the file CMakeLists.txt found in the top of the curl
  13. source tree. Once the correct version of CMake is installed you can follow
  14. the instructions below for the platform you are building on.
  15. CMake builds can be configured either from the command line, or from one
  16. of CMake's GUI's.
  17. Current flaws in the curl CMake build
  18. =====================================
  19. Missing features in the cmake build:
  20. - Builds libcurl without large file support
  21. - Can't select which SSL library to build with, only OpenSSL
  22. - Doesn't build with SCP and SFTP support (libssh2)
  23. - Doesn't allow different resolver backends (no c-ares build support)
  24. - No RTMP support built
  25. - Doesn't allow build curl and libcurl debug enabled
  26. - Doesn't allow a custom CA bundle path
  27. - Doesn't allow you to disable specific protocols from the build
  28. - Doesn't find or use krb4 or GSS
  29. - Rebuilds test files too eagerly, but still can't run the tests
  30. Important notice
  31. ==================
  32. If you got your curl sources from a distribution tarball, make sure to
  33. delete the generic 'include/curl/curlbuild.h' file that comes with it:
  34. rm -f curl/include/curl/curlbuild.h
  35. The purpose of this file is to provide reasonable definitions for systems
  36. where autoconfiguration is not available. CMake will create its own
  37. version of this file in its build directory. If the "generic" version
  38. is not deleted, weird build errors may occur on some systems.
  39. Command Line CMake
  40. ==================
  41. A CMake build of curl is similar to the autotools build of curl. It
  42. consists of the following steps after you have unpacked the source.
  43. 1. Create an out of source build tree parallel to the curl source
  44. tree and change into that directory
  45. $ mkdir curl-build
  46. $ cd curl-build
  47. 2. Run CMake from the build tree, giving it the path to the top of
  48. the curl source tree. CMake will pick a compiler for you. If you
  49. want to specify the compile, you can set the CC environment
  50. variable prior to running CMake.
  51. $ cmake ../curl
  52. $ make
  53. 3. Install to default location:
  54. $ make install
  55. (The test suite does not work with the cmake build)
  56. ccmake
  57. =========
  58. CMake comes with a curses based interface called ccmake. To run ccmake on
  59. a curl use the instructions for the command line cmake, but substitute
  60. ccmake ../curl for cmake ../curl. This will bring up a curses interface
  61. with instructions on the bottom of the screen. You can press the "c" key
  62. to configure the project, and the "g" key to generate the project. After
  63. the project is generated, you can run make.
  64. cmake-gui
  65. =========
  66. CMake also comes with a Qt based GUI called cmake-gui. To configure with
  67. cmake-gui, you run cmake-gui and follow these steps:
  68. 1. Fill in the "Where is the source code" combo box with the path to
  69. the curl source tree.
  70. 2. Fill in the "Where to build the binaries" combo box with the path
  71. to the directory for your build tree, ideally this should not be the
  72. same as the source tree, but a parallel directory called curl-build or
  73. something similar.
  74. 3. Once the source and binary directories are specified, press the
  75. "Configure" button.
  76. 4. Select the native build tool that you want to use.
  77. 5. At this point you can change any of the options presented in the
  78. GUI. Once you have selected all the options you want, click the
  79. "Generate" button.
  80. 6. Run the native build tool that you used CMake to generate.