-
Notifications
You must be signed in to change notification settings - Fork 0
/
aria2.default.conf
1377 lines (1170 loc) · 55 KB
/
aria2.default.conf
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# Basic Options
################
# The directory to store the downloaded file.
#dir=<DIR>
# Downloads the URIs listed in ``FILE``. You can specify multiple sources for a
# single entity by putting multiple URIs on a single line separated by the
# :kbd:`TAB` character.
# Additionally, options can be specified after each URI line. Option lines
# must start with one or more white space characters (:kbd:`SPACE` or :kbd:`TAB`)
# and must only contain one option per line.
# Input files can use gzip compression.
# When ``FILE`` is specified as ``-``, aria2 will read the input from ``stdin``.
# See the `Input File`_ subsection for details.
# See also the :option:`--deferred-input` option.
# See also the :option:`--save-session` option.
#input-file=<FILE>
# The file name of the log file. If ``-`` is specified, log is written to
# ``stdout``. If empty string("") is specified, or this option is omitted,
# no log is written to disk at all.
#log=<LOG>
# Set the maximum number of parallel downloads for every queue item.
# See also the :option:`--split <-s>` option.
# .. note::
# :option:`--max-concurrent-downloads` limits the number of items
# which are downloaded concurrently. :option:`--split <-s>` and
# :option:`--min-split-size <-k>` affect the number of connections
# inside each item. Imagine that you have an input file (see
# :option:`--input-file <-i>` option) like this:
# .. code-block:: text
# http://example.com/foo
# http://example.com/bar
# Here is 2 download items. aria2 can download these items
# concurrently if the value more than or equal 2 is given to
# :option:`--max-concurrent-downloads`. In each download item, you
# can configure the number of connections using :option:`--split
# <-s>` and/or :option:`--min-split-size <-k>`, etc.
# Default: ``5``
#max-concurrent-downloads=<N>
# Check file integrity by validating piece hashes or a hash of entire
# file. This option has effect only in BitTorrent, Metalink downloads
# with checksums or HTTP(S)/FTP downloads with
# :option:`--checksum` option. If
# piece hashes are provided, this option can detect damaged portions
# of a file and re-download them. If a hash of entire file is
# provided, hash check is only done when file has been already
# download. This is determined by file length. If hash check fails,
# file is re-downloaded from scratch. If both piece hashes and a hash
# of entire file are provided, only piece hashes are used.
# Default: ``false``
#check-integrity=[true|false]
# Continue downloading a partially downloaded file.
# Use this option to resume a download started by a web browser or another
# program which downloads files sequentially from the beginning.
# Currently this option is only applicable to HTTP(S)/FTP downloads.
#continue=[true|false]
# HTTP/FTP/SFTP Options
################
# Use a proxy server for all protocols. To override a previously
# defined proxy, use "". You also can override this setting and specify a
# proxy server for a particular protocol using :option:`--http-proxy`,
# :option:`--https-proxy` and :option:`--ftp-proxy` options. This affects all
# downloads.
# The format of PROXY is ``[http://][USER:PASSWORD@]HOST[:PORT]``.
# See also `ENVIRONMENT`_ section.
# .. note::
# If user and password are embedded in proxy URI and they are also
# specified by *--{http,https,ftp,all}-proxy-{user,passwd}* options,
# those specified later override prior options. For example, if you specified
# ``http-proxy-user=myname``, ``http-proxy-passwd=mypass`` in aria2.conf and
# you specified ``--http-proxy="http://proxy"`` on the command-line, then
# you'd get HTTP proxy ``http://proxy`` with user ``myname`` and password
# ``mypass``.
# Another example: if you specified on the command-line
# ``--http-proxy="http://user:pass@proxy" --http-proxy-user="myname"
# --http-proxy-passwd="mypass"``, then you'd get HTTP proxy
# ``http://proxy`` with user ``myname`` and password ``mypass``.
# One more example: if you specified in command-line ``--http-proxy-user="myname"
# --http-proxy-passwd="mypass" --http-proxy="http://user:pass@proxy"``,
# then you'd get HTTP proxy ``http://proxy`` with user ``user`` and password
# ``pass``.
#all-proxy=<PROXY>
# Set password for :option:`--all-proxy` option.
#all-proxy-passwd=<PASSWD>
# Set user for :option:`--all-proxy` option.
#all-proxy-user=<USER>
# Set the connect timeout in seconds to establish connection to
# HTTP/FTP/proxy server. After the connection is established, this
# option makes no effect and :option:`--timeout <-t>` option is used instead.
# Default: ``60``
#connect-timeout=<SEC>
# If ``true`` is given, aria2 just checks whether the remote file is
# available and doesn't download data. This option has effect on
# HTTP/FTP download. BitTorrent downloads are canceled if ``true`` is
# specified.
# Default: ``false``
#dry-run=[true|false]
# Close connection if download speed is lower than or equal to this
# value(bytes per sec).
# ``0`` means aria2 does not have a lowest speed limit.
# You can append ``K`` or ``M`` (1K = 1024, 1M = 1024K).
# This option does not affect BitTorrent downloads.
# Default: ``0``
#lowest-speed-limit=<SPEED>
# The maximum number of connections to one server for each download.
# Default: ``1``
#max-connection-per-server=<NUM>
# If aria2 receives "file not found" status from the remote HTTP/FTP
# servers NUM times without getting a single byte, then force the
# download to fail. Specify ``0`` to disable this option. This options
# is effective only when using HTTP/FTP servers. The number of retry
# attempt is counted toward :option:`--max-tries`, so it should be
# configured too.
# Default: ``0``
#max-file-not-found=<NUM>
# Set number of tries. ``0`` means unlimited.
# See also :option:`--retry-wait`.
# Default: ``5``
#max-tries=<N>
# aria2 does not split less than 2*SIZE byte range. For example,
# let's consider downloading 20MiB file. If SIZE is 10M, aria2 can
# split file into 2 range [0-10MiB) and [10MiB-20MiB) and download it
# using 2 sources(if :option:`--split <-s>` >= 2, of course). If SIZE is 15M,
# since 2*15M > 20MiB, aria2 does not split file and download it using
# 1 source. You can append ``K`` or ``M`` (1K = 1024, 1M = 1024K).
# Possible Values: ``1M`` -``1024M``
# Default: ``20M``
#min-split-size=<SIZE>
# Specify the path to the netrc file.
# .. note::
# Permission of the .netrc file must be 600. Otherwise, the file
# will be ignored.
# Default: ``$(HOME)/.netrc``
#netrc-path=<FILE>
# Disables netrc support. netrc support is enabled by default.
# .. note::
# netrc file is only read at the startup if
# :option:`--no-netrc <-n>` is ``false``.
# So if :option:`--no-netrc <-n>` is ``true`` at the startup,
# no netrc is available throughout the session.
# You cannot get netrc enabled even if you send
# :option:`--no-netrc=false <-n>` using
# :func:`aria2.changeGlobalOption`.
#no-netrc=[true|false]
# Specify a comma separated list of host names, domains and network addresses
# with or without a subnet mask where no proxy should be used.
# .. note::
# For network addresses with a subnet mask, both IPv4 and IPv6 addresses work.
# The current implementation does not resolve the host name in an URI to compare
# network addresses specified in :option:`--no-proxy`. So it is only effective
# if URI has numeric IP addresses.
#no-proxy=<DOMAINS>
# Set the method to use in proxy request. METHOD is either ``get`` or
# ``tunnel``. HTTPS downloads always use ``tunnel`` regardless of this
# option.
# Default: ``get``
#proxy-method=<METHOD>
# Retrieve timestamp of the remote file from the remote HTTP/FTP
# server and if it is available, apply it to the local file.
# Default: ``false``
#remote-time=[true|false]
# Reuse already used URIs if no unused URIs are left.
# Default: ``true``
#reuse-uri=[true|false]
# Set the seconds to wait between retries. When ``SEC > 0``, aria2 will
# retry downloads when the HTTP server returns a 503 response.
# Default: ``0``
#retry-wait=<SEC>
# Specify the file name to which performance profile of the servers is
# saved. You can load saved data using :option:`--server-stat-if` option. See
# `Server Performance Profile`_
# subsection below for file format.
#server-stat-of=<FILE>
# Specify the file name to load performance profile of the servers. The
# loaded data will be used in some URI selector such as ``feedback``.
# See also :option:`--uri-selector` option. See
# `Server Performance Profile`_
# subsection below for file format.
#server-stat-if=<FILE>
# Specifies timeout in seconds to invalidate performance profile of
# the servers since the last contact to them.
# Default: ``86400`` (24hours)
#server-stat-timeout=<SEC>
# Download a file using N connections. If more than N URIs are given,
# first N URIs are used and remaining URIs are used for backup. If
# less than N URIs are given, those URIs are used more than once so
# that N connections total are made simultaneously. The number of
# connections to the same host is restricted by the
# :option:`--max-connection-per-server <-x>` option.
# See also the :option:`--min-split-size <-k>` option.
# .. note::
# Some Metalinks regulate the number of servers to connect. aria2
# strictly respects them. This means that if Metalink defines the
# ``maxconnections`` attribute lower than N, then aria2 uses the
# value of this lower value instead of N.
# Default: ``5``
#split=<N>
# 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``
#stream-piece-selector=<SELECTOR>
# Set timeout in seconds.
# Default: ``60``
#timeout=<SEC>
# Specify URI selection algorithm. If ``inorder`` is given, URI is tried in
# the order appeared in the URI list. If ``feedback`` is given, aria2
# uses download speed observed in the previous downloads and choose
# fastest server in the URI list. This also effectively skips dead
# mirrors. The observed download speed is a part of performance
# profile of servers mentioned in :option:`--server-stat-of` and
# :option:`--server-stat-if` options. If ``adaptive`` is given, selects one of
# the best mirrors for the first and reserved connections. For
# supplementary ones, it returns mirrors which has not been tested
# yet, and if each of them has already been tested, returns mirrors
# which has to be tested again. Otherwise, it doesn't select anymore
# mirrors. Like ``feedback``, it uses a performance profile of servers.
# Possible Values: ``inorder``, ``feedback``, ``adaptive``
# Default: ``feedback``
#uri-selector=<SELECTOR>
# HTTP Specific Options
################
# Use the certificate authorities in FILE to verify the peers.
# The certificate file must be in PEM format and can contain multiple CA
# certificates.
# Use :option:`--check-certificate` option to enable verification.
# .. note::
# If you build with OpenSSL or the recent version of GnuTLS which
# has ``gnutls_certificate_set_x509_system_trust()`` function and
# the library is properly configured to locate the system-wide CA
# certificates store, aria2 will automatically load those
# certificates at the startup.
# .. note::
# *WinTLS* and *AppleTLS* do not support this option. Instead you will
# have to import the certificate into the OS trust store.
#ca-certificate=<FILE>
# Use the client certificate in FILE. The certificate must be
# either in PKCS12 (.p12, .pfx) or in PEM format.
# PKCS12 files must contain the certificate, a key and optionally a chain
# of additional certificates. Only PKCS12 files with a blank import password
# can be opened!
# When using PEM, you have to specify the private key via :option:`--private-key`
# as well.
# .. note::
# *WinTLS* does not support PEM files at the moment. Users have to use PKCS12
# files.
# .. note::
# *AppleTLS* users should use the KeyChain Access utility to import the client
# certificate and get the SHA-1 fingerprint from the Information dialog
# corresponding to that certificate.
# To start aria2c use `--certificate=<SHA-1>`.
# Alternatively PKCS12 files are also supported. PEM files, however, are not
# supported.
#certificate=<FILE>
# Verify the peer using certificates specified in :option:`--ca-certificate` option.
# Default: ``true``
#check-certificate=[true|false]
# Send ``Accept: deflate, gzip`` request header and inflate response if
# remote server responds with ``Content-Encoding: gzip`` or
# ``Content-Encoding: deflate``.
# .. note::
# Some server responds with ``Content-Encoding: gzip`` for files which
# itself is gzipped file. aria2 inflates them anyway because of the
# response header.
# Default: ``false``
#http-accept-gzip=[true|false]
# Send HTTP authorization header only when it is requested by the
# server. If ``false`` is set, then authorization header is always sent
# to the server. There is an exception: if user name and password are
# embedded in URI, authorization header is always sent to the server
# regardless of this option.
# Default: ``false``
#http-auth-challenge=[true|false]
# Send ``Cache-Control: no-cache`` and ``Pragma: no-cache`` header to avoid
# cached content. If ``false`` is given, these headers are not sent
# and you can add Cache-Control header with a directive you like
# using :option:`--header` option.
# Default: ``false``
#http-no-cache=[true|false]
# Set HTTP user. This affects all URIs.
#http-user=<USER>
# Set HTTP password. This affects all URIs.
#http-passwd=<PASSWD>
# Use a proxy server for HTTP. To override a previously defined proxy,
# use "".
# See also the :option:`--all-proxy` option. This affects all http downloads.
# The format of PROXY is ``[http://][USER:PASSWORD@]HOST[:PORT]``
#http-proxy=<PROXY>
# Set password for :option:`--http-proxy`.
#http-proxy-passwd=<PASSWD>
# Set user for :option:`--http-proxy`.
#http-proxy-user=<USER>
# Use a proxy server for HTTPS. To override a previously defined proxy,
# use "".
# See also the :option:`--all-proxy` option. This affects all https download.
# The format of PROXY is ``[http://][USER:PASSWORD@]HOST[:PORT]``
#https-proxy=<PROXY>
# Set password for :option:`--https-proxy`.
#https-proxy-passwd=<PASSWD>
# Set user for :option:`--https-proxy`.
#https-proxy-user=<USER>
# 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.
# See also :option:`--certificate` option.
#private-key=<FILE>
# Set an http referrer (Referer). This affects all http/https downloads.
# If ``*`` is given, the download URI is also used as the referrer.
# This may be useful when used together with the
# :option:`--parameterized-uri <-P>` option.
#referer=<REFERER>
# Enable HTTP/1.1 persistent connection.
# Default: ``true``
#enable-http-keep-alive=[true|false]
# Enable HTTP/1.1 pipelining.
# .. note::
# In performance perspective, there is usually no advantage to enable
# this option.
# Default: ``false``
#enable-http-pipelining=[true|false]
# Append HEADER to HTTP request header.
# You can use this option repeatedly to specify more than one header:
# .. code-block:: console
# $ aria2c --header="X-A: b78" --header="X-B: 9J1" "http://host/file"
#header=<HEADER>
# Load Cookies from FILE using the Firefox3 format (SQLite3),
# Chromium/Google Chrome (SQLite3) and the
# Mozilla/Firefox(1.x/2.x)/Netscape format.
# .. note::
# If aria2 is built without libsqlite3, then it doesn't support Firefox3
# and Chromium/Google Chrome cookie format.
#load-cookies=<FILE>
# Save Cookies to FILE in Mozilla/Firefox(1.x/2.x)/ Netscape
# format. If FILE already exists, it is overwritten. Session Cookies
# are also saved and their expiry values are treated as 0.
# Possible Values: ``/path/to/file``
#save-cookies=<FILE>
# Use HEAD method for the first request to the HTTP server.
# Default: ``false``
#use-head=[true|false]
# Set user agent for HTTP(S) downloads.
# Default: ``aria2/$VERSION``, $VERSION is replaced by package version.
#user-agent=<USER_AGENT>
# FTP/SFTP Specific Options
################
# Set FTP user. This affects all URIs.
# Default: ``anonymous``
#ftp-user=<USER>
# Set FTP password. This affects all URIs.
# If user name is embedded but password is missing in URI, aria2 tries
# to resolve password using .netrc. If password is found in .netrc,
# then use it as password. If not, use the password specified in this
# option.
# Default: ``ARIA2USER@``
#ftp-passwd=<PASSWD>
# Use the passive mode in FTP.
# If ``false`` is given, the active mode will be used.
# .. note::
# This option is ignored for SFTP transfer.
# Default: ``true``
#ftp-pasv=[true|false]
# Use a proxy server for FTP. To override a previously defined proxy,
# use "".
# See also the :option:`--all-proxy` option. This affects all ftp downloads.
# The format of PROXY is ``[http://][USER:PASSWORD@]HOST[:PORT]``
#ftp-proxy=<PROXY>
# Set password for :option:`--ftp-proxy` option.
#ftp-proxy-passwd=<PASSWD>
# Set user for :option:`--ftp-proxy` option.
#ftp-proxy-user=<USER>
# Set FTP transfer type. TYPE is either ``binary`` or ``ascii``.
# .. note::
# This option is ignored for SFTP transfer.
# Possible Values: ``binary``, ``ascii``
# Default: ``binary``
#ftp-type=<TYPE>
# Reuse connection in FTP.
# Default: ``true``
#ftp-reuse-connection=[true|false]
# Set checksum for SSH host public key. TYPE is hash type. The
# supported hash type is ``sha-1`` or ``md5``. DIGEST is hex
# digest. For example:
# ``sha-1=b030503d4de4539dc7885e6f0f5e256704edf4c3``. This option can
# be used to validate server's public key when SFTP is used. If this
# option is not set, which is default, no validation takes place.
#ssh-host-key-md=<TYPE>=<DIGEST>
# BitTorrent Specific Options
################
# Exclude seed only downloads when counting concurrent active
# downloads (See :option:`-j` option). This means that if ``-j3`` is
# given and this option is turned on and 3 downloads are active and
# one of those enters seed mode, then it is excluded from active
# download count (thus it becomes 2), and the next download waiting in
# queue gets started. But be aware that seeding item is still
# recognized as active download in RPC method.
# Default: ``false``
#bt-detach-seed-only=[true|false]
# Allow hook command invocation after hash check (see :option:`-V`
# option) in BitTorrent download. By default, when hash check
# succeeds, the command given by :option:`--on-bt-download-complete`
# is executed. To disable this action, give ``false`` to this option.
# Default: ``true``
#bt-enable-hook-after-hash-check=[true|false]
# Enable Local Peer Discovery. If a private flag is set in a torrent,
# aria2 doesn't use this feature for that download even if ``true`` is
# given.
# Default: ``false``
#bt-enable-lpd=[true|false]
# Comma separated list of BitTorrent tracker's announce URI to
# remove. You can use special value ``*`` which matches all URIs, thus
# removes all announce URIs. When specifying ``*`` in shell
# command-line, don't forget to escape or quote it. See also
# :option:`--bt-tracker` option.
#bt-exclude-tracker=<URI>[,...]
# Specify the external IP address to use in BitTorrent download and DHT.
# It may be sent to BitTorrent tracker. For DHT, this option should be
# set to report that local node is downloading a particular torrent.
# This is critical to use DHT in a private network. Although this
# function is named ``external``, it can accept any kind of IP
# addresses.
#bt-external-ip=<IPADDRESS>
# Requires BitTorrent message payload encryption with arc4. This is a
# shorthand of :option:`--bt-require-crypto`
# :option:`--bt-min-crypto-level`\=arc4. This option does not change
# the option value of those options. If ``true`` is given, deny
# legacy BitTorrent handshake and only use Obfuscation handshake and
# always encrypt message payload.
# Default: ``false``
#bt-force-encryption=[true|false]
# If ``true`` is given, after hash check using :option:`--check-integrity <-V>` option and
# file is complete, continue to seed file. If you want to check file
# and download it only when it is damaged or incomplete, set this
# option to ``false``. This option has effect only on BitTorrent download.
# Default: ``true``
#bt-hash-check-seed=[true|false]
# Before getting torrent metadata from DHT when downloading with
# magnet link, first try to read file saved by
# :option:`--bt-save-metadata` option. If it is successful, then skip
# downloading metadata from DHT.
# Default: ``false``
#bt-load-saved-metadata=[true|false]
# Use given interface for Local Peer Discovery. If this option is not
# specified, the default interface is chosen. You can specify
# interface name and IP address.
# Possible Values: interface, IP address
#bt-lpd-interface=<INTERFACE>
# Specify maximum number of files to open in multi-file
# BitTorrent/Metalink download globally.
# Default: ``100``
#bt-max-open-files=<NUM>
# Specify the maximum number of peers per torrent. ``0`` means
# unlimited. See also :option:`--bt-request-peer-speed-limit` option.
# Default: ``55``
#bt-max-peers=<NUM>
# Download meta data only. The file(s) described in meta data will not
# be downloaded. This option has effect only when BitTorrent Magnet
# URI is used. See also :option:`--bt-save-metadata` option.
# Default: ``false``
#bt-metadata-only=[true|false]
# Set minimum level of encryption method.
# If several encryption methods are provided by a peer, aria2 chooses the lowest
# one which satisfies the given level.
# Default: ``plain``
#bt-min-crypto-level=plain|arc4
# Try to download first and last pieces of each file first. This is
# useful for previewing files. The argument can contain 2 keywords:
# ``head`` and ``tail``. To include both keywords, they must be separated
# by comma. These keywords can take one parameter, SIZE. For example,
# if ``head=<SIZE>`` is specified, pieces in the range of first SIZE bytes
# of each file get higher priority. ``tail=<SIZE>`` means the range of
# last SIZE bytes of each file. SIZE can include ``K`` or ``M`` (1K = 1024,
# 1M = 1024K). If SIZE is omitted, SIZE=1M is used.
#bt-prioritize-piece=head[=<SIZE>],tail[=<SIZE>]
# Removes the unselected files when download is completed in
# BitTorrent. To select files, use
# :option:`--select-file` option. If it is
# not used, all files are assumed to be selected. Please use this
# option with care because it will actually remove files from your
# disk.
# Default: ``false``
#bt-remove-unselected-file=[true|false]
# If ``true`` is given, aria2 doesn't accept and establish connection with legacy
# BitTorrent handshake(\\19BitTorrent protocol).
# Thus aria2 always uses Obfuscation handshake.
# Default: ``false``
#bt-require-crypto=[true|false]
# If the whole download speed of every torrent is lower than SPEED,
# aria2 temporarily increases the number of peers to try for more
# download speed. Configuring this option with your preferred download
# speed can increase your download speed in some cases.
# You can append ``K`` or ``M`` (1K = 1024, 1M = 1024K).
# Default: ``50K``
#bt-request-peer-speed-limit=<SPEED>
# Save meta data 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`
# option.
# Default: ``false``
#bt-save-metadata=[true|false]
# Seed previously downloaded files without verifying piece hashes.
# Default: ``false``
#bt-seed-unverified=[true|false]
# Stop BitTorrent download if download speed is 0 in consecutive SEC
# seconds. If ``0`` is given, this feature is disabled.
# Default: ``0``
#bt-stop-timeout=<SEC>
# Comma separated list of additional BitTorrent tracker's announce
# URI. These URIs are not affected by :option:`--bt-exclude-tracker` option
# because they are added after URIs in :option:`--bt-exclude-tracker` option are
# removed.
#bt-tracker=<URI>[,...]
# Set the connect timeout in seconds to establish connection to
# tracker. After the connection is established, this option makes no
# effect and :option:`--bt-tracker-timeout` option is used instead.
# Default: ``60``
#bt-tracker-connect-timeout=<SEC>
# Set the interval in seconds between tracker requests. This
# completely overrides interval value and aria2 just uses this value
# and ignores the min interval and interval value in the response of
# tracker. If ``0`` is set, aria2 determines interval based on the
# response of tracker and the download progress.
# Default: ``0``
#bt-tracker-interval=<SEC>
# Set timeout in seconds.
# Default: ``60``
#bt-tracker-timeout=<SEC>
# Set host and port as an entry point to IPv4 DHT network.
#dht-entry-point=<HOST>:<PORT>
# Set host and port as an entry point to IPv6 DHT network.
#dht-entry-point6=<HOST>:<PORT>
# Change the IPv4 DHT routing table file to PATH.
# Default: ``$HOME/.aria2/dht.dat`` if present, otherwise
# ``$XDG_CACHE_HOME/aria2/dht.dat``.
#dht-file-path=<PATH>
# Change the IPv6 DHT routing table file to PATH.
# Default: ``$HOME/.aria2/dht6.dat`` if present, otherwise
# ``$XDG_CACHE_HOME/aria2/dht6.dat``.
#dht-file-path6=<PATH>
# Specify address to bind socket for IPv6 DHT. It should be a global
# unicast IPv6 address of the host.
#dht-listen-addr6=<ADDR>
# Set UDP listening port used by DHT(IPv4, IPv6) and UDP tracker.
# Multiple ports can be specified by using ``,``, for example:
# ``6881,6885``. You can also use ``-`` to specify a range:
# ``6881-6999``. ``,`` and ``-`` can be used together.
# Default: ``6881-6999``
# .. note::
# Make sure that the specified ports are open for incoming UDP traffic.
#dht-listen-port=<PORT>...
# Set timeout in seconds.
# Default: ``10``
#dht-message-timeout=<SEC>
# Enable IPv4 DHT functionality. It also enables UDP tracker
# support. If a private flag is set in a torrent, aria2 doesn't use
# DHT for that download even if ``true`` is given.
# Default: ``true``
#enable-dht=[true|false]
# Enable IPv6 DHT functionality. If a private flag is set in a
# torrent, aria2 doesn't use DHT for that download even if ``true`` is
# given. Use :option:`--dht-listen-port` option to specify port number to
# listen on. See also :option:`--dht-listen-addr6` option.
#enable-dht6=[true|false]
# Enable Peer Exchange extension. If a private flag is set in a torrent, this
# feature is disabled for that download even if ``true`` is given.
# Default: ``true``
#enable-peer-exchange=[true|false]
# If ``true`` or ``mem`` is specified, when a file whose suffix is ``.torrent`` or content
# type is ``application/x-bittorrent`` is downloaded, aria2 parses it as a torrent
# file and downloads files mentioned in it.
# If ``mem`` is specified, a torrent file is not written to the disk, but is just
# kept in memory.
# If ``false`` is specified, the ``.torrent`` file is downloaded to the disk, but
# is not parsed as a torrent and its contents are not downloaded.
# Default: ``true``
#follow-torrent=true|false|mem
# Set TCP port number for BitTorrent downloads.
# Multiple ports can be specified by using ``,``, for example: ``6881,6885``.
# You can also use ``-`` to specify a range: ``6881-6999``.
# ``,`` and ``-`` can be used together: ``6881-6889,6999``.
# .. note::
# Make sure that the specified ports are open for incoming TCP traffic.
# Default: ``6881-6999``
#listen-port=<PORT>...
# Set max overall upload speed in bytes/sec.
# ``0`` means unrestricted.
# You can append ``K`` or ``M`` (1K = 1024, 1M = 1024K).
# To limit the upload speed per torrent, use :option:`--max-upload-limit <-u>` option.
# Default: ``0``
#max-overall-upload-limit=<SPEED>
# Set max upload speed per each torrent in bytes/sec.
# ``0`` means unrestricted.
# You can append ``K`` or ``M`` (1K = 1024, 1M = 1024K).
# To limit the overall upload speed, use :option:`--max-overall-upload-limit` option.
# Default: ``0``
#max-upload-limit=<SPEED>
# Specify the prefix of peer ID. The peer ID in
# BitTorrent is 20 byte length. If more than 20
# bytes are specified, only first 20 bytes are
# used. If less than 20 bytes are specified, random
# byte data are added to make its length 20 bytes.
# Default: ``A2-$MAJOR-$MINOR-$PATCH-``, $MAJOR, $MINOR and $PATCH are
# replaced by major, minor and patch version number respectively. For
# instance, aria2 version 1.18.8 has prefix ID ``A2-1-18-8-``.
#peer-id-prefix=<PEER_ID_PREFIX>
# Specify the string used during the bitorrent extended handshake
# for the peer's client version.
# Default: ``aria2/$MAJOR.$MINOR.$PATCH``, $MAJOR, $MINOR and $PATCH are
# replaced by major, minor and patch version number respectively. For
# instance, aria2 version 1.18.8 has peer agent ``aria2/1.18.8``.
#peer-agent=<PEER_AGENT>
# Specify share ratio. Seed completed torrents until share ratio reaches
# RATIO.
# You are strongly encouraged to specify equals or more than ``1.0`` here.
# Specify ``0.0`` if you intend to do seeding regardless of share ratio.
# If :option:`--seed-time` option is specified along with this option, seeding ends when
# at least one of the conditions is satisfied.
# Default: ``1.0``
#seed-ratio=<RATIO>
# Specify seeding time in (fractional) minutes. Also see the
# :option:`--seed-ratio` option.
# .. note::
# Specifying :option:`--seed-time=0 <--seed-time>` disables seeding after download completed.
#seed-time=<MINUTES>
# Metalink Specific Options
################
# If ``true`` or ``mem`` is specified, when a file whose suffix is ``.meta4`` or ``.metalink`` or content
# type of ``application/metalink4+xml`` or ``application/metalink+xml`` is downloaded, aria2 parses it as a metalink
# file and downloads files mentioned in it.
# If ``mem`` is specified, a metalink file is not written to the disk, but is just
# kept in memory.
# If ``false`` is specified, the ``.metalink`` file is downloaded to
# the disk, but is not parsed as a metalink file and its contents are not
# downloaded.
# Default: ``true``
#follow-metalink=true|false|mem
# Specify base URI to resolve relative URI in metalink:url and
# metalink:metaurl element in a metalink file stored in local disk. If
# URI points to a directory, URI must end with ``/``.
#metalink-base-uri=<URI>
# The language of the file to download.
#metalink-language=<LANGUAGE>
# The location of the preferred server.
# A comma-delimited list of locations is acceptable, for example, ``jp,us``.
#metalink-location=<LOCATION>[,...]
# The operating system of the file to download.
#metalink-os=<OS>
# The version of the file to download.
#metalink-version=<VERSION>
# Specify preferred protocol.
# Specify ``none`` to disable this feature.
# Possible Values: ``http``, ``https``, ``ftp``, ``none``
# Default: ``none``
#metalink-preferred-protocol=<PROTO>
# If ``true`` is given and several protocols are available for a mirror in a
# metalink file, aria2 uses one of them.
# Use :option:`--metalink-preferred-protocol` option to specify the preference of
# protocol.
# Default: ``true``
#metalink-enable-unique-protocol=[true|false]
# RPC Options
################
# Enable JSON-RPC/XML-RPC server. It is strongly recommended to set
# secret authorization token using :option:`--rpc-secret` option. See
# also :option:`--rpc-listen-port` option.
# Default: ``false``
#enable-rpc=[true|false]
# Pause download after added. This option is effective only when
# :option:`--enable-rpc=true <--enable-rpc>` is given.
# Default: ``false``
#pause=[true|false]
# Pause downloads created as a result of metadata download. There are
# 3 types of metadata downloads in aria2: (1) downloading .torrent
# file. (2) downloading torrent metadata using magnet link. (3)
# downloading metalink file. These metadata downloads will generate
# downloads using their metadata. This option pauses these subsequent
# downloads. This option is effective only when
# :option:`--enable-rpc=true <--enable-rpc>` is given.
# Default: ``false``
#pause-metadata=[true|false]
# Save the uploaded torrent or metalink meta data 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
# 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
# saved by :option:`--save-session` option.
# Default: ``true``
#rpc-save-upload-metadata=[true|false]
# Add Access-Control-Allow-Origin header field with value ``*`` to the
# RPC response.
# Default: ``false``
#rpc-allow-origin-all=[true|false]
# RPC transport will be encrypted by SSL/TLS. The RPC clients must
# use https scheme to access the server. For WebSocket client, use wss
# scheme. Use :option:`--rpc-certificate` and
# :option:`--rpc-private-key` options to specify the server
# certificate and private key.
#rpc-secure=[true|false]
# Use the certificate in FILE for RPC server. The certificate must be
# either in PKCS12 (.p12, .pfx) or in PEM format.
# PKCS12 files must contain the certificate, a key and optionally a chain
# of additional certificates. Only PKCS12 files with a blank import password
# can be opened!
# When using PEM, you have to specify the private key via :option:`--rpc-private-key`
# as well. Use :option:`--rpc-secure` option to enable encryption.
# .. note::
# *WinTLS* does not support PEM files at the moment. Users have to use PKCS12
# files.
# .. note::
# *AppleTLS* users should use the KeyChain Access utility to first generate a
# self-signed SSL-Server certificate, e.g. using the wizard, and get the
# SHA-1 fingerprint from the Information dialog corresponding to that new
# certificate.
# To start aria2c with :option:`--rpc-secure` use
# `--rpc-certificate=<SHA-1>`.
# Alternatively PKCS12 files are also supported. PEM files, however, are not
# supported.
#rpc-certificate=<FILE>
# Use the private key in FILE for RPC server. The private key must be
# decrypted and in PEM format. Use :option:`--rpc-secure` option to
# enable encryption. See also :option:`--rpc-certificate` option.
#rpc-private-key=<FILE>
# Listen incoming JSON-RPC/XML-RPC requests on all network interfaces. If false
# is given, listen only on local loopback interface.
# Default: ``false``
#rpc-listen-all=[true|false]
# Specify a port number for JSON-RPC/XML-RPC server to listen to.
# Possible Values: ``1024`` - ``65535``
# Default: ``6800``
#rpc-listen-port=<PORT>
# Set max size of JSON-RPC/XML-RPC request. If aria2 detects the request is
# more than SIZE bytes, it drops connection.
# Default: ``2M``
#rpc-max-request-size=<SIZE>
# Set JSON-RPC/XML-RPC user.
# .. Warning::
# :option:`--rpc-user` option will be deprecated in the future
# release. Migrate to :option:`--rpc-secret` option as soon as
# possible.
#rpc-user=<USER>
# Set JSON-RPC/XML-RPC password.
# .. Warning::
# :option:`--rpc-passwd` option will be deprecated in the future
# release. Migrate to :option:`--rpc-secret` option as soon as
# possible.
#rpc-passwd=<PASSWD>
# Set RPC secret authorization token. Read :ref:`rpc_auth` to know
# how this option value is used.
#rpc-secret=<TOKEN>
# Advanced Options
################
# Restart download from scratch if the corresponding control file
# doesn't exist. See also :option:`--auto-file-renaming` option.
# Default: ``false``
#allow-overwrite=[true|false]
# If false is given, aria2 aborts download when a piece length is different
# from one in a control file.
# If true is given, you can proceed but some download progress will be lost.
# Default: ``false``
#allow-piece-length-change=[true|false]
# Always resume download. If ``true`` is given, aria2 always tries to
# resume download and if resume is not possible, aborts download. If
# ``false`` is given, when all given URIs do not support resume or aria2
# encounters ``N`` URIs which does not support resume (``N`` is the value
# specified using :option:`--max-resume-failure-tries` option), aria2
# downloads file from scratch. See :option:`--max-resume-failure-tries`
# option.
# Default: ``true``
#always-resume=[true|false]
# Enable asynchronous DNS.
# Default: ``true``
#async-dns=[true|false]
# Comma separated list of DNS server address used in asynchronous DNS
# resolver. Usually asynchronous DNS resolver reads DNS server
# addresses from ``/etc/resolv.conf``. When this option is used, it uses
# DNS servers specified in this option instead of ones in
# ``/etc/resolv.conf``. You can specify both IPv4 and IPv6 address. This
# option is useful when the system does not have ``/etc/resolv.conf`` and
# user does not have the permission to create it.
#async-dns-server=<IPADDRESS>[,...]
# Rename file name if the same file already exists.
# This option works only in HTTP(S)/FTP download.
# The new file name has a dot and a number(1..9999) appended after the
# name, but before the file extension, if any.
# Default: ``true``
#auto-file-renaming=[true|false]
# Save a control file(\*.aria2) every SEC seconds.
# If ``0`` is given, a control file is not saved during download. aria2 saves a
# control file when it stops regardless of the value.
# Possible Values: ``0`` - ``600``
# Default: ``60``
#auto-save-interval=<SEC>
# Download file only when the local file is older than remote
# file. This function only works with HTTP(S) downloads only. It does
# not work if file size is specified in Metalink. It also ignores
# Content-Disposition header. If a control file exists, this option
# will be ignored. This function uses If-Modified-Since header to get
# only newer file conditionally. When getting modification time of
# local file, it uses user supplied file name (see :option:`--out <-o>` option) or
# file name part in URI if :option:`--out <-o>` is not specified.
# To overwrite existing file, :option:`--allow-overwrite` is required.
# Default: ``false``
#conditional-get=[true|false]
# Change the configuration file path to PATH.
# Default: ``$HOME/.aria2/aria2.conf`` if present, otherwise
# ``$XDG_CONFIG_HOME/aria2/aria2.conf``.
#conf-path=<PATH>
# Set log level to output to console. LEVEL is either ``debug``,
# ``info``, ``notice``, ``warn`` or ``error``.
# Default: ``notice``
#console-log-level=<LEVEL>
# Handle quoted string in Content-Disposition header as UTF-8 instead
# of ISO-8859-1, for example, the filename parameter, but not the
# extended version filename*.
# Default: ``false``
#content-disposition-default-utf8=[true|false]
# Run as daemon. The current working directory will be changed to ``/``
# and standard input, standard output and standard error will be
# redirected to ``/dev/null``.
# Default: ``false``
#daemon=[true|false]