mirror of
https://github.com/moparisthebest/curl
synced 2024-12-21 23:58:49 -05:00
Added a brief description of curl-config, mentioned that curl_* functions are
the only public ones
This commit is contained in:
parent
8755c44d40
commit
a91b7d461d
27
docs/LIBCURL
27
docs/LIBCURL
@ -6,8 +6,8 @@
|
||||
|
||||
How To Use Libcurl In Your C/C++ Program
|
||||
|
||||
[ libcurl can be used directly from within your PHP or Perl programs as well,
|
||||
look elsewhere for documentation on this ]
|
||||
[ libcurl can be used directly from within your Java, PHP, Perl, Ruby or Tcl
|
||||
programs as well, look elsewhere for documentation on this ]
|
||||
|
||||
The interface is meant to be very simple for applictions/programmers, hence
|
||||
the name "easy". We have therefore minimized the number of entries.
|
||||
@ -49,6 +49,29 @@ The Easy Interface
|
||||
|
||||
For details on these, read the separate man pages.
|
||||
|
||||
Linking with libcurl
|
||||
|
||||
Staring with 7.7.2 (on unix-like machines), there's a tool named curl-config
|
||||
that gets installed with the rest of the curl stuff when 'make install' is
|
||||
performed.
|
||||
|
||||
curl-config is added to make it easier for applications to link with
|
||||
libcurl and developers to learn about libcurl and how to use it.
|
||||
|
||||
Run 'curl-config --libs' to get the (additional) linker options you need to
|
||||
link with the particular version of libcurl you've installed.
|
||||
|
||||
For details, see the curl-config.1 man page.
|
||||
|
||||
libcurl symbol names
|
||||
|
||||
All public functions in the libcurl interface are prefixed with 'curl_' (with
|
||||
a lowercase c). You can find other functions in the library source code, but
|
||||
other prefixes indicate the functions are private and may change without
|
||||
further notice in the next release.
|
||||
|
||||
Only use documented functions and functionality!
|
||||
|
||||
Portability
|
||||
|
||||
libcurl works *exactly* the same, on any of the platforms it compiles and
|
||||
|
Loading…
Reference in New Issue
Block a user