2009-11-28 Tatsuhiro Tsujikawa <t-tujikawa@users.sourceforge.net>

	Updated man page for BitTorrent Magnet URI.
	* doc/aria2c.1.txt

4 files changed, 24 insertions, 15 deletions

diff --git a/ChangeLog b/ChangeLog
index a3f5d10c..009fa3c1 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,10 @@
 2009-11-28  Tatsuhiro Tsujikawa  <t-tujikawa@users.sourceforge.net>
 
+	Updated man page for BitTorrent Magnet URI.
+	* doc/aria2c.1.txt
+
+2009-11-28  Tatsuhiro Tsujikawa  <t-tujikawa@users.sourceforge.net>
+
 	Call DownloadContext::setOwnerRequestGroup() in
 	RequestGroup::setDownloadContext().
 	* src/BtDependency.cc
diff --git a/doc/aria2c.1 b/doc/aria2c.1
index ae9565ff..5ee9f6d6 100644
--- a/doc/aria2c.1
+++ b/doc/aria2c.1
@@ -2,12 +2,12 @@
 .\"     Title: aria2c
 .\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
 .\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
-.\"      Date: 11/27/2009
+.\"      Date: 11/28/2009
 .\"    Manual: Aria2 Manual
 .\"    Source: Aria2
 .\"  Language: English
 .\"
-.TH "ARIA2C" "1" "11/27/2009" "Aria2" "Aria2 Manual"
+.TH "ARIA2C" "1" "11/28/2009" "Aria2" "Aria2 Manual"
 .\" -----------------------------------------------------------------
 .\" * set default formatting
 .\" -----------------------------------------------------------------
@@ -22,7 +22,7 @@
 aria2c \- The ultra fast download utility
 .SH "SYNOPSIS"
 .sp
