Skip to content

Commit 07be9e0

Browse files
tatsuhiro-ttatsuhiro-t
committed
Update doc
1 parent 5ce1091 commit 07be9e0

26 files changed

+223
-79
lines changed

‎manual/en/html/README.html‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
<meta name="viewport" content="width=device-width, initial-scale=1.0">
1010

11-
<title>aria2 - The ultra fast download utility &mdash; aria2 1.21.0 documentation</title>
11+
<title>aria2 - The ultra fast download utility &mdash; aria2 1.22.0 documentation</title>
1212

1313

1414

@@ -30,7 +30,7 @@
3030

3131

3232

33-
<link rel="top" title="aria2 1.21.0 documentation" href="index.html"/>
33+
<link rel="top" title="aria2 1.22.0 documentation" href="index.html"/>
3434
<link rel="next" title="libaria2: C++ library interface to aria2" href="libaria2.html"/>
3535
<link rel="prev" title="aria2c(1)" href="aria2c.html"/>
3636

@@ -41,6 +41,7 @@
4141

4242
<body class="wy-body-for-nav" role="document">
4343

44+
4445
<div class="wy-grid-for-nav">
4546

4647

@@ -60,7 +61,7 @@
6061

6162

6263
<div class="version">
63-
1.21.0
64+
1.22.0
6465
</div>
6566

6667

