Skip to content

Commit b5c98b9

Browse files
tatsuhiro-ttatsuhiro-t
committed
Update doc
1 parent d69a2d5 commit b5c98b9

Some content is hidden

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

70 files changed

+15493
-12687
lines changed

‎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.36.0">version 1.36.0</a> をダウンロードしよう.
80+
<p><a href="https://github.com/aria2/aria2/releases/tag/release-1.37.0">version 1.37.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.36.0">version 1.36.0</a>.
82+
<p>Download <a href="https://github.com/aria2/aria2/releases/tag/release-1.37.0">version 1.37.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: 159 additions & 152 deletions
Large diffs are not rendered by default.

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

Lines changed: 43 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -334,29 +334,30 @@ HTTP/FTP/SFTP Options
334334

335335
.. option:: --stream-piece-selector=<SELECTOR>
336336

337-
Specify piece selection algorithm used in HTTP/FTP download. Piece
338-
means fixed length segment which is downloaded in parallel in
339-
segmented download. If ``default`` is given, aria2 selects piece so
340-
that it reduces the number of establishing connection. This is
341-
reasonable default behavior because establishing connection is an
342-
expensive operation. If ``inorder`` is given, aria2 selects piece
343-
which has minimum index. Index=0 means first of the file. This will
344-
be useful to view movie while downloading it.
345-
:option:`--enable-http-pipelining` option may
346-
be useful to reduce re-connection overhead. Please note that aria2
347-
honors
348-
:option:`--min-split-size <-k>` option,
349-
so it will be necessary to specify a reasonable value to
350-
:option:`--min-split-size <-k>` option.
351-
If ``random`` is given, aria2 selects piece randomly. Like
352-
``inorder``, :option:`--min-split-size <-k>` option is honored.
353-
If ``geom`` is given, at the beginning aria2 selects piece which has
354-
minimum index like ``inorder``, but it exponentially increasingly
355-
keeps space from previously selected piece. This will reduce the
356-
number of establishing connection and at the same time it will
357-
download the beginning part of the file first. This will be useful
358-
to view movie while downloading it.
359-
Default: ``default``
337+
Specify piece selection algorithm used in HTTP/FTP download. A piece is a
338+
fixed length segment which is downloaded in parallel in a segmented download.
339+
Default: ``default``.
340+
341+
default
342+
Select a piece to reduce the number of connections established.
343+
This is reasonable default behavior because establishing a connection is an
344+
expensive operation.
345+
inorder
346+
Select a piece closest to the beginning of the file. This is useful for
347+
viewing movies while downloading. :option:`--enable-http-pipelining` option
348+
may be useful to reduce re-connection overhead. Note that aria2 honors
349+
:option:`--min-split-size <-k>` option, so it will be necessary to specify
350+
a reasonable value to :option:`--min-split-size <-k>` option.
351+
random
352+
Select a piece randomly. Like ``inorder``, :option:`--min-split-size <-k>`
353+
option is honored.
354+
geom
355+
When starting to download a file, select a piece closest to the beginning
356+
of the file like ``inorder``, but then exponentially increases space
357+
between pieces.
358+
This reduces the number of connections established, while
359+
at the same time downloads the beginning part of the file first. This is
360+
useful for viewing movies while downloading.
360361

361362
.. option:: -t, --timeout=<SEC>
362363

@@ -433,7 +434,7 @@ HTTP Specific Options
433434

434435
.. option:: --http-accept-gzip [true|false]
435436

436-
Send ``Accept: deflate, gzip`` request header and inflate response if
437+
Send ``Accept-Encoding: deflate, gzip`` request header and inflate response if
437438
remote server responds with ``Content-Encoding: gzip`` or
438439
``Content-Encoding: deflate``. Default: ``false``
439440

@@ -500,7 +501,7 @@ HTTP Specific Options
500501

501502
Use the private key in FILE.
502503
The private key must be decrypted and in PEM format.
503-
The behavior when encrypted one is given is undefined.
504+
An encrypted key may cause undefined behavior.
504505
See also :option:`--certificate` option.
505506

506507
.. option:: --referer=<REFERER>
@@ -522,8 +523,7 @@ HTTP Specific Options
522523

523524
.. note::
524525

525-
In performance perspective, there is usually no advantage to enable
526-
this option.
526+
There is usually no performance gain from enabling this option.
527527

528528
.. option:: --header=<HEADER>
529529

@@ -557,6 +557,10 @@ HTTP Specific Options
557557
Use HEAD method for the first request to the HTTP server.
558558
Default: ``false``
559559

560+
.. option:: --no-want-digest-header [true|false]
561+
562+
Whether to disable Want-Digest header when doing requests.
563+
Default: ``false``
560564

561565
.. option:: -U, --user-agent=<USER_AGENT>
562566

@@ -742,7 +746,7 @@ BitTorrent Specific Options
742746

743747
.. option:: --bt-metadata-only [true|false]
744748

