From 4ede925ce3829e08b473f94832051da18f4ae2a9 Mon Sep 17 00:00:00 2001 From: Tatsuhiro Tsujikawa Date: Tue, 24 Nov 2009 16:44:08 +0000 Subject: [PATCH] 2009-11-25 Tatsuhiro Tsujikawa Documented about BitTorrent Magnet URI in man page. * doc/aria2c.1.txt --- ChangeLog | 5 ++ doc/aria2c.1 | 47 ++++++++-- doc/aria2c.1.html | 222 ++++++++++++++++++++++++++++++++++++++++++---- doc/aria2c.1.txt | 30 ++++++- 4 files changed, 277 insertions(+), 27 deletions(-) diff --git a/ChangeLog b/ChangeLog index 617fb965..83e8a202 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,8 @@ +2009-11-25 Tatsuhiro Tsujikawa + + Documented about BitTorrent Magnet URI in man page. + * doc/aria2c.1.txt + 2009-11-25 Tatsuhiro Tsujikawa Fixed the bug that trackers in BitTorrent Magnet URI are not diff --git a/doc/aria2c.1 b/doc/aria2c.1 index c4bfac6d..10a6b292 100644 --- a/doc/aria2c.1 +++ b/doc/aria2c.1 @@ -1,13 +1,13 @@ '\" t .\" Title: aria2c .\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] -.\" Generator: DocBook XSL Stylesheets v1.75.1 -.\" Date: 10/27/2009 +.\" Generator: DocBook XSL Stylesheets v1.75.2 +.\" Date: 11/25/2009 .\" Manual: Aria2 Manual .\" Source: Aria2 .\" Language: English .\" -.TH "ARIA2C" "1" "10/27/2009" "Aria2" "Aria2 Manual" +.TH "ARIA2C" "1" "11/25/2009" "Aria2" "Aria2 Manual" .\" ----------------------------------------------------------------- .\" * set default formatting .\" ----------------------------------------------------------------- @@ -22,7 +22,7 @@ aria2c \- The ultra fast download utility .SH "SYNOPSIS" .sp -aria2c [\fIOPTIONS\fR] [\fIURL\fR | \fITORRENT_FILE\fR | \fIMETALINK_FILE\fR]\&... +aria2c [\fIOPTIONS\fR] [\fIURI\fR | \fITORRENT_FILE\fR | \fIMETALINK_FILE\fR]\&... .SH "DESCRIPTION" .sp aria2 is a utility for downloading files\&. The supported protocols are HTTP(S), FTP, BitTorrent, and Metalink\&. aria2 can download a file from multiple sources/protocols and tries to utilize your maximum download bandwidth\&. It supports downloading a file from HTTP(S)/FTP and BitTorrent at the same time, while the data downloaded from HTTP(S)/FTP is uploaded to the BitTorrent swarm\&. Using Metalink\(cqs chunk checksums, aria2 automatically validates chunks of data while downloading a file like BitTorrent\&. @@ -1069,10 +1069,12 @@ Print the version number, copyright and the configuration information and exit\& .SS "Options That Take An Optional Argument" .sp The options that have its argument surrounded by square brackets([]) take an optional argument\&. Usually omiting the argument is evaluated to \fItrue\fR\&. If you use short form of these options(such as \fI\-V\fR) and give an argument, then the option name and its argument should be concatenated(e\&.g\&. \fI\-Vfalse\fR)\&. If any spaces are inserted between the option name and the argument, the argument will be treated as URI and usually this is not what you expect\&. -.SS "URL, TORRENT_FILE, METALINK_FILE" +.SS "URI, TORRENT_FILE, METALINK_FILE" .sp You can specify multiple URLs in command\-line\&. Unless you specify \fB\-Z\fR option, all URLs must point to the same file or downloading will fail\&. .sp +You can specify arbitrary number of BitTorrent Magnet URI\&. Please note that they are always treated as a separate download\&. Both hex encoded 40 characters Info Hash and Base32 encoded 32 characters Info Hash are supported\&. The multiple "tr" paramters are supported\&. Because BitTorrent Magnet URI is likely to contain "&" character, it is highly recommended to always quote URI with single(\') or double(") quotation\&. See http://www\&.bittorrent\&.org/beps/bep_0009\&.html for more details about BitTorrent Magnet URI\&. +.sp You can also specify arbitrary number of torrent files and metalink files stored on a local drive\&. Please note that they are always treated as a separate download\&. .sp You can specify both torrent file with \-T option and URLs\&. By doing this, you can download a file from both torrent swarm and HTTP(S)/FTP server at the same time, while the data from HTTP(S)/FTP are uploaded to the torrent swarm\&. For single file torrents, URL can be a complete URL pointing to the resource or if URL ends with /, name in torrent file in torrent is added\&. For multi\-file torrents, name and path are added to form a URL for each file\&. @@ -2778,6 +2780,41 @@ To pause a download, press Ctrl\-C\&. You can resume the transfer by running ari .nr an-break-flag 1 .br .ps +1 +\fBDownload using BitTorrent Magnet URI\fR +.RS 4 +.sp +.if n \{\ +.RS 4 +.\} +.nf +aria2c "magnet:?xt=urn:btih:248d0a1cd08284299de78d5c1ed359bb46717d8c&dn=aria2" +.fi +.if n \{\ +.RE +.\} +.if n \{\ +.sp +.\} +.RS 4 +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.ps +1 +\fBNote\fR +.ps -1 +.br +.sp +Don\(cqt forget to quote BitTorrent Magnet URI which includes "&" character with single(\') or double(") quotation\&. +.sp .5v +.RE +.RE +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.ps +1 \fBDownload 2 torrents\fR .RS 4 .sp diff --git a/doc/aria2c.1.html b/doc/aria2c.1.html index 6efb7acb..945a8fc6 100644 --- a/doc/aria2c.1.html +++ b/doc/aria2c.1.html @@ -3,7 +3,7 @@ - + ARIA2C(1) + -