@@ -765,7 +766,7 @@ <h2>References<a class="headerlink" href="#references" title="Permalink to this
765766
<script type="text/javascript">
766767
var DOCUMENTATION_OPTIONS = {
767768
URL_ROOT:'./',
768-
VERSION:'1.21.0',
769+
VERSION:'1.22.0',
769770
COLLAPSE_INDEX:false,
770771
FILE_SUFFIX:'.html',
771772
HAS_SOURCE: true

‎manual/en/html/_sources/aria2c.txt‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -327,6 +327,8 @@ HTTP/FTP/SFTP Options
327327
:option:`--min-split-size <-k>` option,
328328
so it will be necessary to specify a reasonable value to
329329
:option:`--min-split-size <-k>` option.
330+
If ``random`` is given, aria2 selects piece randomly. Like
331+
``inorder``, :option:`--min-split-size <-k>` option is honored.
330332
If ``geom`` is given, at the beginning aria2 selects piece which has
331333
minimum index like ``inorder``, but it exponentially increasingly
332334
keeps space from previously selected piece. This will reduce the
@@ -1318,6 +1320,12 @@ Advanced Options
13181320
Possible Values: ``none``, ``prealloc``, ``trunc``, ``falloc``
13191321
Default: ``prealloc``
13201322

1323+
.. Warning::
1324+
1325+
Using ``trunc`` seemingly allocates disk space very quickly, but
1326+
what it actually does is that it sets file length metadata in
1327+
file system, and does not allocate disk space at all. This means
1328+
that it does not help avoiding fragmentation.
13211329

13221330
.. option:: --force-save[=true|false]
13231331

@@ -1457,6 +1465,21 @@ Advanced Options
14571465
See `Event Hook`_ for more details about COMMAND.
14581466
Possible Values: ``/path/to/command``
14591467

1468+
1469+
.. option:: --optimize-concurrent-downloads[=true|false|<A>:<B>]
1470+
1471+
Optimizes the number of concurrent downloads according to the
1472+
bandwidth available. aria2 uses the download speed observed in the
1473+
previous downloads to adapt the number of downloads launched in
1474+
parallel according to the rule N = A + B Log10(speed in Mbps). The
1475+
coefficients A and B can be customized in the option arguments with
1476+
A and B separated by a colon. The default values (A=5, B=25) lead to
1477+
using typically 5 parallel downloads on 1Mbps networks and above 50
1478+
on 100Mbps networks. The number of parallel downloads remains
1479+
constrained under the maximum defined by the
1480+
:option:`--max-concurrent-downloads` parameter.
1481+
Default: ``false``
1482+
14601483
.. option:: --piece-length=<LENGTH>
14611484

14621485
Set a piece length for HTTP/FTP downloads. This is the boundary when
@@ -3191,6 +3214,7 @@ For information on the *secret* parameter, see :ref:`rpc_auth`.
31913214
* :option:`max-download-result <--max-download-result>`
31923215
* :option:`max-overall-download-limit <--max-overall-download-limit>`
31933216
* :option:`max-overall-upload-limit <--max-overall-upload-limit>`
3217+
* :option:`optimize-concurrent-downloads <--optimize-concurrent-downloads>`
31943218
* :option:`save-cookies <--save-cookies>`
31953219
* :option:`save-session <--save-session>`
31963220
* :option:`server-stat-of <--server-stat-of>`

‎manual/en/html/_static/css/theme.css‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎manual/en/html/aria2c.html‎

Lines changed: 31 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
<meta name="viewport" content="width=device-width, initial-scale=1.0">
1010

11-
<title>aria2c(1) &mdash; aria2 1.21.0 documentation</title>
11+
<title>aria2c(1) &mdash; aria2 1.22.0 documentation</title>
1212

1313

1414

@@ -30,7 +30,7 @@
3030

3131

3232

33-
<link rel="top" title="aria2 1.21.0 documentation" href="index.html"/>
33+
<link rel="top" title="aria2 1.22.0 documentation" href="index.html"/>
3434
<link rel="next" title="aria2 - The ultra fast download utility" href="README.html"/>
3535
<link rel="prev" title="Aria2 Manual" href="index.html"/>
3636

@@ -41,6 +41,7 @@
4141

4242
<body class="wy-body-for-nav" role="document">
4343

44+
4445
<div class="wy-grid-for-nav">
4546

4647

@@ -60,7 +61,7 @@
6061

6162

6263
<div class="version">
63-
1.21.0
64+
1.22.0
6465
</div>
6566

6667

@@ -631,6 +632,8 @@ <h3>HTTP/FTP/SFTP Options<a class="headerlink" href="#http-ftp-sftp-options" tit
631632
<a class="reference internal" href="#cmdoption-k"><code class="xref std std-option docutils literal"><span class="pre">--min-split-size</span></code></a> option,
632633
so it will be necessary to specify a reasonable value to
633634
<a class="reference internal" href="#cmdoption-k"><code class="xref std std-option docutils literal"><span class="pre">--min-split-size</span></code></a> option.
635+
If <code class="docutils literal"><span class="pre">random</span></code> is given, aria2 selects piece randomly. Like
636+
<code class="docutils literal"><span class="pre">inorder</span></code>, <a class="reference internal" href="#cmdoption-k"><code class="xref std std-option docutils literal"><span class="pre">--min-split-size</span></code></a> option is honored.
634637
If <code class="docutils literal"><span class="pre">geom</span></code> is given, at the beginning aria2 selects piece which has
635638
minimum index like <code class="docutils literal"><span class="pre">inorder</span></code>, but it exponentially increasingly
636639
keeps space from previously selected piece. This will reduce the
@@ -1866,6 +1869,13 @@ <h3>Advanced Options<a class="headerlink" href="#advanced-options" title="Permal
18661869
length.</p>
18671870
<p>Possible Values: <code class="docutils literal"><span class="pre">none</span></code>, <code class="docutils literal"><span class="pre">prealloc</span></code>, <code class="docutils literal"><span class="pre">trunc</span></code>, <code class="docutils literal"><span class="pre">falloc</span></code>
18681871
Default: <code class="docutils literal"><span class="pre">prealloc</span></code></p>
1872+
<div class="admonition warning">
1873+
<p class="first admonition-title">Warning</p>
1874+
<p class="last">Using <code class="docutils literal"><span class="pre">trunc</span></code> seemingly allocates disk space very quickly, but
1875+
what it actually does is that it sets file length metadata in
1876+
file system, and does not allocate disk space at all. This means
1877+
that it does not help avoiding fragmentation.</p>
1878+
</div>
18691879
</dd></dl>
18701880

18711881
<dl class="option">
@@ -2040,6 +2050,22 @@ <h3>Advanced Options<a class="headerlink" href="#advanced-options" title="Permal
20402050
Possible Values: <code class="docutils literal"><span class="pre">/path/to/command</span></code></p>
20412051
</dd></dl>
20422052

2053+
<dl class="option">
2054+
<dt id="cmdoption--optimize-concurrent-downloads">
2055+
<code class="descname">--optimize-concurrent-downloads</code><code class="descclassname">[=true|false|&lt;A&gt;:&lt;B&gt;]</code><a class="headerlink" href="#cmdoption--optimize-concurrent-downloads" title="Permalink to this definition"></a></dt>
2056+
<dd><p>Optimizes the number of concurrent downloads according to the
2057+
bandwidth available. aria2 uses the download speed observed in the
2058+
previous downloads to adapt the number of downloads launched in
2059+
parallel according to the rule N = A + B Log10(speed in Mbps). The
2060+
coefficients A and B can be customized in the option arguments with
2061+
A and B separated by a colon. The default values (A=5, B=25) lead to
2062+
using typically 5 parallel downloads on 1Mbps networks and above 50
2063+
on 100Mbps networks. The number of parallel downloads remains
2064+
constrained under the maximum defined by the
2065+
<a class="reference internal" href="#cmdoption--max-concurrent-downloads"><code class="xref std std-option docutils literal"><span class="pre">--max-concurrent-downloads</span></code></a> parameter.
2066+
Default: <code class="docutils literal"><span class="pre">false</span></code></p>
2067+
</dd></dl>
2068+
20432069
<dl class="option">
20442070
<dt id="cmdoption--piece-length">
20452071
<code class="descname">--piece-length</code><code class="descclassname">=&lt;LENGTH&gt;</code><a class="headerlink" href="#cmdoption--piece-length" title="Permalink to this definition"></a></dt>
@@ -3686,6 +3712,7 @@ <h3>Methods<a class="headerlink" href="#methods" title="Permalink to this headli
36863712
<li><a class="reference internal" href="#cmdoption--max-download-result"><code class="xref std std-option docutils literal"><span class="pre">max-download-result</span></code></a></li>
36873713
<li><a class="reference internal" href="#cmdoption--max-overall-download-limit"><code class="xref std std-option docutils literal"><span class="pre">max-overall-download-limit</span></code></a></li>
36883714
<li><a class="reference internal" href="#cmdoption--max-overall-upload-limit"><code class="xref std std-option docutils literal"><span class="pre">max-overall-upload-limit</span></code></a></li>
3715+
<li><a class="reference internal" href="#cmdoption--optimize-concurrent-downloads"><code class="xref std std-option docutils literal"><span class="pre">optimize-concurrent-downloads</span></code></a></li>
36893716
<li><a class="reference internal" href="#cmdoption--save-cookies"><code class="xref std std-option docutils literal"><span class="pre">save-cookies</span></code></a></li>
36903717
<li><a class="reference internal" href="#cmdoption--save-session"><code class="xref std std-option docutils literal"><span class="pre">save-session</span></code></a></li>
36913718
<li><a class="reference internal" href="#cmdoption--server-stat-of"><code class="xref std std-option docutils literal"><span class="pre">server-stat-of</span></code></a></li>
@@ -4732,7 +4759,7 @@ <h2>COPYRIGHT<a class="headerlink" href="#copyright" title="Permalink to this he
47324759
<script type="text/javascript">
47334760
var DOCUMENTATION_OPTIONS = {
47344761
URL_ROOT:'./',
4735-
VERSION:'1.21.0',
4762+
VERSION:'1.22.0',
47364763
COLLAPSE_INDEX:false,
47374764
FILE_SUFFIX:'.html',
47384765
HAS_SOURCE: true

‎manual/en/html/genindex.html‎

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

1010
<meta name="viewport" content="width=device-width, initial-scale=1.0">
1111

12-
<title>Index &mdash; aria2 1.21.0 documentation</title>
12+
<title>Index &mdash; aria2 1.22.0 documentation</title>
1313

1414

1515

@@ -31,7 +31,7 @@
3131

3232

3333

34-
<link rel="top" title="aria2 1.21.0 documentation" href="index.html"/>
34+
<link rel="top" title="aria2 1.22.0 documentation" href="index.html"/>
3535

3636

3737
<script src="_static/js/modernizr.min.js"></script>
@@ -40,6 +40,7 @@
4040

4141
<body class="wy-body-for-nav" role="document">
4242

43+
4344
<div class="wy-grid-for-nav">
4445

4546

@@ -59,7 +60,7 @@
5960

6061

6162
<div class="version">
62-
1.21.0
63+
1.22.0
6364
</div>
6465

6566

@@ -1476,6 +1477,17 @@ <h2 id="Symbols">Symbols</h2>
14761477

14771478
</dl></dd>
14781479

1480+
<dt>
1481+
--optimize-concurrent-downloads[=true|false|&lt;A&gt;:&lt;B&gt;]
1482+
</dt>
1483+
1484+
<dd><dl>
1485+
1486+
<dt><a href="aria2c.html#cmdoption--optimize-concurrent-downloads">command line option</a>
1487+
</dt>
1488+
1489+
</dl></dd>
1490+
14791491
<dt>
14801492
--pause-metadata[=true|false]
14811493
</dt>
@@ -2969,6 +2981,10 @@ <h2 id="C">C</h2>
29692981
</dt>
29702982

29712983

2984+
<dt><a href="aria2c.html#cmdoption--optimize-concurrent-downloads">--optimize-concurrent-downloads[=true|false|&lt;A&gt;:&lt;B&gt;]</a>
2985+
</dt>
2986+
2987+
29722988
<dt><a href="aria2c.html#cmdoption--pause-metadata">--pause-metadata[=true|false]</a>
29732989
</dt>
29742990

@@ -3759,7 +3775,7 @@ <h2 id="U">U</h2>
37593775
<script type="text/javascript">
37603776
var DOCUMENTATION_OPTIONS = {
37613777
URL_ROOT:'./',
3762-
VERSION:'1.21.0',
3778+
VERSION:'1.22.0',
37633779
COLLAPSE_INDEX:false,
37643780
FILE_SUFFIX:'.html',
37653781
HAS_SOURCE: true

‎manual/en/html/index.html‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
<meta name="viewport" content="width=device-width, initial-scale=1.0">
1010

11-
<title>Aria2 Manual &mdash; aria2 1.21.0 documentation</title>
11+
<title>Aria2 Manual &mdash; aria2 1.22.0 documentation</title>
1212

1313

1414

@@ -30,7 +30,7 @@
3030

3131

3232

33-
<link rel="top" title="aria2 1.21.0 documentation" href="#"/>
33+
<link rel="top" title="aria2 1.22.0 documentation" href="#"/>
3434
<link rel="next" title="aria2c(1)" href="aria2c.html"/>
3535

3636

@@ -40,6 +40,7 @@
4040

4141
<body class="wy-body-for-nav" role="document">
4242

43+
4344
<div class="wy-grid-for-nav">
4445

4546

@@ -59,7 +60,7 @@
5960

6061

6162
<div class="version">
62-
1.21.0
63+
1.22.0
6364
</div>
6465

6566

@@ -223,7 +224,7 @@ <h1>Aria2 Manual<a class="headerlink" href="#aria2-manual" title="Permalink to t
223224
<script type="text/javascript">
224225
var DOCUMENTATION_OPTIONS = {
225226
URL_ROOT:'./',
226-
VERSION:'1.21.0',
227+
VERSION:'1.22.0',
227228
COLLAPSE_INDEX:false,
228229
FILE_SUFFIX:'.html',
229230
HAS_SOURCE: true

‎manual/en/html/libaria2.html‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
<meta name="viewport" content="width=device-width, initial-scale=1.0">
1010

11-
<title>libaria2: C++ library interface to aria2 &mdash; aria2 1.21.0 documentation</title>
11+
<title>libaria2: C++ library interface to aria2 &mdash; aria2 1.22.0 documentation</title>
1212

1313

1414

@@ -30,7 +30,7 @@
3030

3131

3232

33-
<link rel="top" title="aria2 1.21.0 documentation" href="index.html"/>
33+
<link rel="top" title="aria2 1.22.0 documentation" href="index.html"/>
3434
<link rel="next" title="Technical Notes" href="technical-notes.html"/>
3535
<link rel="prev" title="aria2 - The ultra fast download utility" href="README.html"/>
3636

@@ -41,6 +41,7 @@
4141

4242
<body class="wy-body-for-nav" role="document">
4343

44+
4445
<div class="wy-grid-for-nav">
4546

4647

@@ -60,7 +61,7 @@
6061

6162

6263
<div class="version">
63-
1.21.0
64+
1.22.0
6465
</div>
6566

6667

@@ -1282,7 +1283,7 @@ <h2>Functions<a class="headerlink" href="#functions" title="Permalink to this he
12821283
<script type="text/javascript">
12831284
var DOCUMENTATION_OPTIONS = {
12841285
URL_ROOT:'./',
1285-
VERSION:'1.21.0',
1286+
VERSION:'1.22.0',
12861287
COLLAPSE_INDEX:false,
12871288
FILE_SUFFIX:'.html',
12881289
HAS_SOURCE: true

‎manual/en/html/objects.inv‎

8 Bytes
Binary file not shown.

‎manual/en/html/search.html‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
<meta name="viewport" content="width=device-width, initial-scale=1.0">
1010

11-
<title>Search &mdash; aria2 1.21.0 documentation</title>
11+
<title>Search &mdash; aria2 1.22.0 documentation</title>
1212

1313

1414

@@ -30,7 +30,7 @@
3030

3131

3232

33-
<link rel="top" title="aria2 1.21.0 documentation" href="index.html"/>
33+
<link rel="top" title="aria2 1.22.0 documentation" href="index.html"/>
3434

3535

3636
<script src="_static/js/modernizr.min.js"></script>
@@ -39,6 +39,7 @@
3939

4040
<body class="wy-body-for-nav" role="document">
4141

42+
4243
<div class="wy-grid-for-nav">
4344

4445

@@ -58,7 +59,7 @@
5859

5960

6061
<div class="version">
61-
1.21.0
62+
1.22.0
6263
</div>
6364

6465

@@ -168,7 +169,7 @@
168169
<script type="text/javascript">
169170
var DOCUMENTATION_OPTIONS = {
170171
URL_ROOT:'./',
171-
VERSION:'1.21.0',
172+
VERSION:'1.22.0',
172173
COLLAPSE_INDEX:false,
173174
FILE_SUFFIX:'.html',
174175
HAS_SOURCE: true

‎manual/en/html/searchindex.js‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)