Skip to content

Commit 7932c60

Browse files
tatsuhiro-ttatsuhiro-t
committed
Update doc
1 parent 8f339bb commit 7932c60

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

51 files changed

+6774
-3273
lines changed

‎manual/en/html/README.html‎

Lines changed: 27 additions & 41 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.34.0 documentation</title>
11+
<title>aria2 - The ultra fast download utility &mdash; aria2 1.35.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.34.0 documentation" href="index.html"/>
36+
<link rel="top" title="aria2 1.35.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.34.0
67+
1.35.0
6868
</div>
6969

7070

@@ -174,7 +174,7 @@ <h2>Introduction<a class="headerlink" href="#introduction" title="Permalink to t
174174
download bandwidth. It supports downloading a file from
175175
HTTP(S)/FTP/SFTP and BitTorrent at the same time, while the data
176176
downloaded from HTTP(S)/FTP/SFTP is uploaded to the BitTorrent
177-
swarm. Using Metalink’s chunk checksums, aria2 automatically validates
177+
swarm. Using Metalink's chunk checksums, aria2 automatically validates
178178
chunks of data while downloading a file like BitTorrent.</p>
179179
<p>The project page is located at <a class="reference external" href="https://aria2.github.io/">https://aria2.github.io/</a>.</p>
180180
<p>See <a class="reference external" href="https://aria2.github.io/manual/en/html/">aria2 Online Manual</a> (<a class="reference external" href="https://aria2.github.io/manual/ru/html/">Russian translation</a>, <a class="reference external" href="https://aria2.github.io/manual/pt/html/">Portuguese
@@ -309,7 +309,7 @@ <h2>Dependency<a class="headerlink" href="#dependency" title="Permalink to this
309309
<div class="admonition note">
310310
<p class="first admonition-title">Note</p>
311311
<p>On Apple OSX the OS-level SSL/TLS support will be preferred. Hence
312-
neither GnuTLS nor OpenSSL are required on that platform. If you’d
312+
neither GnuTLS nor OpenSSL are required on that platform. If you'd
313313
like to disable this behavior, run configure with
314314
<code class="docutils literal notranslate"><span class="pre">--without-appletls</span></code>.</p>
315315
<p>GnuTLS has precedence over OpenSSL if both libraries are installed.
@@ -318,7 +318,7 @@ <h2>Dependency<a class="headerlink" href="#dependency" title="Permalink to this
318318
<p class="last">On Windows there is SSL implementation available that is based on
319319
the native Windows SSL capabilities (Schannel) and it will be
320320
preferred. Hence neither GnuTLS nor OpenSSL are required on that
321-
platform. If you’d like to disable this behavior, run configure
321+
platform. If you'd like to disable this behavior, run configure
322322
with <code class="docutils literal notranslate"><span class="pre">--without-wintls</span></code>.</p>
323323
</div>
324324
<div class="admonition note">
@@ -433,7 +433,7 @@ <h2>How to build<a class="headerlink" href="#how-to-build" title="Permalink to t
433433
certificates store, aria2 will automatically load those certificates
434434
at the startup. If it is not the case, I recommend to supply the path
435435
to the CA bundle file. For example, in Debian the path to CA bundle
436-
file is ‘/etc/ssl/certs/ca-certificates.crt’ (in ca-certificates
436+
file is '/etc/ssl/certs/ca-certificates.crt' (in ca-certificates
437437
package). This may vary depending on your distribution. You can give
438438
it to configure script using <code class="docutils literal notranslate"><span class="pre">--with-ca-bundle</span> <span class="pre">option</span></code>:</p>
439439
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ ./configure --with-ca-bundle=&#39;/etc/ssl/certs/ca-certificates.crt&#39;
@@ -443,7 +443,7 @@ <h2>How to build<a class="headerlink" href="#how-to-build" title="Permalink to t
443443
<p>Without <code class="docutils literal notranslate"><span class="pre">--with-ca-bundle</span></code> option, you will encounter the error when
444444
accessing HTTPS servers because the certificate cannot be verified
445445
without CA bundle. In such case, you can specify the CA bundle file
446-
using aria2’s <code class="docutils literal notranslate"><span class="pre">--ca-certificate</span></code> option. If you don’t have CA bundle
446+
using aria2's <code class="docutils literal notranslate"><span class="pre">--ca-certificate</span></code> option. If you don't have CA bundle
447447
file installed, then the last resort is disable the certificate
448448
validation using <code class="docutils literal notranslate"><span class="pre">--check-certificate=false</span></code>.</p>
449449
<p>Using the native OSX (AppleTLS) and/or Windows (WinTLS) implementation
@@ -503,15 +503,15 @@ <h2>Cross-compiling Windows binary<a class="headerlink" href="#cross-compiling-w
503503
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ HOST=x86_64-w64-mingw32 ./mingw-config
504504
</pre></div>
505505
</div>
506-
<p>If you want libaria2 dll with <code class="docutils literal notranslate"><span class="pre">--enable-libaria2</span></code>, then don’t use
506+
<p>If you want libaria2 dll with <code class="docutils literal notranslate"><span class="pre">--enable-libaria2</span></code>, then don't use
507507
<code class="docutils literal notranslate"><span class="pre">ARIA2_STATIC=yes</span></code> and prepare the DLL version of external
508508
libraries.</p>
509509
</div>
510510
<div class="section" id="cross-compiling-android-binary">
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-r14b should compile aria2
514+
<p>At the time of this writing, Android NDK r20 should compile aria2
515515
without errors.</p>
516516
<p><code class="docutils literal notranslate"><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
@@ -526,29 +526,14 @@ <h2>Cross-compiling Android binary<a class="headerlink" href="#cross-compiling-a
526526
<p>When building the above libraries, make sure that disable shared
527527
library and enable only static library. We are going to link those
528528
libraries statically.</p>
529-
<p>We use zlib which comes with Android NDK, so we don’t have to build it
530-
by ourselves.</p>
531-
<p><code class="docutils literal notranslate"><span class="pre">android-config</span></code> assumes the existence of <code class="docutils literal notranslate"><span class="pre">$ANDROID_HOME</span></code>
532-
environment variable which must fulfill the following conditions:</p>
533-
<ul>
534-
<li><p class="first">Android NDK toolchain is installed under
535-
<code class="docutils literal notranslate"><span class="pre">$ANDROID_HOME/toolchain</span></code>. Refer to <a class="reference external" href="https://developer.android.com/ndk/guides/standalone_toolchain.html">Standalone Toolchain</a>
536-
for more details, but it is a bit out of date.</p>
537-
<p>To install toolchain under <code class="docutils literal notranslate"><span class="pre">$ANDROID_HOME/toolchain</span></code>, do this:</p>
538-
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>$NDK/build/tools/make_standalone_toolchain.py \
539-
--arch arm --api 16 --stl=gnustl \
540-
--install-dir $ANDROID_HOME/toolchain
541-
</pre></div>
542-
</div>
543-
</li>
544-
<li><p class="first">The dependent libraries must be installed under
529+
<p><code class="docutils literal notranslate"><span class="pre">android-config</span></code> assumes that <code class="docutils literal notranslate"><span class="pre">$ANDROID_HOME</span></code> and <code class="docutils literal notranslate"><span class="pre">$NDK</span></code>
530+
environment variables are defined.</p>
531+
<p>We currently use Android NDK r20. <code class="docutils literal notranslate"><span class="pre">$NDK</span></code> should point to the
532+
directory to Anroid NDK. The build tools will be found under
533+
<code class="docutils literal notranslate"><span class="pre">$NDK/toolchains/llvm/prebuilt/linux-x86_64/bin/</span></code>.</p>
534+
<p>All the dependent libraries must be installed under
545535
<code class="docutils literal notranslate"><span class="pre">$ANDROID_HOME/usr/local</span></code>.</p>
546-
</li>
547-
</ul>
548-
<p>Before running <code class="docutils literal notranslate"><span class="pre">android-config</span></code> and <code class="docutils literal notranslate"><span class="pre">android-make</span></code>,
549-
<code class="docutils literal notranslate"><span class="pre">$ANDROID_HOME</span></code> environment variable must be set to point to the
550-
correct path.</p>
551-
<p>After <code class="docutils literal notranslate"><span class="pre">android-config</span></code>, run <code class="docutils literal notranslate"><span class="pre">android-make</span></code> to compile sources.</p>
536+
<p>After <code class="docutils literal notranslate"><span class="pre">android-config</span></code>, run <code class="docutils literal notranslate"><span class="pre">make</span></code> to compile sources.</p>
552537
</div>
553538
<div class="section" id="building-documentation">
554539
<h2>Building documentation<a class="headerlink" href="#building-documentation" title="Permalink to this headline"></a></h2>
@@ -567,10 +552,10 @@ <h3>About file names<a class="headerlink" href="#about-file-names" title="Permal
567552
<p>The file name of the downloaded file is determined as follows:</p>
568553
<dl class="docutils">
569554
<dt>single-file mode</dt>
570-
<dd>If “name” key is present in .torrent file, file name is the value
571-
of “name” key. Otherwise, file name is the base name of .torrent
572-
file appended by “.file”. For example, .torrent file is
573-
“test.torrent”, then file name is “test.torrent.file”. The
555+
<dd>If &quot;name&quot; key is present in .torrent file, file name is the value
556+
of &quot;name&quot; key. Otherwise, file name is the base name of .torrent
557+
file appended by &quot;.file&quot;. For example, .torrent file is
558+
&quot;test.torrent&quot;, then file name is &quot;test.torrent.file&quot;. The
574559
directory to store the downloaded file can be specified by -d
575560
option.</dd>
576561
<dt>multi-file mode</dt>
@@ -607,7 +592,7 @@ <h3>Other things should be noted<a class="headerlink" href="#other-things-should
607592
<code class="docutils literal notranslate"><span class="pre">--index-out</span></code> option instead.</li>
608593
<li>The port numbers that aria2 uses by default are 6881-6999 for TCP
609594
and UDP.</li>
610-
<li>aria2 doesn’t configure port-forwarding automatically. Please
595+
<li>aria2 doesn't configure port-forwarding automatically. Please
611596
configure your router or firewall manually.</li>
612597
<li>The maximum number of peers is 55. This limit may be exceeded when
613598
download rate is low. This download rate can be adjusted using
@@ -625,15 +610,15 @@ <h2>Metalink<a class="headerlink" href="#metalink" title="Permalink to this head
625610
<p>For checksum verification, md5, sha-1, sha-224, sha-256, sha-384 and
626611
sha-512 are supported. If multiple hash algorithms are provided, aria2
627612
uses stronger one. If whole file checksum verification fails, aria2
628-
doesn’t retry the download and just exits with non-zero return code.</p>
613+
doesn't retry the download and just exits with non-zero return code.</p>
629614
<p>The supported user preferences are version, language, location,
630615
protocol and os.</p>
631616
<p>If chunk checksums are provided in Metalink file, aria2 automatically
632617
validates chunks of data during download. This behavior can be turned
633618
off by a command-line option.</p>
634619
<p>If signature is included in a Metalink file, aria2 saves it as a file
635620
after the completion of the download. The file name is download
636-
file name + “.sig”. If same file already exists, the signature file is
621+
file name + &quot;.sig&quot;. If same file already exists, the signature file is
637622
not saved.</p>
638623
<p>In Metalink4, multi-file torrent could appear in metalink:metaurl
639624
element. Since aria2 cannot download 2 same torrents at the same
@@ -686,7 +671,7 @@ <h2>References<a class="headerlink" href="#references" title="Permalink to this
686671
<li><a class="reference external" href="http://tools.ietf.org/html/rfc959">RFC 959 FILE TRANSFER PROTOCOL (FTP)</a></li>
687672
<li><a class="reference external" href="http://tools.ietf.org/html/rfc1738">RFC 1738 Uniform Resource Locators (URL)</a></li>
688673
<li><a class="reference external" href="http://tools.ietf.org/html/rfc2428">RFC 2428 FTP Extensions for IPv6 and NATs</a></li>
689-
<li><a class="reference external" href="http://tools.ietf.org/html/rfc2616">RFC 2616 Hypertext Transfer Protocol – HTTP/1.1</a></li>
674+
<li><a class="reference external" href="http://tools.ietf.org/html/rfc2616">RFC 2616 Hypertext Transfer Protocol -- HTTP/1.1</a></li>
690675
<li><a class="reference external" href="http://tools.ietf.org/html/rfc3659">RFC 3659 Extensions to FTP</a></li>
691676
<li><a class="reference external" href="http://tools.ietf.org/html/rfc3986">RFC 3986 Uniform Resource Identifier (URI): Generic Syntax</a></li>
692677
<li><a class="reference external" href="http://tools.ietf.org/html/rfc4038">RFC 4038 Application Aspects of IPv6 Transition</a></li>
@@ -754,7 +739,7 @@ <h2>References<a class="headerlink" href="#references" title="Permalink to this
754739
<script type="text/javascript">
755740
var DOCUMENTATION_OPTIONS = {
756741
URL_ROOT:'./',
757-
VERSION:'1.34.0',
742+
VERSION:'1.35.0',
758743
COLLAPSE_INDEX:false,
759744
FILE_SUFFIX:'.html',
760745
HAS_SOURCE: true
@@ -763,6 +748,7 @@ <h2>References<a class="headerlink" href="#references" title="Permalink to this
763748
<script type="text/javascript" src="_static/jquery.js"></script>
764749
<script type="text/javascript" src="_static/underscore.js"></script>
765750
<script type="text/javascript" src="_static/doctools.js"></script>
751+
<script type="text/javascript" src="_static/language_data.js"></script>
766752

767753

768754

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1477,8 +1477,8 @@ Advanced Options
14771477
.. option:: --min-tls-version=<VERSION>
14781478

14791479
Specify minimum SSL/TLS version to enable.
1480-
Possible Values: ``SSLv3``, ``TLSv1``, ``TLSv1.1``, ``TLSv1.2``
1481-
Default: ``TLSv1``
1480+
Possible Values: ``TLSv1.1``, ``TLSv1.2``, ``TLSv1.3``
1481+
Default: ``TLSv1.2``
14821482

14831483
.. option:: --multiple-interface=<INTERFACES>
14841484

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

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
*
55
* Sphinx stylesheet -- basic theme.
66
*
7-
* :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
7+
* :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS.
88
* :license: BSD, see LICENSE for details.
99
*
1010
*/
@@ -81,6 +81,10 @@ div.sphinxsidebar input {
8181
font-size: 1em;
8282
}
8383

84+
div.sphinxsidebar #searchbox form.search {
85+
overflow: hidden;
86+
}
87+
8488
div.sphinxsidebar #searchbox input[type="text"] {
8589
float: left;
8690
width: 80%;
@@ -427,6 +431,13 @@ table.field-list td, table.field-list th {
427431
hyphens: manual;
428432
}
429433

434+
/* -- hlist styles ---------------------------------------------------------- */
435+
436+
table.hlist td {
437+
vertical-align: top;
438+
}
439+
440+
430441
/* -- other body styles ----------------------------------------------------- */
431442

432443
ol.arabic {

‎manual/en/html/_static/doctools.js‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
*
55
* Sphinx JavaScript utilities for all documentation.
66
*
7-
* :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
7+
* :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS.
88
* :license: BSD, see LICENSE for details.
99
*
1010
*/
@@ -150,7 +150,9 @@ var Documentation = {
150150
this.fixFirefoxAnchorBug();
151151
this.highlightSearchWords();
152152
this.initIndexTable();
153-
153+
if (DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) {
154+
this.initOnKeyListeners();
155+
}
154156
},
155157

156158
/**
@@ -310,4 +312,4 @@ _ = Documentation.gettext;
310312

311313
$(document).ready(function() {
312314
Documentation.init();
313-
});
315+
});

‎manual/en/html/_static/documentation_options.js‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
var DOCUMENTATION_OPTIONS = {
22
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
3-
VERSION: '1.34.0',
3+
VERSION: '1.35.0',
44
LANGUAGE: 'None',
55
COLLAPSE_INDEX: false,
66
FILE_SUFFIX: '.html',
77
HAS_SOURCE: true,
8-
SOURCELINK_SUFFIX: '.txt'
8+
SOURCELINK_SUFFIX: '.txt',
9+
NAVIGATION_WITH_KEYS: false,
910
};

0 commit comments

Comments
 (0)