diff options
| author | Daniel Stenberg <daniel@haxx.se> | 2014-10-21 10:26:40 +0200 |
|---|---|---|
| committer | Daniel Stenberg <daniel@haxx.se> | 2014-10-21 10:26:40 +0200 |
| commit | 7b82b07fba1a339aecbf85256c759682db6379d6 (patch) | |
| tree | 5422877f8519767f80f5da4b7dd68739a7a37081 /docs/libcurl/curl_easy_init.3 | |
| parent | c857bb68ec37f82b62238fca73942e6ede8bd8f7 (diff) | |
docs: edited lots of libcurl docs for clarity
Diffstat (limited to 'docs/libcurl/curl_easy_init.3')
| -rw-r--r-- | docs/libcurl/curl_easy_init.3 | 25 |
1 files changed, 11 insertions, 14 deletions
diff --git a/docs/libcurl/curl_easy_init.3 b/docs/libcurl/curl_easy_init.3 index 837ba32a5..f85abdd31 100644 --- a/docs/libcurl/curl_easy_init.3 +++ b/docs/libcurl/curl_easy_init.3 @@ -5,7 +5,7 @@ .\" * | (__| |_| | _ <| |___ .\" * \___|\___/|_| \_\_____| .\" * -.\" * Copyright (C) 1998 - 2011, Daniel Stenberg, <daniel@haxx.se>, et al. +.\" * Copyright (C) 1998 - 2014, Daniel Stenberg, <daniel@haxx.se>, et al. .\" * .\" * This software is licensed as described in the file COPYING, which .\" * you should have received as part of this distribution. The terms @@ -26,24 +26,21 @@ curl_easy_init - Start a libcurl easy session .B #include <curl/curl.h> .BI "CURL *curl_easy_init( );" - .SH DESCRIPTION This function must be the first function to call, and it returns a CURL easy -handle that you must use as input to other easy-functions. curl_easy_init -initializes curl and this call \fBMUST\fP have a corresponding call to +handle that you must use as input to other functions in the easy +interface. This call \fBMUST\fP have a corresponding call to \fIcurl_easy_cleanup(3)\fP when the operation is complete. -If you did not already call \fIcurl_global_init(3)\fP, -\fIcurl_easy_init(3)\fP does it automatically. -This may be lethal in multi-threaded cases, since \fIcurl_global_init(3)\fP is -not thread-safe, and it may result in resource problems because there is -no corresponding cleanup. - -You are strongly advised to not allow this automatic behaviour, by -calling \fIcurl_global_init(3)\fP yourself properly. -See the description in \fBlibcurl\fP(3) of global environment -requirements for details of how to use this function. +If you did not already call \fIcurl_global_init(3)\fP, \fIcurl_easy_init(3)\fP +does it automatically. This may be lethal in multi-threaded cases, since +\fIcurl_global_init(3)\fP is not thread-safe, and it may result in resource +problems because there is no corresponding cleanup. +You are strongly advised to not allow this automatic behaviour, by calling +\fIcurl_global_init(3)\fP yourself properly. See the description in +\fBlibcurl\fP(3) of global environment requirements for details of how to use +this function. .SH RETURN VALUE If this function returns NULL, something went wrong and you cannot use the other curl functions. |