745-
Download meta data only. The file(s) described in meta data will not
749+
Download metadata only. The file(s) described in metadata will not
746750
be downloaded. This option has effect only when BitTorrent Magnet
747751
URI is used. See also :option:`--bt-save-metadata` option. Default: ``false``
748752

@@ -792,11 +796,11 @@ BitTorrent Specific Options
792796

793797
.. option:: --bt-save-metadata [true|false]
794798

795-
Save meta data as ".torrent" file. This option has effect only when
799+
Save metadata as ".torrent" file. This option has effect only when
796800
BitTorrent Magnet URI is used. The file name is hex encoded info
797801
hash with suffix ".torrent". The directory to be saved is the same
798802
directory where download file is saved. If the same file already
799-
exists, meta data is not saved. See also :option:`--bt-metadata-only`
803+
exists, metadata is not saved. See also :option:`--bt-metadata-only`
800804
option. Default: ``false``
801805

802806
.. option:: --bt-seed-unverified [true|false]
@@ -1136,9 +1140,9 @@ RPC Options
11361140

11371141
.. option:: --rpc-save-upload-metadata [true|false]
11381142

1139-
Save the uploaded torrent or metalink meta data in the directory
1143+
Save the uploaded torrent or metalink metadata in the directory
11401144
specified by :option:`--dir` option. The file name consists of SHA-1
1141-
hash hex string of meta data plus extension. For torrent, the
1145+
hash hex string of metadata plus extension. For torrent, the
11421146
extension is '.torrent'. For metalink, it is '.meta4'. If false is
11431147
given to this option, the downloads added by
11441148
:func:`aria2.addTorrent` or :func:`aria2.addMetalink` will not be
@@ -1359,7 +1363,7 @@ Advanced Options
13591363
your best choice. It allocates large(few GiB)
13601364
files almost instantly. Don't use ``falloc`` with
13611365
legacy file systems such as ext3 and FAT32 because it takes
1362-
almost same time as ``prealloc`` and it blocks aria2
1366+
almost the same time as ``prealloc`` and it blocks aria2
13631367
entirely until allocation finishes. ``falloc`` may
13641368
not be available if your system doesn't have
13651369
:manpage:`posix_fallocate(3)` function.
@@ -1483,7 +1487,7 @@ Advanced Options
14831487
.. option:: --multiple-interface=<INTERFACES>
14841488

14851489
Comma separated list of interfaces to bind sockets to. Requests will
1486-
be splited among the interfaces to achieve link aggregation. You can
1490+
be split among the interfaces to achieve link aggregation. You can
14871491
specify interface name, IP address and hostname. If
14881492
:option:`--interface` is used, this option will be ignored.
14891493
Possible Values: interface, IP address, hostname
@@ -1652,19 +1656,19 @@ Advanced Options
16521656
the file name.
16531657
Please note that downloads added by
16541658
:func:`aria2.addTorrent` and :func:`aria2.addMetalink` RPC method
1655-
and whose meta data could not be saved as a file are not saved.
1659+
and whose metadata could not be saved as a file are not saved.
16561660
Downloads removed using :func:`aria2.remove` and
16571661
:func:`aria2.forceRemove` will not be saved. GID is also saved with
16581662
:option:`gid <--gid>`, but there are some restrictions, see below.
16591663

16601664
.. note::
16611665

16621666
Normally, GID of the download itself is saved. But some downloads
1663-
use meta data (e.g., BitTorrent and Metalink). In this case, there
1667+
use metadata (e.g., BitTorrent and Metalink). In this case, there
16641668
are some restrictions.
16651669

16661670
magnet URI, and followed by torrent download
1667-
GID of BitTorrent meta data download is saved.
1671+
GID of BitTorrent metadata download is saved.
16681672
URI to torrent file, and followed by torrent download
16691673
GID of torrent file download is saved.
16701674
URI to metalink file, and followed by file downloads described in metalink file
@@ -4284,8 +4288,8 @@ Alternatively, if PEM files are supported, use a command like the following:
42844288
42854289
.. note::
42864290

4287-
The file specified in :option:`--private-key` must be decrypted. The behavior when
4288-
encrypted one is given is undefined.
4291+
The file specified in :option:`--private-key` must be decrypted; an encrypted
4292+
key may cause undefined behavior.
42894293

42904294
Verify SSL/TLS servers using given CA certificates
42914295
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

‎manual/en/html/_sources/technical-notes.rst.txt‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -112,10 +112,10 @@ they should be all zeros:
112112
113113
0 1 2 3
114114
0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
115-
+---+-+---+-----+---------------+---------------+---------------+
116-
|MGC|F|VER| RSV | MTIME | RSV |LOCAL NODE ID :
117-
|(2)|M|(2)| (3) | (8) | (8) | (20) :
118-
| |T| | | | | :
115+
+---+-+-----+---+---------------+---------------+---------------+
116+
|MGC|F| RSV |VER| MTIME | RSV |LOCAL NODE ID :
117+
|(2)|M| (3) |(2)| (8) | (8) | (20) :
118+
| |T| | | | | :
119119
+---+-+---+-----+-------+-------+-------+-------+---------------+
120120
:LOCAL NODE ID | RSV | NUM | RSV |
121121
: (continued) | (4) | NODE | (4) |

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

