aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorDaniel Stenberg <daniel@haxx.se>2004-03-15 11:37:37 +0000
committerDaniel Stenberg <daniel@haxx.se>2004-03-15 11:37:37 +0000
commit6dc8fac1229c7cb23995dd105f3cd5184d4bd6ca (patch)
tree6e59c1cafdb8843854574293e2d70e435d5e4efa /docs
parent8114f8562b2c9762e8bd164de4b2d73b8094a781 (diff)
random formatting updates to look better in HTML version
Diffstat (limited to 'docs')
-rw-r--r--docs/libcurl/curl_multi_add_handle.36
-rw-r--r--docs/libcurl/curl_multi_cleanup.32
-rw-r--r--docs/libcurl/curl_multi_fdset.33
-rw-r--r--docs/libcurl/curl_multi_init.37
-rw-r--r--docs/libcurl/curl_multi_perform.37
-rw-r--r--docs/libcurl/libcurl-multi.32
6 files changed, 14 insertions, 13 deletions
diff --git a/docs/libcurl/curl_multi_add_handle.3 b/docs/libcurl/curl_multi_add_handle.3
index c2077a048..1f0755002 100644
--- a/docs/libcurl/curl_multi_add_handle.3
+++ b/docs/libcurl/curl_multi_add_handle.3
@@ -9,11 +9,11 @@ curl_multi_add_handle - add an easy handle to a multi session
CURLMcode curl_multi_add_handle(CURLM *multi_handle, CURL *easy_handle);
.ad
.SH DESCRIPTION
-Adds a standard easy handle to the multi stack. This will make this multi
-handle control the specified easy handle.
+Adds a standard easy handle to the multi stack. This function call will make
+this \fImulti_handle\fP control the specified \fIeasy_handle\fP.
When an easy handle has been added to a multi stack, you can not and you must
-not use curl_easy_perform() on that handle!
+not use \fIcurl_easy_perform(3)\fP on that handle!
.SH RETURN VALUE
CURLMcode type, general libcurl multi interface error code.
.SH "SEE ALSO"
diff --git a/docs/libcurl/curl_multi_cleanup.3 b/docs/libcurl/curl_multi_cleanup.3
index d7830e7ac..cbe3f0f11 100644
--- a/docs/libcurl/curl_multi_cleanup.3
+++ b/docs/libcurl/curl_multi_cleanup.3
@@ -11,7 +11,7 @@ curl_multi_cleanup - close down a multi session
.SH DESCRIPTION
Cleans up and removes a whole multi stack. It does not free or touch any
individual easy handles in any way - they still need to be closed
-individually, using the usual curl_easy_cleanup() way.
+individually, using the usual \fIcurl_easy_cleanup(3)\fP way.
.SH RETURN VALUE
CURLMcode type, general libcurl multi interface error code.
.SH "SEE ALSO"
diff --git a/docs/libcurl/curl_multi_fdset.3 b/docs/libcurl/curl_multi_fdset.3
index 2ec821029..f2b3f9aed 100644
--- a/docs/libcurl/curl_multi_fdset.3
+++ b/docs/libcurl/curl_multi_fdset.3
@@ -22,6 +22,7 @@ NOTE that once this call is made, you must not remove the sets you point to,
as libcurl will need to be able to read them. It needs them after select()
calls, to know if certain sockets are readable or writable.
.SH RETURN VALUE
-CURLMcode type, general libcurl multi interface error code.
+CURLMcode type, general libcurl multi interface error code. See
+\fIlibcurl-errors.3\fP
.SH "SEE ALSO"
.BR curl_multi_cleanup "(3)," curl_multi_init "(3)"
diff --git a/docs/libcurl/curl_multi_init.3 b/docs/libcurl/curl_multi_init.3
index e3619d5c5..40875a81e 100644
--- a/docs/libcurl/curl_multi_init.3
+++ b/docs/libcurl/curl_multi_init.3
@@ -2,7 +2,7 @@
.\"
.TH curl_multi_init 3 "1 March 2002" "libcurl 7.9.5" "libcurl Manual"
.SH NAME
-curl_multi_init - Start a multi session
+curl_multi_init - create a multi handle
.SH SYNOPSIS
.B #include <curl/curl.h>
.sp
@@ -12,11 +12,10 @@ curl_multi_init - Start a multi session
This function returns a CURLM handle to be used as input to all the other
multi-functions, sometimes refered to as a multi handle on some places in the
documentation. This init call MUST have a corresponding call to
-\fIcurl_multi_cleanup\fP when the operation is complete.
+\fIcurl_multi_cleanup(3)\fP when the operation is complete.
.SH RETURN VALUE
If this function returns NULL, something went wrong and you cannot use the
other curl functions.
.SH "SEE ALSO"
.BR curl_multi_cleanup "(3)," curl_global_init "(3)," curl_easy_init "(3)"
-.SH BUGS
-Surely there are some, you tell me!
+
diff --git a/docs/libcurl/curl_multi_perform.3 b/docs/libcurl/curl_multi_perform.3
index 5b54fea8d..51c45aa93 100644
--- a/docs/libcurl/curl_multi_perform.3
+++ b/docs/libcurl/curl_multi_perform.3
@@ -29,8 +29,9 @@ NOTE that this only returns errors etc regarding the whole multi stack. There
might still have occurred problems on invidual transfers even when this
function returns OK.
.SH "TYPICAL USAGE"
-Most application will use \fIcurl_multi_fdset\fP to get the multi_handle's
+Most application will use \fIcurl_multi_fdset(3)\fP to get the multi_handle's
file descriptors, then it'll wait for action on them using select() and as
-soon as one or more of them are ready, \fIcurl_multi_perform\fP gets called.
+soon as one or more of them are ready, \fIcurl_multi_perform(3)\fP gets
+called.
.SH "SEE ALSO"
-.BR curl_multi_cleanup "(3)," curl_multi_init "(3)"
+.BR curl_multi_cleanup "(3)," curl_multi_init "(3)," curl_multi_fdset "(3)"
diff --git a/docs/libcurl/libcurl-multi.3 b/docs/libcurl/libcurl-multi.3
index 90b627329..13b6b84dc 100644
--- a/docs/libcurl/libcurl-multi.3
+++ b/docs/libcurl/libcurl-multi.3
@@ -32,7 +32,7 @@ complicated for the application.
file descriptors simultaneous easily.
.SH "ONE MULTI HANDLE MANY EASY HANDLES"
To use the multi interface, you must first create a 'multi handle' with
-\fIcurl_multi_init\fP. This handle is then used as input to all further
+\fIcurl_multi_init(3)\fP. This handle is then used as input to all further
curl_multi_* functions.
Each single transfer is built up with an easy handle. You must create them,