diff --git a/ChangeLog b/ChangeLog index c9dc3f1e..238c3305 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,11 @@ +2009-03-13 Tatsuhiro Tsujikawa + + Updated man page: Documented --dry-run and --index-out + options. Changed the default value of --uri-selector and + --http-auth-challenge options. Removed --direct-file-mapping + option. Added example for --index-out + * doc/aria2c.1.txt + 2009-03-13 Tatsuhiro Tsujikawa Updated TEXT_DRY_RUN diff --git a/doc/aria2c.1 b/doc/aria2c.1 index 38e9d1f5..d71d3c01 100644 --- a/doc/aria2c.1 +++ b/doc/aria2c.1 @@ -1,11 +1,11 @@ .\" Title: aria2c .\" Author: .\" Generator: DocBook XSL Stylesheets v1.73.2 -.\" Date: 02/28/2009 +.\" Date: 03/13/2009 .\" Manual: .\" Source: .\" -.TH "ARIA2C" "1" "02/28/2009" "" "" +.TH "ARIA2C" "1" "03/13/2009" "" "" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) @@ -101,6 +101,16 @@ option is used instead\&. Default: \fI60\fR .RE .PP +\fB\-\-dry\-run\fR[=\fItrue\fR|\fIfalse\fR] +.RS 4 +If +\fItrue\fR +is given, aria2 just checks whether the remote file is available and doesn\'t download data\&. This option has effect on HTTP/FTP download\&. BitTorrent downloads are canceled if +\fItrue\fR +is specified\&. Default: +\fIfalse\fR +.RE +.PP \fB\-\-lowest\-speed\-limit\fR=SPEED .RS 4 Close connection if download speed is lower than or equal to this value(bytes per sec)\&. @@ -233,7 +243,7 @@ options\&. If \fIadaptive\fR is given, selects one of the best mirrors for the first and reserved connections\&. For supplementary ones, it returns mirrors which has not been tested yet, and if each of them has already been tested, returns mirrors which has to be tested again\&. Otherwise, it doesn\'t select anymore mirrors\&. Like \fIfeedback\fR, it uses a performance profile of servers\&. Default: -\fIinorder\fR +\fIfeedback\fR .RE .SS "HTTP Specific Options" .PP @@ -264,7 +274,7 @@ option\&. Default: Send HTTP authorization header only when it is requested by the server\&. If \fIfalse\fR is set, then authorization header is always sent to the server\&. There is an exception: if username and password are embedded in URI, authorization header is always sent to the server regardless of this option\&. Default: -\fItrue\fR +\fIfalse\fR .RE .PP \fB\-\-http\-auth\-scheme\fR=SCHEME @@ -511,12 +521,6 @@ Set UDP listening port for DHT\&. Multiple ports can be specified by using ",", Note Make sure that the specified ports are open for incoming UDP traffic\&. .PP -\fB\-\-direct\-file\-mapping\fR=\fItrue\fR|\fIfalse\fR -.RS 4 -Directly read from and write to each file mentioned in \&.torrent file\&. Use this option if lots of files are listed in \&.torrent file and aria2 complains it cannot open files anymore\&. Default: -\fItrue\fR -.RE -.PP \fB\-\-enable\-dht\fR[=\fItrue\fR|\fIfalse\fR] .RS 4 Enable DHT functionality\&. If a private flag is set in a torrent, aria2 doesn\'t use DHT for that download even if @@ -547,6 +551,15 @@ is specified, the action mentioned above is not taken\&. Default: \fItrue\fR .RE .PP +\fB\-O\fR, \fB\-\-index\-out\fR=INDEX=PATH +.RS 4 +Set file path for file with index=INDEX\&. You can find the file index using the +\fB\-\-show\-files\fR +option\&. PATH is a relative path to the path specified in +\fB\-\-dir\fR +option\&. You can use this option multiple times\&. Using this option, you can specify the output filenames of BitTorrent downloads\&. +.RE +.PP \fB\-\-listen\-port\fR=PORT\&... .RS 4 Set TCP port number for BitTorrent downloads\&. Multiple ports can be specified by using ",", for example: @@ -1057,6 +1070,10 @@ Additionally, the following options can be specified after each line of URIs\&. .RS 4 \h'-04'\(bu\h'+03'select\-file .RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'index\-out +.RE These options have exactly same meaning of the ones in the command\-line options, but it just applies to the URIs it belongs to\&. .sp For example, the content of uri\&.txt is @@ -1472,6 +1489,37 @@ The index is printed to the console using \-S option\&. .nr an-no-space-flag 1 .nr an-break-flag 1 .br +Specify output filename +.RS +To specify output filename for BitTorrent downloads, you need to know the index of file in torrent file using \fB\-S\fR option\&. For example, the output looks like this: +.sp +.sp +.RS 4 +.nf +idx|path/length +===+====================== + 1|dist/base\-2\&.6\&.18\&.iso + |99\&.9MiB +\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- + 2|dist/driver\-2\&.6\&.18\&.iso + |169\&.0MiB +\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +.fi +.RE +To save \fIdist/base\-2\&.6\&.18\&.iso\fR in \fI/tmp/mydir/base\&.iso\fR and \fIdist/driver\-2\&.6\&.18\&.iso\fR in \fI/tmp/dir/driver\&.iso\fR, use the following command: +.sp +.sp +.RS 4 +.nf +aria2c \-\-dir=/tmp \-\-index\-out=1=mydir/base\&.iso \-\-index\-out=2=dir/driver\&.iso file\&.torrent +.fi +.RE +.RE +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br Change the listening port for incoming peer .RS .sp diff --git a/doc/aria2c.1.html b/doc/aria2c.1.html index 362cdcfb..7268b395 100644 --- a/doc/aria2c.1.html +++ b/doc/aria2c.1.html @@ -495,6 +495,17 @@ downloading a file like BitTorrent.

