~ubuntu-branches/ubuntu/maverick/libtorrent-rasterbar/maverick

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).

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">#libtorrent</tt>

IRC channel on <tt class="docutils literal">irc.freenode.net</tt>.

Community contributed build tutorials can be found on the <a class="reference external" href="http://code.rasterbar.com/libtorrent/wiki/Building">wiki</a>.

<h2>building from svn</h2>

To build libtorrent from svn you need to check out the libtorrent sources from

sourceforge and also check out the asio sources from its sourceforge cvs.

If you downloaded a release tarball, you can skip this section.

To prepare the directory structure for building, follow these steps:

<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>

<li>Copy the <tt class="docutils literal">asio/include/asio/</tt> directory into the <tt class="docutils literal">libtorrent/include/libtorrent/</tt>

directory. Alternatively you can make a symbolic link.</li>

<li>Copy <tt class="docutils literal">asio/include/asio.hpp</tt> into <tt class="docutils literal">libtorrent/include/libtorrent</tt>.</li>

</ul>

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.

</div>

<h2>building with BBv2</h2>

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

ensure that the build targets are link compatible (see <a class="reference external" href="http://boost.org/more/separate_compilation.html">boost guidelines</a>

for some details on this issue).

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).

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).

<h3>Step 1: Download boost</h3>

You'll find boost <a class="reference external" href="http://sourceforge.net/project/showfiles.php?group_id=7586&package_id=8041&release_id=376197">here</a>.

Extract the archive to some directory where you want it. For the sake of this

guide, let's assume you extract the package to <tt class="docutils literal">c:\boost_1_34_0</tt> (I'm using

a windows path in this example since if you're on linux/unix you're more likely

to use the autotools). You'll need at least version 1.34 of the boost library

in order to build libtorrent.

</div>

<h3>Step 2: Setup BBv2</h3>

First you need to build <tt class="docutils literal">bjam</tt>. You do this by opening a terminal (In

windows, run <tt class="docutils literal">cmd</tt>). Change directory to

<tt class="docutils literal">c:\boost_1_34_0\tools\jam\src</tt>. Then run the script called

<tt class="docutils literal">build.bat</tt> or <tt class="docutils literal">build.sh</tt> on a unix system. This will build <tt class="docutils literal">bjam</tt> and

place it in a directory starting with <tt class="docutils literal">bin.</tt> and then have the name of your

platform. Copy the <tt class="docutils literal">bjam.exe</tt> (or <tt class="docutils literal">bjam</tt> on a unix system) to a place

that's in you shell's <tt class="docutils literal">PATH</tt>. On linux systems a place commonly used may be

<tt class="docutils literal">/usr/local/bin</tt> or on windows <tt class="docutils literal">c:\windows</tt> (you can also add directories

to the search paths by modifying the environment variable called <tt class="docutils literal">PATH</tt>).

Now you have <tt class="docutils literal">bjam</tt> installed. <tt class="docutils literal">bjam</tt> can be considered an interpreter

that the boost-build system is implemented on. So boost-build uses <tt class="docutils literal">bjam</tt>.

So, to complete the installation you need to make two more things. You need to

set the environment variable <tt class="docutils literal">BOOST_BUILD_PATH</tt>. This is the path that tells

<tt class="docutils literal">bjam</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

it to <tt class="docutils literal">c:\boost_1_34_0\tools\build\v2</tt>.

100

To set an environment variable in windows, type for example:

101

102

set BOOST_BUILD_PATH=c:\boost_1_34_0\tools\build\v2

103

</pre>

104

In a terminal window.

105

The last thing to do to complete the setup of BBv2 is to modify your

106

<tt class="docutils literal">user-config.jam</tt> file. It is located in <tt class="docutils literal">c:\boost_1_34_0\tools\build\v2</tt>.

107

Depending on your platform and which compiler you're using, you should add a

108

line for each compiler and compiler version you have installed on your system

109

that you want to be able to use with BBv2. For example, if you're using

110

Microsoft Visual Studio 7.1 (2003), just add a line:

