Skip to content

Commit 9247235

Browse files
tatsuhiro-ttatsuhiro-t
committed
Update doc
1 parent 30a9864 commit 9247235

Some content is hidden

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

67 files changed

+9398
-11245
lines changed

‎atom.xml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<title><![CDATA[aria2]]></title>
55
<link href="https://aria2.github.io/atom.xml" rel="self"/>
66
<link href="https://aria2.github.io/"/>
7-
<updated>2016-11-15T23:13:00+09:00</updated>
7+
<updated>2016-12-15T22:44:26+09:00</updated>
88
<id>https://aria2.github.io/</id>
99
<author>
1010
<name><![CDATA[Tatsuhiro Tsujikawa]]></name>

‎index-ja.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ <h2>The next generation download utility.</h2>
7777

7878
<h2>ダウンロード</h2>
7979

80-
<p><a href="https://github.com/aria2/aria2/releases/tag/release-1.29.0">version 1.29.0</a> をダウンロードしよう.
80+
<p><a href="https://github.com/aria2/aria2/releases/tag/release-1.30.0">version 1.30.0</a> をダウンロードしよう.
8181
ソースコード, OS X バイナリ, Windows バイナリおよび Android バイナリがダウンロードできる.</p>
8282

8383
<p>1.19.0 以前のリリースは<a href="http://sourceforge.net/projects/aria2/files/stable/">ここ</a>.</p>

‎index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ <h2>The next generation download utility.</h2>
7979

8080
<h2>Download</h2>
8181

82-
<p>Download <a href="https://github.com/aria2/aria2/releases/tag/release-1.29.0">version 1.29.0</a>.
82+
<p>Download <a href="https://github.com/aria2/aria2/releases/tag/release-1.30.0">version 1.30.0</a>.
8383
There you can download source distribution and binaries for OS X, Windows and Android.</p>
8484

8585
<p>The legacy releases earlier than 1.19.1 are available

‎manual/en/html/README.html‎

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

1313

1414

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

3131

3232

33-
<link rel="top" title="aria2 1.29.0 documentation" href="index.html"/>
33+
<link rel="index" title="Index"
34+
href="genindex.html"/>
35+
<link rel="search" title="Search" href="search.html"/>
36+
<link rel="top" title="aria2 1.30.0 documentation" href="index.html"/>
3437
<link rel="next" title="libaria2: C++ library interface to aria2" href="libaria2.html"/>
3538
<link rel="prev" title="aria2c(1)" href="aria2c.html"/>
3639

@@ -61,7 +64,7 @@
6164

6265

6366
<div class="version">
64-
1.29.0
67+
1.30.0
6568
</div>
6669

6770