-aria2c [\fIOPTIONS\fR] [\fIURI\fR | \fITORRENT_FILE\fR | \fIMETALINK_FILE\fR]\&...
+aria2c [\fIOPTIONS\fR] [\fIURI\fR | \fIMAGNET\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,7 +1069,7 @@ 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 "URI, TORRENT_FILE, METALINK_FILE"
+.SS "URI, MAGNET, 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
@@ -2065,7 +2065,7 @@ GID(or gid) is the key to manage each download\&. Each download has an unique GI
 .sp
 \fBaria2\&.addUri\fR \fIuris[, options[, position]]\fR
 .sp
-This method adds new HTTP(S)/FTP download\&. \fIuris\fR is of type array and its element is URI which is of type string\&. \fIoptions\fR is of type struct and its members are a pair of option name and value\&. See \fBOptions\fR below for more details\&. If \fIposition\fR is given as an integer starting from 0, the new download is inserted at \fIposition\fR in the waiting queue\&. If \fIposition\fR is not given or \fIposition\fR is larger than the size of the queue, it is appended at the end of the queue\&. This method returns GID of registered download\&.
+This method adds new HTTP(S)/FTP/BitTorrent Magnet URI with this method\&. \fIuris\fR is of type array and its element is URI which is of type string\&. For BitTorrent Magnet URI, \fIuris\fR must have one element only and it should be BitTorrent Magnet URI\&. \fIoptions\fR is of type struct and its members are a pair of option name and value\&. See \fBOptions\fR below for more details\&. If \fIposition\fR is given as an integer starting from 0, the new download is inserted at \fIposition\fR in the waiting queue\&. If \fIposition\fR is not given or \fIposition\fR is larger than the size of the queue, it is appended at the end of the queue\&. This method returns GID of registered download\&.
 .sp
 \fBaria2\&.addTorrent\fR \fItorrent[, uris[, options[, position]]]\fR
 .sp
diff --git a/doc/aria2c.1.html b/doc/aria2c.1.html
index d1d6e183..4d8fb287 100644
--- a/doc/aria2c.1.html
+++ b/doc/aria2c.1.html
@@ -575,7 +575,7 @@ ARIA2C(1) Manual Page
 <div id="content">

 <h2 id="_synopsis">SYNOPSIS</h2>

 <div class="sectionbody">

-<div class="paragraph"><p>aria2c [<em>OPTIONS</em>] [<em>URI</em> | <em>TORRENT_FILE</em> | <em>METALINK_FILE</em>]&#8230;</p></div>

+<div class="paragraph"><p>aria2c [<em>OPTIONS</em>] [<em>URI</em> | <em>MAGNET</em> | <em>TORRENT_FILE</em> | <em>METALINK_FILE</em>]&#8230;</p></div>

 </div>

 <h2 id="_description">DESCRIPTION</h2>

 <div class="sectionbody">

@@ -1909,7 +1909,7 @@ If you use short form of these options(such as <em>-V</em>) and give
 an argument, then the option name and its argument should be concatenated(e.g.

 <em>-Vfalse</em>). 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.</p></div>

-<h3 id="_uri_torrent_file_metalink_file">URI, TORRENT_FILE, METALINK_FILE</h3><div style="clear:left"></div>

+<h3 id="_uri_magnet_torrent_file_metalink_file">URI, MAGNET, TORRENT_FILE, METALINK_FILE</h3><div style="clear:left"></div>

 <div class="paragraph"><p>You can specify multiple URLs in command-line.  Unless you specify

 <strong>-Z</strong> option, all URLs must point to the same file or downloading will

 fail.</p></div>

@@ -2599,8 +2599,10 @@ GID
 </dl></div>

 <h3 id="_methods">Methods</h3><div style="clear:left"></div>

 <div class="paragraph"><p><strong>aria2.addUri</strong> <em>uris[, options[, position]]</em></p></div>

-<div class="paragraph"><p>This method adds new HTTP(S)/FTP download.  <em>uris</em> is of type array

-and its element is URI which is of type string. <em>options</em> is of type

+<div class="paragraph"><p>This method adds new HTTP(S)/FTP/BitTorrent Magnet URI with this

+method.  <em>uris</em> is of type array and its element is URI which is of

+type string.  For BitTorrent Magnet URI, <em>uris</em> must have one element

+only and it should be BitTorrent Magnet URI.  <em>options</em> is of type

 struct and its members are a pair of option name and value. See

 <strong>Options</strong> below for more details.  If <em>position</em> is given as an

 integer starting from 0, the new download is inserted at <em>position</em> in

@@ -3415,7 +3417,7 @@ files in the program, then also delete it here.</p></div>
 <div id="footnotes"><hr /></div>

 <div id="footer">

 <div id="footer-text">

-Last updated 2009-11-27 22:08:57 JST

+Last updated 2009-11-28 21:20:26 JST

 </div>

 </div>

 </body>

diff --git a/doc/aria2c.1.txt b/doc/aria2c.1.txt
index 749db300..9c693d42 100644
--- a/doc/aria2c.1.txt
+++ b/doc/aria2c.1.txt
@@ -10,7 +10,7 @@ aria2c - The ultra fast download utility
 
 SYNOPSIS
 --------
-aria2c ['OPTIONS'] ['URI' | 'TORRENT_FILE' | 'METALINK_FILE']...
+aria2c ['OPTIONS'] ['URI' | 'MAGNET' | 'TORRENT_FILE' | 'METALINK_FILE']...
 
 DESCRIPTION
 -----------
@@ -736,8 +736,8 @@ 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.
 
-URI, TORRENT_FILE, METALINK_FILE
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+URI, MAGNET, 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
@@ -1070,8 +1070,10 @@ Methods
 
 *aria2.addUri* 'uris[, options[, position]]'
 
-This method adds new HTTP(S)/FTP download.  'uris' is of type array
-and its element is URI which is of type string. 'options' is of type
+This method adds new HTTP(S)/FTP/BitTorrent Magnet URI with this
+method.  'uris' is of type array and its element is URI which is of
+type string.  For BitTorrent Magnet URI, 'uris' must have one element
+only and it should be BitTorrent Magnet URI.  'options' is of type
 struct and its members are a pair of option name and value. See
 *Options* below for more details.  If 'position' is given as an
 integer starting from 0, the new download is inserted at 'position' in