README 2.5 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455
  1. _ _ ____ _
  2. ___| | | | _ \| |
  3. / __| | | | |_) | |
  4. | (__| |_| | _ <| |___
  5. \___|\___/|_| \_\_____|
  6. Include files for libcurl, external users.
  7. They're all placed in the curl subdirectory here for better fit in any kind
  8. of environment. You must include files from here using...
  9. #include <curl/curl.h>
  10. ... style and point the compiler's include path to the directory holding the
  11. curl subdirectory. It makes it more likely to survive future modifications.
  12. NOTE FOR LIBCURL HACKERS
  13. The following notes apply to libcurl version 7.19.0 and later.
  14. * The distributed curl/curlbuild.h file is only intended to be used on systems
  15. which can not run the also distributed configure script.
  16. * The distributed curlbuild.h file is generated as a copy of curlbuild.h.dist
  17. when the libcurl source code distribution archive file is originally created.
  18. * If you check out from git on a non-configure platform, you must run the
  19. appropriate buildconf* script to set up curlbuild.h and other local files
  20. before being able of compiling the library.
  21. * On systems capable of running the configure script, the configure process
  22. will overwrite the distributed include/curl/curlbuild.h file with one that
  23. is suitable and specific to the library being configured and built, which
  24. is generated from the include/curl/curlbuild.h.in template file.
  25. * If you intend to distribute an already compiled libcurl library you _MUST_
  26. also distribute along with it the generated curl/curlbuild.h which has been
  27. used to compile it. Otherwise the library will be of no use for the users of
  28. the library that you have built. It is _your_ responsibility to provide this
  29. file. No one at the cURL project can know how you have built the library.
  30. * File curl/curlbuild.h includes platform and configuration dependent info,
  31. and must not be modified by anyone. Configure script generates it for you.
  32. * We cannot assume anything else but very basic compiler features being
  33. present. While libcurl requires an ANSI C compiler to build, some of the
  34. earlier ANSI compilers clearly can't deal with some preprocessor operators.
  35. * Newlines must remain unix-style for older compilers' sake.
  36. * Comments must be written in the old-style /* unnested C-fashion */
  37. To figure out how to do good and portable checks for features, operating
  38. systems or specific hardwarare, a very good resource is Bjorn Reese's
  39. collection at http://predef.sf.net/