111

112

using msvc : 7.1 ;

113

</pre>

114

If you use GCC, add the line:

115

116

using gcc ;

117

</pre>

118

If you have more than one version of GCC installed, you can add the

119

commandline used to invoke g++ after the version number, like this:

120

121

using gcc : 3.3 : g++-3.3 ;

122

using gcc : 4.0 : g++-4.0 ;

123

</pre>

124

Another toolset worth mentioning is the <tt class="docutils literal">darwin</tt> toolset (For MacOS X).

125

From Tiger (10.4) MacOS X comes with both GCC 3.3 and GCC 4.0. Then you can

126

use the following toolsets:

127

128

using darwin : 3.3 : g++-3.3 ;

129

using darwin : 4.0 : g++-4.0 ;

130

</pre>

131

Note that the spaces around the semi-colons and colons are important!

132

Also see the <a class="reference external" href="http://www.boost.org/doc/html/bbv2/installation.html">official installation instructions</a>.

133

</div>

134

135

<h3>Step 3: Building libtorrent</h3>

136

When building libtorrent, the <tt class="docutils literal">Jamfile</tt> expects the environment variable

137

<tt class="docutils literal">BOOST_ROOT</tt> to be set to the boost installation directory. It uses this to

138

find the boost libraries it depends on, so they can be built and their headers

139

files found. So, set this to <tt class="docutils literal">c:\boost_1_34_0</tt>. You only need this if you're

140

building against a source distribution of boost.

141

Then the only thing left is simply to invoke <tt class="docutils literal">bjam</tt>. If you want to specify

142

a specific toolset to use (compiler) you can just add that to the commandline.

143

For example:

144

145

bjam msvc-7.1 boost=source

146

bjam gcc-3.3 boost=source

147

bjam darwin-4.0 boost=source

148

</pre>

149

If you're building against a system installed boost, specify <tt class="docutils literal">boost=system</tt>.

150

To build different versions you can also just add the name of the build

151

variant. Some default build variants in BBv2 are <tt class="docutils literal">release</tt>, <tt class="docutils literal">debug</tt>,

152

<tt class="docutils literal">profile</tt>.

153

You can build libtorrent as a dll too, by typing <tt class="docutils literal">link=shared</tt>, or

154

<tt class="docutils literal">link=static</tt> to build a static library.

155

If you want to explicitly say how to link against the runtime library, you

156

can set the <tt class="docutils literal">runtime-link</tt> feature on the commandline, either to <tt class="docutils literal">shared</tt>

157

or <tt class="docutils literal">static</tt>. Most operating systems will only allow linking shared against

158

the runtime, but on windows you can do both. Example:

159

160

bjam msvc-7.1 link=static runtime-link=static boost=source

161

</pre>

162

163

Warning

164

If you link statically to the runtime library, you cannot build libtorrent

165

as a shared library (DLL), since you will get separate heaps in the library

166

and in the client application. It will result in crashes and possibly link

167

errors.

168

</div>

169

170

Warning

171

With boost-build V2 (Milestone 11), the darwin toolset uses the <tt class="docutils literal">-s</tt> linker

172

option to strip debug symbols. This option is buggy in Apple's GCC, and

173

will make the executable crash on startup. On Mac OS X, instead build

174

your release executables with the <tt class="docutils literal">debug-symbols=on</tt> option, and

175

later strip your executable with <tt class="docutils literal">strip</tt>.

176

</div>

177

178

Warning

179

Some linux systems requires linking against <tt class="docutils literal">librt</tt> in order to access

180

the POSIX clock functions. If you get an error complaining about a missing

181

symbol <tt class="docutils literal">clock_gettime</tt>, you have to give <tt class="docutils literal">need-librt=yes</tt> on the

182

bjam command line. This will make libtorrent link against <tt class="docutils literal">librt</tt>.

183

</div>

184

The build targets are put in a directory called bin, and under it they are

185

sorted in directories depending on the toolset and build variant used.

186

To build the examples, just change directory to the examples directory and

187

