Skip to content

Commit

Permalink
Update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
tatsuhiro-t committed Nov 15, 2023
1 parent d69a2d5 commit b5c98b9
Show file tree
Hide file tree
Showing 70 changed files with 15,493 additions and 12,687 deletions.
2 changes: 1 addition & 1 deletion index-ja.html
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ <h2>The next generation download utility.</h2>

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

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

<p>1.19.0 以前のリリースは<a href="http://sourceforge.net/projects/aria2/files/stable/">ここ</a>.</p>
Expand Down
2 changes: 1 addition & 1 deletion index.html
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ <h2>The next generation download utility.</h2>

<h2>Download</h2>

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

<p>The legacy releases earlier than 1.19.1 are available
Expand Down
311 changes: 159 additions & 152 deletions manual/en/html/README.html

Large diffs are not rendered by default.

82 changes: 43 additions & 39 deletions manual/en/html/_sources/aria2c.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -334,29 +334,30 @@ HTTP/FTP/SFTP Options

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

Specify piece selection algorithm used in HTTP/FTP download. Piece
means fixed length segment which is downloaded in parallel in
segmented download. If ``default`` is given, aria2 selects piece so
that it reduces the number of establishing connection. This is
reasonable default behavior because establishing connection is an
expensive operation. If ``inorder`` is given, aria2 selects piece
which has minimum index. Index=0 means first of the file. This will
be useful to view movie while downloading it.
:option:`--enable-http-pipelining` option may
be useful to reduce re-connection overhead. Please note that aria2
honors
:option:`--min-split-size <-k>` option,
so it will be necessary to specify a reasonable value to
:option:`--min-split-size <-k>` option.
If ``random`` is given, aria2 selects piece randomly. Like
``inorder``, :option:`--min-split-size <-k>` option is honored.
If ``geom`` is given, at the beginning aria2 selects piece which has
minimum index like ``inorder``, but it exponentially increasingly
keeps space from previously selected piece. This will reduce the
number of establishing connection and at the same time it will
download the beginning part of the file first. This will be useful
to view movie while downloading it.
Default: ``default``
Specify piece selection algorithm used in HTTP/FTP download. A piece is a
fixed length segment which is downloaded in parallel in a segmented download.
Default: ``default``.

default
Select a piece to reduce the number of connections established.
This is reasonable default behavior because establishing a connection is an
expensive operation.
inorder
Select a piece closest to the beginning of the file. This is useful for
viewing movies while downloading. :option:`--enable-http-pipelining` option
may be useful to reduce re-connection overhead. Note that aria2 honors
:option:`--min-split-size <-k>` option, so it will be necessary to specify
a reasonable value to :option:`--min-split-size <-k>` option.
random
Select a piece randomly. Like ``inorder``, :option:`--min-split-size <-k>`
option is honored.
geom
When starting to download a file, select a piece closest to the beginning
of the file like ``inorder``, but then exponentially increases space
between pieces.
This reduces the number of connections established, while
at the same time downloads the beginning part of the file first. This is
useful for viewing movies while downloading.

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

Expand Down Expand Up @@ -433,7 +434,7 @@ HTTP Specific Options

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

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

Expand Down Expand Up @@ -500,7 +501,7 @@ HTTP Specific Options

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

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

.. note::

In performance perspective, there is usually no advantage to enable
this option.
There is usually no performance gain from enabling this option.

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

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

.. option:: --no-want-digest-header [true|false]

Whether to disable Want-Digest header when doing requests.
Default: ``false``

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

Expand Down Expand Up @@ -742,7 +746,7 @@ BitTorrent Specific Options

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

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

Expand Down Expand Up @@ -792,11 +796,11 @@ BitTorrent Specific Options

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

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

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

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

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

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

.. note::

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

magnet URI, and followed by torrent download
GID of BitTorrent meta data download is saved.
GID of BitTorrent metadata download is saved.
URI to torrent file, and followed by torrent download
GID of torrent file download is saved.
URI to metalink file, and followed by file downloads described in metalink file
Expand Down Expand Up @@ -4284,8 +4288,8 @@ Alternatively, if PEM files are supported, use a command like the following:
.. note::

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

