curl/docs
Daniel Stenberg 01f05d0c75 return code cleanup: build, init and run-time errors
Stop the abuse of CURLE_FAILED_INIT as return code for things not being
init related by introducing two new return codes:

CURLE_NOT_BUILT_IN and CURLE_UNKNOWN_OPTION

CURLE_NOT_BUILT_IN replaces return code 4 that has been obsoleted for
several years. It is used for returning error when something is
attempted to be used but the feature/option was not enabled or
explictitly disabled at build-time. Getting this error mostly means that
libcurl needs to be rebuilt.

CURLE_FAILED_INIT is now saved and used strictly for init
failures. Getting this problem means something went seriously wrong,
like a resource shortage or similar.

CURLE_UNKNOWN_OPTION is the option formerly known as
CURLE_UNKNOWN_TELNET_OPTION (and the old name is still present,
separately defined to be removed in a very distant future). This error
code is meant to be used to return when an option is given to libcurl
that isn't known. This problem would mostly indicate a problem in the
program that uses libcurl.
2011-04-05 15:14:02 +02:00
..
examples source header: added to more files 2011-03-12 00:14:32 +01:00
libcurl return code cleanup: build, init and run-time errors 2011-04-05 15:14:02 +02:00
.gitignore IGNORE: files generated by maketgz 2010-04-14 17:34:57 +02:00
BINDINGS a binding for Falcon 2009-11-29 19:12:00 +00:00
BUGS remove the CVSish $Id$ lines 2010-03-24 11:02:54 +01:00
CONTRIBUTE CONTRIBUTE: minor edits 2011-03-18 11:14:51 +01:00
curl-config.1 remove the CVSish $Id$ lines 2010-03-24 11:02:54 +01:00
curl.1 curl.1: clarify -E 2011-03-08 11:43:42 +01:00
DISTRO-DILEMMA removed trailing whitespace 2010-02-14 19:40:18 +00:00
FAQ FAQ: better english 2011-03-17 11:30:29 +01:00
FEATURES Mention axTLS in some more documentation 2011-01-21 14:27:10 -08:00
HISTORY HISTORY: mention the gopher story 2010-08-28 22:51:22 +02:00
index.html
INSTALL Updated OpenSSL version, added links to docu. 2011-02-13 12:13:21 +01:00
INSTALL.cmake removed trailing whitespace 2010-02-14 19:40:18 +00:00
INSTALL.devcpp removed trailing whitespace 2010-02-14 19:40:18 +00:00
INTERNALS Some minor edits including updates to function names 2011-01-27 14:37:16 -08:00
KNOWN_BUGS multi: support timeouts 2010-08-15 13:16:39 +02:00
LICENSE-MIXING Mention axTLS in some more documentation 2011-01-21 14:27:10 -08:00
MAIL-ETIQUETTE MAIL-ETIQUETTE: intro and spam 2011-03-23 14:22:29 +01:00
Makefile.am headers: more copyright headers added 2011-03-22 22:48:11 +01:00
MANUAL replaced tabs with spaces 2010-02-16 13:32:45 +00:00
README.cmake removed trailing whitespace 2010-02-14 19:40:18 +00:00
README.netware removed trailing whitespace 2010-02-14 19:40:18 +00:00
README.win32 removed trailing whitespace 2010-02-14 19:40:18 +00:00
RESOURCES Implement SMTP authentication 2010-04-19 11:16:30 +02:00
SSLCERTS removed trailing whitespace 2010-02-14 19:40:18 +00:00
THANKS THANKS: add contributors from 7.21.4 2011-02-17 13:58:24 +01:00
TheArtOfHttpScripting TheArtOfHttpScripting: extended 2011-01-19 13:08:03 +01:00
TODO TODO: get rid of PATH_MAX 2011-01-03 09:40:40 +01:00
VERSIONS removed trailing whitespace 2010-02-14 19:40:18 +00:00

                                  _   _ ____  _
                              ___| | | |  _ \| |
                             / __| | | | |_) | |
                            | (__| |_| |  _ <| |___
                             \___|\___/|_| \_\_____|

README.win32

  Read the README file first.

  Curl has been compiled, built and run on all sorts of Windows and win32
  systems. While not being the main develop target, a fair share of curl users
  are win32-based.

  The unix-style man pages are tricky to read on windows, so therefore are all
  those pages converted to HTML as well as pdf, and included in the release
  archives.

  The main curl.1 man page is also "built-in" in the command line tool. Use a
  command line similar to this in order to extract a separate text file:

        curl -M >manual.txt

  Read the INSTALL file for instructions how to compile curl self.