diff options
| -rw-r--r-- | docs/libcurl/Makefile.am | 153 | ||||
| -rw-r--r-- | docs/libcurl/curl_easy_strerror.3 | 18 | ||||
| -rw-r--r-- | docs/libcurl/curl_multi_strerror.3 | 18 | ||||
| -rw-r--r-- | docs/libcurl/curl_share_strerror.3 | 18 | ||||
| -rw-r--r-- | docs/libcurl/index.html | 27 | ||||
| -rw-r--r-- | docs/libcurl/libcurl-errors.3 | 17 |
6 files changed, 120 insertions, 131 deletions
diff --git a/docs/libcurl/Makefile.am b/docs/libcurl/Makefile.am index 14d1a49b4..0c85e82a0 100644 --- a/docs/libcurl/Makefile.am +++ b/docs/libcurl/Makefile.am @@ -4,119 +4,50 @@ AUTOMAKE_OPTIONS = foreign no-dependencies -man_MANS = \ - curl_easy_cleanup.3 \ - curl_easy_getinfo.3 \ - curl_easy_init.3 \ - curl_easy_perform.3 \ - curl_easy_setopt.3 \ - curl_easy_duphandle.3 \ - curl_formparse.3 \ - curl_formadd.3 \ - curl_formfree.3 \ - curl_getdate.3 \ - curl_getenv.3 \ - curl_slist_append.3 \ - curl_slist_free_all.3 \ - curl_version.3 \ - curl_version_info.3 \ - curl_escape.3 \ - curl_unescape.3 \ - curl_free.3 \ - curl_strequal.3 \ - curl_strnequal.3 \ - curl_mprintf.3 \ - curl_global_init.3 \ - curl_global_cleanup.3 \ - curl_multi_add_handle.3 \ - curl_multi_cleanup.3 \ - curl_multi_fdset.3 \ - curl_multi_info_read.3 \ - curl_multi_init.3 \ - curl_multi_perform.3 \ - curl_multi_remove_handle.3 \ - curl_share_cleanup.3 curl_share_init.3 curl_share_setopt.3 \ - libcurl.3 \ - libcurl-easy.3 \ - libcurl-multi.3 \ - libcurl-share.3 \ - libcurl-errors.3 +man_MANS = curl_easy_cleanup.3 curl_easy_getinfo.3 curl_easy_init.3 \ + curl_easy_perform.3 curl_easy_setopt.3 curl_easy_duphandle.3 \ + curl_formparse.3 curl_formadd.3 curl_formfree.3 curl_getdate.3 \ + curl_getenv.3 curl_slist_append.3 curl_slist_free_all.3 \ + curl_version.3 curl_version_info.3 curl_escape.3 curl_unescape.3 \ + curl_free.3 curl_strequal.3 curl_mprintf.3 curl_global_init.3 \ + curl_global_cleanup.3 curl_multi_add_handle.3 curl_multi_cleanup.3 \ + curl_multi_fdset.3 curl_multi_info_read.3 curl_multi_init.3 \ + curl_multi_perform.3 curl_multi_remove_handle.3 curl_share_cleanup.3 \ + curl_share_init.3 curl_share_setopt.3 libcurl.3 libcurl-easy.3 \ + libcurl-multi.3 libcurl-share.3 libcurl-errors.3 curl_easy_strerror.3 \ + curl_multi_strerror.3 curl_share_strerror.3 -HTMLPAGES = \ - curl_easy_cleanup.html \ - curl_easy_getinfo.html \ - curl_easy_init.html \ - curl_easy_perform.html \ - curl_easy_setopt.html \ - curl_easy_duphandle.html \ - curl_formadd.html \ - curl_formparse.html \ - curl_formfree.html \ - curl_getdate.html \ - curl_getenv.html \ - curl_slist_append.html \ - curl_slist_free_all.html \ - curl_version.html \ - curl_version_info.html \ - curl_escape.html \ - curl_unescape.html \ - curl_free.html \ - curl_strequal.html \ - curl_strnequal.html \ - curl_mprintf.html \ - curl_global_init.html \ - curl_global_cleanup.html \ - curl_multi_add_handle.html \ - curl_multi_cleanup.html \ - curl_multi_fdset.html \ - curl_multi_info_read.html \ - curl_multi_init.html \ - curl_multi_perform.html \ - curl_multi_remove_handle.html \ - curl_share_cleanup.html curl_share_init.html curl_share_setopt.html \ - libcurl.html \ - libcurl-multi.html \ - libcurl-easy.html \ - libcurl-share.html \ - libcurl-errors.html +HTMLPAGES = curl_easy_cleanup.html curl_easy_getinfo.html \ + curl_easy_init.html curl_easy_perform.html curl_easy_setopt.html \ + curl_easy_duphandle.html curl_formadd.html curl_formparse.html \ + curl_formfree.html curl_getdate.html curl_getenv.html \ + curl_slist_append.html curl_slist_free_all.html curl_version.html \ + curl_version_info.html curl_escape.html curl_unescape.html \ + curl_free.html curl_strequal.html curl_mprintf.html \ + curl_global_init.html curl_global_cleanup.html \ + curl_multi_add_handle.html curl_multi_cleanup.html \ + curl_multi_fdset.html curl_multi_info_read.html curl_multi_init.html \ + curl_multi_perform.html curl_multi_remove_handle.html \ + curl_share_cleanup.html curl_share_init.html curl_share_setopt.html \ + libcurl.html libcurl-multi.html libcurl-easy.html libcurl-share.html \ + libcurl-errors.html curl_easy_strerror.3 curl_multi_strerror.3 \ + curl_share_strerror.3 -PDFPAGES = \ - curl_easy_cleanup.pdf \ - curl_easy_getinfo.pdf \ - curl_easy_init.pdf \ - curl_easy_perform.pdf \ - curl_easy_setopt.pdf \ - curl_easy_duphandle.pdf \ - curl_formadd.pdf \ - curl_formparse.pdf \ - curl_formfree.pdf \ - curl_getdate.pdf \ - curl_getenv.pdf \ - curl_slist_append.pdf \ - curl_slist_free_all.pdf \ - curl_version.pdf \ - curl_version_info.pdf \ - curl_escape.pdf \ - curl_unescape.pdf \ - curl_free.pdf \ - curl_strequal.pdf \ - curl_strnequal.pdf \ - curl_mprintf.pdf \ - curl_global_init.pdf \ - curl_global_cleanup.pdf \ - curl_multi_add_handle.pdf \ - curl_multi_cleanup.pdf \ - curl_multi_fdset.pdf \ - curl_multi_info_read.pdf \ - curl_multi_init.pdf \ - curl_multi_perform.pdf \ - curl_multi_remove_handle.pdf \ - curl_share_cleanup.pdf curl_share_init.pdf curl_share_setopt.pdf \ - libcurl.pdf \ - libcurl-multi.pdf \ - libcurl-easy.pdf \ - libcurl-share.pdf \ - libcurl-errors.pdf +PDFPAGES = curl_easy_cleanup.pdf curl_easy_getinfo.pdf \ + curl_easy_init.pdf curl_easy_perform.pdf curl_easy_setopt.pdf \ + curl_easy_duphandle.pdf curl_formadd.pdf curl_formparse.pdf \ + curl_formfree.pdf curl_getdate.pdf curl_getenv.pdf \ + curl_slist_append.pdf curl_slist_free_all.pdf curl_version.pdf \ + curl_version_info.pdf curl_escape.pdf curl_unescape.pdf curl_free.pdf \ + curl_strequal.pdf curl_mprintf.pdf curl_global_init.pdf \ + curl_global_cleanup.pdf curl_multi_add_handle.pdf \ + curl_multi_cleanup.pdf curl_multi_fdset.pdf curl_multi_info_read.pdf \ + curl_multi_init.pdf curl_multi_perform.pdf \ + curl_multi_remove_handle.pdf curl_share_cleanup.pdf \ + curl_share_init.pdf curl_share_setopt.pdf libcurl.pdf \ + libcurl-multi.pdf libcurl-easy.pdf libcurl-share.pdf \ + libcurl-errors.pdf curl_easy_strerror.3 curl_multi_strerror.3 \ + curl_share_strerror.3 CLEANFILES = $(HTMLPAGES) $(PDFPAGES) diff --git a/docs/libcurl/curl_easy_strerror.3 b/docs/libcurl/curl_easy_strerror.3 new file mode 100644 index 000000000..eb7cecc4c --- /dev/null +++ b/docs/libcurl/curl_easy_strerror.3 @@ -0,0 +1,18 @@ +.\" You can view this file with: +.\" nroff -man [file] +.\" $Id$ +.\" +.TH curl_easy_strerror 3 "26 Apr 2004" "libcurl 7.12" "libcurl Manual" +.SH NAME +curl_easy_strerror - return string describing error code +.SH SYNOPSIS +.nf +.B #include <curl/curl.h> +.BI "const char *curl_easy_strerror(CURLcode " errornum ");" +.SH DESCRIPTION +The curl_easy_strerror() function returns a string describing the CURLcode +error code passed in the argument \fIerrornum\fP. +.SH RETURN VALUE +A pointer to a zero terminated string. +.SH "SEE ALSO" +.BR libcurl-errors "(3), " curl_multi_strerror "(3), " curl_share_strerror "(3)" diff --git a/docs/libcurl/curl_multi_strerror.3 b/docs/libcurl/curl_multi_strerror.3 new file mode 100644 index 000000000..f2fea3b92 --- /dev/null +++ b/docs/libcurl/curl_multi_strerror.3 @@ -0,0 +1,18 @@ +.\" You can view this file with: +.\" nroff -man [file] +.\" $Id$ +.\" +.TH curl_multi_strerror 3 "26 Apr 2004" "libcurl 7.12" "libcurl Manual" +.SH NAME +curl_multi_strerror - return string describing error code +.SH SYNOPSIS +.nf +.B #include <curl/curl.h> +.BI "const char *curl_multi_strerror(CURLMcode " errornum ");" +.SH DESCRIPTION +The curl_multi_strerror() function returns a string describing the CURLMcode +error code passed in the argument \fIerrornum\fP. +.SH RETURN VALUE +A pointer to a zero terminated string. +.SH "SEE ALSO" +.BR libcurl-errors "(3), " curl_easy_strerror "(3), " curl_share_strerror "(3)" diff --git a/docs/libcurl/curl_share_strerror.3 b/docs/libcurl/curl_share_strerror.3 new file mode 100644 index 000000000..35fa4db8c --- /dev/null +++ b/docs/libcurl/curl_share_strerror.3 @@ -0,0 +1,18 @@ +.\" You can view this file with: +.\" nroff -man [file] +.\" $Id$ +.\" +.TH curl_share_strerror 3 "26 Apr 2004" "libcurl 7.12" "libcurl Manual" +.SH NAME +curl_share_strerror - return string describing error code +.SH SYNOPSIS +.nf +.B #include <curl/curl.h> +.BI "const char *curl_share_strerror(CURLSHcode " errornum ");" +.SH DESCRIPTION +The curl_share_strerror() function returns a string describing the CURLSHcode +error code passed in the argument \fIerrornum\fP. +.SH RETURN VALUE +A pointer to a zero terminated string. +.SH "SEE ALSO" +.BR libcurl-errors "(3), " curl_multi_strerror "(3), " curl_easy_strerror "(3)" diff --git a/docs/libcurl/index.html b/docs/libcurl/index.html index 997e6cea1..817ffe6dd 100644 --- a/docs/libcurl/index.html +++ b/docs/libcurl/index.html @@ -1,14 +1,14 @@ -<HTML> -<HEAD> -<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=iso-8859-1"> -<TITLE>Index to libcurl documentation</TITLE> -</HEAD> +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<html><head> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +<title>Index to libcurl documentation</title> +</head> -<BODY> -<H1 ALIGN="CENTER">Index to libcurl documentation</H1> +<body> +<h1 align="center">Index to libcurl documentation</h1> -<H2>Programs</H2> -<P><A HREF="../index.html">curl and tools</A> +<h2>Programs</h2> +<p><a href="../index.html">curl and tools</a> <h2>Overviews</h2> <A HREF="libcurl.html">libcurl</A> @@ -25,6 +25,7 @@ <br><a href="curl_easy_init.html">curl_easy_init</A> <br><a href="curl_easy_perform.html">curl_easy_perform</A> <br><a href="curl_easy_setopt.html">curl_easy_setopt</A> +<br><a href="curl_easy_strerror.html">curl_easy_strerror</A> <br><a href="curl_escape.html">curl_escape</A> <br><a href="curl_formadd.html">curl_formadd</A> <br><a href="curl_formfree.html">curl_formfree</A> @@ -42,16 +43,16 @@ <br><a href="curl_multi_init.html">curl_multi_init</a> <br><a href="curl_multi_perform.html">curl_multi_perform</a> <br><a href="curl_multi_remove_handle.html">curl_multi_remove_handle</a> +<br><a href="curl_multi_strerror.html">curl_multi_strerror.html</a> <br><a href="curl_share_cleanup.html">curl_share_cleanup</A> <br><a href="curl_share_init.html">curl_share_init</A> <br><a href="curl_share_setopt.html">curl_share_setopt</A> +<br><a href="curl_share_strerror.html">curl_share_strerror.html</a> <br><a href="curl_slist_append.html">curl_slist_append</A> <br><a href="curl_slist_free_all.html">curl_slist_free_all</A> -<br><a href="curl_strequal.html">curl_strequal</A> -<br><a href="curl_strnequal.html">curl_strnequal</A> +<br><a href="curl_strequal.html">curl_strequal and curl_strnequal</A> <br><a href="curl_unescape.html">curl_unescape</A> <br><a href="curl_version.html">curl_version</A> <br><a href="curl_version_info.html">curl_version_info</A> -</BODY> -</HTML> +</body></html> diff --git a/docs/libcurl/libcurl-errors.3 b/docs/libcurl/libcurl-errors.3 index 037ef7c1f..e0699645f 100644 --- a/docs/libcurl/libcurl-errors.3 +++ b/docs/libcurl/libcurl-errors.3 @@ -2,7 +2,7 @@ .\" nroff -man [file] .\" $Id$ .\" -.TH libcurl-errors 3 "8 Mar 2004" "libcurl 7.11.0" "libcurl errors" +.TH libcurl-errors 3 "27 Apr 2004" "libcurl 7.12" "libcurl errors" .SH NAME libcurl-errors \- error codes in libcurl .SH DESCRIPTION @@ -10,9 +10,11 @@ This man page includes most, if not all, available error codes in libcurl. Why they occur and possibly what you can do to fix the problem. .SH "CURLcode" Almost all "easy" interface functions return a CURLcode error code. No matter -what, using \fICURLOPT_ERRORBUFFER\fP is a good idea as it will give you a -human readable error string that may offer more details about the error cause -than just the error code does. +what, using the \fIcurl_easy_setopt(3)\fP option \fICURLOPT_ERRORBUFFER\fP is +a good idea as it will give you a human readable error string that may offer +more details about the error cause than just the error code +does. \fIcurl_easy_strerror(3)\fP can be called to get an error string from a +given CURLcode number. CURLcode is one of the following: .IP "CURLE_OK (0)" @@ -186,7 +188,8 @@ Maximum file size exceeded Requested FTP SSL level failed .SH "CURLMcode" This is the generic return code used by functions in the libcurl multi -interface. +interface. Also consider \fIcurl_multi_strerror(3)\fI. + .IP "CURLM_CALL_MULTI_PERFORM (-1)" This is not really an error. It means you should call \fIcurl_multi_perform(3)\fP again without doing select() or similar in between. @@ -201,8 +204,8 @@ You are doomed. .IP "CURLM_INTERNAL_ERROR (4)" This can only be returned if libcurl bugs. Please report it to us! .SH "CURLSHcode" -The "share" interface will return a CURLSHcode to indicate when an -error has occurred. +The "share" interface will return a CURLSHcode to indicate when an error has +occurred. Also consider \fIcurl_share_strerror(3)\fI. CURLSHcode is one of the following: .IP "CURLSHE_OK (0)" |