premiere-libtorrent/docs/index.rst

175 lines
4.4 KiB
ReStructuredText
Raw Normal View History

2014-10-14 18:36:06 +02:00
:Author: Arvid Norberg, arvid@libtorrent.org
:Version: 1.0.2
2006-08-28 02:36:00 +02:00
.. raw:: html
2006-08-28 02:36:00 +02:00
<div id="librarySidebar">
* download_
* `download python binding`_
2006-08-28 02:36:00 +02:00
* features_
* contributing_
2006-08-28 02:36:00 +02:00
* `building libtorrent`_
* examples_
* `library overview`_
* `reference documentation`_
* `troubleshooting issues`_
* `tuning`_
2006-08-28 02:36:00 +02:00
* screenshot_
* `mailing list`_ (archive_)
2006-08-28 02:36:00 +02:00
* `who's using libtorrent?`_
* `report bugs`_
* `sourceforge page`_
2011-11-10 09:50:24 +01:00
* `blog`_
* `wiki`_
--------
2006-11-26 18:39:04 +01:00
Extensions
2010-11-29 02:33:05 +01:00
* `uTP`_
2006-11-26 18:39:04 +01:00
* `extensions protocol`_
* `plugin interface`_
* `streaming`_
2006-11-26 18:39:04 +01:00
* `DHT extensions`_
* `DHT security extension`_
* `DHT store extension`_
2006-11-26 18:39:04 +01:00
* `UDP tracker protocol`_
* `HTTP seed`_
* multitracker_
--------
Bindings
* `ruby bindings`_
* `python bindings`_
--------
* `Introduction, slides`_
2006-08-28 02:36:00 +02:00
.. raw:: html
</div>
<div id="libraryBody">
==========
libtorrent
==========
.. _download: https://sourceforge.net/projects/libtorrent/files/libtorrent/
.. _`download python binding`: https://sourceforge.net/projects/libtorrent/files/py-libtorrent/
2006-08-28 02:36:00 +02:00
.. _features: features.html
.. _contributing: contributing.html
2006-08-28 02:36:00 +02:00
.. _`building libtorrent`: building.html
.. _examples: examples.html
.. _`library overview`: manual-ref.html
.. _`reference documentation`: reference.html
.. _`troubleshooting issues`: troubleshooting.html
.. _`tuning`: tuning.html
.. _screenshot: client_test.png
2010-11-29 02:33:05 +01:00
.. _`uTP`: utp.html
2006-11-26 18:39:04 +01:00
.. _`extensions protocol`: extension_protocol.html
.. _`plugin interface`: reference-Plugins.html
.. _`streaming`: streaming.html
2006-11-26 18:39:04 +01:00
.. _`DHT extensions`: dht_extensions.html
.. _`DHT security extension`: dht_sec.html
.. _`DHT store extension`: dht_store.html
2006-11-26 18:39:04 +01:00
.. _`UDP tracker protocol`: udp_tracker_protocol.html
.. _`HTTP seed`: http://www.getright.com/seedtorrent.html
2009-12-07 06:07:43 +01:00
.. _multitracker: http://bittorrent.org/beps/bep_0012.html
2003-12-09 19:09:34 +01:00
.. _mailing list: http://lists.sourceforge.net/lists/listinfo/libtorrent-discuss
.. _archive: http://dir.gmane.org/gmane.network.bit-torrent.libtorrent
.. _`who's using libtorrent?`: projects.html
.. _`report bugs`: http://code.google.com/p/libtorrent/issues/entry
2006-08-28 02:36:00 +02:00
.. _sourceforge page: http://www.sourceforge.net/projects/libtorrent
2010-01-10 15:31:52 +01:00
.. _wiki: http://code.google.com/p/libtorrent/wiki/index
2011-11-10 09:50:24 +01:00
.. _blog: http://blog.libtorrent.org
.. _`ruby bindings`: http://libtorrent-ruby.rubyforge.org/
.. _`python bindings`: python_binding.html
.. _`Introduction, slides`: bittorrent.pdf
2009-02-09 04:48:27 +01:00
libtorrent is a feature complete C++ bittorrent implementation focusing
on efficiency and scalability. It runs on embedded devices as well as
desktops. It boasts a well documented library interface that is easy to
use. It comes with a `simple bittorrent client`__ demonstrating the use of
the library.
__ client_test.html
The main goals of libtorrent are:
2006-08-28 02:36:00 +02:00
* to be cpu efficient
* to be memory efficient
* to be very easy to use
2004-01-03 04:22:53 +01:00
2004-01-17 21:04:19 +01:00
Donate
======
Support the development of libtorrent
.. raw:: html
<a class="FlattrButton" style="display:none;" href="http://libtorrent.org"></a>
2011-08-05 08:15:08 +02:00
<noscript><a href="http://flattr.com/thing/95662/libtorrent" target="_blank">
<img src="http://api.flattr.com/button/flattr-badge-large.png" alt="Flattr this" title="Flattr this" border="0" /></a></noscript>
2004-01-17 21:04:19 +01:00
Feedback
========
2004-01-17 21:04:19 +01:00
There's a `mailing list`__, general libtorrent discussion.
__ http://lists.sourceforge.net/lists/listinfo/libtorrent-discuss
You can usually find me as hydri in ``#libtorrent`` on ``irc.freenode.net``.
2009-02-09 04:48:27 +01:00
license
=======
libtorrent is released under the BSD-license_.
.. _BSD-license: http://www.opensource.org/licenses/bsd-license.php
This means that you can use the library in your project without having to
release its source code. The only requirement is that you give credit
to the author of the library by including the libtorrent license in your
software or documentation.
It is however greatly appreciated if additional features are contributed
back to the open source project. Patches can be emailed to the mailing
list or posted to the `bug tracker`_.
2013-12-25 18:04:11 +01:00
.. _`bug tracker`: https://code.google.com/p/libtorrent/issues/list
2004-10-13 14:14:11 +02:00
Acknowledgements
2004-10-14 03:17:04 +02:00
================
2014-05-26 17:42:53 +02:00
Written by Arvid Norberg. Copyright |copy| 2003-2014
2003-11-26 17:02:17 +01:00
2005-06-21 14:25:05 +02:00
Contributions by Magnus Jonsson, Daniel Wallin and Cory Nelson
2003-12-14 06:56:12 +01:00
2003-12-17 22:21:09 +01:00
Thanks to Reimond Retz for bugfixes, suggestions and testing
2009-02-09 04:48:27 +01:00
Thanks to `Umeå University`__ for providing development and test hardware.
__ http://www.cs.umu.se
2003-11-26 17:02:17 +01:00
Project is hosted by sourceforge.
|sf_logo|__
__ http://sourceforge.net
2009-02-09 04:48:27 +01:00
.. |sf_logo| image:: http://sourceforge.net/sflogo.php?group_id=7994
.. |copy| unicode:: 0xA9 .. copyright sign
2006-08-28 02:36:00 +02:00
.. raw:: html
</div>