From 85e6e935c5937c1f9c21eef53058faa34cf812ca Mon Sep 17 00:00:00 2001
From: Daniel Stenberg <daniel@haxx.se>
Date: Fri, 26 May 2000 11:59:43 +0000
Subject: updated

---
 docs/README.libcurl      | 30 ++++++++++++++++--------------
 docs/curl_easy_perform.3 | 11 ++++++++---
 2 files changed, 24 insertions(+), 17 deletions(-)

(limited to 'docs')

diff --git a/docs/README.libcurl b/docs/README.libcurl
index 9d6da3d60..579989fa1 100644
--- a/docs/README.libcurl
+++ b/docs/README.libcurl
@@ -26,24 +26,26 @@ Function descriptions
  The interface is meant to be very simple for very simple
  implementations. Thus, we have minimized the number of entries.
 
-Main Operations
+The Easy Interface
 
- You INIT the lib
+ When using the easy interface, you init your easy-session and get a handle,
+ which you use as input to the following interface functions you use.
 
- You SET OPTIONS you want the lib to use.
+ You continue be setting all the options you want in the upcoming transfer,
+ most important among them is the URL itself. You might want to set some
+ callbacks as well that will be called from the library when data is available
+ etc.
 
- You tell the lib to PERFORM the transfer.
+ When all is setup, you tell libcurl to perform the transfer. It will then do
+ the entire operation and won't return until it is done or failed.
 
- You CLEAN UP the lib
+ After the performance is made, you cleanup the easy-session's handle and
+ libcurl is entire off the hook!
 
- done.
+ See the separate man pages for the libcurl functions for details:
 
- See the separate man pages for the libcurl functions for details.
+        curl_easy_init() 
+        curl_easy_setopt() 
+        curl_easy_perform() 
+        curl_easy_cleanup() 
 
-
-        CURLcode curl_easy_setopt(CURL *curl, CURLoption option, ...);
-
-
-
-CURLcode curl_easy_perform(CURL *curl);
-void curl_easy_cleanup(CURL *curl);
diff --git a/docs/curl_easy_perform.3 b/docs/curl_easy_perform.3
index 35b3b6118..959340c15 100644
--- a/docs/curl_easy_perform.3
+++ b/docs/curl_easy_perform.3
@@ -4,11 +4,11 @@
 .\"
 .TH curl_easy_perform 3 "26 May 2000" "Curl 7.0" "libcurl Manual"
 .SH NAME
-curl_easy_perform - Do the actual transfers in a "easy" session
+curl_easy_perform - Do the actual transfer in a "easy" session
 .SH SYNOPSIS
 .B #include <curl/easy.h>
 .sp
-.BI "curl_easy_perform(CURL *" handle ");
+.BI "CURLcode curl_easy_perform(CURL *" handle ");
 .ad
 .SH DESCRIPTION
 This function is called after the init and all the curl_easy_setopt() calls
@@ -17,7 +17,12 @@ It must be called with the same
 .I handle
 as input as the curl_easy_init call returned.
 .SH RETURN VALUE
-None
+0 means everything was ok, non-zero means an error occurred as
+.I <curl/curl.h>
+defines. If the CURLOPT_ERRORBUFFER was set with
+.I curl_easy_setopt
+there willo be a readable error message in the error buffer when non-zero is
+returned.
 .SH "SEE ALSO"
 .BR curl_easy_init "(3), " curl_easy_setopt "(3), "
 .SH BUGS
-- 
cgit v1.2.3