diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/git-annex.mdwn | 4 | ||||
| -rw-r--r-- | doc/special_remotes.mdwn | 1 | ||||
| -rw-r--r-- | doc/special_remotes/bittorrent.mdwn | 25 | ||||
| -rw-r--r-- | doc/tips/using_the_web_as_a_special_remote.mdwn | 12 |
4 files changed, 42 insertions, 0 deletions
diff --git a/doc/git-annex.mdwn b/doc/git-annex.mdwn index 7ccb36b5d..8a2633e15 100644 --- a/doc/git-annex.mdwn +++ b/doc/git-annex.mdwn @@ -1728,6 +1728,10 @@ Here are all the supported configuration settings. Options to pass to quvi when using it to find the url to download for a video. +* `annex.aria-torrent-options` + + Options to pass to aria2c when using it to download a torrent. + * `annex.http-headers` HTTP headers to send when downloading from the web. Multiple lines of diff --git a/doc/special_remotes.mdwn b/doc/special_remotes.mdwn index dd82d23f1..e6c1e6da5 100644 --- a/doc/special_remotes.mdwn +++ b/doc/special_remotes.mdwn @@ -17,6 +17,7 @@ They cannot be used by other git commands though. * [[webdav]] * [[tahoe]] * [[web]] +* [[bittorrent]] * [[xmpp]] * [[hook]] diff --git a/doc/special_remotes/bittorrent.mdwn b/doc/special_remotes/bittorrent.mdwn new file mode 100644 index 000000000..c5ef91aca --- /dev/null +++ b/doc/special_remotes/bittorrent.mdwn @@ -0,0 +1,25 @@ +Similar to the [[web]] special remote, git-annex can use BitTorrent as +a source for files that are added to the git-annex repository. + +It supports both `.torrent` files, and `magnet:` links. When you run `git +annex addurl` with either of these, it will download the contents of the +torrent and add it to the git annex repository. + +See [[tips/using_the_web_as_a_special_remote]] for usage examples. + +git-annex uses [aria2](http://aria2.sourceforge.net/) to download torrents. +It also needs the `btshowmetainfo` program, from either +bittornado or the original BitTorrent client. + +## notes + +Currently git-annex only supports downloading content from a torrent; +it cannot upload or remove content. + +Torrent swarms tend to come and go, so git-annex defaults to *not* +trusting the bittorrent special remote. + +Multi-file torrents are supported; to handle them, `git annex addurl` +will add a directory containing all the files from the torrent. To +specify a single file from a multi-file torrent, append "#n" to its url; +"#1" is the first file, "#2" is the second, and so on. diff --git a/doc/tips/using_the_web_as_a_special_remote.mdwn b/doc/tips/using_the_web_as_a_special_remote.mdwn index 62ef58b69..087d2e24b 100644 --- a/doc/tips/using_the_web_as_a_special_remote.mdwn +++ b/doc/tips/using_the_web_as_a_special_remote.mdwn @@ -104,6 +104,18 @@ feed is "http://gdata.youtube.com/feeds/api/playlists/PL4F80C7D2DC8D9B6C" More details about youtube feeds at <http://googlesystem.blogspot.com/2008/01/youtube-feeds.html> -- `git-annex importfeed` should handle all of them. +## bittorrent + +The [[bittorrent_special_remote|special_remotes/bittorrent]] lets git-annex +also download the content of torrent files, and magnet links to torrents. + +You can simply pass the url to a torrent to `git annex addurl` +the same as any other url. + +You have to have [aria2](http://aria2.sourceforge.net/) +and bittornado (or the original bittorrent) installed for this +to work. + ## podcasts This is done using `git annex importfeed`. See [[downloading podcasts]]. |