Verify SSL/TLS servers using given CA certificates
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Expand Down
8 changes: 4 additions & 4 deletions manual/en/html/_sources/technical-notes.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -112,10 +112,10 @@ they should be all zeros:
0 1 2 3
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
+---+-+---+-----+---------------+---------------+---------------+
|MGC|F|VER| RSV | MTIME | RSV |LOCAL NODE ID :
|(2)|M|(2)| (3) | (8) | (8) | (20) :
| |T| | | | | :
+---+-+-----+---+---------------+---------------+---------------+
|MGC|F| RSV |VER| MTIME | RSV |LOCAL NODE ID :
|(2)|M| (3) |(2)| (8) | (8) | (20) :
| |T| | | | | :
+---+-+---+-----+-------+-------+-------+-------+---------------+
:LOCAL NODE ID | RSV | NUM | RSV |
: (continued) | (4) | NODE | (4) |
Expand Down
134 changes: 134 additions & 0 deletions manual/en/html/_static/_sphinx_javascript_frameworks_compat.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,134 @@
/*
* _sphinx_javascript_frameworks_compat.js
* ~~~~~~~~~~
*
* Compatability shim for jQuery and underscores.js.
*
* WILL BE REMOVED IN Sphinx 6.0
* xref RemovedInSphinx60Warning
*
*/

/**
* select a different prefix for underscore
*/
$u = _.noConflict();


/**
* small helper function to urldecode strings
*
* See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL
*/
jQuery.urldecode = function(x) {
if (!x) {
return x
}
return decodeURIComponent(x.replace(/\+/g, ' '));
};

/**
* small helper function to urlencode strings
*/
jQuery.urlencode = encodeURIComponent;

/**
* This function returns the parsed url parameters of the
* current request. Multiple values per key are supported,
* it will always return arrays of strings for the value parts.
*/
jQuery.getQueryParameters = function(s) {
if (typeof s === 'undefined')
s = document.location.search;
var parts = s.substr(s.indexOf('?') + 1).split('&');
var result = {};
for (var i = 0; i < parts.length; i++) {
var tmp = parts[i].split('=', 2);
var key = jQuery.urldecode(tmp[0]);
var value = jQuery.urldecode(tmp[1]);
if (key in result)
result[key].push(value);
else
result[key] = [value];
}
return result;
};

/**
* highlight a given string on a jquery object by wrapping it in
* span elements with the given class name.
*/
jQuery.fn.highlightText = function(text, className) {
function highlight(node, addItems) {
if (node.nodeType === 3) {
var val = node.nodeValue;
var pos = val.toLowerCase().indexOf(text);
if (pos >= 0 &&
!jQuery(node.parentNode).hasClass(className) &&
!jQuery(node.parentNode).hasClass("nohighlight")) {
var span;
var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg");
if (isInSVG) {
span = document.createElementNS("http://www.w3.org/2000/svg", "tspan");
} else {
span = document.createElement("span");
span.className = className;
}
span.appendChild(document.createTextNode(val.substr(pos, text.length)));
node.parentNode.insertBefore(span, node.parentNode.insertBefore(
document.createTextNode(val.substr(pos + text.length)),
node.nextSibling));
node.nodeValue = val.substr(0, pos);
if (isInSVG) {
var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect");
var bbox = node.parentElement.getBBox();
rect.x.baseVal.value = bbox.x;
rect.y.baseVal.value = bbox.y;
rect.width.baseVal.value = bbox.width;
rect.height.baseVal.value = bbox.height;
rect.setAttribute('class', className);
addItems.push({
"parent": node.parentNode,
"target": rect});
}
}
}
else if (!jQuery(node).is("button, select, textarea")) {
jQuery.each(node.childNodes, function() {
highlight(this, addItems);
});
}
}
var addItems = [];
var result = this.each(function() {
highlight(this, addItems);
});
for (var i = 0; i < addItems.length; ++i) {
jQuery(addItems[i].parent).before(addItems[i].target);
}
return result;
};

/*
* backward compatibility for jQuery.browser
* This will be supported until firefox bug is fixed.
*/
if (!jQuery.browser) {
jQuery.uaMatch = function(ua) {
ua = ua.toLowerCase();

var match = /(chrome)[ \/]([\w.]+)/.exec(ua) ||
/(webkit)[ \/]([\w.]+)/.exec(ua) ||
/(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) ||
/(msie) ([\w.]+)/.exec(ua) ||
ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) ||
[];

return {
browser: match[ 1 ] || "",
version: match[ 2 ] || "0"
};
};
jQuery.browser = {};
jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true;
}
Loading

0 comments on commit b5c98b9

Please sign in to comment.