@@ -751,7 +754,7 @@ <h2>References<a class="headerlink" href="#references" title="Permalink to this
751754
<script type="text/javascript">
752755
var DOCUMENTATION_OPTIONS = {
753756
URL_ROOT:'./',
754-
VERSION:'1.29.0',
757+
VERSION:'1.30.0',
755758
COLLAPSE_INDEX:false,
756759
FILE_SUFFIX:'.html',
757760
HAS_SOURCE: true

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

Lines changed: 38 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1106,7 +1106,7 @@ RPC Options
11061106
extension is '.torrent'. For metalink, it is '.meta4'. If false is
11071107
given to this option, the downloads added by
11081108
:func:`aria2.addTorrent` or :func:`aria2.addMetalink` will not be
1109-
saved by :option:`--save-session` option. Default: ``false``
1109+
saved by :option:`--save-session` option. Default: ``true``
11101110

11111111
.. option:: --rpc-secret=<TOKEN>
11121112

@@ -1958,6 +1958,43 @@ lines beginning ``#`` are treated as comments::
19581958
bits of the configuration file (e.g., ``chmod 600 aria2.conf``), so
19591959
that other user cannot see the contents of the file.
19601960

1961+
The environment variables, such as ``${HOME}``, are expanded by shell.
1962+
This means that those variables used in configuration file are not
1963+
expanded. However, it is useful to ``${HOME}`` to refer user's home
1964+
directory in configuration file to specify file paths. Therefore,
1965+
aria2 expands ``${HOME}`` found in the following option values to
1966+
user's home directory:
1967+
1968+
* :option:`ca-certificate <--ca-certificate>`
1969+
* :option:`certificate <--certificate>`
1970+
* :option:`dht-file-path <--dht-file-path>`
1971+
* :option:`dht-file-path6 <--dht-file-path6>`
1972+
* :option:`dir <--dir>`
1973+
* :option:`input-file <--input-file>`
1974+
* :option:`load-cookies <--load-cookies>`
1975+
* :option:`log <--log>`
1976+
* :option:`metalink-file <--metalink-file>`
1977+
* :option:`netrc-path <--netrc-path>`
1978+
* :option:`on-bt-download-complete <--on-bt-download-complete>`
1979+
* :option:`on-download-complete <--on-download-complete>`
1980+
* :option:`on-download-error <--on-download-error>`
1981+
* :option:`on-download-start <--on-download-start>`
1982+
* :option:`on-download-stop <--on-download-stop>`
1983+
* :option:`on-download-pause <--on-download-pause>`
1984+
* :option:`out <--out>`
1985+
* :option:`private-key <--private-key>`
1986+
* :option:`rpc-certificate <--rpc-certificate>`
1987+
* :option:`rpc-private-key <--rpc-private-key>`
1988+
* :option:`save-cookies <--save-cookies>`
1989+
* :option:`save-session <--save-session>`
1990+
* :option:`server-stat-if <--server-stat-if>`
1991+
* :option:`server-stat-of <--server-stat-of>`
1992+
* :option:`torrent-file <--torrent-file>`
1993+
1994+
Note that this expansion occurs even if the above options are used in
1995+
the command-line. This means that expansion may occur 2 times: first,
1996+
shell and then aria2c.
1997+
19611998
dht.dat
19621999
~~~~~~~~
19632000

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

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -54,12 +54,14 @@ And create aria2 session object::
5454
:type:`Session` ``session`` is an aria2 session object. You need this
5555
object through out the download process. Please keep in mind that only
5656
one :type:`Session` object can be allowed per process due to the heavy
57-
use of static objects in aria2 code base. :type:`SessionConfig`
58-
``config`` holds configuration for the session object. The constructor
59-
initializes it with the default values. In this setup,
60-
:member:`SessionConfig::keepRunning` is ``false`` which means
61-
:func:`run()` returns when all downloads are processed, just like
62-
aria2c utility without RPC enabled. And
57+
use of static objects in aria2 code base. :type:`Session` object is
58+
not safe for concurrent accesses from multiple threads. It must be
59+
used from one thread at a time. In general, libaria2 is not entirely
60+
thread-safe. :type:`SessionConfig` ``config`` holds configuration for
61+
the session object. The constructor initializes it with the default
62+
values. In this setup, :member:`SessionConfig::keepRunning` is
63+
``false`` which means :func:`run()` returns when all downloads are
64+
processed, just like aria2c utility without RPC enabled. And
6365
:member:`SessionConfig::useSignalHandler` is ``true``, which means
6466
libaria2 will setup signal handlers and catches certain signals to
6567
halt download process gracefully. We also setup event handler callback

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

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -494,6 +494,13 @@ pre {
494494
overflow-y: hidden; /* fixes display issues on Chrome browsers */
495495
}
496496

497+
span.pre {
498+
-moz-hyphens: none;
499+
-ms-hyphens: none;
500+
-webkit-hyphens: none;
501+
hyphens: none;
502+
}
503+
497504
td.linenos pre {
498505
padding: 5px 0px;
499506
border: 0;

‎manual/en/html/_static/comment-bright.png‎

0 Bytes
Loading

‎manual/en/html/_static/comment-close.png‎

0 Bytes
Loading

‎manual/en/html/_static/comment.png‎

0 Bytes
Loading

0 commit comments

Comments
 (0)