invoke <tt class="docutils literal">bjam</tt> from there. To build and run the tests, go to the test

188

directory and run <tt class="docutils literal">bjam</tt>.

189

Note that if you're building on windows using the <tt class="docutils literal">msvc</tt> toolset, you cannot run it

190

from a cygwin terminal, you'll have to run it from a <tt class="docutils literal">cmd</tt> terminal. The same goes for

191

cygwin, if you're building with gcc in cygwin you'll have to run it from a cygwin terminal.

192

Also, make sure the paths are correct in the different environments. In cygwin, the paths

193

(<tt class="docutils literal">BOOST_BUILD_PATH</tt> and <tt class="docutils literal">BOOST_ROOT</tt>) should be in the typical unix-format (e.g.

194

<tt class="docutils literal">/cygdrive/c/boost_1_34_0</tt>). In the windows environment, they should have the typical

195

windows format (<tt class="docutils literal">c:/boost_1_34_0</tt>).

196

The <tt class="docutils literal">Jamfile</tt> will define <tt class="docutils literal">NDEBUG</tt> when it's building a release build.

197

For more build configuration flags see <a class="reference internal" href="#build-configurations">Build configurations</a>.

198

Build features:

199

200

201

202

203

</colgroup>

204

205

<tr><th class="head">boost build feature</th>

206

<th class="head">values</th>

207

</tr>

208

</thead>

209

210

<tr><td><tt class="docutils literal">boost</tt></td>

211

212

<li><tt class="docutils literal">system</tt> - default. Tells the Jamfile that

213

boost is installed and should be linked against

214

the system libraries.</li>

215

<li><tt class="docutils literal">source</tt> - Specifies that boost is to be built

216

from source. The environment variable

217

<tt class="docutils literal">BOOST_ROOT</tt> must be defined to point to the

218

boost directory.</li>

219

</ul>

220

</td>

221

</tr>

222

<tr><td><tt class="docutils literal">logging</tt></td>

223

224

<li><tt class="docutils literal">none</tt> - no logging.</li>

225

<li><tt class="docutils literal">default</tt> - basic session logging.</li>

226

<li><tt class="docutils literal">verbose</tt> - verbose peer wire logging.</li>

227

</ul>

228

</td>

229

</tr>

230

<tr><td><tt class="docutils literal">dht-support</tt></td>

231

232

<li><tt class="docutils literal">on</tt> - build with support for tracker less

233

torrents and DHT support.</li>

234

<li><tt class="docutils literal">logging</tt> - build with DHT support and verbose

235

logging of the DHT protocol traffic.</li>

236

<li><tt class="docutils literal">off</tt> - build without DHT support.</li>

237

</ul>

238

</td>

239

</tr>

240

<tr><td><tt class="docutils literal">need-librt</tt></td>

241

242

<li><tt class="docutils literal">no</tt> - this platform does not need to link

243

against librt to have POSIX time functions.</li>

244

<li><tt class="docutils literal">yes</tt> - specify this if your linux system

245

requires you to link against librt.a. This is

246

typically the case on x86 64 bit systems.</li>

247

</ul>

248

</td>

249

</tr>

250

251

252

<li><tt class="docutils literal">system</tt> - links against the zlib supplied

253

with your operating system.</li>

254

<li><tt class="docutils literal">shipped</tt> - links against the zlib bundled

255

with the libtorrent package.</li>

256

</ul>

257

</td>

258

</tr>

259

<tr><td><tt class="docutils literal">upnp-logging</tt></td>

260

261

<li><tt class="docutils literal">off</tt> - default. Does not log UPnP traffic.</li>

262

<li><tt class="docutils literal">on</tt> - creates "upnp.log" with the messages

263

sent to and received from UPnP devices.</li>

264

</ul>

265

</td>

266

</tr>

267

<tr><td><tt class="docutils literal">openssl</tt></td>

268

269

<li><tt class="docutils literal">pe</tt> - turns on support for encrypted

270

connections. requires openssl (libcrypto)</li>

271

<li><tt class="docutils literal">sha-1</tt> - openssl will be used instead of the

