-
-
Notifications
You must be signed in to change notification settings - Fork 14
/
_aria2c
2972 lines (2969 loc) · 149 KB
/
_aria2c
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
#compdef aria2c
# -----------------------------------------------------------------------------
# The BSD-3-Clause License
#
# Copyright (c) 2016, Koichi Shiraishi
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# * Redistributions of source code must retain the above copyright notice, this
# list of conditions and the following disclaimer.
#
# * Redistributions in binary form must reproduce the above copyright notice,
# this list of conditions and the following disclaimer in the documentation
# and/or other materials provided with the distribution.
#
# * Neither the name of que nor the names of its
# contributors may be used to endorse or promote products derived from
# this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.
# -----------------------------------------------------------------------------
# aria2c '--help=#help'
#
# Usage: aria2c [OPTIONS] [URI | MAGNET | TORRENT_FILE | METALINK_FILE]...
# Printing options tagged with '#help'.
# See 'aria2c -h#help' to know all available tags.
# Options:
# -h, --help[=TAG|KEYWORD] Print usage and exit.
# The help messages are classified with tags. A tag
# starts with "#". For example, type "--help=#http"
# to get the usage for the options tagged with
# "#http". If non-tag word is given, print the usage
# for the options whose name includes that word.
#
# Possible Values: #basic, #advanced, #http, #https, #ftp, #metalink, #bittorrent, #cookie, #hook, #file, #rpc, #checksum, #experimental, #deprecated, #help, #all
# Default: #basic
# Tags: #basic, #help
#
# Refer to man page for more information.
# -----------------------------------------------------------------------------
# aria2c '--help=#basic'
#
# Usage: aria2c [OPTIONS] [URI | MAGNET | TORRENT_FILE | METALINK_FILE]...
# Printing options tagged with '#basic'.
# See 'aria2c -h#help' to know all available tags.
# Options:
# -v, --version Print the version number and exit.
#
# Tags: #basic
#
# -h, --help[=TAG|KEYWORD] Print usage and exit.
# The help messages are classified with tags. A tag
# starts with "#". For example, type "--help=#http"
# to get the usage for the options tagged with
# "#http". If non-tag word is given, print the usage
# for the options whose name includes that word.
#
# Possible Values: #basic, #advanced, #http, #https, #ftp, #metalink, #bittorrent, #cookie, #hook, #file, #rpc, #checksum, #experimental, #deprecated, #help, #all
# Default: #basic
# Tags: #basic, #help
#
# -l, --log=LOG The file name of the log file. If '-' is
# specified, log is written to stdout.
#
# Possible Values: /path/to/file, -
# Tags: #basic
#
# -d, --dir=DIR The directory to store the downloaded file.
#
# Possible Values: /path/to/directory
# Default: /usr/local/share/zsh/site-functions
# Tags: #basic, #file
#
# -o, --out=FILE The file name of the downloaded file. It is
# always relative to the directory given in -d
# option. When the -Z option is used, this option
# will be ignored.
#
# Possible Values: /path/to/file
# Tags: #basic, #http, #ftp, #file
#
# -s, --split=N Download a file using N connections. If more
# than N URIs are given, first N URIs are used and
# remaining URLs are used for backup. If less than
# N URIs are given, those URLs 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
# --max-connection-per-server option. See also the
# --min-split-size option.
#
# Possible Values: 1-*
# Default: 5
# Tags: #basic, #http, #ftp
#
# --file-allocation=METHOD Specify file allocation method.
# 'none' doesn't pre-allocate file space. 'prealloc'
# pre-allocates file space before download begins.
# This may take some time depending on the size of
# the file.
# If you are using newer file systems such as ext4
# (with extents support), btrfs, xfs or NTFS
# (MinGW build only), 'falloc' is 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 entirely until allocation finishes.
# 'falloc' may not be available if your system
# doesn't have posix_fallocate() function.
# 'trunc' uses ftruncate() system call or
# platform-specific counterpart to truncate a file
# to a specified length.
#
# Possible Values: none, prealloc, trunc, falloc
# Default: prealloc
# Tags: #basic, #file
#
# -V, --check-integrity[=true|false] 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
# --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.
#
# Possible Values: true, false
# Default: false
# Tags: #basic, #metalink, #bittorrent, #file, #checksum
#
# -c, --continue[=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.
#
# Possible Values: true, false
# Default: false
# Tags: #basic, #http, #ftp
#
# -i, --input-file=FILE Downloads URIs found in FILE. You can specify
# multiple URIs for a single entity: separate
# URIs on a single line using the TAB character.
# Reads input from stdin when '-' is specified.
# Additionally, options can be specified after each
# line of URI. This optional line must start with
# one or more white spaces and have one option per
# single line. See INPUT FILE section of man page
# for details. See also --deferred-input option.
#
# Possible Values: /path/to/file, -
# Tags: #basic
#
# -j, --max-concurrent-downloads=N Set maximum number of parallel downloads for
# every static (HTTP/FTP) URL, torrent and metalink.
# See also --split and --optimize-concurrent-downloads options.
#
# Possible Values: 1-*
# Default: 5
# Tags: #basic
#
# -Z, --force-sequential[=true|false] Fetch URIs in the command-line sequentially
# and download each URI in a separate session, like
# the usual command-line download utilities.
#
# Possible Values: true, false
# Default: false
# Tags: #basic
#
# -x, --max-connection-per-server=NUM The maximum number of connections to one
# server for each download.
#
# Possible Values: 1-16
# Default: 1
# Tags: #basic, #http, #ftp
#
# -k, --min-split-size=SIZE 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 --split >= 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: 1048576-1073741824
# Default: 20M
# Tags: #basic, #http, #ftp
#
# --ftp-user=USER Set FTP user. This affects all URLs.
#
# Tags: #basic, #ftp
#
# --ftp-passwd=PASSWD Set FTP password. This affects all URLs.
#
# Tags: #basic, #ftp
#
# --http-user=USER Set HTTP user. This affects all URLs.
#
# Tags: #basic, #http
#
# --http-passwd=PASSWD Set HTTP password. This affects all URLs.
#
# Tags: #basic, #http
#
# --load-cookies=FILE Load Cookies from FILE using the Firefox3 format
# and Mozilla/Firefox(1.x/2.x)/Netscape format.
#
# Possible Values: /path/to/file
# Tags: #basic, #http, #cookie
#
# -S, --show-files[=true|false] Print file listing of .torrent, .meta4 and
# .metalink file and exit. More detailed
# information will be listed in case of torrent
# file.
#
# Possible Values: true, false
# Default: false
# Tags: #basic, #metalink, #bittorrent
#
# --max-overall-upload-limit=SPEED 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
# --max-upload-limit option.
#
# Possible Values: 0-*
# Default: 0
# Tags: #basic, #bittorrent
#
# -u, --max-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
# --max-overall-upload-limit option.
#
# Possible Values: 0-*
# Default: 0
# Tags: #basic, #bittorrent
#
# -T, --torrent-file=TORRENT_FILE The path to the .torrent file.
#
# Possible Values: /path/to/file
# Tags: #basic, #bittorrent
#
# --listen-port=PORT... 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.
#
# Possible Values: 1024-65535
# Default: 6881-6999
# Tags: #basic, #bittorrent
#
# --enable-dht[=true|false] 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.
#
# Possible Values: true, false
# Default: true
# Tags: #basic, #bittorrent
#
# --dht-listen-port=PORT... 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.
#
# Possible Values: 1024-65535
# Default: 6881-6999
# Tags: #basic, #bittorrent
#
# --enable-dht6[=true|false] Enable IPv6 DHT functionality.
# Use --dht-listen-port option to specify port
# number to listen on. See also --dht-listen-addr6
# option.
#
# Possible Values: true, false
# Default: false
# Tags: #basic, #bittorrent
#
# --dht-listen-addr6=ADDR Specify address to bind socket for IPv6 DHT.
# It should be a global unicast IPv6 address of the
# host.
#
# Tags: #basic, #bittorrent
#
# -M, --metalink-file=METALINK_FILE The file path to the .meta4 and .metalink
# file. Reads input from stdin when '-' is
# specified.
#
# Possible Values: /path/to/file, -
# Tags: #basic, #metalink
#
# URI, MAGNET, TORRENT_FILE, METALINK_FILE:
# You can specify multiple HTTP(S)/FTP URIs. Unless you specify -Z option, all
# URIs must point to the same file or downloading will fail.
# You can also specify arbitrary number of BitTorrent Magnet URIs, torrent/
# metalink files stored in a local drive. Please note that they are always
# treated as a separate download.
#
# You can specify both torrent file with -T option and URIs. By doing this,
# download a file from both torrent swarm and HTTP/FTP server at the same time,
# while the data from HTTP/FTP are uploaded to the torrent swarm. For single file
# torrents, URI can be a complete URI pointing to the resource or if URI ends
# with '/', 'name' in torrent file is added. For multi-file torrents, 'name' and
# 'path' in torrent are added to form a URI for each file.
#
# Make sure that URI is quoted with single(') or double(") quotation if it
# contains "&" or any characters that have special meaning in shell.
#
# About the number of connections
# Since 1.10.0 release, aria2 uses 1 connection per host by default and has 20MiB
# segment size restriction. So whatever value you specify using -s option, it
# uses 1 connection per host. To make it behave like 1.9.x, use
# --max-connection-per-server=4 --min-split-size=1M.
#
# Refer to man page for more information.
# -----------------------------------------------------------------------------
# aria2c '--help=#advanced'
#
# Usage: aria2c [OPTIONS] [URI | MAGNET | TORRENT_FILE | METALINK_FILE]...
# Printing options tagged with '#advanced'.
# See 'aria2c -h#help' to know all available tags.
# Options:
# --auto-save-interval=SEC 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
# Tags: #advanced
#
# -D, --daemon[=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".
#
# Possible Values: true, false
# Default: false
# Tags: #advanced
#
# --piece-length=LENGTH Set a piece length for HTTP/FTP downloads. This
# is the boundary when aria2 splits a file. All
# splits occur at multiple of this length. This
# option will be ignored in BitTorrent downloads.
# It will be also ignored if Metalink file
# contains piece hashes.
#
# Possible Values: 1048576-1073741824
# Default: 1M
# Tags: #advanced, #http, #ftp
#
# --no-file-allocation-limit=SIZE No file allocation is made for files whose
# size is smaller than SIZE.
# You can append K or M(1K = 1024, 1M = 1024K).
#
# Possible Values: 0-*
# Default: 5M
# Tags: #advanced, #file
#
# --allow-overwrite[=true|false] Restart download from scratch if the
# corresponding control file doesn't exist. See
# also --auto-file-renaming option.
#
# Possible Values: true, false
# Default: false
# Tags: #advanced, #file
#
# --deferred-input[=true|false] If true is given, aria2 does not read all URIs
# and options from file specified by -i option at
# startup, but it reads one by one when it needs
# later. This may reduce memory usage if input
# file contains a lot of URIs to download.
# If false is given, aria2 reads all URIs and
# options at startup.
#
# Possible Values: true, false
# Default: false
# Tags: #advanced
#
# --optimize-concurrent-downloads[=true|false|A:B] Optimizes the number of
# concurrent downloads according to the bandwidth
# available. aria2 uses the download speed observed
# in the previous downloads to adapt the number of
# downloads launched in parallel according to the
# rule N = A + B Log10(speed in Mbps). The
# coefficients A and B can be customized in the
# option arguments with A and B separated by a
# colon. The default values (A=5,B=25) lead to
# using typically 5 parallel downloads on 1Mbps
# networks and above 50 on 100Mbps networks. The
# number of parallel downloads remains constrained
# under the maximum defined by the
# max-concurrent-downloads parameter.
#
# Possible Values: true, false, A:B
# Default: false
# Tags: #advanced
#
# --auto-file-renaming[=true|false] 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.
#
# Possible Values: true, false
# Default: true
# Tags: #advanced, #file
#
# -P, --parameterized-uri[=true|false] Enable parameterized URI support.
# You can specify set of parts:
# http://{sv1,sv2,sv3}/foo.iso
# Also you can specify numeric sequences with step
# counter:
# http://host/image[000-100:2].img
# A step counter can be omitted.
# If all URIs do not point to the same file, such
# as the second example above, -Z option is
# required.
#
# Possible Values: true, false
# Default: false
# Tags: #advanced
#
# --allow-piece-length-change[=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.
#
# Possible Values: true, false
# Default: false
# Tags: #advanced
#
# --no-conf[=true|false] Disable loading aria2.conf file.
#
# Possible Values: true, false
# Default: false
# Tags: #advanced
#
# --conf-path=PATH Change the configuration file path to PATH.
#
# Possible Values: /path/to/file
# Default: /Users/zchee/.config/aria2/aria2.conf
# Tags: #advanced
#
# --stop=SEC Stop application after SEC seconds has passed.
# If 0 is given, this feature is disabled.
#
# Possible Values: 0-2147483647
# Default: 0
# Tags: #advanced
#
# -q, --quiet[=true|false] Make aria2 quiet(no console output).
#
# Possible Values: true, false
# Default: false
# Tags: #advanced
#
# --async-dns[=true|false] Enable asynchronous DNS.
#
# Possible Values: true, false
# Default: true
# Tags: #advanced
#
# --summary-interval=SEC Set interval to output download progress summary.
# Setting 0 suppresses the output.
#
# Possible Values: 0-2147483647
# Default: 60
# Tags: #advanced
#
# --log-level=LEVEL Set log level to output to file specified using
# --log option.
#
# Possible Values: debug, info, notice, warn, error
# Default: debug
# Tags: #advanced
#
# --console-log-level=LEVEL Set log level to output to console.
#
# Possible Values: debug, info, notice, warn, error
# Default: notice
# Tags: #advanced
#
# --event-poll=POLL Specify the method for polling events.
#
# Possible Values: kqueue, libuv, poll, select
# Default: kqueue
# Tags: #advanced
#
# --on-download-start=COMMAND Set the command to be executed after download
# got started. aria2 passes 3 arguments to COMMAND:
# GID, the number of files and file path. See Event
# Hook in man page for more details.
#
# Possible Values: /path/to/command
# Tags: #advanced, #hook
#
# --on-download-pause=COMMAND Set the command to be executed after download
# was paused.
# See --on-download-start option for the
# requirement of COMMAND.
#
# Possible Values: /path/to/command
# Tags: #advanced, #hook
#
# --on-download-stop=COMMAND Set the command to be executed after download
# stopped. You can override the command to be
# executed for particular download result using
# --on-download-complete and --on-download-error. If
# they are specified, command specified in this
# option is not executed.
# See --on-download-start option for the
# requirement of COMMAND.
#
# Possible Values: /path/to/command
# Tags: #advanced, #hook
#
# --on-download-complete=COMMAND Set the command to be executed after download
# completed.
# See --on-download-start option for the
# requirement of COMMAND.
# See also --on-download-stop option.
#
# Possible Values: /path/to/command
# Tags: #advanced, #hook
#
# --on-download-error=COMMAND Set the command to be executed after download
# aborted due to error.
# See --on-download-start option for the
# requirement of COMMAND.
# See also --on-download-stop option.
#
# Possible Values: /path/to/command
# Tags: #advanced, #hook
#
# --interface=INTERFACE Bind sockets to given interface. You can specify
# interface name, IP address and hostname.
#
# Possible Values: interface, IP address, hostname
# Tags: #advanced
#
# --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
# specify interface name, IP address and hostname.
# If --interface is used, this option will be
# ignored.
#
# Possible Values: interface, IP address, hostname
# Tags: #advanced
#
# --disable-ipv6[=true|false] Disable IPv6.
#
# Possible Values: true, false
# Default: false
# Tags: #advanced
#
# --human-readable[=true|false] Print sizes and speed in human readable format
# (e.g., 1.2Ki, 3.4Mi) in the console readout.
#
# Possible Values: true, false
# Default: true
# Tags: #advanced
#
# --remove-control-file[=true|false] Remove control file before download. Using
# with --allow-overwrite=true, download always
# starts from scratch. This will be useful for
# users behind proxy server which disables resume.
#
# Possible Values: true, false
# Default: false
# Tags: #advanced
#
# --always-resume[=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
# --max-resume-failure-tries option), aria2
# downloads file from scratch.
# See --max-resume-failure-tries option.
#
# Possible Values: true, false
# Default: true
# Tags: #advanced, #http, #ftp
#
# --max-resume-failure-tries=N When used with --always-resume=false, aria2
# downloads file from scratch when aria2 detects N
# number of URIs that does not support resume. If N
# is 0, aria2 downloads file from scratch when all
# given URIs do not support resume.
# See --always-resume option.
#
# Possible Values: 0-*
# Default: 0
# Tags: #advanced, #http, #ftp
#
# --save-session=FILE Save error/unfinished downloads to FILE on exit.
# You can pass this output file to aria2c with -i
# option on restart. Please note that downloads
# added by aria2.addTorrent and aria2.addMetalink
# RPC method and whose metadata could not be saved
# as a file will not be saved. Downloads removed
# using aria2.remove and aria2.forceRemove will not
# be saved.
#
# Possible Values: /path/to/file
# Tags: #advanced
#
# --conditional-get[=true|false] Download file only when the local file is older
# than remote file. Currently, this function has
# many limitations. See man page for details.
#
# Possible Values: true, false
# Default: false
# Tags: #advanced, #http
#
# --enable-async-dns6[=true|false] Enable IPv6 name resolution in asynchronous
# DNS resolver. This option will be ignored when
# --async-dns=false.
#
# Possible Values: true, false
# Tags: #advanced, #deprecated
#
# --max-download-result=NUM Set maximum number of download result kept in
# memory. The download results are completed/error/
# removed downloads. The download results are stored
# in FIFO queue and it can store at most NUM
# download results. When queue is full and new
# download result is created, oldest download result
# is removed from the front of the queue and new one
# is pushed to the back. Setting big number in this
# option may result high memory consumption after
# thousands of downloads. Specifying 0 means no
# download result is kept. Note that unfinished
# downloads are kept in memory regardless of this
# option value. See
# --keep-unfinished-download-result option.
#
# Possible Values: 0-*
# Default: 1000
# Tags: #advanced
#
# --async-dns-server=IPADDRESS[,...] 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.
#
# Tags: #advanced
#
# --show-console-readout[=true|false] Show console readout.
#
# Possible Values: true, false
# Default: true
# Tags: #advanced
#
# --truncate-console-readout[=true|false] Truncate console readout to fit in
# a single line.
#
# Possible Values: true, false
# Default: true
# Tags: #advanced
#
# --pause[=true|false] Pause download after added. This option is
# effective only when --enable-rpc=true is given.
#
# Possible Values: true, false
# Default: false
# Tags: #advanced, #rpc
#
# --download-result=OPT This option changes the way "Download Results"
# is formatted. If OPT is 'default', print GID,
# status, average download speed and path/URI. If
# multiple files are involved, path/URI of first
# requested file is printed and remaining ones are
# omitted.
# If OPT is 'full', print GID, status, average
# download speed, percentage of progress and
# path/URI. The percentage of progress and
# path/URI are printed for each requested file in
# each row.
# If OPT is 'hide', "Download Results" is hidden.
#
# Possible Values: default, full, hide
# Default: default
# Tags: #advanced
#
# --hash-check-only[=true|false] If true is given, after hash check using
# --check-integrity option, abort download whether
# or not download is complete.
#
# Possible Values: true, false
# Default: false
# Tags: #advanced, #metalink, #bittorrent, #file, #checksum
#
# --stop-with-process=PID Stop application when process PID is not running.
# This is useful if aria2 process is forked from a
# parent process. The parent process can fork aria2
# with its own pid and when parent process exits
# for some reason, aria2 can detect it and shutdown
# itself.
#
# Possible Values: 0-*
# Tags: #advanced
#
# --enable-mmap[=true|false] Map files into memory.
#
# Possible Values: true, false
# Default: false
# Tags: #advanced, #experimental
#
# --force-save[=true|false] Save download with --save-session option even
# if the download is completed or removed. This
# option also saves control file in that
# situations. This may be useful to save
# BitTorrent seeding which is recognized as
# completed state.
#
# Possible Values: true, false
# Default: false
# Tags: #advanced
#
# --save-not-found[=true|false] Save download with --save-session option even
# if the file was not found on the server. This
# option also saves control file in that
# situations.
#
# Possible Values: true, false
# Default: true
# Tags: #advanced
#
# --disk-cache=SIZE Enable disk cache. If SIZE is 0, the disk cache
# is disabled. This feature caches the downloaded
# data in memory, which grows to at most SIZE
# bytes. The cache storage is created for aria2
# instance and shared by all downloads. The one
# advantage of the disk cache is reduce the disk
# I/O because the data are written in larger unit
# and it is reordered by the offset of the file.
# If hash checking is involved and the data are
# cached in memory, we don't need to read them
# from the disk.
# SIZE can include K or M(1K = 1024, 1M = 1024K).
#
# Possible Values: 0-*
# Default: 16M
# Tags: #advanced
#
# --gid=GID Set GID manually. aria2 identifies each
# download by the ID called GID. The GID must be
# hex string of 16 characters, thus [0-9a-zA-Z]
# are allowed and leading zeros must not be
# stripped. The GID all 0 is reserved and must
# not be used. The GID must be unique, otherwise
# error is reported and the download is not added.
# This option is useful when restoring the
# sessions saved using --save-session option. If
# this option is not used, new GID is generated
# by aria2.
#
# Tags: #advanced
#
# --save-session-interval=SEC Save error/unfinished downloads to a file
# specified by --save-session option every SEC
# seconds. If 0 is given, file will be saved only
# when aria2 exits.
#
# Possible Values: 0-*
# Default: 0
# Tags: #advanced
#
# --enable-color[=true|false] Enable color output for a terminal.
#
# Possible Values: true, false
# Default: true
# Tags: #advanced
#
# --dscp=DSCP Set DSCP value in outgoing IP packets of
# BitTorrent traffic for QoS. This parameter sets
# only DSCP bits in TOS field of IP packets,
# not the whole field. If you take values
# from /usr/include/netinet/ip.h divide them by 4
# (otherwise values would be incorrect, e.g. your
# CS1 class would turn into CS4). If you take
# commonly used values from RFC, network vendors'
# documentation, Wikipedia or any other source,
# use them as they are.
#
# Possible Values: 0-*
# Default: 0
# Tags: #advanced
#
# --pause-metadata[=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 --enable-rpc=true is given.
#
# Possible Values: true, false
# Default: false
# Tags: #advanced, #rpc
#
# --rlimit-nofile=NUM Set the soft limit of open file descriptors.
# This open will only have effect when:
# a) The system supports it (posix)
# b) The limit does not exceed the hard limit.
# c) The specified limit is larger than the
# current soft limit.
# This is equivalent to setting nofile via ulimit,
# except that it will never decrease the limit.
#
# Possible Values: 1-*
# Default: 1024
# Tags: #advanced
#
# --min-tls-version=VERSION Specify minimum SSL/TLS version to enable.
#
# Possible Values: SSLv3, TLSv1, TLSv1.1, TLSv1.2
# Default: TLSv1
# Tags: #advanced
#
# --socket-recv-buffer-size=SIZE
# Set the maximum socket receive buffer in bytes.
# Specifying 0 will disable this option. This value
# will be set to socket file descriptor using
# SO_RCVBUF socket option with setsockopt() call.
#
# Possible Values: 0-16777216
# Default: 0
# Tags: #advanced
#
# --max-mmap-limit=SIZE Set the maximum file size to enable mmap (see
# --enable-mmap option). The file size is
# determined by the sum of all files contained in
# one download. For example, if a download
# contains 5 files, then file size is the total
# size of those files. If file size is strictly
# greater than the size specified in this option,
# mmap will be disabled.
#
# Possible Values: 0-*
# Default: 9223372036854775807
# Tags: #advanced
#
# --stderr[=true|false] Redirect all console output that would be
# otherwise printed in stdout to stderr.
#
# Possible Values: true, false
# Default: false
# Tags: #advanced
#
# --keep-unfinished-download-result[=true|false]
# Keep unfinished download results even if doing
# so exceeds --max-download-result. This is useful
# if all unfinished downloads must be saved in
# session file (see --save-session option). Please
# keep in mind that there is no upper bound to the
# number of unfinished download result to keep. If
# that is undesirable, turn this option off.
#
# Possible Values: true, false
# Default: true
# Tags: #advanced
#
# --content-disposition-default-utf8[=true|false] 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*.
#
# Possible Values: true, false
# Default: false
# Tags: #advanced, #http
#
# --on-bt-download-complete=COMMAND For BitTorrent, a command specified in
# --on-download-complete is called after download
# completed and seeding is over. On the other hand,
# this option sets the command to be executed after
# download completed but before seeding.
# See --on-download-start option for the
# requirement of COMMAND.
#
# Possible Values: /path/to/command
# Tags: #advanced, #hook
#
# Refer to man page for more information.
#
# -----------------------------------------------------------------------------
# aria2c '--help=#advanced'
#
# Usage: aria2c [OPTIONS] [URI | MAGNET | TORRENT_FILE | METALINK_FILE]...
# Printing options tagged with '#http'.
# See 'aria2c -h#help' to know all available tags.
# Options:
# -t, --timeout=SEC Set timeout in seconds.
#
# Possible Values: 1-600
# Default: 60
# Tags: #http, #ftp
#
# --connect-timeout=SEC 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 --timeout option is used instead.
#
# Possible Values: 1-600
# Default: 60
# Tags: #http, #ftp
#
# -m, --max-tries=N Set number of tries. 0 means unlimited.
#
# Possible Values: 0-*
# Default: 5
# Tags: #http, #ftp
#
# -o, --out=FILE The file name of the downloaded file. It is
# always relative to the directory given in -d
# option. When the -Z option is used, this option
# will be ignored.
#
# Possible Values: /path/to/file
# Tags: #basic, #http, #ftp, #file
#
# -s, --split=N Download a file using N connections. If more
# than N URIs are given, first N URIs are used and
# remaining URLs are used for backup. If less than
# N URIs are given, those URLs 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
# --max-connection-per-server option. See also the
# --min-split-size option.
#
# Possible Values: 1-*
# Default: 5
# Tags: #basic, #http, #ftp
#
# --referer=REFERER Set an http referrrer (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 -P option.
#
# Tags: #http
#
# --lowest-speed-limit=SPEED 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.
#
# Possible Values: 0-*
# Default: 0
# Tags: #http, #ftp
#
# --piece-length=LENGTH Set a piece length for HTTP/FTP downloads. This
# is the boundary when aria2 splits a file. All
# splits occur at multiple of this length. This
# option will be ignored in BitTorrent downloads.
# It will be also ignored if Metalink file
# contains piece hashes.
#
# Possible Values: 1048576-1073741824