55
55
[[aria2_optref_check_integrity]]*-V*, *--check-integrity*[='true'|'false']::
57
57
Check file integrity by validating piece hashes or a hash of entire
58
file. This option has effect only in BitTorrent and Metalink
59
downloads with checksums. If piece hashes are provided, this option
60
can detect damaged portions of a file and re-download them. If a
61
hash of entire file is provided, hash check is only done when file
62
has benn already download. This is determined by file length. If
63
hash check fails, file is re-downloaded from scratch. If both piece
64
hashes and a hash of entire file are provided, only piece hashes are
65
used. Default: 'false'
58
file. This option has effect only in BitTorrent, Metalink downloads
59
with checksums or HTTP(S)/FTP downloads with
60
*<<aria2_optref_checksum, --checksum>>* option. If
61
piece hashes are provided, this option can detect damaged portions
62
of a file and re-download them. If a hash of entire file is
63
provided, hash check is only done when file has been already
64
download. This is determined by file length. If hash check fails,
65
file is re-downloaded from scratch. If both piece hashes and a hash
66
of entire file are provided, only piece hashes are used. Default:
67
69
[[aria2_optref_continue]]*-c*, *--continue*[='true'|'false']::
68
70
Continue downloading a partially downloaded file.
75
77
The help messages are classified with tags. A tag starts with
76
78
"#". For example, type "--help=#http" to get the usage for the
77
79
options tagged with "#http". If non-tag word is given, print the
78
usage for the options whose name includes that word.
79
Available Values: '#basic', '#advanced', '#http', '#https', '#ftp',
80
'#metalink', '#bittorrent', '#cookie', '#hook', '#file',
81
'#rpc', '#experimental', '#deprecated', '#help', '#all'
80
usage for the options whose name includes that word. Available
81
Values: '#basic', '#advanced', '#http', '#https', '#ftp',
82
'#metalink', '#bittorrent', '#cookie', '#hook', '#file', '#rpc',
83
'#checksum', '#experimental', '#deprecated', '#help', '#all'
118
120
Set user for *<<aria2_optref_all_proxy, --all-proxy>>* option.
122
[[aria2_optref_checksum]]*--checksum*=TYPE=DIGEST::
124
Set checksum. TYPE is hash type. The supported hash type is listed
125
in "Hash Algorithms" in "aria2c -v". DIGEST is hex digest. For
126
example, setting sha-1 digest looks like this:
127
sha-1=0192ba11326fe2298c8cb4de616f4d4140213838 This option applies
128
only to HTTP(S)/FTP downloads.
120
130
[[aria2_optref_connect_timeout]]*--connect-timeout*=SEC::
121
131
Set the connect timeout in seconds to establish connection to
122
132
HTTP/FTP/proxy server. After the connection is established, this
245
255
[[aria2_optref_stream_piece_selector]]*--stream-piece-selector*=SELECTOR::
247
Specify piece selection algorithm used in HTTP/FTP download. Piece
248
means fixed length segment which is downloaded in parallel in
249
segmented download. If 'default' is given, aria2 selects piece so that
250
it reduces the number of establishing connection. This is reasonable
251
default behaviour because establishing connection is an expensive
252
operation. If 'inorder' is given, aria2 selects piece which has
253
minimum index. Index=0 means first of the file. This will be useful to
254
view movie while downloading it.
255
*<<aria2_optref_enable_http_pipelining, --enable-http-pipelining>>* option may
256
be useful to reduce reconnection overhead. Please note that aria2
258
*<<aria2_optref_min_split_size, --min-split-size>>* option,
259
so it will be necessary to specify a
261
*<<aria2_optref_min_split_size, --min-split-size>>* option.
257
Specify piece selection algorithm used in HTTP/FTP download. Piece
258
means fixed length segment which is downloaded in parallel in
259
segmented download. If 'default' is given, aria2 selects piece so
260
that it reduces the number of establishing connection. This is
261
reasonable default behaviour because establishing connection is an
262
expensive operation. If 'inorder' is given, aria2 selects piece
263
which has minimum index. Index=0 means first of the file. This will
264
be useful to view movie while downloading it.
265
*<<aria2_optref_enable_http_pipelining, --enable-http-pipelining>>* option may
266
be useful to reduce reconnection overhead. Please note that aria2
268
*<<aria2_optref_min_split_size, --min-split-size>>* option,
269
so it will be necessary to specify a reasonable value to
270
*<<aria2_optref_min_split_size, --min-split-size>>* option.
271
If 'geom' is given, at the beginning aria2 selects piece which has
272
minimum index like 'inorder', but it exponentially increasingly
273
keeps space from previously selected piece. This will reduce the
274
number of establishing connection and at the same time it will
275
download the beginning part of the file first. This will be useful
276
to view movie while downloading it.
264
279
[[aria2_optref_timeout]]*-t*, *--timeout*=SEC::
265
280
Set timeout in seconds.
795
810
*<<aria2_optref_enable_rpc, --enable-rpc>>*='true' is given.
814
[[aria2_optref_rpc_allow_origin_all]]*--rpc-allow-origin-all*[='true'|'false']::
816
Add Access-Control-Allow-Origin header field with value '*' to the
798
820
[[aria2_optref_rpc_listen_all]]*--rpc-listen-all*[='true'|'false']::
800
822
Listen incoming JSON-RPC/XML-RPC requests on all network interfaces. If false
893
915
Disable IPv6. This is useful if you have to use broken DNS and want
894
916
to avoid terribly slow AAAA record lookup. Default: 'false'
918
[[aria2_optref_download_result]]*--download-result*=OPT::
920
This option changes the way "Download Results" is formatted. If OPT
921
is 'default', print GID, status, average download speed and
922
path/URI. If multiple files are involved, path/URI of first
923
requested file is printed and remaining ones are omitted. If OPT is
924
'full', print GID, status, average download speed, percentage of
925
progress and path/URI. The percentage of progress and path/URI are
926
printed for each requested file in each row.
896
929
[[aria2_optref_enable_async_dns6]]*--enable-async-dns6*[='true'|'false']::
898
931
Enable IPv6 name resolution in asynchronous DNS resolver. This
926
959
Possible Values: 'none', 'prealloc', 'falloc'
927
960
Default: 'prealloc'
962
[[aria2_optref_hash_check_only]]*--hash-check-only*[=true|false]::
964
If 'true' is given, after hash check using
965
*<<aria2_optref_check_integrity, --check-integrity>>* option,
966
abort download whether or not download is complete.
929
969
[[aria2_optref_human_readable]]*--human-readable*[='true'|'false']::
931
971
Print sizes and speed in human readable format (e.g., 1.2Ki, 3.4Mi)
1012
1052
See *<<_event_hook, Event Hook>>* for more details about COMMAND.
1013
1053
Possible Values: '/path/to/command'
1055
[[aria2_optref_piece_length]]*--piece-length*=LENGTH::
1057
Set a piece length for HTTP/FTP downloads. This is the boundary when
1058
aria2 splits a file. All splits occur at multiple of this
1059
length. This option will be ignored in BitTorrent downloads. It
1060
will be also ignored if Metalink file contains piece hashes.
1065
The possible usecase of *<<aria2_optref_piece_length, --piece-length>>*
1066
option is change the request range in one HTTP pipelined request.
1067
To enable HTTP pipelining use
1068
*<<aria2_optref_enable_http_pipelining, --enable-http-pipelining>>*.
1015
1070
[[aria2_optref_show_console_readout]]*--show-console-readout*[='true'|'false']::
1017
1072
Show console readout. Default: 'true'
1555
1610
* *<<aria2_optref_metalink_base_uri, metalink-base-uri>>*
1556
1611
* *<<aria2_optref_pause, pause>>*
1557
1612
* *<<aria2_optref_stream_piece_selector, stream-piece-selector>>*
1613
* *<<aria2_optref_hash_check_only, hash-check-only>>*
1614
* *<<aria2_optref_checksum, checksum>>*
1615
* *<<aria2_optref_piece_length, piece_length>>*
1559
1617
These options have exactly same meaning of the ones in the
1560
1618
command-line options, but it just applies to the URIs it belongs to.
2120
2178
u'downloadSpeed': u'15158',
2121
2179
u'files': [{u'index': u'1',
2122
2180
u'length': u'34896138',
2181
u'completedLength': u'34896138',
2123
2182
u'path': u'/downloads/file',
2124
2183
u'selected': u'true',
2125
2184
u'uris': [{u'status': u'used',
2266
2326
File size in bytes.
2330
Completed length of this file in bytes. Please note that it is
2331
possible that sum of completedLength is less than completedLength in
2332
*<<aria2_rpc_aria2_tellStatus, aria2.tellStatus>>* method.
2333
This is because completedLength in
2334
*<<aria2_rpc_aria2_getFiles, aria2.getFiles>>*
2335
only calculates completed pieces. On the other hand, completedLength
2337
*<<aria2_rpc_aria2_tellStatus, aria2.tellStatus>>* takes into account
2338
of partially completed piece.
2270
2342
"true" if this file is selected by *<<aria2_optref_select_file, --select-file>>* option. If
2290
2362
u'jsonrpc': u'2.0',
2291
2363
u'result': [{u'index': u'1',
2292
2364
u'length': u'34896138',
2365
u'completedLength': u'34896138',
2293
2366
u'path': u'/downloads/file',
2294
2367
u'selected': u'true',
2295
2368
u'uris': [{u'status': u'used',
3540
3614
aria2c -V file.metalink
3541
3615
-----------------------
3543
This option is only available used with BitTorrent or metalink with chunk
3618
Repairing damaged downloads can be done efficiently when used with
3619
BitTorrent or Metalink with chunk checksums.
3546
3621
Drop connection if download speed is lower than specified value
3547
3622
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3569
3644
aria2c -Z -P "http://host/image[A-Z:2].png"
3570
3645
-------------------------------------------
3650
----------------------------------------------------------------------------------------
3651
aria2c --checksum=sha-1=0192ba11326fe2298c8cb4de616f4d4140213837 http://example.org/file
3652
----------------------------------------------------------------------------------------
3572
3654
Parallel downloads of arbitrary number of URI,metalink,torrent
3573
3655
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3574
3656
--------------------------------------------------------------
added
removed
doc/aria2c.1.asciidoc