SYNOPSIS

+
+

SYNOPSIS

-

aria2c [OPTIONS] [URL | TORRENT_FILE | METALINK_FILE]…

+

aria2c [OPTIONS] [URI | TORRENT_FILE | METALINK_FILE]…

DESCRIPTION

@@ -521,7 +682,7 @@ downloading a file like BitTorrent.

You can override this setting and specify a proxy server for a particular protocol using --http-proxy, --https-proxy and --ftp-proxy options. This affects all URLs. - The format of PROXY is [http://][USER:PASSWORD@]HOST[:PORT] + The format of PROXY is [http://][USER:PASSWORD@]HOST[:PORT]

@@ -794,7 +955,7 @@ aria2c -o myfile.zip "http://mirror1/file.zip" "http://mirror2/file.zip"

Use this proxy server for HTTP. See also --all-proxy option. This affects all URLs. - The format of PROXY is [http://][USER:PASSWORD@]HOST[:PORT] + The format of PROXY is [http://][USER:PASSWORD@]HOST[:PORT]

@@ -804,7 +965,7 @@ aria2c -o myfile.zip "http://mirror1/file.zip" "http://mirror2/file.zip"

Use this proxy server for HTTPS. See also --all-proxy option. This affects all URLs. - The format of PROXY is [http://][USER:PASSWORD@]HOST[:PORT] + The format of PROXY is [http://][USER:PASSWORD@]HOST[:PORT]

@@ -944,7 +1105,7 @@ aria2c -o myfile.zip "http://mirror1/file.zip" "http://mirror2/file.zip"

Use this proxy server for FTP. See also --all-proxy option. This affects all URLs. - The format of PROXY is [http://][USER:PASSWORD@]HOST[:PORT] + The format of PROXY is [http://][USER:PASSWORD@]HOST[:PORT]

@@ -1748,9 +1909,18 @@ If you use short form of these options(such as -V) and give an argument, then the option name and its argument should be concatenated(e.g. -Vfalse). If any spaces are inserted between the option name and the argument, the argument will be treated as URI and usually this is not what you expect.

-

URL, TORRENT_FILE, METALINK_FILE

-

You can specify multiple URLs in command-line. -Unless you specify -Z option, all URLs must point to the same file or downloading will fail.

+

URI, TORRENT_FILE, METALINK_FILE

+

You can specify multiple URLs in command-line. Unless you specify +-Z option, all URLs must point to the same file or downloading will +fail.

+

You can specify arbitrary number of BitTorrent Magnet URI. Please note +that they are always treated as a separate download. Both hex encoded +40 characters Info Hash and Base32 encoded 32 characters Info Hash are +supported. The multiple "tr" paramters are supported. Because +BitTorrent Magnet URI is likely to contain "&" character, it is highly +recommended to always quote URI with single(') or double(") quotation. +See http://www.bittorrent.org/beps/bep_0009.html for more details +about BitTorrent Magnet URI.

You can also specify arbitrary number of torrent files and metalink files stored on a local drive. Please note that they are always treated as a separate download.

@@ -1868,7 +2038,7 @@ as exit status.

aria2 recognizes the following environment variables.

-http_proxy [http://][USER:PASSWORD@]HOST[:PORT] +http_proxy [http://][USER:PASSWORD@]HOST[:PORT]

@@ -1878,7 +2048,7 @@ http_proxy [http://][USER:PASSWORD@]HOST[:PORT]

-https_proxy [http://][USER:PASSWORD@]HOST[:PORT] +https_proxy [http://][USER:PASSWORD@]HOST[:PORT]

@@ -1888,7 +2058,7 @@ https_proxy [http://][USER:PASSWORD@]HOST[:PORT]

-ftp_proxy [http://][USER:PASSWORD@]HOST[:PORT] +ftp_proxy [http://][USER:PASSWORD@]HOST[:PORT]

@@ -1898,7 +2068,7 @@ ftp_proxy [http://][USER:PASSWORD@]HOST[:PORT]

-all_proxy [http://][USER:PASSWORD@]HOST[:PORT] +all_proxy [http://][USER:PASSWORD@]HOST[:PORT]

@@ -2995,6 +3165,20 @@ directory. To pause a download, press Ctrl-C. You can resume the transfer by running aria2c with the same argument in the same directory.

+

Download using BitTorrent Magnet URI

+
+
+
aria2c "magnet:?xt=urn:btih:248d0a1cd08284299de78d5c1ed359bb46717d8c&dn=aria2"
+
+
+ + + +
+
Note
+		Don’t forget to quote BitTorrent Magnet URI which includes "&" +character with single(') or double(") quotation.
+

Download 2 torrents

@@ -3226,9 +3410,11 @@ do not wish to do so, delete this exception statement from your version. If you delete this exception statement from all source files in the program, then also delete it here.

+ +
diff --git a/doc/aria2c.1.txt b/doc/aria2c.1.txt index a512bba9..fe948089 100644 --- a/doc/aria2c.1.txt +++ b/doc/aria2c.1.txt @@ -10,7 +10,7 @@ aria2c - The ultra fast download utility SYNOPSIS -------- -aria2c ['OPTIONS'] ['URL' | 'TORRENT_FILE' | 'METALINK_FILE']... +aria2c ['OPTIONS'] ['URI' | 'TORRENT_FILE' | 'METALINK_FILE']... DESCRIPTION ----------- @@ -736,10 +736,21 @@ an argument, then the option name and its argument should be concatenated(e.g. '-Vfalse'). If any spaces are inserted between the option name and the argument, the argument will be treated as URI and usually this is not what you expect. -URL, TORRENT_FILE, METALINK_FILE +URI, TORRENT_FILE, METALINK_FILE ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -You can specify multiple URLs in command-line. -Unless you specify *-Z* option, all URLs must point to the same file or downloading will fail. + +You can specify multiple URLs in command-line. Unless you specify +*-Z* option, all URLs must point to the same file or downloading will +fail. + +You can specify arbitrary number of BitTorrent Magnet URI. Please note +that they are always treated as a separate download. Both hex encoded +40 characters Info Hash and Base32 encoded 32 characters Info Hash are +supported. The multiple "tr" paramters are supported. Because +BitTorrent Magnet URI is likely to contain "&" character, it is highly +recommended to always quote URI with single(') or double(") quotation. +See http://www.bittorrent.org/beps/bep_0009.html for more details +about BitTorrent Magnet URI. You can also specify arbitrary number of torrent files and metalink files stored on a local drive. Please note that they are always treated as a @@ -1500,6 +1511,17 @@ aria2c --max-upload-limit=40K file.torrent [NOTE] To pause a download, press Ctrl-C. You can resume the transfer by running aria2c with the same argument in the same directory. +Download using BitTorrent Magnet URI +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +------------------------------------------------------------------------------ +aria2c "magnet:?xt=urn:btih:248d0a1cd08284299de78d5c1ed359bb46717d8c&dn=aria2" +------------------------------------------------------------------------------ + +[NOTE] +Don't forget to quote BitTorrent Magnet URI which includes "&" +character with single(') or double(") quotation. + Download 2 torrents ^^^^^^^^^^^^^^^^^^^ --------------------------------------