Skip to content

Commit 60a85c7

Browse files
tatsuhiro-ttatsuhiro-t
committed
Update doc
1 parent f2862ae commit 60a85c7

23 files changed

+153
-80
lines changed

‎manual/en/html/README.html‎

Lines changed: 5 additions & 5 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.31.0 documentation</title>
11+
<title>aria2 - The ultra fast download utility &mdash; aria2 1.32.0 documentation</title>
1212

1313

1414

@@ -33,7 +33,7 @@
3333
<link rel="index" title="Index"
3434
href="genindex.html"/>
3535
<link rel="search" title="Search" href="search.html"/>
36-
<link rel="top" title="aria2 1.31.0 documentation" href="index.html"/>
36+
<link rel="top" title="aria2 1.32.0 documentation" href="index.html"/>
3737
<link rel="next" title="libaria2: C++ library interface to aria2" href="libaria2.html"/>
3838
<link rel="prev" title="aria2c(1)" href="aria2c.html"/>
3939

@@ -64,7 +64,7 @@
6464

6565

6666
<div class="version">
67-
1.31.0
67+
1.32.0
6868
</div>
6969

7070

@@ -511,7 +511,7 @@ <h2>Cross-compiling Windows binary<a class="headerlink" href="#cross-compiling-w
511511
<h2>Cross-compiling Android binary<a class="headerlink" href="#cross-compiling-android-binary" title="Permalink to this headline"></a></h2>
512512
<p>In this section, we describe how to build Android binary using Android
513513
NDK cross-compiler on Debian Linux.</p>
514-
<p>At the time of this writing, android-ndk-r12b should compile aria2
514+
<p>At the time of this writing, android-ndk-r14b should compile aria2
515515
without errors.</p>
516516
<p><code class="docutils literal"><span class="pre">android-config</span></code> script is a configure script wrapper for Android
517517
build. We use it to create official Android build. This script
@@ -754,7 +754,7 @@ <h2>References<a class="headerlink" href="#references" title="Permalink to this
754754
<script type="text/javascript">
755755
var DOCUMENTATION_OPTIONS = {
756756
URL_ROOT:'./',
757-
VERSION:'1.31.0',
757+
VERSION:'1.32.0',
758758
COLLAPSE_INDEX:false,
759759
FILE_SUFFIX:'.html',
760760
HAS_SOURCE: true

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

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,25 @@ Basic Options
5757
See also the :option:`--split <-s>` option.
5858
Default: ``5``
5959

60+
.. note::
61+
62+
:option:`--max-concurrent-downloads` limits the number of items
63+
which are downloaded concurrently. :option:`--split <-s>` and
64+
:option:`--min-split-size <-k>` affect the number of connections
65+
inside each item. Imagine that you have an input file (see
66+
:option:`--input-file <-i>` option) like this:
67+
68+
.. code-block:: text
69+
70+
http://example.com/foo
71+
http://example.com/bar
72+
73+
Here is 2 download items. aria2 can download these items
74+
concurrently if the value more than or equal 2 is given to
75+
:option:`--max-concurrent-downloads`. In each download item, you
76+
can configure the number of connections using :option:`--split
77+
<-s>` and/or :option:`--min-split-size <-k>`, etc.
78+
6079
.. option:: -V, --check-integrity[=true|false]
6180

6281
Check file integrity by validating piece hashes or a hash of entire
@@ -2563,7 +2582,7 @@ For information on the *secret* parameter, see :ref:`rpc_auth`.
25632582

25642583
.. function:: aria2.unpauseAll([secret])
25652584

2566-
This method is equal to calling :func:`aria2.unpause` for every active/waiting
2585+
This method is equal to calling :func:`aria2.unpause` for every paused
25672586
download. This methods returns ``OK``.
25682587

25692588
.. function:: aria2.tellStatus([secret], gid[, keys])

‎manual/en/html/aria2c.html‎

Lines changed: 21 additions & 5 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.31.0 documentation</title>
11+
<title>aria2c(1) &mdash; aria2 1.32.0 documentation</title>
1212

1313

1414

@@ -33,7 +33,7 @@
3333
<link rel="index" title="Index"
3434
href="genindex.html"/>
3535
<link rel="search" title="Search" href="search.html"/>
36-
<link rel="top" title="aria2 1.31.0 documentation" href="index.html"/>
36+
<link rel="top" title="aria2 1.32.0 documentation" href="index.html"/>
3737
<link rel="next" title="aria2 - The ultra fast download utility" href="README.html"/>
3838
<link rel="prev" title="Aria2 Manual" href="index.html"/>
3939

@@ -64,7 +64,7 @@
6464

6565

6666
<div class="version">
67-
1.31.0
67+
1.32.0
6868
</div>
6969

7070

@@ -316,6 +316,22 @@ <h3>Basic Options<a class="headerlink" href="#basic-options" title="Permalink to
316316
<dd><p>Set the maximum number of parallel downloads for every queue item.
317317
See also the <a class="reference internal" href="#cmdoption-s"><code class="xref std std-option docutils literal"><span class="pre">--split</span></code></a> option.
318318
Default: <code class="docutils literal"><span class="pre">5</span></code></p>
319+
<div class="admonition note">
320+
<p class="first admonition-title">Note</p>
321+
<p><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> limits the number of items
322+
which are downloaded concurrently. <a class="reference internal" href="#cmdoption-s"><code class="xref std std-option docutils literal"><span class="pre">--split</span></code></a> and
323+
<a class="reference internal" href="#cmdoption-k"><code class="xref std std-option docutils literal"><span class="pre">--min-split-size</span></code></a> affect the number of connections
324+
inside each item. Imagine that you have an input file (see
325+
<a class="reference internal" href="#cmdoption-i"><code class="xref std std-option docutils literal"><span class="pre">--input-file</span></code></a> option) like this:</p>
326+
<div class="highlight-text"><div class="highlight"><pre><span></span>http://example.com/foo
327+
http://example.com/bar
328+
</pre></div>
329+
</div>
330+
<p class="last">Here is 2 download items. aria2 can download these items
331+
concurrently if the value more than or equal 2 is given to
332+
<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>. In each download item, you
333+
can configure the number of connections using <a class="reference internal" href="#cmdoption-s"><code class="xref std std-option docutils literal"><span class="pre">--split</span></code></a> and/or <a class="reference internal" href="#cmdoption-k"><code class="xref std std-option docutils literal"><span class="pre">--min-split-size</span></code></a>, etc.</p>
334+
</div>
319335
</dd></dl>
320336

321337
<dl class="option">
@@ -3111,7 +3127,7 @@ <h3>Methods<a class="headerlink" href="#methods" title="Permalink to this headli
31113127
<dl class="function">
31123128
<dt id="aria2.unpauseAll">
31133129
<code class="descclassname">aria2.</code><code class="descname">unpauseAll</code><span class="sig-paren">(</span><span class="optional">[</span><em>secret</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#aria2.unpauseAll" title="Permalink to this definition"></a></dt>
3114-
<dd><p>This method is equal to calling <a class="reference internal" href="#aria2.unpause" title="aria2.unpause"><code class="xref py py-func docutils literal"><span class="pre">aria2.unpause()</span></code></a> for every active/waiting
3130+
<dd><p>This method is equal to calling <a class="reference internal" href="#aria2.unpause" title="aria2.unpause"><code class="xref py py-func docutils literal"><span class="pre">aria2.unpause()</span></code></a> for every paused
31153131
download. This methods returns <code class="docutils literal"><span class="pre">OK</span></code>.</p>
31163132
</dd></dl>
31173133

@@ -4884,7 +4900,7 @@ <h2>COPYRIGHT<a class="headerlink" href="#copyright" title="Permalink to this he
48844900
<script type="text/javascript">
48854901
var DOCUMENTATION_OPTIONS = {
48864902
URL_ROOT:'./',
4887-
VERSION:'1.31.0',
4903+
VERSION:'1.32.0',
48884904
COLLAPSE_INDEX:false,
48894905
FILE_SUFFIX:'.html',
48904906
HAS_SOURCE: true

‎manual/en/html/genindex.html‎

Lines changed: 4 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.31.0 documentation</title>
12+
<title>Index &mdash; aria2 1.32.0 documentation</title>
1313

1414

1515

@@ -34,7 +34,7 @@
3434
<link rel="index" title="Index"
3535
href="#"/>
3636
<link rel="search" title="Search" href="search.html"/>
37-
<link rel="top" title="aria2 1.31.0 documentation" href="index.html"/>
37+
<link rel="top" title="aria2 1.32.0 documentation" href="index.html"/>
3838

3939

4040
<script src="_static/js/modernizr.min.js"></script>
@@ -63,7 +63,7 @@
6363

6464

6565
<div class="version">
66-
1.31.0
66+
1.32.0
6767
</div>
6868

6969

@@ -3840,7 +3840,7 @@ <h2 id="U">U</h2>
38403840
<script type="text/javascript">
38413841
var DOCUMENTATION_OPTIONS = {
38423842
URL_ROOT:'./',
3843-
VERSION:'1.31.0',
3843+
VERSION:'1.32.0',
38443844
COLLAPSE_INDEX:false,
38453845
FILE_SUFFIX:'.html',
38463846
HAS_SOURCE: true

‎manual/en/html/index.html‎

Lines changed: 4 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.31.0 documentation</title>
11+
<title>Aria2 Manual &mdash; aria2 1.32.0 documentation</title>
1212

1313

1414

@@ -33,7 +33,7 @@
3333
<link rel="index" title="Index"
3434
href="genindex.html"/>
3535
<link rel="search" title="Search" href="search.html"/>
36-
<link rel="top" title="aria2 1.31.0 documentation" href="#"/>
36+
<link rel="top" title="aria2 1.32.0 documentation" href="#"/>
3737
<link rel="next" title="aria2c(1)" href="aria2c.html"/>
3838

3939

@@ -63,7 +63,7 @@
6363

6464

6565
<div class="version">
66-
1.31.0
66+
1.32.0
6767
</div>
6868

6969

@@ -227,7 +227,7 @@ <h1>Aria2 Manual<a class="headerlink" href="#aria2-manual" title="Permalink to t
227227
<script type="text/javascript">
228228
var DOCUMENTATION_OPTIONS = {
229229
URL_ROOT:'./',
230-
VERSION:'1.31.0',
230+
VERSION:'1.32.0',
231231
COLLAPSE_INDEX:false,
232232
FILE_SUFFIX:'.html',
233233
HAS_SOURCE: true

‎manual/en/html/libaria2.html‎

Lines changed: 4 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.31.0 documentation</title>
11+
<title>libaria2: C++ library interface to aria2 &mdash; aria2 1.32.0 documentation</title>
1212

1313

1414

@@ -33,7 +33,7 @@
3333
<link rel="index" title="Index"
3434
href="genindex.html"/>
3535
<link rel="search" title="Search" href="search.html"/>
36-
<link rel="top" title="aria2 1.31.0 documentation" href="index.html"/>
36+
<link rel="top" title="aria2 1.32.0 documentation" href="index.html"/>
3737
<link rel="next" title="Technical Notes" href="technical-notes.html"/>
3838
<link rel="prev" title="aria2 - The ultra fast download utility" href="README.html"/>
3939

@@ -64,7 +64,7 @@
6464

6565

6666
<div class="version">
67-
1.31.0
67+
1.32.0
6868
</div>
6969

7070

@@ -1288,7 +1288,7 @@ <h2>Functions<a class="headerlink" href="#functions" title="Permalink to this he
12881288
<script type="text/javascript">
12891289
var DOCUMENTATION_OPTIONS = {
12901290
URL_ROOT:'./',
1291-
VERSION:'1.31.0',
1291+
VERSION:'1.32.0',
12921292
COLLAPSE_INDEX:false,
12931293
FILE_SUFFIX:'.html',
12941294
HAS_SOURCE: true

‎manual/en/html/objects.inv‎

0 Bytes
Binary file not shown.

‎manual/en/html/search.html‎

Lines changed: 4 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.31.0 documentation</title>
11+
<title>Search &mdash; aria2 1.32.0 documentation</title>
1212

1313

1414

@@ -33,7 +33,7 @@
3333
<link rel="index" title="Index"
3434
href="genindex.html"/>
3535
<link rel="search" title="Search" href="#"/>
36-
<link rel="top" title="aria2 1.31.0 documentation" href="index.html"/>
36+
<link rel="top" title="aria2 1.32.0 documentation" href="index.html"/>
3737

3838

3939
<script src="_static/js/modernizr.min.js"></script>
@@ -62,7 +62,7 @@
6262

6363

6464
<div class="version">
65-
1.31.0
65+
1.32.0
6666
</div>
6767

6868

@@ -172,7 +172,7 @@
172172
<script type="text/javascript">
173173
var DOCUMENTATION_OPTIONS = {
174174
URL_ROOT:'./',
175-
VERSION:'1.31.0',
175+
VERSION:'1.32.0',
176176
COLLAPSE_INDEX:false,
177177
FILE_SUFFIX:'.html',
178178
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.

‎manual/en/html/technical-notes.html‎

Lines changed: 4 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>Technical Notes &mdash; aria2 1.31.0 documentation</title>
11+
<title>Technical Notes &mdash; aria2 1.32.0 documentation</title>
1212

1313

1414

@@ -33,7 +33,7 @@
3333
<link rel="index" title="Index"
3434
href="genindex.html"/>
3535
<link rel="search" title="Search" href="search.html"/>
36-
<link rel="top" title="aria2 1.31.0 documentation" href="index.html"/>
36+
<link rel="top" title="aria2 1.32.0 documentation" href="index.html"/>
3737
<link rel="prev" title="libaria2: C++ library interface to aria2" href="libaria2.html"/>
3838

3939

@@ -63,7 +63,7 @@
6363

6464

6565
<div class="version">
66-
1.31.0
66+
1.32.0
6767
</div>
6868

6969

@@ -320,7 +320,7 @@ <h2>DHT routing table file format<a class="headerlink" href="#dht-routing-table-
320320
<script type="text/javascript">
321321
var DOCUMENTATION_OPTIONS = {
322322
URL_ROOT:'./',
323-
VERSION:'1.31.0',
323+
VERSION:'1.32.0',
324324
COLLAPSE_INDEX:false,
325325
FILE_SUFFIX:'.html',
326326
HAS_SOURCE: true

0 commit comments

Comments
 (0)