github
/
aria2
mirror of https://github.com/aria2/aria2
1
0
Fork 0
Code Issues Releases Wiki Activity

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

Updated man page for BitTorrent Magnet URI.
	* doc/aria2c.1.txt
pull/1/head
Tatsuhiro Tsujikawa 2009-11-28 12:21:59 +00:00
parent 88bfe8b084
commit 1d8a3df058
4 changed files with 24 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
ChangeLog
View File

@ -1,3 +1,8 @@
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> 2009-11-28 Tatsuhiro Tsujikawa <t-tujikawa@users.sourceforge.net>
Call DownloadContext::setOwnerRequestGroup() in Call DownloadContext::setOwnerRequestGroup() in

10
doc/aria2c.1
View File

@ -2,12 +2,12 @@
.\" Title: aria2c .\" Title: aria2c
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] .\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/> .\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 11/27/2009 .\" Date: 11/28/2009
.\" Manual: Aria2 Manual .\" Manual: Aria2 Manual
.\" Source: Aria2 .\" Source: Aria2
.\" Language: English .\" Language: English
.\" .\"
.TH "ARIA2C" "1" "11/27/2009" "Aria2" "Aria2 Manual" .TH "ARIA2C" "1" "11/28/2009" "Aria2" "Aria2 Manual"
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
.\" * set default formatting .\" * set default formatting
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
@ -22,7 +22,7 @@
aria2c \- The ultra fast download utility aria2c \- The ultra fast download utility
.SH "SYNOPSIS" .SH "SYNOPSIS"
.sp .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" .SH "DESCRIPTION"
.sp .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\&. 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" .SS "Options That Take An Optional Argument"
.sp .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\&. 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 .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\&. 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 .sp
@ -2065,7 +2065,7 @@ GID(or gid) is the key to manage each download\&. Each download has an unique GI
.sp .sp
\fBaria2\&.addUri\fR \fIuris[, options[, position]]\fR \fBaria2\&.addUri\fR \fIuris[, options[, position]]\fR
.sp .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 .sp
\fBaria2\&.addTorrent\fR \fItorrent[, uris[, options[, position]]]\fR \fBaria2\&.addTorrent\fR \fItorrent[, uris[, options[, position]]]\fR
.sp .sp

12
doc/aria2c.1.html
View File

@ -575,7 +575,7 @@ ARIA2C(1) Manual Page
<div id="content"> <div id="content">
<h2 id="_synopsis">SYNOPSIS</h2> <h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody"> <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> </div>
<h2 id="_description">DESCRIPTION</h2> <h2 id="_description">DESCRIPTION</h2>
<div class="sectionbody"> <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. 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, <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> 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 <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 <strong>-Z</strong> option, all URLs must point to the same file or downloading will
fail.</p></div> fail.</p></div>
@ -2599,8 +2599,10 @@ GID
</dl></div> </dl></div>
<h3 id="_methods">Methods</h3><div style="clear:left"></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><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 <div class="paragraph"><p>This method adds new HTTP(S)/FTP/BitTorrent Magnet URI with this
and its element is URI which is of type string. <em>options</em> is of type 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 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 <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 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="footnotes"><hr /></div>
<div id="footer"> <div id="footer">
<div id="footer-text"> <div id="footer-text">
Last updated 2009-11-27 22:08:57 JST Last updated 2009-11-28 21:20:26 JST
</div> </div>
</div> </div>
</body> </body>

12
doc/aria2c.1.txt
View File

@ -10,7 +10,7 @@ aria2c - The ultra fast download utility
SYNOPSIS SYNOPSIS
-------- --------
aria2c ['OPTIONS'] ['URI' | 'TORRENT_FILE' | 'METALINK_FILE']... aria2c ['OPTIONS'] ['URI' | 'MAGNET' | 'TORRENT_FILE' | 'METALINK_FILE']...
DESCRIPTION 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, '-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. 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 You can specify multiple URLs in command-line. Unless you specify
*-Z* option, all URLs must point to the same file or downloading will *-Z* option, all URLs must point to the same file or downloading will
@ -1070,8 +1070,10 @@ Methods
*aria2.addUri* 'uris[, options[, position]]' *aria2.addUri* 'uris[, options[, position]]'
This method adds new HTTP(S)/FTP download. 'uris' is of type array This method adds new HTTP(S)/FTP/BitTorrent Magnet URI with this
and its element is URI which is of type string. 'options' is of type 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 struct and its members are a pair of option name and value. See
*Options* below for more details. If 'position' is given as an *Options* below for more details. If 'position' is given as an
integer starting from 0, the new download is inserted at 'position' in integer starting from 0, the new download is inserted at 'position' in