2006-08-28 02:36:00 +02:00
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
< html xmlns = "http://www.w3.org/1999/xhtml" xml:lang = "en" lang = "en" >
< head >
< meta http-equiv = "Content-Type" content = "text/html; charset=utf-8" / >
2009-08-02 22:09:32 +02:00
< meta name = "generator" content = "Docutils 0.5: http://docutils.sourceforge.net/" / >
2006-08-28 02:36:00 +02:00
< title > libtorrent manual< / title >
< meta name = "author" content = "Arvid Norberg, arvid@rasterbar.com" / >
2008-10-17 05:23:30 +02:00
< link rel = "stylesheet" type = "text/css" href = "../../css/base.css" / >
< link rel = "stylesheet" type = "text/css" href = "../../css/rst.css" / >
2006-08-28 02:36:00 +02:00
< link rel = "stylesheet" href = "style.css" type = "text/css" / >
2008-10-17 05:23:30 +02:00
< style type = "text/css" >
/* Hides from IE-mac \*/
* html pre { height: 1%; }
/* End hide from IE-mac */
< / style >
2006-08-28 02:36:00 +02:00
< / head >
< body >
< div class = "document" id = "libtorrent-manual" >
2008-10-17 05:23:30 +02:00
< div id = "container" >
< div id = "headerNav" >
< ul >
< li class = "first" > < a href = "/" > Home< / a > < / li >
< li > < a href = "../../products.html" > Products< / a > < / li >
< li > < a href = "../../contact.html" > Contact< / a > < / li >
< / ul >
< / div >
< div id = "header" >
< h1 > < span > Rasterbar Software< / span > < / h1 >
< h2 > < span > Software developement and consulting< / span > < / h2 >
< / div >
< div id = "main" >
2006-08-28 02:36:00 +02:00
< h1 class = "title" > libtorrent manual< / h1 >
< table class = "docinfo" frame = "void" rules = "none" >
< col class = "docinfo-name" / >
< col class = "docinfo-content" / >
< tbody valign = "top" >
< tr > < th class = "docinfo-name" > Author:< / th >
2009-02-09 04:48:27 +01:00
< td > Arvid Norberg, < a class = "last reference external" href = "mailto:arvid@rasterbar.com" > arvid@ rasterbar.com< / a > < / td > < / tr >
< tr > < th class = "docinfo-name" > Version:< / th >
2010-03-19 19:40:32 +01:00
< td > 0.16.0< / td > < / tr >
2006-08-28 02:36:00 +02:00
< / tbody >
< / table >
< div class = "contents topic" id = "table-of-contents" >
2008-10-17 05:23:30 +02:00
< p class = "topic-title first" > Table of contents< / p >
2006-08-28 02:36:00 +02:00
< ul class = "simple" >
2009-02-09 04:48:27 +01:00
< li > < a class = "reference internal" href = "#downloading-and-building" id = "id9" > downloading and building< / a > < ul >
< li > < a class = "reference internal" href = "#building-from-svn" id = "id10" > building from svn< / a > < / li >
< li > < a class = "reference internal" href = "#building-with-bbv2" id = "id11" > building with BBv2< / a > < / li >
< li > < a class = "reference internal" href = "#building-with-autotools" id = "id12" > building with autotools< / a > < / li >
< li > < a class = "reference internal" href = "#building-with-other-build-systems" id = "id13" > building with other build systems< / a > < / li >
< li > < a class = "reference internal" href = "#build-configurations" id = "id14" > build configurations< / a > < / li >
< li > < a class = "reference internal" href = "#building-openssl-for-windows" id = "id15" > building openssl for windows< / a > < / li >
2006-08-28 02:36:00 +02:00
< / ul >
< / li >
< / ul >
< / div >
2008-10-17 05:23:30 +02:00
< div class = "section" id = "downloading-and-building" >
< h1 > downloading and building< / h1 >
2007-04-01 00:07:36 +02:00
< p > To acquire the latest version of libtorrent, you'll have to grab it from SVN.
2009-02-09 04:48:27 +01:00
You'll find instructions on how to do this < a class = "reference external" href = "http://sourceforge.net/svn/?group_id=79942" > here< / a > (see subversion access).< / p >
2006-08-28 02:36:00 +02:00
< p > The build systems supported " out of the box" in libtorrent are boost-build v2
(BBv2) and autotools (for unix-like systems). If you still can't build after
following these instructions, you can usually get help in the < tt class = "docutils literal" > < span class = "pre" > #libtorrent< / span > < / tt >
IRC channel on < tt class = "docutils literal" > < span class = "pre" > irc.freenode.net< / span > < / tt > .< / p >
2009-02-09 04:48:27 +01:00
< p > Community contributed build tutorials can be found on the < a class = "reference external" href = "http://code.rasterbar.com/libtorrent/wiki/Building" > wiki< / a > .< / p >
2009-02-15 21:39:54 +01:00
< div class = "warning" >
< p class = "first admonition-title" > Warning< / p >
< p > A common mistake when building and linking against libtorrent is
to build with one set of configuration options (#defines) and
link against it using a different set of configuration options. Since
libtorrent has some code in header files, that code will not be
compatible with the built library if they see different configurations.< / p >
< p > Always make sure that the same TORRENT_* macros are defined when you
link against libtorrent as when you build it.< / p >
< p class = "last" > Boost-build supports propagating configuration options to dependencies.
When building using the makefiles, this is handled by setting the
configuration options in the pkg-config file. Always use pkg-config
when linking against libtorrent.< / p >
< / div >
2008-10-17 05:23:30 +02:00
< div class = "section" id = "building-from-svn" >
< h2 > building from svn< / h2 >
2007-04-01 00:07:36 +02:00
< p > To build libtorrent from svn you need to check out the libtorrent sources from
2007-01-03 12:42:10 +01:00
sourceforge and also check out the asio sources from its sourceforge cvs.
If you downloaded a release tarball, you can skip this section.< / p >
< p > To prepare the directory structure for building, follow these steps:< / p >
< ul class = "simple" >
2009-02-09 04:48:27 +01:00
< li > Check out libtorrent (< a class = "reference external" href = "http://sourceforge.net/svn/?group_id=79942" > instructions< / a > ).< / li >
< li > Check out asio (< a class = "reference external" href = "http://sourceforge.net/cvs/?group_id=122478" > instructions< / a > ).< / li >
2007-01-03 12:42:10 +01:00
< li > Copy the < tt class = "docutils literal" > < span class = "pre" > asio/include/asio/< / span > < / tt > directory into the < tt class = "docutils literal" > < span class = "pre" > libtorrent/include/libtorrent/< / span > < / tt >
directory. Alternatively you can make a symbolic link.< / li >
< li > Copy < tt class = "docutils literal" > < span class = "pre" > asio/include/asio.hpp< / span > < / tt > into < tt class = "docutils literal" > < span class = "pre" > libtorrent/include/libtorrent< / span > < / tt > .< / li >
< / ul >
< p > Now the libtorrent directory is ready for building. Follow the steps in one
of the following sections depending on which build system you prefer to use.< / p >
< / div >
2008-10-17 05:23:30 +02:00
< div class = "section" id = "building-with-bbv2" >
< h2 > building with BBv2< / h2 >
2006-08-28 02:36:00 +02:00
< p > The primary reason to use boost-build is that it will automatically build the
dependent boost libraries with the correct compiler settings, in order to
2009-02-09 04:48:27 +01:00
ensure that the build targets are link compatible (see < a class = "reference external" href = "http://boost.org/more/separate_compilation.html" > boost guidelines< / a >
2006-08-28 02:36:00 +02:00
for some details on this issue).< / p >
< p > Since BBv2 will build the boost libraries for you, you need the full boost
source package. Having boost installed via some package system is usually not
enough (and even if it is enough, the necessary environment variables are
usually not set by the package installer).< / p >
2008-03-10 07:25:00 +01:00
< p > If you want to build against an installed copy of boost, you can skip directly
to step 3 (assuming you also have boost build installed).< / p >
2008-10-17 05:23:30 +02:00
< div class = "section" id = "step-1-download-boost" >
< h3 > Step 1: Download boost< / h3 >
2009-02-09 04:48:27 +01:00
< p > You'll find boost < a class = "reference external" href = "http://sourceforge.net/project/showfiles.php?group_id=7586&package_id=8041&release_id=619445" > here< / a > .< / p >
2006-08-28 02:36:00 +02:00
< p > Extract the archive to some directory where you want it. For the sake of this
2008-01-11 09:27:16 +01:00
guide, let's assume you extract the package to < tt class = "docutils literal" > < span class = "pre" > c:\boost_1_34_0< / span > < / tt > (I'm using
2006-08-28 02:36:00 +02:00
a windows path in this example since if you're on linux/unix you're more likely
2008-01-11 09:27:16 +01:00
to use the autotools). You'll need at least version 1.34 of the boost library
2006-08-28 02:36:00 +02:00
in order to build libtorrent.< / p >
< / div >
2008-10-17 05:23:30 +02:00
< div class = "section" id = "step-2-setup-bbv2" >
< h3 > Step 2: Setup BBv2< / h3 >
2006-08-28 02:36:00 +02:00
< p > First you need to build < tt class = "docutils literal" > < span class = "pre" > bjam< / span > < / tt > . You do this by opening a terminal (In
windows, run < tt class = "docutils literal" > < span class = "pre" > cmd< / span > < / tt > ). Change directory to
2008-01-11 09:27:16 +01:00
< tt class = "docutils literal" > < span class = "pre" > c:\boost_1_34_0\tools\jam\src< / span > < / tt > . Then run the script called
2006-08-28 02:36:00 +02:00
< tt class = "docutils literal" > < span class = "pre" > build.bat< / span > < / tt > or < tt class = "docutils literal" > < span class = "pre" > build.sh< / span > < / tt > on a unix system. This will build < tt class = "docutils literal" > < span class = "pre" > bjam< / span > < / tt > and
place it in a directory starting with < tt class = "docutils literal" > < span class = "pre" > bin.< / span > < / tt > and then have the name of your
platform. Copy the < tt class = "docutils literal" > < span class = "pre" > bjam.exe< / span > < / tt > (or < tt class = "docutils literal" > < span class = "pre" > bjam< / span > < / tt > on a unix system) to a place
that's in you shell's < tt class = "docutils literal" > < span class = "pre" > PATH< / span > < / tt > . On linux systems a place commonly used may be
< tt class = "docutils literal" > < span class = "pre" > /usr/local/bin< / span > < / tt > or on windows < tt class = "docutils literal" > < span class = "pre" > c:\windows< / span > < / tt > (you can also add directories
to the search paths by modifying the environment variable called < tt class = "docutils literal" > < span class = "pre" > PATH< / span > < / tt > ).< / p >
< p > Now you have < tt class = "docutils literal" > < span class = "pre" > bjam< / span > < / tt > installed. < tt class = "docutils literal" > < span class = "pre" > bjam< / span > < / tt > can be considered an interpreter
that the boost-build system is implemented on. So boost-build uses < tt class = "docutils literal" > < span class = "pre" > bjam< / span > < / tt > .
So, to complete the installation you need to make two more things. You need to
set the environment variable < tt class = "docutils literal" > < span class = "pre" > BOOST_BUILD_PATH< / span > < / tt > . This is the path that tells
< tt class = "docutils literal" > < span class = "pre" > bjam< / span > < / tt > where it can find boost-build, your configuration file and all the
toolsets (descriptions used by boost-build to know how to use different
compilers on different platforms). Assuming the boost install path above, set
2008-01-11 09:27:16 +01:00
it to < tt class = "docutils literal" > < span class = "pre" > c:\boost_1_34_0\tools\build\v2< / span > < / tt > .< / p >
2006-08-28 02:36:00 +02:00
< p > To set an environment variable in windows, type for example:< / p >
< pre class = "literal-block" >
2008-01-11 09:27:16 +01:00
set BOOST_BUILD_PATH=c:\boost_1_34_0\tools\build\v2
2006-08-28 02:36:00 +02:00
< / pre >
< p > In a terminal window.< / p >
< p > The last thing to do to complete the setup of BBv2 is to modify your
2008-01-11 09:27:16 +01:00
< tt class = "docutils literal" > < span class = "pre" > user-config.jam< / span > < / tt > file. It is located in < tt class = "docutils literal" > < span class = "pre" > c:\boost_1_34_0\tools\build\v2< / span > < / tt > .
2006-08-28 02:36:00 +02:00
Depending on your platform and which compiler you're using, you should add a
line for each compiler and compiler version you have installed on your system
that you want to be able to use with BBv2. For example, if you're using
Microsoft Visual Studio 7.1 (2003), just add a line:< / p >
< pre class = "literal-block" >
using msvc : 7.1 ;
< / pre >
< p > If you use GCC, add the line:< / p >
< pre class = "literal-block" >
using gcc ;
< / pre >
< p > If you have more than one version of GCC installed, you can add the
commandline used to invoke g++ after the version number, like this:< / p >
< pre class = "literal-block" >
using gcc : 3.3 : g++-3.3 ;
using gcc : 4.0 : g++-4.0 ;
< / pre >
< p > Another toolset worth mentioning is the < tt class = "docutils literal" > < span class = "pre" > darwin< / span > < / tt > toolset (For MacOS X).
From Tiger (10.4) MacOS X comes with both GCC 3.3 and GCC 4.0. Then you can
use the following toolsets:< / p >
< pre class = "literal-block" >
using darwin : 3.3 : g++-3.3 ;
using darwin : 4.0 : g++-4.0 ;
< / pre >
< p > Note that the spaces around the semi-colons and colons are important!< / p >
2009-02-09 04:48:27 +01:00
< p > Also see the < a class = "reference external" href = "http://www.boost.org/doc/html/bbv2/installation.html" > official installation instructions< / a > .< / p >
2006-08-28 02:36:00 +02:00
< / div >
2008-10-17 05:23:30 +02:00
< div class = "section" id = "step-3-building-libtorrent" >
< h3 > Step 3: Building libtorrent< / h3 >
2006-08-28 02:36:00 +02:00
< p > When building libtorrent, the < tt class = "docutils literal" > < span class = "pre" > Jamfile< / span > < / tt > expects the environment variable
< tt class = "docutils literal" > < span class = "pre" > BOOST_ROOT< / span > < / tt > to be set to the boost installation directory. It uses this to
find the boost libraries it depends on, so they can be built and their headers
2008-03-10 07:25:00 +01:00
files found. So, set this to < tt class = "docutils literal" > < span class = "pre" > c:\boost_1_34_0< / span > < / tt > . You only need this if you're
building against a source distribution of boost.< / p >
2006-08-28 02:36:00 +02:00
< p > Then the only thing left is simply to invoke < tt class = "docutils literal" > < span class = "pre" > bjam< / span > < / tt > . If you want to specify
a specific toolset to use (compiler) you can just add that to the commandline.
For example:< / p >
< pre class = "literal-block" >
2008-03-10 07:25:00 +01:00
bjam msvc-7.1 boost=source
bjam gcc-3.3 boost=source
bjam darwin-4.0 boost=source
2006-08-28 02:36:00 +02:00
< / pre >
2008-03-10 07:25:00 +01:00
< p > If you're building against a system installed boost, specify < tt class = "docutils literal" > < span class = "pre" > boost=system< / span > < / tt > .< / p >
2006-08-28 02:36:00 +02:00
< p > To build different versions you can also just add the name of the build
variant. Some default build variants in BBv2 are < tt class = "docutils literal" > < span class = "pre" > release< / span > < / tt > , < tt class = "docutils literal" > < span class = "pre" > debug< / span > < / tt > ,
< tt class = "docutils literal" > < span class = "pre" > profile< / span > < / tt > .< / p >
< p > You can build libtorrent as a dll too, by typing < tt class = "docutils literal" > < span class = "pre" > link=shared< / span > < / tt > , or
2008-03-10 07:25:00 +01:00
< tt class = "docutils literal" > < span class = "pre" > link=static< / span > < / tt > to build a static library.< / p >
2006-08-28 02:36:00 +02:00
< p > If you want to explicitly say how to link against the runtime library, you
can set the < tt class = "docutils literal" > < span class = "pre" > runtime-link< / span > < / tt > feature on the commandline, either to < tt class = "docutils literal" > < span class = "pre" > shared< / span > < / tt >
or < tt class = "docutils literal" > < span class = "pre" > static< / span > < / tt > . Most operating systems will only allow linking shared against
the runtime, but on windows you can do both. Example:< / p >
< pre class = "literal-block" >
2008-03-10 07:25:00 +01:00
bjam msvc-7.1 link=static runtime-link=static boost=source
2006-08-28 02:36:00 +02:00
< / pre >
< div class = "warning" >
< p class = "first admonition-title" > Warning< / p >
< p class = "last" > If you link statically to the runtime library, you cannot build libtorrent
as a shared library (DLL), since you will get separate heaps in the library
2006-08-31 02:26:41 +02:00
and in the client application. It will result in crashes and possibly link
errors.< / p >
2006-08-28 02:36:00 +02:00
< / div >
2008-03-21 06:59:34 +01:00
< div class = "warning" >
< p class = "first admonition-title" > Warning< / p >
< p class = "last" > With boost-build V2 (Milestone 11), the darwin toolset uses the < tt class = "docutils literal" > < span class = "pre" > -s< / span > < / tt > linker
option to strip debug symbols. This option is buggy in Apple's GCC, and
will make the executable crash on startup. On Mac OS X, instead build
your release executables with the < tt class = "docutils literal" > < span class = "pre" > debug-symbols=on< / span > < / tt > option, and
later strip your executable with < tt class = "docutils literal" > < span class = "pre" > strip< / span > < / tt > .< / p >
< / div >
2008-05-15 20:51:19 +02:00
< div class = "warning" >
< p class = "first admonition-title" > Warning< / p >
< p class = "last" > Some linux systems requires linking against < tt class = "docutils literal" > < span class = "pre" > librt< / span > < / tt > in order to access
the POSIX clock functions. If you get an error complaining about a missing
symbol < tt class = "docutils literal" > < span class = "pre" > clock_gettime< / span > < / tt > , you have to give < tt class = "docutils literal" > < span class = "pre" > need-librt=yes< / span > < / tt > on the
bjam command line. This will make libtorrent link against < tt class = "docutils literal" > < span class = "pre" > librt< / span > < / tt > .< / p >
< / div >
2009-02-09 04:48:27 +01:00
< div class = "note" >
< p class = "first admonition-title" > Note< / p >
< p class = "last" > When building on Solaris, you might have to specify < tt class = "docutils literal" > < span class = "pre" > stdlib=sun-stlport< / span > < / tt >
on the bjam command line.< / p >
< / div >
2006-08-28 02:36:00 +02:00
< p > The build targets are put in a directory called bin, and under it they are
sorted in directories depending on the toolset and build variant used.< / p >
< p > To build the examples, just change directory to the examples directory and
invoke < tt class = "docutils literal" > < span class = "pre" > bjam< / span > < / tt > from there. To build and run the tests, go to the test
directory and run < tt class = "docutils literal" > < span class = "pre" > bjam< / span > < / tt > .< / p >
< p > Note that if you're building on windows using the < tt class = "docutils literal" > < span class = "pre" > msvc< / span > < / tt > toolset, you cannot run it
from a cygwin terminal, you'll have to run it from a < tt class = "docutils literal" > < span class = "pre" > cmd< / span > < / tt > terminal. The same goes for
cygwin, if you're building with gcc in cygwin you'll have to run it from a cygwin terminal.
Also, make sure the paths are correct in the different environments. In cygwin, the paths
(< tt class = "docutils literal" > < span class = "pre" > BOOST_BUILD_PATH< / span > < / tt > and < tt class = "docutils literal" > < span class = "pre" > BOOST_ROOT< / span > < / tt > ) should be in the typical unix-format (e.g.
2008-01-11 09:27:16 +01:00
< tt class = "docutils literal" > < span class = "pre" > /cygdrive/c/boost_1_34_0< / span > < / tt > ). In the windows environment, they should have the typical
windows format (< tt class = "docutils literal" > < span class = "pre" > c:/boost_1_34_0< / span > < / tt > ).< / p >
2006-08-28 02:36:00 +02:00
< p > The < tt class = "docutils literal" > < span class = "pre" > Jamfile< / span > < / tt > will define < tt class = "docutils literal" > < span class = "pre" > NDEBUG< / span > < / tt > when it's building a release build.
2009-02-09 04:48:27 +01:00
For more build configuration flags see < a class = "reference internal" href = "#build-configurations" > Build configurations< / a > .< / p >
2006-08-31 02:26:41 +02:00
< p > Build features:< / p >
< table border = "1" class = "docutils" >
< colgroup >
2008-08-03 17:14:08 +02:00
< col width = "33%" / >
< col width = "67%" / >
2006-08-31 02:26:41 +02:00
< / colgroup >
< thead valign = "bottom" >
< tr > < th class = "head" > boost build feature< / th >
< th class = "head" > values< / th >
< / tr >
< / thead >
< tbody valign = "top" >
2008-01-11 09:27:16 +01:00
< tr > < td > < tt class = "docutils literal" > < span class = "pre" > boost< / span > < / tt > < / td >
< td > < ul class = "first last simple" >
< li > < tt class = "docutils literal" > < span class = "pre" > system< / span > < / tt > - default. Tells the Jamfile that
boost is installed and should be linked against
the system libraries.< / li >
< li > < tt class = "docutils literal" > < span class = "pre" > source< / span > < / tt > - Specifies that boost is to be built
from source. The environment variable
< tt class = "docutils literal" > < span class = "pre" > BOOST_ROOT< / span > < / tt > must be defined to point to the
boost directory.< / li >
< / ul >
< / td >
< / tr >
2008-07-06 14:22:56 +02:00
< tr > < td > < tt class = "docutils literal" > < span class = "pre" > boost-link< / span > < / tt > < / td >
< td > < ul class = "first last simple" >
< li > < tt class = "docutils literal" > < span class = "pre" > static< / span > < / tt > - links statically against the boost
libraries.< / li >
< li > < tt class = "docutils literal" > < span class = "pre" > shared< / span > < / tt > - links dynamically against the boost
libraries.< / li >
< / ul >
< / td >
< / tr >
2006-08-31 02:26:41 +02:00
< tr > < td > < tt class = "docutils literal" > < span class = "pre" > logging< / span > < / tt > < / td >
< td > < ul class = "first last simple" >
< li > < tt class = "docutils literal" > < span class = "pre" > none< / span > < / tt > - no logging.< / li >
< li > < tt class = "docutils literal" > < span class = "pre" > default< / span > < / tt > - basic session logging.< / li >
< li > < tt class = "docutils literal" > < span class = "pre" > verbose< / span > < / tt > - verbose peer wire logging.< / li >
2008-02-07 08:09:52 +01:00
< li > < tt class = "docutils literal" > < span class = "pre" > errors< / span > < / tt > - like verbose, but limited to errors.< / li >
2006-08-28 02:36:00 +02:00
< / ul >
2006-08-31 02:26:41 +02:00
< / td >
< / tr >
< tr > < td > < tt class = "docutils literal" > < span class = "pre" > dht-support< / span > < / tt > < / td >
< td > < ul class = "first last simple" >
< li > < tt class = "docutils literal" > < span class = "pre" > on< / span > < / tt > - build with support for tracker less
torrents and DHT support.< / li >
< li > < tt class = "docutils literal" > < span class = "pre" > logging< / span > < / tt > - build with DHT support and verbose
logging of the DHT protocol traffic.< / li >
< li > < tt class = "docutils literal" > < span class = "pre" > off< / span > < / tt > - build without DHT support.< / li >
< / ul >
< / td >
< / tr >
2008-04-05 07:36:18 +02:00
< tr > < td > < tt class = "docutils literal" > < span class = "pre" > need-librt< / span > < / tt > < / td >
< td > < ul class = "first last simple" >
< li > < tt class = "docutils literal" > < span class = "pre" > no< / span > < / tt > - this platform does not need to link
against librt to have POSIX time functions.< / li >
< li > < tt class = "docutils literal" > < span class = "pre" > yes< / span > < / tt > - specify this if your linux system
requires you to link against librt.a. This is
typically the case on x86 64 bit systems.< / li >
< / ul >
< / td >
< / tr >
2007-06-06 02:41:20 +02:00
< tr > < td > < tt class = "docutils literal" > < span class = "pre" > zlib< / span > < / tt > < / td >
< td > < ul class = "first last simple" >
< li > < tt class = "docutils literal" > < span class = "pre" > system< / span > < / tt > - links against the zlib supplied
with your operating system.< / li >
< li > < tt class = "docutils literal" > < span class = "pre" > shipped< / span > < / tt > - links against the zlib bundled
with the libtorrent package.< / li >
< / ul >
< / td >
< / tr >
2008-04-05 06:53:22 +02:00
< tr > < td > < tt class = "docutils literal" > < span class = "pre" > geoip< / span > < / tt > < / td >
< td > < ul class = "first last simple" >
< li > < tt class = "docutils literal" > < span class = "pre" > off< / span > < / tt > - geo ip lookups disabled< / li >
2009-02-09 04:48:27 +01:00
< li > < tt class = "docutils literal" > < span class = "pre" > static< / span > < / tt > - < a class = "reference external" href = "http://www.maxmind.com/app/api" > MaxMind< / a > geo ip lookup code linked
2008-04-05 06:53:22 +02:00
in statically. Note that this code is under
LGPL license.< / li >
2009-02-09 04:48:27 +01:00
< li > < tt class = "docutils literal" > < span class = "pre" > shared< / span > < / tt > - The < a class = "reference external" href = "http://www.maxmind.com/app/api" > MaxMind< / a > geo ip lookup library
2008-04-05 06:53:22 +02:00
is expected to be installed on the system and
it will be used.< / li >
< / ul >
< / td >
< / tr >
2008-01-06 22:39:56 +01:00
< tr > < td > < tt class = "docutils literal" > < span class = "pre" > upnp-logging< / span > < / tt > < / td >
< td > < ul class = "first last simple" >
< li > < tt class = "docutils literal" > < span class = "pre" > off< / span > < / tt > - default. Does not log UPnP traffic.< / li >
< li > < tt class = "docutils literal" > < span class = "pre" > on< / span > < / tt > - creates " upnp.log" with the messages
sent to and received from UPnP devices.< / li >
< / ul >
< / td >
< / tr >
2009-11-11 08:03:50 +01:00
< tr > < td > < tt class = "docutils literal" > < span class = "pre" > encryption< / span > < / tt > < / td >
2007-06-06 02:41:20 +02:00
< td > < ul class = "first last simple" >
2009-11-11 08:03:50 +01:00
< li > < tt class = "docutils literal" > < span class = "pre" > openssl< / span > < / tt > - links against openssl and
libcrypto to enable https and encrypted
bittorrent connections.< / li >
< li > < tt class = "docutils literal" > < span class = "pre" > gcrypt< / span > < / tt > - links against libgcrypt to enable
encrypted bittorrent connections.< / li >
< li > < tt class = "docutils literal" > < span class = "pre" > tommath< / span > < / tt > - uses a shipped version of
libtommath and a custom rc4 implementation
(based on libtomcrypt). This is the default
option.< / li >
2007-06-06 02:41:20 +02:00
< li > < tt class = "docutils literal" > < span class = "pre" > off< / span > < / tt > - turns off support for encrypted
2009-11-11 08:03:50 +01:00
connections. The shipped public domain SHA-1
implementation is used.< / li >
2007-06-06 02:41:20 +02:00
< / ul >
< / td >
< / tr >
2008-04-10 12:03:23 +02:00
< tr > < td > < tt class = "docutils literal" > < span class = "pre" > pool-allocators< / span > < / tt > < / td >
< td > < ul class = "first last simple" >
< li > < tt class = "docutils literal" > < span class = "pre" > on< / span > < / tt > - default, uses pool allocators for send
buffers.< / li >
< li > < tt class = "docutils literal" > < span class = "pre" > off< / span > < / tt > - uses < tt class = "docutils literal" > < span class = "pre" > malloc()< / span > < / tt > and < tt class = "docutils literal" > < span class = "pre" > free()< / span > < / tt >
instead. Might be useful to debug buffer issues
with tools like electric fence or libgmalloc.< / li >
< / ul >
< / td >
< / tr >
2006-09-01 05:06:00 +02:00
< tr > < td > < tt class = "docutils literal" > < span class = "pre" > link< / span > < / tt > < / td >
< td > < ul class = "first last simple" >
< li > < tt class = "docutils literal" > < span class = "pre" > static< / span > < / tt > - builds libtorrent as a static
library (.a / .lib)< / li >
< li > < tt class = "docutils literal" > < span class = "pre" > shared< / span > < / tt > - builds libtorrent as a shared
library (.so / .dll).< / li >
< / ul >
< / td >
< / tr >
< tr > < td > < tt class = "docutils literal" > < span class = "pre" > runtime-link< / span > < / tt > < / td >
< td > < ul class = "first last simple" >
< li > < tt class = "docutils literal" > < span class = "pre" > static< / span > < / tt > - links statically against the
run-time library (if available on your
platform).< / li >
< li > < tt class = "docutils literal" > < span class = "pre" > shared< / span > < / tt > - link dynamically against the
run-time library (default).< / li >
< / ul >
< / td >
< / tr >
< tr > < td > < tt class = "docutils literal" > < span class = "pre" > variant< / span > < / tt > < / td >
< td > < ul class = "first last simple" >
< li > < tt class = "docutils literal" > < span class = "pre" > debug< / span > < / tt > - builds libtorrent with debug
information and invariant checks.< / li >
< li > < tt class = "docutils literal" > < span class = "pre" > release< / span > < / tt > - builds libtorrent in release mode
without invariant checks and with optimization.< / li >
< li > < tt class = "docutils literal" > < span class = "pre" > profile< / span > < / tt > - builds libtorrent with profile
information.< / li >
< / ul >
< / td >
< / tr >
2007-04-27 18:26:30 +02:00
< tr > < td > < tt class = "docutils literal" > < span class = "pre" > character-set< / span > < / tt > < / td >
< td > < p class = "first" > This setting will only have an affect on windows.
Other platforms are expected to support UTF-8.< / p >
< ul class = "last simple" >
2008-07-20 13:53:21 +02:00
< li > < tt class = "docutils literal" > < span class = "pre" > unicode< / span > < / tt > - The unicode version of the win32
API is used. This is default.< / li >
2007-04-27 18:26:30 +02:00
< li > < tt class = "docutils literal" > < span class = "pre" > ansi< / span > < / tt > - The ansi version of the win32 API is
used.< / li >
< / ul >
< / td >
< / tr >
2008-01-13 07:17:56 +01:00
< tr > < td > < tt class = "docutils literal" > < span class = "pre" > invariant-checks< / span > < / tt > < / td >
< td > < p class = "first" > This setting only affects debug builds (where
< tt class = "docutils literal" > < span class = "pre" > NDEBUG< / span > < / tt > is not defined). It defaults to < tt class = "docutils literal" > < span class = "pre" > on< / span > < / tt > .< / p >
< ul class = "last simple" >
< li > < tt class = "docutils literal" > < span class = "pre" > on< / span > < / tt > - internal invariant checks are enabled.< / li >
< li > < tt class = "docutils literal" > < span class = "pre" > off< / span > < / tt > - internal invariant checks are
disabled. The resulting executable will run
faster than a regular debug build.< / li >
2008-07-19 09:57:43 +02:00
< li > < tt class = "docutils literal" > < span class = "pre" > full< / span > < / tt > - turns on extra expensive invariant
checks.< / li >
2008-01-13 07:17:56 +01:00
< / ul >
< / td >
< / tr >
< tr > < td > < tt class = "docutils literal" > < span class = "pre" > debug-symbols< / span > < / tt > < / td >
< td > < ul class = "first last simple" >
< li > < tt class = "docutils literal" > < span class = "pre" > on< / span > < / tt > - default for debug builds. This setting
is useful for building release builds with
symbols.< / li >
< li > < tt class = "docutils literal" > < span class = "pre" > off< / span > < / tt > - default for release builds.< / li >
< / ul >
< / td >
< / tr >
2008-08-03 17:14:08 +02:00
< tr > < td > < tt class = "docutils literal" > < span class = "pre" > deprecated-functions< / span > < / tt > < / td >
< td > < ul class = "first last simple" >
< li > < tt class = "docutils literal" > < span class = "pre" > on< / span > < / tt > - default. Includes deprecated functions
of the API (might produce warnings during build
when deprecated functions are used).< / li >
< li > < tt class = "docutils literal" > < span class = "pre" > off< / span > < / tt > - excludes deprecated functions from the
API. Generates build errors when deprecated
functions are used.< / li >
< / ul >
< / td >
< / tr >
2010-02-19 05:20:11 +01:00
< tr > < td > < tt class = "docutils literal" > < span class = "pre" > full-stats< / span > < / tt > < / td >
< td > < ul class = "first last simple" >
< li > < tt class = "docutils literal" > < span class = "pre" > on< / span > < / tt > - default, collects stats for IP overhead
and DHT and trackers. This uses a little bit
extra memory for each peer and torrent.< / li >
< li > < tt class = "docutils literal" > < span class = "pre" > off< / span > < / tt > - only collects the standard stats for
upload and download rate.< / li >
< / ul >
< / td >
< / tr >
2006-08-31 02:26:41 +02:00
< / tbody >
< / table >
2006-09-01 05:06:00 +02:00
< p > The < tt class = "docutils literal" > < span class = "pre" > variant< / span > < / tt > feature is < em > implicit< / em > , which means you don't need to specify
the name of the feature, just the value.< / p >
2006-08-28 02:36:00 +02:00
< p > The logs created when building vlog or log mode are put in a directory called
< tt class = "docutils literal" > < span class = "pre" > libtorrent_logs< / span > < / tt > in the current working directory.< / p >
< p > When building the example client on windows, you need to build with
< tt class = "docutils literal" > < span class = "pre" > link=static< / span > < / tt > otherwise you may get unresolved external symbols for some
boost.program-options symbols.< / p >
2009-02-09 04:48:27 +01:00
< p > For more information, see the < a class = "reference external" href = "http://www.boost.org/tools/build/v2/index.html" > Boost build v2 documentation< / a > , or more
specifically < a class = "reference external" href = "http://www.boost.org/doc/html/bbv2/reference.html#bbv2.advanced.builtins.features" > the section on builtin features< / a > .< / p >
2006-08-28 02:36:00 +02:00
< / div >
< / div >
2008-10-17 05:23:30 +02:00
< div class = "section" id = "building-with-autotools" >
< h2 > building with autotools< / h2 >
2006-08-28 02:36:00 +02:00
< p > First of all, you need to install < tt class = "docutils literal" > < span class = "pre" > automake< / span > < / tt > and < tt class = "docutils literal" > < span class = "pre" > autoconf< / span > < / tt > . Many
unix/linux systems comes with these preinstalled.< / p >
2008-04-05 06:53:22 +02:00
< p > The prerequisites for building libtorrent are boost.thread, boost.date_time
2006-09-23 23:24:28 +02:00
and boost.filesystem. Those are the < em > compiled< / em > boost libraries needed. The
headers-only libraries needed include (but is not necessarily limited to)
boost.bind, boost.ref, boost.multi_index, boost.optional, boost.lexical_cast,
boost.integer, boost.iterator, boost.tuple, boost.array, boost.function,
boost.smart_ptr, boost.preprocessor, boost.static_assert.< / p >
< p > If you want to build the < tt class = "docutils literal" > < span class = "pre" > client_test< / span > < / tt > example, you'll also need boost.regex
and boost.program_options.< / p >
2008-10-17 05:23:30 +02:00
< div class = "section" id = "step-1-generating-the-build-system" >
< h3 > Step 1: Generating the build system< / h3 >
2006-08-28 02:36:00 +02:00
< p > No build system is present if libtorrent is checked out from CVS - it
needs to be generated first. If you're building from a released tarball,
2009-02-09 04:48:27 +01:00
you may skip directly to < a class = "reference internal" href = "#step-2-running-configure" > Step 2: Running configure< / a > .< / p >
2006-08-28 02:36:00 +02:00
< p > Execute the following commands, in the given order, to generate
the build system:< / p >
2006-09-01 05:06:00 +02:00
< pre class = "literal-block" >
aclocal -I m4
autoheader
libtoolize --copy --force
automake --add-missing --copy --gnu
autoconf
< / pre >
< p > On darwin/OSX you have to run < tt class = "docutils literal" > < span class = "pre" > glibtoolize< / span > < / tt > instead of < tt class = "docutils literal" > < span class = "pre" > libtoolize< / span > < / tt > .< / p >
2006-08-28 02:36:00 +02:00
< / div >
2008-10-17 05:23:30 +02:00
< div class = "section" id = "step-2-running-configure" >
< h3 > Step 2: Running configure< / h3 >
2006-08-28 02:36:00 +02:00
< p > In your shell, change directory to the libtorrent directory and run
< tt class = "docutils literal" > < span class = "pre" > ./configure< / span > < / tt > . This will look for libraries and C++ features that libtorrent
is dependent on. If something is missing or can't be found it will print an
error telling you what failed.< / p >
< p > The most likely problem you may encounter is that the configure script won't
find the boost libraries. Make sure you have boost installed on your system.
The easiest way to install boost is usually to use the preferred package
system on your platform. Usually libraries and headers are installed in
standard directories where the compiler will find them, but sometimes that
may not be the case. For example when installing boost on darwin using
darwinports (the package system based on BSD ports) all libraries are
installed to < tt class = "docutils literal" > < span class = "pre" > /opt/local/lib< / span > < / tt > and headers are installed to
< tt class = "docutils literal" > < span class = "pre" > /opt/local/include< / span > < / tt > . By default the compiler will not look in these
directories. You have to set the enviornment variables < tt class = "docutils literal" > < span class = "pre" > LDFLAGS< / span > < / tt > and
< tt class = "docutils literal" > < span class = "pre" > CXXFLAGS< / span > < / tt > in order to make the compiler find those libs. In this example
you'd set them like this:< / p >
< pre class = "literal-block" >
export LDFLAGS=-L/opt/local/lib
export CXXFLAGS=-I/opt/local/include
< / pre >
< p > It was observed on FreeBSD (release 6.0) that one needs to add '-lpthread' to
LDFLAGS, as Boost::Thread detection will fail without it, even if
Boost::Thread is installed.< / p >
< p > If you need to set these variables, it may be a good idea to add those lines
to your < tt class = "docutils literal" > < span class = "pre" > ~/.profile< / span > < / tt > or < tt class = "docutils literal" > < span class = "pre" > ~/.tcshrc< / span > < / tt > depending on your shell.< / p >
2006-09-26 00:37:48 +02:00
< p > If the boost libraries are named with a suffix on your platform, you may use
the < tt class = "docutils literal" > < span class = "pre" > --with-boost-thread=< / span > < / tt > option to specify the suffix used for the thread
library in this case. For more information about these options, run:< / p >
< pre class = "literal-block" >
./configure --help
< / pre >
< p > On gentoo the boost libraries that are built with multi-threading support have
the suffix < tt class = "docutils literal" > < span class = "pre" > mt< / span > < / tt > .< / p >
2006-08-28 02:36:00 +02:00
< p > You know that the boost libraries were found if you see the following output
from the configure script:< / p >
< pre class = "literal-block" >
checking whether the Boost::DateTime library is available... yes
checking for main in -lboost_date_time... yes
checking whether the Boost::Filesystem library is available... yes
checking for main in -lboost_filesystem... yes
checking whether the Boost::Thread library is available... yes
checking for main in -lboost_thread... yes
< / pre >
< p > Another possible source of problems may be if the path to your libtorrent
directory contains spaces. Make sure you either rename the directories with
spaces in their names to remove the spaces or move the libtorrent directory.< / p >
< / div >
2008-10-17 05:23:30 +02:00
< div class = "section" id = "creating-a-debug-build" >
< h3 > Creating a debug build< / h3 >
2006-08-28 02:36:00 +02:00
< p > To tell configure to build a debug version (with debug info, asserts
and invariant checks enabled), you have to run the configure script
with the following option:< / p >
< pre class = "literal-block" >
./configure --enable-debug=yes
< / pre >
< / div >
2008-10-17 05:23:30 +02:00
< div class = "section" id = "creating-a-release-build" >
< h3 > Creating a release build< / h3 >
2006-08-28 02:36:00 +02:00
< p > To tell the configure to build a release version (without debug info,
asserts and invariant checks), you have to run the configure script
with the following option:< / p >
< pre class = "literal-block" >
./configure --enable-debug=no
< / pre >
< p > The above option make use of -DNDEBUG, which is used throughout libtorrent.< / p >
< / div >
2008-10-17 05:23:30 +02:00
< div class = "section" id = "id8" >
< h3 > Step 3: Building libtorrent< / h3 >
2006-08-28 02:36:00 +02:00
< p > Once the configure script is run successfully, you just type < tt class = "docutils literal" > < span class = "pre" > make< / span > < / tt > and
libtorrent, the examples and the tests will be built.< / p >
< p > When libtorrent is built it may be a good idea to run the tests, you do this
by running < tt class = "docutils literal" > < span class = "pre" > make< / span > < span class = "pre" > check< / span > < / tt > .< / p >
< p > If you want to build a release version (without debug info, asserts and
invariant checks), you have to rerun the configure script and rebuild, like this:< / p >
< pre class = "literal-block" >
./configure --disable-debug
make clean
make
< / pre >
< / div >
< / div >
2008-10-17 05:23:30 +02:00
< div class = "section" id = "building-with-other-build-systems" >
< h2 > building with other build systems< / h2 >
2006-08-28 02:36:00 +02:00
< p > If you're making your own project file, note that there are two versions of
the file abstraction. There's one < tt class = "docutils literal" > < span class = "pre" > file_win.cpp< / span > < / tt > which relies on windows
file API that supports files larger than 2 Gigabytes. This does not work in
vc6 for some reason, possibly because it may require windows NT and above.
The other file, < tt class = "docutils literal" > < span class = "pre" > file.cpp< / span > < / tt > is the default implementation that simply relies
on the standard low level io routines (< tt class = "docutils literal" > < span class = "pre" > read()< / span > < / tt > , < tt class = "docutils literal" > < span class = "pre" > write()< / span > < / tt > , < tt class = "docutils literal" > < span class = "pre" > open()< / span > < / tt >
etc.), this implementation doesn't do anything special to support unicode
filenames, so if your target is Windows 2000 and up, you may want to use
< tt class = "docutils literal" > < span class = "pre" > file_win.cpp< / span > < / tt > which supports unicode filenames.< / p >
< p > If you're building in MS Visual Studio, you may have to set the compiler
options " force conformance in for loop scope" , " treat wchar_t as built-in
type" and " Enable Run-Time Type Info" to Yes. For a detailed description
2009-02-09 04:48:27 +01:00
on how to build libtorrent with VS, see < a class = "reference external" href = "http://code.rasterbar.com/libtorrent/wiki/Building" > the wiki< / a > .< / p >
2006-08-28 02:36:00 +02:00
< / div >
2008-10-17 05:23:30 +02:00
< div class = "section" id = "build-configurations" >
< h2 > build configurations< / h2 >
2006-08-28 02:36:00 +02:00
< p > By default libtorrent is built In debug mode, and will have pretty expensive
invariant checks and asserts built into it. If you want to disable such checks
(you want to do that in a release build) you can see the table below for which
defines you can use to control the build.< / p >
< table border = "1" class = "docutils" >
< colgroup >
2008-07-19 09:57:43 +02:00
< col width = "45%" / >
< col width = "55%" / >
2006-08-28 02:36:00 +02:00
< / colgroup >
< thead valign = "bottom" >
< tr > < th class = "head" > macro< / th >
< th class = "head" > description< / th >
< / tr >
< / thead >
< tbody valign = "top" >
< tr > < td > < tt class = "docutils literal" > < span class = "pre" > NDEBUG< / span > < / tt > < / td >
< td > If you define this macro, all asserts,
invariant checks and general debug code will be
2008-01-12 19:19:18 +01:00
removed. Since there is quite a lot of code in
in header files in libtorrent, it may be
important to define the symbol consistently
across compilation units, including the clients
files. Potential problems is different
compilation units having different views of
structs and class layouts and sizes.< / td >
2006-08-28 02:36:00 +02:00
< / tr >
< tr > < td > < tt class = "docutils literal" > < span class = "pre" > TORRENT_LOGGING< / span > < / tt > < / td >
< td > This macro will enable logging of the session
events, such as tracker announces and incoming
connections (as well as blocked connections).< / td >
< / tr >
2008-04-05 06:53:22 +02:00
< tr > < td > < tt class = "docutils literal" > < span class = "pre" > TORRENT_DISABLE_GEO_IP< / span > < / tt > < / td >
< td > This is defined by default by the Jamfile. It
disables the GeoIP features, and avoids linking
against LGPL:ed code.< / td >
< / tr >
2006-08-28 02:36:00 +02:00
< tr > < td > < tt class = "docutils literal" > < span class = "pre" > TORRENT_VERBOSE_LOGGING< / span > < / tt > < / td >
< td > If you define this macro, every peer connection
will log its traffic to a log file as well as
the session log.< / td >
< / tr >
< tr > < td > < tt class = "docutils literal" > < span class = "pre" > TORRENT_STORAGE_DEBUG< / span > < / tt > < / td >
< td > This will enable extra expensive invariant
checks in the storage, including logging of
piece sorting.< / td >
< / tr >
2008-01-06 22:39:56 +01:00
< tr > < td > < tt class = "docutils literal" > < span class = "pre" > TORRENT_UPNP_LOGGING< / span > < / tt > < / td >
< td > Generates a " upnp.log" file with the UPnP
traffic. This is very useful when debugging
2008-01-12 19:44:22 +01:00
support for various UPnP routers.
2008-01-06 22:39:56 +01:00
support for various UPnP routers.< / td >
< / tr >
2008-01-12 19:44:22 +01:00
< tr > < td > < tt class = "docutils literal" > < span class = "pre" > TORRENT_DISK_STATS< / span > < / tt > < / td >
< td > This will create a log of all disk activity
which later can parsed and graphed using
< tt class = "docutils literal" > < span class = "pre" > parse_disk_log.py< / span > < / tt > .< / td >
< / tr >
< tr > < td > < tt class = "docutils literal" > < span class = "pre" > TORRENT_STATS< / span > < / tt > < / td >
< td > This will generate a log with transfer rates,
downloading torrents, seeding torrents, peers,
connecting peers and disk buffers in use. The
log can be parsed and graphed with
< tt class = "docutils literal" > < span class = "pre" > parse_session_stats.py< / span > < / tt > .< / td >
< / tr >
2006-08-28 02:36:00 +02:00
< tr > < td > < tt class = "docutils literal" > < span class = "pre" > UNICODE< / span > < / tt > < / td >
< td > If building on windows this will make sure the
UTF-8 strings in pathnames are converted into
UTF-16 before they are passed to the file
operations.< / td >
< / tr >
2008-04-10 12:03:23 +02:00
< tr > < td > < tt class = "docutils literal" > < span class = "pre" > TORRENT_DISABLE_POOL_ALLOCATOR< / span > < / tt > < / td >
< td > Disables use of < tt class = "docutils literal" > < span class = "pre" > boost::pool< > < / span > < / tt > .< / td >
< / tr >
2006-08-28 02:36:00 +02:00
< tr > < td > < tt class = "docutils literal" > < span class = "pre" > TORRENT_LINKING_SHARED< / span > < / tt > < / td >
< td > If this is defined when including the
libtorrent headers, the classes and functions
will be tagged with < tt class = "docutils literal" > < span class = "pre" > __declspec(dllimport)< / span > < / tt >
on msvc and default visibility on GCC 4 and
later. Set this in your project if you're
linking against libtorrent as a shared library.
(This is set by the Jamfile when
< tt class = "docutils literal" > < span class = "pre" > link=shared< / span > < / tt > is set).< / td >
< / tr >
< tr > < td > < tt class = "docutils literal" > < span class = "pre" > TORRENT_BUILDING_SHARED< / span > < / tt > < / td >
< td > If this is defined, the functions and classes
in libtorrent are marked with
< tt class = "docutils literal" > < span class = "pre" > __declspec(dllexport)< / span > < / tt > on msvc, or with
default visibility on GCC 4 and later. This
should be defined when building libtorrent as
a shared library. (This is set by the Jamfile
when < tt class = "docutils literal" > < span class = "pre" > link=shared< / span > < / tt > is set).< / td >
< / tr >
< tr > < td > < tt class = "docutils literal" > < span class = "pre" > TORRENT_DISABLE_DHT< / span > < / tt > < / td >
< td > If this is defined, the support for trackerless
torrents will be disabled.< / td >
< / tr >
2006-08-31 02:26:41 +02:00
< tr > < td > < tt class = "docutils literal" > < span class = "pre" > TORRENT_DHT_VERBOSE_LOGGING< / span > < / tt > < / td >
< td > This will enable verbose logging of the DHT
protocol traffic.< / td >
< / tr >
2007-09-10 03:57:40 +02:00
< tr > < td > < tt class = "docutils literal" > < span class = "pre" > TORRENT_DISABLE_ENCRYPTION< / span > < / tt > < / td >
< td > This will disable any encryption support and
2009-11-11 08:03:50 +01:00
the dependencies of a crypto library.
2007-09-10 03:57:40 +02:00
Encryption support is the peer connection
encrypted supported by clients such as
2009-11-11 08:03:50 +01:00
uTorrent, Azureus and KTorrent.
If this is not defined, either
< tt class = "docutils literal" > < span class = "pre" > TORRENT_USE_OPENSSL< / span > < / tt > or
< tt class = "docutils literal" > < span class = "pre" > TORRENT_USE_GCRYPT< / span > < / tt > must be defined.< / td >
2007-09-10 03:57:40 +02:00
< / tr >
2008-01-12 19:44:22 +01:00
< tr > < td > < tt class = "docutils literal" > < span class = "pre" > _UNICODE< / span > < / tt > < / td >
< td > On windows, this will cause the file IO
use wide character API, to properly support
non-ansi characters.< / td >
< / tr >
< tr > < td > < tt class = "docutils literal" > < span class = "pre" > TORRENT_DISABLE_RESOLVE_COUNTRIES< / span > < / tt > < / td >
< td > Defining this will disable the ability to
resolve countries of origin for peer IPs.< / td >
< / tr >
2008-01-13 07:17:56 +01:00
< tr > < td > < tt class = "docutils literal" > < span class = "pre" > TORRENT_DISABLE_INVARIANT_CHECKS< / span > < / tt > < / td >
< td > This will disable internal invariant checks in
libtorrent. The invariant checks can sometime
be quite expensive, they typically don't scale
very well. This option can be used to still
build in debug mode, with asserts enabled, but
make the resulting executable faster.< / td >
< / tr >
2008-07-19 09:57:43 +02:00
< tr > < td > < tt class = "docutils literal" > < span class = "pre" > TORRENT_EXPENSIVE_INVARIANT_CHECKS< / span > < / tt > < / td >
< td > This will enable extra expensive invariant
checks. Useful for finding particular bugs
or for running before releases.< / td >
< / tr >
2008-08-03 17:14:08 +02:00
< tr > < td > < tt class = "docutils literal" > < span class = "pre" > TORRENT_NO_DEPRECATE< / span > < / tt > < / td >
< td > This will exclude all deprecated functions from
the header files and cpp files.< / td >
< / tr >
2006-08-28 02:36:00 +02:00
< / tbody >
< / table >
< p > If you experience that libtorrent uses unreasonable amounts of cpu, it will
definitely help to define < tt class = "docutils literal" > < span class = "pre" > NDEBUG< / span > < / tt > , since it will remove the invariant checks
within the library.< / p >
< / div >
2008-10-17 05:23:30 +02:00
< div class = "section" id = "building-openssl-for-windows" >
< h2 > building openssl for windows< / h2 >
2008-08-17 13:30:24 +02:00
< p > To build openssl for windows with Visual Studio 7.1 (2003) execute the following commands
in a command shell:< / p >
< pre class = "literal-block" >
perl Configure VC-WIN32 --prefix=" c:/openssl
call ms\do_nasm
call " C:\Program Files\Microsoft Visual Studio .NET 2003\vc7\bin\vcvars32.bat"
nmake -f ms\nt.mak
copy inc32\openssl " C:\Program Files\Microsoft Visual Studio .NET 2003\vc7\include\"
copy out32\libeay32.lib " C:\Program Files\Microsoft Visual Studio .NET 2003\vc7\lib"
copy out32\ssleay32.lib " C:\Program Files\Microsoft Visual Studio .NET 2003\vc7\lib"
< / pre >
< p > This will also install the headers and library files in the visual studio directories to
be picked up by libtorrent.< / p >
< / div >
2006-08-28 02:36:00 +02:00
< / div >
2008-10-17 05:23:30 +02:00
< / div >
< div id = "footer" >
< span > Copyright © 2005 Rasterbar Software.< / span >
< / div >
< / div >
< script src = "http://www.google-analytics.com/urchin.js" type = "text/javascript" >
< / script >
< script type = "text/javascript" >
_uacct = "UA-1599045-1";
urchinTracker();
< / script >
2006-08-28 02:36:00 +02:00
< / div >
< / body >
< / html >
