client.go | 2 ++ doc.go | 9 +++++++++ diff --git a/client.go b/client.go index 3e63cf9bb9d5732b3c64bb42a132a85cbe70d8f2..d2c2b4510c1e6617d0a55e99fbea274c79af028c 100644 --- a/client.go +++ b/client.go @@ -336,6 +336,8 @@ } return cl.config.ConfigDir } +// The directory where the Client expects to find and store configuration +// data. Defaults to $HOME/.config/torrent. func (cl *Client) ConfigDir() string { return cl.configDir() } diff --git a/doc.go b/doc.go index e7cc110687931505166bccbc55516ce251034fa2..a15349e57c9527c52ac29aa1c5af409b1448284b 100644 --- a/doc.go +++ b/doc.go @@ -14,5 +14,14 @@ * IP Blocklists * Some IPv6 * UDP Trackers +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. + */ package torrent