summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorOleg Pudeyev <oleg@bsdpower.com>2014-01-20 05:06:15 -0500
committerOleg Pudeyev <oleg@bsdpower.com>2014-01-20 05:06:15 -0500
commitf40cc9ad8c656bb12c5f368c6bfb8c289f907dc6 (patch)
treee7c1c5668e74029b40ca24ced7a4cab9e6e6b794
parent150b0341dc2346b9fee0d09f3d7112e63ecc86fd (diff)
downloadpycurl-f40cc9ad8c656bb12c5f368c6bfb8c289f907dc6.tar.gz
Converting installation doc to rst syntax
-rw-r--r--INSTALL.rst38
1 files changed, 21 insertions, 17 deletions
diff --git a/INSTALL.rst b/INSTALL.rst
index 4440e7a..7600f0a 100644
--- a/INSTALL.rst
+++ b/INSTALL.rst
@@ -1,3 +1,6 @@
+PycURL Installation
+===================
+
NOTE: You need Python and libcurl installed on your system to use or
build pycurl. Some RPM distributions of curl/libcurl do not include
everything necessary to build pycurl, in which case you need to
@@ -7,7 +10,7 @@ install the developer specific RPM which is usually called curl-dev.
Distutils
---------
-Build and install pycurl with the following commands:
+Build and install pycurl with the following commands::
(if necessary, become root)
tar -zxvf pycurl-$VER.tar.gz
@@ -19,8 +22,8 @@ $VER should be substituted with the pycurl version number, e.g. 7.10.5.
Note that the installation script assumes that 'curl-config' can be
located in your path setting. If curl-config is installed outside
your path or you want to force installation to use a particular
-version of curl-config, use the '--curl-config' commandline option to
-specify the location of curl-config. Example:
+version of curl-config, use the '--curl-config' command line option to
+specify the location of curl-config. Example::
python setup.py install --curl-config=/usr/local/bin/curl-config
@@ -31,19 +34,21 @@ e.g. one in /usr/lib and one in /usr/local/lib.
easy_install / pip
-----------------
+------------------
+
+::
easy_install pycurl
pip install pycurl
If you need to specify an alternate curl-config, it can be done via an
-environment variable:
+environment variable::
export PYCURL_CURL_CONFIG=/usr/local/bin/curl-config
easy_install pycurl
The same applies to the SSL backend, if you need to specify it (see the SSL
-section below):
+section below)::
export PYCURL_SSL_LIBRARY=openssl
easy_install pycurl
@@ -73,22 +78,21 @@ or source packages that you are going to compile yourself.
For a minimum build you will just need libcurl source. Follow its Windows
build instructions to build either a static or a DLL version of the library,
-then configure PycURL as follows to use it:
+then configure PycURL as follows to use it::
python setup.py --curl-dir=c:\dev\curl-7.33.0\builds\libcurl-vc-x86-release-dll-ipv6-sspi-spnego-winssl --use-libcurl-dll
-Note that --curl-dir does not point to libcurl source but rather to headers
+Note that ``--curl-dir`` does not point to libcurl source but rather to headers
and compiled libraries.
Additional Windows setup.py options:
---use-libcurl-dll - build against libcurl DLL, if not given PycURL will be built
-against libcurl statically.
-
---libcurl-lib-name=libcurl_imp.lib - specify a different name for libcurl
-import library. The default is libcurl.lib which is appropriate for static
-linking and is sometimes the correct choice for dynamic linking as well. The
-other possibility for dynamic linking is libcurl_imp.lib.
+- ``--use-libcurl-dll`` - build against libcurl DLL, if not given PycURL will
+ be built against libcurl statically.
+- ``--libcurl-lib-name=libcurl_imp.lib`` - specify a different name for libcurl
+ import library. The default is ``libcurl.lib`` which is appropriate for
+ static linking and is sometimes the correct choice for dynamic linking as
+ well. The other possibility for dynamic linking is ``libcurl_imp.lib``.
-A good setup.py target to use is bdist_wininst which produces an executable
-installer that you can run to install PycURL.
+A good ``setup.py`` target to use is ``bdist_wininst`` which produces an
+executable installer that you can run to install PycURL.