+--dry-run[=true|false] +
+
+

+ If true is given, aria2 just checks whether the remote file is + available and doesn't download data. This option has effect on + HTTP/FTP download. BitTorrent downloads are canceled if true is + specified. Default: false +

+
+
--lowest-speed-limit=SPEED
@@ -663,7 +674,7 @@ aria2c -o myfile.zip "http://mirror1/file.zip" "http://mirror2/file.zip" yet, and if each of them has already been tested, returns mirrors which has to be tested again. Otherwise, it doesn't select anymore mirrors. Like feedback, it uses a performance profile of servers. - Default: inorder + Default: feedback

@@ -708,7 +719,7 @@ aria2c -o myfile.zip "http://mirror1/file.zip" "http://mirror2/file.zip" server. If false is set, then authorization header is always sent to the server. There is an exception: if username and password are embedded in URI, authorization header is always sent to the server - regardless of this option. Default: true + regardless of this option. Default: false

@@ -1075,17 +1086,6 @@ writes the piece to the appropriate files.
---direct-file-mapping=true|false -
-
-

- Directly read from and write to each file mentioned in .torrent file. - Use this option if lots of files are listed in .torrent file and aria2 - complains it cannot open files anymore. - Default: true -

-
-
--enable-dht[=true|false]
@@ -1120,6 +1120,18 @@ writes the piece to the appropriate files.

+-O, --index-out=INDEX=PATH +
+
+

+ Set file path for file with index=INDEX. You can find the file index + using the --show-files option. PATH is a relative path to the + path specified in --dir option. You can use this option multiple + times. Using this option, you can specify the output filenames of + BitTorrent downloads. +

+
+
--listen-port=PORT…
@@ -1810,6 +1822,11 @@ dir select-file

+
  • +

    +index-out +

    +

    • These options have exactly same meaning of the ones in the command-line options, but it just applies to the URIs it belongs to.

    @@ -2106,6 +2123,28 @@ directory. The index is printed to the console using -S option. +

    Specify output filename

    +

    To specify output filename for BitTorrent downloads, you need to know +the index of file in torrent file using -S option. For example, the +output looks like this:

    +
    +
    +
    idx|path/length
