2010-09-11 Tatsuhiro Tsujikawa <t-tujikawa@users.sourceforge.net>

Updated man page according to changes in options. * doc/aria2c.1.txt
2010-09-11 12:21:10 +00:00 · 2010-09-11 12:21:10 +00:00 · 90c927af74
parent f82ffef460
commit 90c927af74
4 changed files with 70 additions and 25 deletions
--- a/5
+++ b/5
@ -1,3 +1,8 @@
+2010-09-11  Tatsuhiro Tsujikawa  <t-tujikawa@users.sourceforge.net>
+
+	Updated man page according to changes in options.
+	* doc/aria2c.1.txt
+
 2010-09-11  Tatsuhiro Tsujikawa  <t-tujikawa@users.sourceforge.net>

 	Added short option -k for --min-split-size option and -x for
--- 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: 08/31/2010
+.\"      Date: 09/11/2010
 .\"    Manual: Aria2 Manual
 .\"    Source: Aria2 1.10.2
 .\"  Language: English
 .\"
-.TH "ARIA2C" "1" "08/31/2010" "Aria2 1\&.10\&.2" "Aria2 Manual"
+.TH "ARIA2C" "1" "09/11/2010" "Aria2 1\&.10\&.2" "Aria2 Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
@ -75,7 +75,7 @@ option\&. Default:
 .PP
 \fB\-V\fR, \fB\-\-check\-integrity\fR[=\fItrue\fR|\fIfalse\fR]
 .RS 4
-Check file integrity by validating piece hashes\&. This option has effect only in BitTorrent and Metalink downloads with chunk checksums\&. Use this option to re\-download a damaged portion of a file\&. Default:
+Check file integrity by validating piece hashes or a hash of entire file\&. This option has effect only in BitTorrent and Metalink downloads with checksums\&. If piece hashes are provided, this option can detect damaged portions of a file and re\-download them\&. If a hash of entire file is provided, hash check is only done when file has benn already download\&. This is determined by file length\&. If hash check fails, file is re\-downloaded from scratch\&. If both piece hashes and a hash of entire file are provided, only piece hashes are used\&. Default:
 \fIfalse\fR
 .RE
 .PP
@ -1255,14 +1255,18 @@ If an interface has multiple addresses, it is highly recommended to specify IP a
 .sp .5v
 .RE
 .PP
-\fB\-\-max\-connection\-per\-server\fR=NUM
+\fB\-x\fR, \fB\-\-max\-connection\-per\-server\fR=NUM
 .RS 4
-The maximum number of connections to one server for each download\&. Possible Values:
-\fI1\fR\-\fI4\fR
-Default:
+The maximum number of connections to one server for each download\&. Default:
 \fI1\fR
 .RE
 .PP
+\fB\-\-max\-download\-result\fR=NUM
+.RS 4
+Set maximum number of download result kept in memory\&. The download results are completed/error/removed downloads\&. The download results are stored in FIFO queue and it can store at most NUM download results\&. When queue is full and new download result is created, oldest download result is removed from the front of the queue and new one is pushed to the back\&. Setting big number in this option may result high memory consumption after thousands of downloads\&. Specifying 0 means no download result is kept\&. Default:
+\fI1000\fR
+.RE
+.PP
 \fB\-\-max\-resume\-failure\-tries\fR=N
 .RS 4
 When used with
@ -1277,7 +1281,7 @@ option\&. Default:
 \fI0\fR
 .RE
 .PP