272

public domain SHA-1 implementation shipped with

273

libtorrent. <tt class="docutils literal">libcrypto.a</tt> will be required for

274

linking. Encryption support is still turned off.</li>

275

<li><tt class="docutils literal">off</tt> - turns off support for encrypted

276

connections. openssl is not linked in. The

277

shipped public domain SHA-1 implementation is

278

used.</li>

279

</ul>

280

</td>

281

</tr>

282

283

284

<li><tt class="docutils literal">static</tt> - builds libtorrent as a static

285

library (.a / .lib)</li>

286

<li><tt class="docutils literal">shared</tt> - builds libtorrent as a shared

287

library (.so / .dll).</li>

288

</ul>

289

</td>

290

</tr>

291

<tr><td><tt class="docutils literal">runtime-link</tt></td>

292

293

<li><tt class="docutils literal">static</tt> - links statically against the

294

run-time library (if available on your

295

platform).</li>

296

<li><tt class="docutils literal">shared</tt> - link dynamically against the

297

run-time library (default).</li>

298

</ul>

299

</td>

300

</tr>

301

<tr><td><tt class="docutils literal">variant</tt></td>

302

303

<li><tt class="docutils literal">debug</tt> - builds libtorrent with debug

304

information and invariant checks.</li>

305

<li><tt class="docutils literal">release</tt> - builds libtorrent in release mode

306

without invariant checks and with optimization.</li>

307

<li><tt class="docutils literal">profile</tt> - builds libtorrent with profile

308

information.</li>

309

</ul>

310

</td>

311

</tr>

312

<tr><td><tt class="docutils literal">character-set</tt></td>

313

<td>This setting will only have an affect on windows.

314

Other platforms are expected to support UTF-8.

315

316

<li><tt class="docutils literal">ansi</tt> - The ansi version of the win32 API is

317

used.</li>

318

<li><tt class="docutils literal">unicode</tt> - The unicode version of the win32

319

API is used.</li>

320

</ul>

321

</td>

322

</tr>

323

<tr><td><tt class="docutils literal">invariant-checks</tt></td>

324

<td>This setting only affects debug builds (where

325

<tt class="docutils literal">NDEBUG</tt> is not defined). It defaults to <tt class="docutils literal">on</tt>.

326

327

<li><tt class="docutils literal">on</tt> - internal invariant checks are enabled.</li>

328

<li><tt class="docutils literal">off</tt> - internal invariant checks are

329

disabled. The resulting executable will run

330

faster than a regular debug build.</li>

331

</ul>

332

</td>

333

</tr>

334

<tr><td><tt class="docutils literal">debug-symbols</tt></td>

335

336

<li><tt class="docutils literal">on</tt> - default for debug builds. This setting

337

is useful for building release builds with

338

symbols.</li>

339

<li><tt class="docutils literal">off</tt> - default for release builds.</li>

340

</ul>

341

</td>

342

</tr>

343

</tbody>

344

</table>

345

The <tt class="docutils literal">variant</tt> feature is implicit, which means you don't need to specify

346

the name of the feature, just the value.

347

The logs created when building vlog or log mode are put in a directory called

348

<tt class="docutils literal">libtorrent_logs</tt> in the current working directory.

349

When building the example client on windows, you need to build with

350

<tt class="docutils literal">link=static</tt> otherwise you may get unresolved external symbols for some

351

boost.program-options symbols.

352

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

353

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>.

354

</div>

355

</div>

356

357

<h2>building with autotools</h2>

358

First of all, you need to install <tt class="docutils literal">automake</tt> and <tt class="docutils literal">autoconf</tt>. Many

359

unix/linux systems comes with these preinstalled.

360

The prerequisites for building libtorrent is boost.thread, boost.date_time

361

and boost.filesystem. Those are the compiled boost libraries needed. The

362

headers-only libraries needed include (but is not necessarily limited to)

363

boost.bind, boost.ref, boost.multi_index, boost.optional, boost.lexical_cast,

364

