torrent/doc.go

28 lines
852 B
Go
Raw Normal View History

2015-06-03 03:30:55 +00:00
/*
Package torrent implements a torrent client. Goals include:
* Configurable data storage, such as file, mmap, and piece-based.
* Downloading on demand: torrent.Reader will request only the data required to
satisfy Reads, which is ideal for streaming and torrentfs.
2015-04-28 05:24:17 +00:00
2015-06-03 03:30:55 +00:00
BitTorrent features implemented include:
* Protocol obfuscation
* DHT
* uTP
* PEX
* Magnet
* IP Blocklists
* Some IPv6
* UDP Trackers
2015-06-22 09:48:50 +00:00
ConfigDir
A Client has a configurable ConfigDir that defaults to $HOME/.config/torrent.
Torrent metainfo files are cached at $CONFIGDIR/torrents/$infohash.torrent.
Infohashes in $CONFIGDIR/banned_infohashes cannot be added to the Client. A
P2P Plaintext Format blocklist is loaded from a file at the location specified
by the environment variable TORRENT_BLOCKLIST_FILE if set, otherwise from
$CONFIGDIR/blocklist.
2015-06-03 03:30:55 +00:00
*/
2015-04-28 05:24:17 +00:00
package torrent