doc.go

   1 /*
   2 Package torrent implements a torrent client. Goals include:
   3  * Configurable data storage, such as file, mmap, and piece-based.
   4  * Downloading on demand: torrent.Reader will request only the data required to
   5    satisfy Reads, which is ideal for streaming and torrentfs.
   6
   7 BitTorrent features implemented include:
   8  * Protocol obfuscation
   9  * DHT
  10  * uTP
  11  * PEX
  12  * Magnet
  13  * IP Blocklists
  14  * Some IPv6
  15  * UDP Trackers
  16
  17 ConfigDir
  18
  19 A Client has a configurable ConfigDir that defaults to $HOME/.config/torrent.
  20 Torrent metainfo files are cached at $CONFIGDIR/torrents/$infohash.torrent.
  21 Infohashes in $CONFIGDIR/banned_infohashes cannot be added to the Client. A
  22 P2P Plaintext Format blocklist is loaded from a file at the location specified
  23 by the environment variable TORRENT_BLOCKLIST_FILE if set. otherwise from
  24 $CONFIGDIR/blocklist. If $CONFIGDIR/packed-blocklist exists, this is memory-
  25 mapped as a packed IP blocklist, saving considerable memory.
  26
  27 */
  28 package torrent