boost.integer, boost.iterator, boost.tuple, boost.array, boost.function,

365

boost.smart_ptr, boost.preprocessor, boost.static_assert.

366

If you want to build the <tt class="docutils literal">client_test</tt> example, you'll also need boost.regex

367

and boost.program_options.

368

369

<h3>Step 1: Generating the build system</h3>

370

No build system is present if libtorrent is checked out from CVS - it

371

needs to be generated first. If you're building from a released tarball,

372

you may skip directly to <a class="reference internal" href="#step-2-running-configure">Step 2: Running configure</a>.

373

Execute the following commands, in the given order, to generate

374

the build system:

375

376

aclocal -I m4

377

autoheader

378

libtoolize --copy --force

379

automake --add-missing --copy --gnu

380

autoconf

381

</pre>

382

On darwin/OSX you have to run <tt class="docutils literal">glibtoolize</tt> instead of <tt class="docutils literal">libtoolize</tt>.

383

</div>

384

385

<h3>Step 2: Running configure</h3>

386

In your shell, change directory to the libtorrent directory and run

387

<tt class="docutils literal">./configure</tt>. This will look for libraries and C++ features that libtorrent

388

is dependent on. If something is missing or can't be found it will print an

389

error telling you what failed.

390

The most likely problem you may encounter is that the configure script won't

391

find the boost libraries. Make sure you have boost installed on your system.

392

The easiest way to install boost is usually to use the preferred package

393

system on your platform. Usually libraries and headers are installed in

394

standard directories where the compiler will find them, but sometimes that

395

may not be the case. For example when installing boost on darwin using

396

darwinports (the package system based on BSD ports) all libraries are

397

installed to <tt class="docutils literal">/opt/local/lib</tt> and headers are installed to

398

<tt class="docutils literal">/opt/local/include</tt>. By default the compiler will not look in these

399

directories. You have to set the enviornment variables <tt class="docutils literal">LDFLAGS</tt> and

400

<tt class="docutils literal">CXXFLAGS</tt> in order to make the compiler find those libs. In this example

401

you'd set them like this:

402

403

export LDFLAGS=-L/opt/local/lib

404

export CXXFLAGS=-I/opt/local/include

405

</pre>

406

It was observed on FreeBSD (release 6.0) that one needs to add '-lpthread' to

407

LDFLAGS, as Boost::Thread detection will fail without it, even if

408

Boost::Thread is installed.

409

If you need to set these variables, it may be a good idea to add those lines

410

to your <tt class="docutils literal">~/.profile</tt> or <tt class="docutils literal">~/.tcshrc</tt> depending on your shell.

411

If the boost libraries are named with a suffix on your platform, you may use

412

the <tt class="docutils literal">--with-boost-thread=</tt> option to specify the suffix used for the thread

413

library in this case. For more information about these options, run:

414

415

./configure --help

416

</pre>

417

On gentoo the boost libraries that are built with multi-threading support have

418

the suffix <tt class="docutils literal">mt</tt>.

419

You know that the boost libraries were found if you see the following output

420

from the configure script:

421

422

checking whether the Boost::DateTime library is available... yes

423

checking for main in -lboost_date_time... yes

424

checking whether the Boost::Filesystem library is available... yes

425

checking for main in -lboost_filesystem... yes

426

checking whether the Boost::Thread library is available... yes

427

checking for main in -lboost_thread... yes

428

</pre>

429

Another possible source of problems may be if the path to your libtorrent

430

directory contains spaces. Make sure you either rename the directories with

431

spaces in their names to remove the spaces or move the libtorrent directory.

432

</div>

433

434

<h3>Creating a debug build</h3>

435

To tell configure to build a debug version (with debug info, asserts

436

and invariant checks enabled), you have to run the configure script

437

with the following option:

438

439

./configure --enable-debug=yes

440

</pre>

441

</div>

442

443

<h3>Creating a release build</h3>

444

To tell the configure to build a release version (without debug info,

445

asserts and invariant checks), you have to run the configure script

446

with the following option:

447

448

./configure --enable-debug=no

449