+===+======================
+  1|dist/base-2.6.18.iso
+   |99.9MiB
+---+----------------------
+  2|dist/driver-2.6.18.iso
+   |169.0MiB
+---+----------------------
    +
    +

    To save dist/base-2.6.18.iso in /tmp/mydir/base.iso and +dist/driver-2.6.18.iso in /tmp/dir/driver.iso, use the following +command:

    +
    +
    +
    aria2c --dir=/tmp --index-out=1=mydir/base.iso --index-out=2=dir/driver.iso file.torrent
    +

    Change the listening port for incoming peer

    @@ -2286,7 +2325,7 @@ files in the program, then also delete it here.

    diff --git a/doc/aria2c.1.txt b/doc/aria2c.1.txt index 62247f3f..0754ba12 100644 --- a/doc/aria2c.1.txt +++ b/doc/aria2c.1.txt @@ -85,6 +85,12 @@ HTTP/FTP Options option makes no effect and *--timeout* option is used instead. Default: '60' +*--dry-run*[='true'|'false']:: + If 'true' is given, aria2 just checks whether the remote file is + available and doesn't download data. This option has effect on + HTTP/FTP download. BitTorrent downloads are canceled if 'true' is + specified. Default: 'false' + *--lowest-speed-limit*=SPEED:: Close connection if download speed is lower than or equal to this value(bytes per sec). @@ -178,7 +184,7 @@ aria2c -o myfile.zip "http://mirror1/file.zip" "http://mirror2/file.zip" yet, and if each of them has already been tested, returns mirrors which has to be tested again. Otherwise, it doesn't select anymore mirrors. Like 'feedback', it uses a performance profile of servers. - Default: 'inorder' + Default: 'feedback' HTTP Specific Options ~~~~~~~~~~~~~~~~~~~~~ @@ -202,7 +208,7 @@ HTTP Specific Options server. If 'false' is set, then authorization header is always sent to the server. There is an exception: if username and password are embedded in URI, authorization header is always sent to the server - regardless of this option. Default: 'true' + regardless of this option. Default: 'false' *--http-auth-scheme*=SCHEME:: Set HTTP authentication scheme. @@ -379,12 +385,6 @@ BitTorrent Specific Options [NOTE] Make sure that the specified ports are open for incoming UDP traffic. -*--direct-file-mapping*='true'|'false':: - Directly read from and write to each file mentioned in .torrent file. - Use this option if lots of files are listed in .torrent file and aria2 - complains it cannot open files anymore. - Default: 'true' - *--enable-dht*[='true'|'false']:: Enable DHT functionality. If a private flag is set in a torrent, aria2 doesn't use DHT for that download even if 'true' is given. @@ -404,6 +404,13 @@ Make sure that the specified ports are open for incoming UDP traffic. If 'false' is specified, the action mentioned above is not taken. Default: 'true' +*-O*, *--index-out*=INDEX=PATH:: + Set file path for file with index=INDEX. You can find the file index + using the *--show-files* option. PATH is a relative path to the + path specified in *--dir* option. You can use this option multiple + times. Using this option, you can specify the output filenames of + BitTorrent downloads. + *--listen-port*=PORT...:: Set TCP port number for BitTorrent downloads. Multiple ports can be specified by using ",", for example: '6881,6885'. @@ -814,6 +821,7 @@ of URIs. These optional lines must start with white space(s). * out * dir * select-file +* index-out These options have exactly same meaning of the ones in the command-line options, but it just applies to the URIs it belongs to. @@ -1033,6 +1041,32 @@ aria2c --select-file=1-4,8 file.torrent [NOTE] The index is printed to the console using -S option. +Specify output filename +^^^^^^^^^^^^^^^^^^^^^^^ + +To specify output filename for BitTorrent downloads, you need to know +the index of file in torrent file using *-S* option. For example, the +output looks like this: + +-------------------------- +idx|path/length +===+====================== + 1|dist/base-2.6.18.iso + |99.9MiB +---+---------------------- + 2|dist/driver-2.6.18.iso + |169.0MiB +---+---------------------- +-------------------------- + +To save 'dist/base-2.6.18.iso' in '/tmp/mydir/base.iso' and +'dist/driver-2.6.18.iso' in '/tmp/dir/driver.iso', use the following +command: + +----------------------------------------------------------------------------------------- +aria2c --dir=/tmp --index-out=1=mydir/base.iso --index-out=2=dir/driver.iso file.torrent +----------------------------------------------------------------------------------------- + Change the listening port for incoming peer ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ---------------------------------------------------