aboutsummaryrefslogtreecommitdiff
path: root/docs/libcurl
diff options
context:
space:
mode:
authorDaniel Stenberg <daniel@haxx.se>2004-05-05 06:11:57 +0000
committerDaniel Stenberg <daniel@haxx.se>2004-05-05 06:11:57 +0000
commit7332350e852f9b4334711e858b71b6697490e3ec (patch)
tree19b1c7545b4393f3999fc1f77bbb9af50ef9493c /docs/libcurl
parent69f4dda74a905d183daaad5837e8c21c5a205bef (diff)
minor update edits
Diffstat (limited to 'docs/libcurl')
-rw-r--r--docs/libcurl/libcurl-easy.35
-rw-r--r--docs/libcurl/libcurl.347
2 files changed, 19 insertions, 33 deletions
diff --git a/docs/libcurl/libcurl-easy.3 b/docs/libcurl/libcurl-easy.3
index 2fe4c82e5..5280bf6ff 100644
--- a/docs/libcurl/libcurl-easy.3
+++ b/docs/libcurl/libcurl-easy.3
@@ -7,9 +7,8 @@
libcurl-easy \- easy interface overview
.SH DESCRIPTION
When using libcurl's "easy" interface you init your session and get a handle
-(often referred to as an "easy handle" in various docs and sources), which you
-use as input to the easy interface functions you use. Use
-\fIcurl_easy_init(3)\fP to get the handle.
+(often referred to as an "easy handle"), which you use as input to the easy
+interface functions you use. Use \fIcurl_easy_init(3)\fP to get the handle.
You continue by setting all the options you want in the upcoming transfer, the
most important among them is the URL itself (you can't transfer anything
diff --git a/docs/libcurl/libcurl.3 b/docs/libcurl/libcurl.3
index 632bcdf61..742511e18 100644
--- a/docs/libcurl/libcurl.3
+++ b/docs/libcurl/libcurl.3
@@ -33,45 +33,28 @@ The multi interface on the other hand is an asynchronous interface, that you
call and that performs only a little piece of the transfer on each invoke. It
is perfect if you want to do things while the transfer is in progress, or
similar. The multi interface allows you to select() on libcurl action, and
-even to easily download multiple files simultaneously using a single thread.
+even to easily download multiple files simultaneously using a single thread. See further deails in the \fIlibcurl-multi(3)\fP man page.
You can have multiple easy handles share certain data, even if they are used
in different threads. This magic is setup using the share interface, as
described in the \fIlibcurl-share(3)\fP man page.
-There is also a series of other helpful functions to use. They are:
-
+There is also a series of other helpful functions to use, including these:
.RS
-.TP 10
-.B curl_version()
-displays the libcurl version
-.TP
-.B curl_getdate()
+.IP curl_version_info()
+gets detailed libcurl (and other used libraries) version info
+.IP curl_getdate()
converts a date string to time_t
-.TP
-.B curl_getenv()
-portable environment variable reader
-.TP
-.B curl_easy_getinfo()
+.IP curl_easy_getinfo()
get information about a performed transfer
-.TP
-.B curl_formadd()
+.IP curl_formadd()
helps building an HTTP form POST
-.TP
-.B curl_formfree()
+.IP curl_formfree()
free a list built with \fIcurl_formadd(3)\fP
-.TP
-.B curl_slist_append()
+.IP curl_slist_append()
builds a linked list
-.TP
-.B curl_slist_free_all()
+.IP curl_slist_free_all()
frees a whole curl_slist
-.TP
-.B curl_mprintf()
-portable printf() functions
-.TP
-.B curl_strequal()
-portable case insensitive string comparisons
.RE
.SH "LINKING WITH LIBCURL"
@@ -82,13 +65,17 @@ 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.
+link with the particular version of libcurl you've installed. See the
+\fIcurl-config(1)\fP man page for further details.
+
+Unix-like operating system that ship libcurl as part of their distributions
+often don't provide the curl-config tool, but simply install the library and
+headers in the common path for this purpose.
-For details, see the curl-config.1 man page.
.SH "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
+other prefixes indicate that the functions are private and may change without
further notice in the next release.
Only use documented functions and functionality!