Revert "Update to 7.40.1"
[platform/upstream/curl.git] / docs / libcurl / curl_multi_remove_handle.3
index a8d93ee..ad6d2ba 100644 (file)
@@ -1,8 +1,27 @@
-.\" $Id$
-.\"
+.\" **************************************************************************
+.\" *                                  _   _ ____  _
+.\" *  Project                     ___| | | |  _ \| |
+.\" *                             / __| | | | |_) | |
+.\" *                            | (__| |_| |  _ <| |___
+.\" *                             \___|\___/|_| \_\_____|
+.\" *
+.\" * Copyright (C) 1998 - 2011, 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
+.\" * are also available at http://curl.haxx.se/docs/copyright.html.
+.\" *
+.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
+.\" * copies of the Software, and permit persons to whom the Software is
+.\" * furnished to do so, under the terms of the COPYING file.
+.\" *
+.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
+.\" * KIND, either express or implied.
+.\" *
+.\" **************************************************************************
 .TH curl_multi_remove_handle 3 "6 March 2002" "libcurl 7.9.5" "libcurl Manual"
 .SH NAME
-curl_multi_remove_handle - add an easy handle to a multi session
+curl_multi_remove_handle - remove an easy handle from a multi session
 .SH SYNOPSIS
 #include <curl/curl.h>
 
@@ -14,6 +33,10 @@ specified easy handle be removed from this multi handle's control.
 
 When the easy handle has been removed from a multi stack, it is again
 perfectly legal to invoke \fIcurl_easy_perform()\fP on this easy handle.
+
+Removing an easy handle while being used, will effectively halt the transfer
+in progress involving that easy handle. All other easy handles and transfers
+will remain unaffected.
 .SH RETURN VALUE
 CURLMcode type, general libcurl multi interface error code.
 .SH "SEE ALSO"