From 7b82b07fba1a339aecbf85256c759682db6379d6 Mon Sep 17 00:00:00 2001 From: Daniel Stenberg Date: Tue, 21 Oct 2014 10:26:40 +0200 Subject: docs: edited lots of libcurl docs for clarity --- docs/libcurl/curl_easy_cleanup.3 | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) (limited to 'docs/libcurl/curl_easy_cleanup.3') diff --git a/docs/libcurl/curl_easy_cleanup.3 b/docs/libcurl/curl_easy_cleanup.3 index d8a3f9fcf..8d8375b62 100644 --- a/docs/libcurl/curl_easy_cleanup.3 +++ b/docs/libcurl/curl_easy_cleanup.3 @@ -5,7 +5,7 @@ .\" * | (__| |_| | _ <| |___ .\" * \___|\___/|_| \_\_____| .\" * -.\" * Copyright (C) 1998 - 2011, Daniel Stenberg, , et al. +.\" * Copyright (C) 1998 - 2014, Daniel Stenberg, , et al. .\" * .\" * This software is licensed as described in the file COPYING, which .\" * you should have received as part of this distribution. The terms @@ -22,20 +22,20 @@ .\" .TH curl_easy_cleanup 3 "22 aug 2007" "libcurl 7.17.0" "libcurl Manual" .SH NAME -curl_easy_cleanup - End a libcurl easy session +curl_easy_cleanup - End a libcurl easy handle .SH SYNOPSIS .B #include .BI "void curl_easy_cleanup(CURL *" handle ");" - .SH DESCRIPTION This function must be the last function to call for an easy session. It is the opposite of the \fIcurl_easy_init(3)\fP function and must be called with the -same \fIhandle\fP as input that the curl_easy_init call returned. +same \fIhandle\fP as input that a \fIcurl_easy_init(3)\fP call returned. -This will effectively close all connections this handle has used and possibly -has kept open until now. Don't call this function if you intend to transfer -more files. +This might close all connections this handle has used and possibly has kept +open until now - unless it was attached to a multi handle while doing the +transfers. Don't call this function if you intend to transfer more files, +re-using handles is a key to good performance with libcurl. Occasionally you may get your progress callback or header callback called from within \fIcurl_easy_cleanup(3)\fP (if previously set for the handle using @@ -43,13 +43,13 @@ within \fIcurl_easy_cleanup(3)\fP (if previously set for the handle using connection and the protocol is of a kind that requires a command/response sequence before disconnect. Examples of such protocols are FTP, POP3 and IMAP. -Any uses of the \fBhandle\fP after this function has been called and have -returned, are illegal. This kills the handle and all memory associated with -it! +Any use of the \fBhandle\fP after this function has been called and have +returned, is illegal. \fIcurl_easy_cleanup(3)\fP kills the handle and all +memory associated with it! -With libcurl versions prior to 7.17.: when you've called this, you can safely -remove all the strings you've previously told libcurl to use, as it won't use -them anymore now. +For libcurl versions before 7.17,: after you've called this function, you can +safely remove all the strings you've previously told libcurl to use, as it +won't use them anymore now. .SH RETURN VALUE None .SH "SEE ALSO" -- cgit v1.2.3