-\fB\-\-min\-split\-size\fR=SIZE
+\fB\-k\fR, \fB\-\-min\-split\-size\fR=SIZE
 .RS 4
 aria2 does not split less than 2*SIZE byte range\&. For example, let\(cqs consider downloading 20MiB file\&. If SIZE is 10M, aria2 can split file into 2 range [0\-10MiB) and [10MiB\-20MiB) and download it using 2 sources(if
 \fB\-\-split\fR
--- a/doc/aria2c.1.html
+++ b/doc/aria2c.1.html
@ -644,11 +644,15 @@ downloading a file like BitTorrent.</p></div>
 </dt>
 <dd>
 <p>
-  Check file integrity by validating piece hashes.
-  This option has effect only in BitTorrent and Metalink downloads with
-  chunk checksums.
-  Use this option to re-download a damaged portion of a file.
-  Default: <em>false</em>
+  Check file integrity by validating piece hashes or a hash of entire
+  file.  This option has effect only in BitTorrent and Metalink
+  downloads with checksums.  If piece hashes are provided, this option
+  can detect damaged portions of a file and re-download them.  If a
+  hash of entire file is provided, hash check is only done when file
+  has benn already download. This is determined by file length. If
+  hash check fails, file is re-downloaded from scratch.  If both piece
+  hashes and a hash of entire file are provided, only piece hashes are
+  used. Default: <em>false</em>
 </p>
 </dd>
 <dt class="hdlist1">
@ -2102,16 +2106,31 @@ name.</td>
 </div>
 <div class="dlist"><dl>
 <dt class="hdlist1">
-<strong>--max-connection-per-server</strong>=NUM
+<strong>-x</strong>, <strong>--max-connection-per-server</strong>=NUM
 </dt>
 <dd>
 <p>
  The maximum number of connections to one server for each download.
-  Possible Values: <em>1</em>-<em>4</em>
  Default: <em>1</em>
 </p>
 </dd>
 <dt class="hdlist1">
+<strong>--max-download-result</strong>=NUM
+</dt>
+<dd>
+<p>
+  Set maximum number of download result kept in memory. The download
+  results are completed/error/removed downloads. The download results
+  are stored in FIFO queue and it can store at most NUM download
+  results. When queue is full and new download result is created,
+  oldest download result is removed from the front of the queue and
+  new one is pushed to the back. Setting big number in this option may
+  result high memory consumption after thousands of
+  downloads. Specifying 0 means no download result is kept. Default:
+  <em>1000</em>
+</p>
+</dd>
+<dt class="hdlist1">
 <strong>--max-resume-failure-tries</strong>=N
 </dt>
 <dd>
@ -2124,7 +2143,7 @@ name.</td>
 </p>
 </dd>
 <dt class="hdlist1">
-<strong>--min-split-size</strong>=SIZE
+<strong>-k</strong>, <strong>--min-split-size</strong>=SIZE
 </dt>
 <dd>
 <p>
@ -4380,7 +4399,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 2010-08-31 22:43:01 JST
+Last updated 2010-09-11 21:18:28 JST
 </div>
 </div>
 </body>
--- a/doc/aria2c.1.txt
+++ b/doc/aria2c.1.txt
@ -51,11 +51,16 @@ Basic Options
  Default: '5'

 *-V*, *--check-integrity*[='true'|'false']::
-  Check file integrity by validating piece hashes.
-  This option has effect only in BitTorrent and Metalink downloads with
-  chunk checksums.
-  Use this option to re-download a damaged portion of a file.
-  Default: 'false'
+
+  Check file integrity by validating piece hashes or a hash of entire
+  file.  This option has effect only in BitTorrent and Metalink
+  downloads with checksums.  If piece hashes are provided, this option
+  can detect damaged portions of a file and re-download them.  If a
+  hash of entire file is provided, hash check is only done when file
+  has benn already download. This is determined by file length. If
+  hash check fails, file is re-downloaded from scratch.  If both piece
+  hashes and a hash of entire file are provided, only piece hashes are
+  used. Default: 'false'

 *-c*, *--continue*::
   Continue downloading a partially downloaded file.
@ -866,12 +871,24 @@ specify IP address explicitly. See also *--disable-ipv6*.  If your
 system doesn't have getifaddrs(), this option doesn't accept interface
 name.

-*--max-connection-per-server*=NUM::
+*-x*, *--max-connection-per-server*=NUM::

  The maximum number of connections to one server for each download.
-  Possible Values: '1'-'4'
  Default: '1'

+
+*--max-download-result*=NUM::
+
+  Set maximum number of download result kept in memory. The download
+  results are completed/error/removed downloads. The download results
+  are stored in FIFO queue and it can store at most NUM download
+  results. When queue is full and new download result is created,
+  oldest download result is removed from the front of the queue and
+  new one is pushed to the back. Setting big number in this option may
+  result high memory consumption after thousands of
+  downloads. Specifying 0 means no download result is kept. Default:
+  '1000'
+
 *--max-resume-failure-tries*=N::

  When used with *--always-resume*='false', aria2 downloads file from
@ -880,7 +897,7 @@ name.
  given URIs do not support resume.  See *--always-resume* option.
  Default: '0'

-*--min-split-size*=SIZE::
+*-k*, *--min-split-size*=SIZE::

  aria2 does not split less than 2*SIZE byte range.  For example,
  let's consider downloading 20MiB file. If SIZE is 10M, aria2 can