</pre>

450

The above option make use of -DNDEBUG, which is used throughout libtorrent.

451

</div>

452

453

<h3>Step 3: Building libtorrent</h3>

454

Once the configure script is run successfully, you just type <tt class="docutils literal">make</tt> and

455

libtorrent, the examples and the tests will be built.

456

When libtorrent is built it may be a good idea to run the tests, you do this

457

by running <tt class="docutils literal">make check</tt>.

458

If you want to build a release version (without debug info, asserts and

459

invariant checks), you have to rerun the configure script and rebuild, like this:

460

461

./configure --disable-debug

462

make clean

463

make

464

</pre>

465

</div>

466

</div>

467

468

<h2>building with other build systems</h2>

469

If you're making your own project file, note that there are two versions of

470

the file abstraction. There's one <tt class="docutils literal">file_win.cpp</tt> which relies on windows

471

file API that supports files larger than 2 Gigabytes. This does not work in

472

vc6 for some reason, possibly because it may require windows NT and above.

473

The other file, <tt class="docutils literal">file.cpp</tt> is the default implementation that simply relies

474

on the standard low level io routines (<tt class="docutils literal">read()</tt>, <tt class="docutils literal">write()</tt>, <tt class="docutils literal">open()</tt>

475

etc.), this implementation doesn't do anything special to support unicode

476

filenames, so if your target is Windows 2000 and up, you may want to use

477

<tt class="docutils literal">file_win.cpp</tt> which supports unicode filenames.

478

If you're building in MS Visual Studio, you may have to set the compiler

479

options "force conformance in for loop scope", "treat wchar_t as built-in

480

type" and "Enable Run-Time Type Info" to Yes. For a detailed description

481

on how to build libtorrent with VS, see <a class="reference external" href="http://code.rasterbar.com/libtorrent/wiki/Building">the wiki</a>.

482

</div>

483

484

<h2>build configurations</h2>

485

By default libtorrent is built In debug mode, and will have pretty expensive

486

invariant checks and asserts built into it. If you want to disable such checks

487

(you want to do that in a release build) you can see the table below for which

488

defines you can use to control the build.

489

490

491

492

493

</colgroup>

494

495

<tr><th class="head">macro</th>

496

<th class="head">description</th>

497

</tr>

498

</thead>

499

500

<tr><td><tt class="docutils literal">NDEBUG</tt></td>

501

<td>If you define this macro, all asserts,

502

invariant checks and general debug code will be

503

removed. Since there is quite a lot of code in

504

in header files in libtorrent, it may be

505

important to define the symbol consistently

506

across compilation units, including the clients

507

files. Potential problems is different

508

compilation units having different views of

509

structs and class layouts and sizes.</td>

510

</tr>

511

<tr><td><tt class="docutils literal">TORRENT_LOGGING</tt></td>

512

<td>This macro will enable logging of the session

513

events, such as tracker announces and incoming

514

connections (as well as blocked connections).</td>

515

</tr>

516

<tr><td><tt class="docutils literal">TORRENT_VERBOSE_LOGGING</tt></td>

517

<td>If you define this macro, every peer connection

518

will log its traffic to a log file as well as

519

the session log.</td>

520

</tr>

521

<tr><td><tt class="docutils literal">TORRENT_STORAGE_DEBUG</tt></td>

522

<td>This will enable extra expensive invariant

523

checks in the storage, including logging of

524

piece sorting.</td>

525

</tr>

526

<tr><td><tt class="docutils literal">TORRENT_UPNP_LOGGING</tt></td>

527

<td>Generates a "upnp.log" file with the UPnP

528

traffic. This is very useful when debugging

529

support for various UPnP routers.

530

support for various UPnP routers.</td>

531

</tr>

532

<tr><td><tt class="docutils literal">TORRENT_DISK_STATS</tt></td>

533

<td>This will create a log of all disk activity

534

which later can parsed and graphed using

535

<tt class="docutils literal">parse_disk_log.py</tt>.</td>

536

</tr>

537

