2010-02-18 21:01:23 +01: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 >
2012-01-16 03:09:07 +01:00
< meta http-equiv = "Content-Type" content = "text/html; charset=utf-8" / >
2015-01-01 00:18:11 +01:00
< meta name = "generator" content = "Docutils 0.12: http://docutils.sourceforge.net/" / >
2012-01-16 03:09:07 +01:00
< title > libtorrent manual< / title >
2014-10-14 04:06:20 +02:00
< meta name = "author" content = "Arvid Norberg, arvid@libtorrent.org" / >
2015-05-12 08:23:14 +02:00
< meta name = viewport content = "width=device-width, initial-scale=1" >
2010-12-08 05:44:20 +01:00
< script type = "text/javascript" >
/* < ![CDATA[ */
(function() {
var s = document.createElement('script'), t = document.getElementsByTagName('script')[0];
s.type = 'text/javascript';
s.async = true;
s.src = 'http://api.flattr.com/js/0.6/load.js?mode=auto';
t.parentNode.insertBefore(s, t);
})();
/* ]]> */
< / script >
2010-02-18 21:01:23 +01:00
< link rel = "stylesheet" href = "style.css" type = "text/css" / >
2015-05-12 08:23:14 +02:00
< link rel = "stylesheet" type = "text/css" href = "rst.css" / >
2010-02-18 21:01:23 +01:00
< style type = "text/css" >
/* Hides from IE-mac \*/
* html pre { height: 1%; }
/* End hide from IE-mac */
< / style >
< / head >
< body >
< div class = "document" id = "libtorrent-manual" >
< div id = "container" >
2014-10-14 18:36:06 +02:00
< table id = "header" >
< tr > < td id = "orange" > < / td >
< td id = "logo" > libtorrent< / td > < / tr >
< / table >
2010-02-18 21:01:23 +01:00
< div id = "main" >
< 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 >
2014-10-14 04:06:20 +02:00
< td > Arvid Norberg, < a class = "last reference external" href = "mailto:arvid@libtorrent.org" > arvid@ libtorrent.org< / a > < / td > < / tr >
2010-02-18 21:01:23 +01:00
< tr > < th class = "docinfo-name" > Version:< / th >
2014-07-06 21:18:00 +02:00
< td > 1.1.0< / td > < / tr >
2010-02-18 21:01:23 +01:00
< / tbody >
< / table >
< div class = "contents topic" id = "table-of-contents" >
< p class = "topic-title first" > Table of contents< / p >
< ul class = "simple" >
< li > < a class = "reference internal" href = "#contributing-to-libtorrent" id = "id1" > contributing to libtorrent< / a > < / li >
< / ul >
< / div >
< div class = "section" id = "contributing-to-libtorrent" >
< h1 > contributing to libtorrent< / h1 >
< p > There are several ways to contribute to libtorrent at various levels. Any help is
much appreciated. If you're interested in something libtorrent related that's not
2014-10-14 04:06:20 +02:00
enumerated on this page, please contact < a class = "reference external" href = "mailto:arvid@libtorrent.org" > arvid@ libtorrent.org< / a > or the < a class = "reference external" href = "http://lists.sourceforge.net/lists/listinfo/libtorrent-discuss" > mailing list< / a > .< / p >
2010-02-18 21:01:23 +01:00
< ol class = "arabic" >
< li > < dl class = "first docutils" >
< dt > Testing< / dt >
2010-02-19 05:20:11 +01:00
< dd > < p class = "first" > This is not just limited to finding bugs and ways to reproduce crashes, but also
2010-02-18 21:01:23 +01:00
sub-optimal behavior is certain scenarios and finding ways to reproduce those. Please
2015-10-11 23:09:30 +02:00
report any issue to the bug tracker at < a class = "reference external" href = "https://github.com/arvidn/libtorrent/issues" > github< / a > .< / p >
2013-01-21 20:13:24 +01:00
< p class = "last" > New features that need testing are streaming (< tt class = "docutils literal" > set_piece_deadline()< / tt > ), the different
2010-02-19 05:20:11 +01:00
choking algorithms (especially the new BitTyrant choker), the disk cache options (such
2013-01-21 20:13:24 +01:00
as < tt class = "docutils literal" > explicit_cache< / tt > ).< / p >
2010-02-18 21:01:23 +01:00
< / dd >
< / dl >
< / li >
< / ol >
< ol class = "arabic" start = "2" >
< li > < dl class = "first docutils" >
< dt > Documentation< / dt >
< dd > < p class = "first last" > Finding typos or outdated sections in the documentation. Contributing documentation
based on your own experience and experimentation with the library or with BitTorrent
in general. Non-reference documentation is very much welcome as well, higher level
2016-02-20 22:38:56 +01:00
descriptions on how to configure libtorrent for various situations for instance.
The reference documentation for libtorrent is generated from the header files.
For updates, please submit a < a class = "reference external" href = "https://github.com/arvidn/libtorrent" > pull request< / a > .< / p >
2010-02-18 21:01:23 +01:00
< / dd >
< / dl >
< / li >
< li > < dl class = "first docutils" >
< dt > Code< / dt >
2010-02-19 05:20:11 +01:00
< dd > < p class = "first" > Contributing code for new features or bug-fixes is highly welcome. If you're interested
2010-02-18 21:01:23 +01:00
in adding a feature but not sure where to start, please contact the < a class = "reference external" href = "http://lists.sourceforge.net/lists/listinfo/libtorrent-discuss" > mailing list< / a > or
2016-02-20 22:38:56 +01:00
< tt class = "docutils literal" > #libtorrent< / tt > @ < tt class = "docutils literal" > irc.freenode.net< / tt > . For proposed fixes or udpates, please
submit a < a class = "reference external" href = "https://github.com/arvidn/libtorrent" > pull request< / a > .< / p >
2010-02-19 05:20:11 +01:00
< p class = "last" > New features might be better support for integrating with other services, new choking
algorithms, seeding policies, ports to new platforms etc.< / p >
2010-02-18 21:01:23 +01:00
< / dd >
< / dl >
< / li >
< / ol >
2013-01-21 20:13:24 +01:00
< p > For an overview of the internals of libtorrent, see the < a class = "reference external" href = "hacking.html" > hacking< / a > page.< / p >
< p > For outstanding things to do, see the < a class = "reference external" href = "todo.html" > todo list< / a > .< / p >
2010-02-18 21:01:23 +01:00
< / div >
2014-10-14 18:36:06 +02:00
< / div >
< / div >
< div id = "gradient" > < / div >
< div id = "footer" >
< table >
< tr >
< td > < a href = "index.html" > home< / a > < / td >
< td > < a href = "http://blog.libtorrent.org" > blog< / a > < / td >
< td > < a href = "utp.html" > uTP< / a > < / td >
< / tr >
< tr >
< td > < a href = "https://sourceforge.net/projects/libtorrent/files/libtorrent/" > download< / a > < / td >
< td > < a href = "reference.html" > documentation< / a > < / td >
< td > < a href = "dht_store.html" > DHT put extension< / a > < / td >
< / tr >
< tr >
< td > < a href = "https://sourceforge.net/projects/libtorrent/files/py-libtorrent/" > python bindings< / a > < / td >
< td > < a href = "features.html" > features< / a > < / td >
< td > < a href = "dht_sec.html" > DHT security extension< / a > < / td >
< / tr >
< tr >
< td > < a href = "http://dir.gmane.org/gmane.network.bit-torrent.libtorrent" > mailing list archive< / a > < / td >
< td > < a href = "contributing.html" > contributing< / a > < / td >
< td > < a href = "streaming.html" > streaming< / a > < / td >
< / tr >
< tr >
< td > < a href = "http://code.google.com/p/libtorrent/issues/entry" > report a bug< / a > < / td >
< td > < a href = "building.html" > building< / a > < / td >
< td > < a href = "bittorrent.pdf" > bittorrent slides< / a > < / td >
< / tr >
< / table >
< / div >
2015-05-12 08:23:14 +02:00
< div id = "filler" > < / div >
2014-10-14 18:36:06 +02:00
2010-02-18 21:01:23 +01:00
< / div >
< / body >
< / html >