Lines changed: 134 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,134 @@
1+
/*
2+
* _sphinx_javascript_frameworks_compat.js
3+
* ~~~~~~~~~~
4+
*
5+
* Compatability shim for jQuery and underscores.js.
6+
*
7+
* WILL BE REMOVED IN Sphinx 6.0
8+
* xref RemovedInSphinx60Warning
9+
*
10+
*/
11+
12+
/**
13+
* select a different prefix for underscore
14+
*/
15+
$u = _.noConflict();
16+
17+
18+
/**
19+
* small helper function to urldecode strings
20+
*
21+
* See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL
22+
*/
23+
jQuery.urldecode = function(x) {
24+
if (!x) {
25+
return x
26+
}
27+
return decodeURIComponent(x.replace(/\+/g, ' '));
28+
};
29+
30+
/**
31+
* small helper function to urlencode strings
32+
*/
33+
jQuery.urlencode = encodeURIComponent;
34+
35+
/**
36+
* This function returns the parsed url parameters of the
37+
* current request. Multiple values per key are supported,
38+
* it will always return arrays of strings for the value parts.
39+
*/
40+
jQuery.getQueryParameters = function(s) {
41+
if (typeof s === 'undefined')
42+
s = document.location.search;
43+
var parts = s.substr(s.indexOf('?') + 1).split('&');
44+
var result = {};
45+
for (var i = 0; i < parts.length; i++) {
46+
var tmp = parts[i].split('=', 2);
47+
var key = jQuery.urldecode(tmp[0]);
48+
var value = jQuery.urldecode(tmp[1]);
49+
if (key in result)
50+
result[key].push(value);
51+
else
52+
result[key] = [value];
53+
}
54+
return result;
55+
};
56+
57+
/**
58+
* highlight a given string on a jquery object by wrapping it in
59+
* span elements with the given class name.
60+
*/
61+
jQuery.fn.highlightText = function(text, className) {
62+
function highlight(node, addItems) {
63+
if (node.nodeType === 3) {
64+
var val = node.nodeValue;
65+
var pos = val.toLowerCase().indexOf(text);
66+
if (pos >= 0 &&
67+
!jQuery(node.parentNode).hasClass(className) &&
68+
!jQuery(node.parentNode).hasClass("nohighlight")) {
69+
var span;
70+
var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg");
71+
if (isInSVG) {
72+
span = document.createElementNS("http://www.w3.org/2000/svg", "tspan");
73+
} else {
74+
span = document.createElement("span");
75+
span.className = className;
76+
}
77+
span.appendChild(document.createTextNode(val.substr(pos, text.length)));
78+
node.parentNode.insertBefore(span, node.parentNode.insertBefore(
79+
document.createTextNode(val.substr(pos + text.length)),
80+
node.nextSibling));
81+
node.nodeValue = val.substr(0, pos);
82+
if (isInSVG) {
83+
var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect");
84+
var bbox = node.parentElement.getBBox();
85+
rect.x.baseVal.value = bbox.x;
86+
rect.y.baseVal.value = bbox.y;
87+
rect.width.baseVal.value = bbox.width;
88+
rect.height.baseVal.value = bbox.height;
89+
rect.setAttribute('class', className);
90+
addItems.push({
91+
"parent": node.parentNode,
92+
"target": rect});
93+
}
94+
}
95+
}
96+
else if (!jQuery(node).is("button, select, textarea")) {
97+
jQuery.each(node.childNodes, function() {
98+
highlight(this, addItems);
99+
});
100+
}
101+
}
102+
var addItems = [];
103+
var result = this.each(function() {
104+
highlight(this, addItems);
105+
});
106+
for (var i = 0; i < addItems.length; ++i) {
107+
jQuery(addItems[i].parent).before(addItems[i].target);
108+
}
109+
return result;
110+
};
111+
112+
/*
113+
* backward compatibility for jQuery.browser
114+
* This will be supported until firefox bug is fixed.
115+
*/
116+
if (!jQuery.browser) {
117+
jQuery.uaMatch = function(ua) {
118+
ua = ua.toLowerCase();
119+
120+
var match = /(chrome)[ \/]([\w.]+)/.exec(ua) ||
121+
/(webkit)[ \/]([\w.]+)/.exec(ua) ||
122+
/(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) ||
123+
/(msie) ([\w.]+)/.exec(ua) ||
124+
ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) ||
125+
[];
126+
127+
return {
128+
browser: match[ 1 ] || "",
129+
version: match[ 2 ] || "0"
130+
};
131+
};
132+
jQuery.browser = {};
133+
jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true;
134+
}

0 commit comments

Comments
 (0)