<tr><td><tt class="docutils literal">TORRENT_STATS</tt></td>

538

<td>This will generate a log with transfer rates,

539

downloading torrents, seeding torrents, peers,

540

connecting peers and disk buffers in use. The

541

log can be parsed and graphed with

542

<tt class="docutils literal">parse_session_stats.py</tt>.</td>

543

</tr>

544

<tr><td><tt class="docutils literal">UNICODE</tt></td>

545

<td>If building on windows this will make sure the

546

UTF-8 strings in pathnames are converted into

547

UTF-16 before they are passed to the file

548

operations.</td>

549

</tr>

550

<tr><td><tt class="docutils literal">LITTLE_ENDIAN</tt></td>

551

<td>This will use the little endian version of the

552

sha-1 code. If defined on a big-endian system

553

the sha-1 hashes will be incorrect and fail.

554

If it is not defined and <tt class="docutils literal">__BIG_ENDIAN__</tt>

555

isn't defined either (it is defined by Apple's

556

GCC) both little-endian and big-endian versions

557

will be built and the correct code will be

558

chosen at run-time.</td>

559

</tr>

560

<tr><td><tt class="docutils literal">TORRENT_LINKING_SHARED</tt></td>

561

<td>If this is defined when including the

562

libtorrent headers, the classes and functions

563

will be tagged with <tt class="docutils literal">__declspec(dllimport)</tt>

564

on msvc and default visibility on GCC 4 and

565

later. Set this in your project if you're

566

linking against libtorrent as a shared library.

567

(This is set by the Jamfile when

568

<tt class="docutils literal">link=shared</tt> is set).</td>

569

</tr>

570

<tr><td><tt class="docutils literal">TORRENT_BUILDING_SHARED</tt></td>

571

<td>If this is defined, the functions and classes

572

in libtorrent are marked with

573

<tt class="docutils literal">__declspec(dllexport)</tt> on msvc, or with

574

default visibility on GCC 4 and later. This

575

should be defined when building libtorrent as

576

a shared library. (This is set by the Jamfile

577

when <tt class="docutils literal">link=shared</tt> is set).</td>

578

</tr>

579

<tr><td><tt class="docutils literal">TORRENT_DISABLE_DHT</tt></td>

580

<td>If this is defined, the support for trackerless

581

torrents will be disabled.</td>

582

</tr>

583

<tr><td><tt class="docutils literal">TORRENT_DHT_VERBOSE_LOGGING</tt></td>

584

<td>This will enable verbose logging of the DHT

585

protocol traffic.</td>

586

</tr>

587

<tr><td><tt class="docutils literal">TORRENT_DISABLE_ENCRYPTION</tt></td>

588

<td>This will disable any encryption support and

589

the openssl dependency that comes with it.

590

Encryption support is the peer connection

591

encrypted supported by clients such as

592

uTorrent, Azureus and KTorrent.</td>

593

</tr>

594

<tr><td><tt class="docutils literal">_UNICODE</tt></td>

595

<td>On windows, this will cause the file IO

596

use wide character API, to properly support

597

non-ansi characters.</td>

598

</tr>

599

<tr><td><tt class="docutils literal">TORRENT_DISABLE_RESOLVE_COUNTRIES</tt></td>

600

<td>Defining this will disable the ability to

601

resolve countries of origin for peer IPs.</td>

602

</tr>

603

<tr><td><tt class="docutils literal">TORRENT_DISABLE_INVARIANT_CHECKS</tt></td>

604

<td>This will disable internal invariant checks in

605

libtorrent. The invariant checks can sometime

606

be quite expensive, they typically don't scale

607

very well. This option can be used to still

608

build in debug mode, with asserts enabled, but

609

make the resulting executable faster.</td>

610

</tr>

611

</tbody>

612

</table>

613

If you experience that libtorrent uses unreasonable amounts of cpu, it will

614

definitely help to define <tt class="docutils literal">NDEBUG</tt>, since it will remove the invariant checks

615

within the library.

616

</div>

617

</div>

618

</div>

619

</body>

620

</html>

Older »