berserker
Version:
Web-based frontend for Aria2-JSONRPC
180 lines (178 loc) • 41.8 kB
JSON
{
"dir" : "The directory to store the downloaded file.",
"input-file" : "Downloads URIs found in FILE. You can specify multiple URIs for a single entity: separate URIs on a single line using the TABcharacter. 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. The input file can use gzip compression. See Input File subsection for details.See also --deferred-input option.",
"log" : "The file name of the log file. If - is specified, log is written to stdout. If empty string('') is specified, log is not written to file.",
"max-concurrent-downloads" : "Set maximum number of parallel downloads for every static (HTTP/FTP) URI, torrent and metalink. See also --split option.Default: 5",
"check-integrity" : "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 pro‐ vided, only piece hashes are used. Default: false",
"continue" : "Continuedownloading apartially 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.",
"help" : "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. Available Values: #basic, #advanced, #http, #https, #ftp, #metalink, #bittorrent, #cookie, #hook, #file, #rpc, #checksum, #experimental, #deprecated, #help, #all Default: #basic",
"all-proxy" : "Use this proxy server for all protocols.To erase previously defined proxy, use ''. You can override this setting and specify a proxy server for a particular protocol using --http-proxy, --https-proxy and --ftp-proxy options. This affects all URIs. The format of PROXY is [http://][USER:PASSWORD@]HOST[:PORT]. See also ENVIRONMENT section.",
"all-proxy-passwd" : "Set password for --all-proxy option.",
"all-proxy-user" : "Set user for --all-proxy option.",
"checksum" : "Set checksum. TYPE is hash type. The supported hash type is listed in Hash Algorithms in aria2c -v. DIGEST is hex digest. For example, set‐ ting sha-1 digest looks like this: sha-1=0192ba11326fe2298c8cb4de616f4d4140213838 This option applies only to HTTP(S)/FTP downloads.",
"connect-timeout" : "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. Default: 60",
"dry-run" : "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 down‐ load. BitTorrent downloads are canceled if true is specified. Default: false",
"lowest-speed-limit" : "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",
"max-connection-per-server" : "The maximum number of connections to one server for each download. Default: 1",
"max-file-not-found" : "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. Default: 0",
"max-tries" : "Set number of tries. 0 means unlimited. See also --retry-wait. Default: 5",
"min-split-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 notsplit file and download it using 1 source.You can append K or M (1K = 1024, 1M = 1024K).Possible Values: 1M -1024M Default: 20M",
"no-netrc" : "Disables netrc support. netrc support is enabled by default. Note: netrc file is only read at the startup if --no-netrc is false. So if --no-netrc is true at the startup, no netrc is availablethroughout the session. You cannot get netrc enabled even if you send --no-netrc=false using aria2.changeGlobalOption().",
"no-proxy" : "Specify comma separated hostnames, domains and network address with or without CIDR block where proxy should not be used. Note: For network address with CIDR block, both IPv4 and IPv6 addresses work. Current implementation does not resolve hostname in URI to compare network address specified in --no-proxy. So it is only effecive if URI has numeric IP addresses.",
"out" : "The file name of the downloaded file. When --force-sequential option is used, this option is ignored. Note: In Metalink or BitTorrent download you cannot specify file name.The file name specified here is only used when the URIs fed toaria2 are done by command line without --input-file, --force-sequential option. For example:",
"proxy-method" : "Set themethodto use in proxy request. METHOD is either get or tunnel. HTTPS downloads always use tunnel regardless of this option. Default: get",
"remote-time" : "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",
"reuse-uri" : "Reuse already used URIs if no unused URIs are left. Default: true",
"retry-wait" : "Set the seconds to wait between retries. With SEC > 0, aria2 will retry download when the HTTP server returns 503 response. Default: 0",
"server-stat-of" : "Specify the filename to which performance profile of the servers is saved. You can load saved data using --server-stat-if option. See Server Performance Profile subsection below for file format.",
"server-stat-if" : "Specify the filename to load performance profile of the servers. The loaded data will be used in some URI selector such as feedback. See also --uri-selector option. See Server Performance Profile subsection below for file format.",
"server-stat-timeout" : "Specifies timeout in seconds to invalidate performance profile of the servers since the last contact to them. Default: 86400 (24hours)",
"split" : "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 --max-connection-per-server option. See also --min-split-size option. Default: 5. Note: Some Metalinks regulate the number of servers to connect. aria2 strictly respects them.This means that if Metalink defines the maxconnec‐ tions attribute lower than N, then aria2 uses the value of maxconnections attribute instead of N.",
"stream-piece-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 be‐ haviour becauseestablishing 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.--enable-http-pipelining option may beusefulto reduce reconnection overhead. Please note that aria2 honors --min-split-size option, so it will be necessary to specify a reasonable value to --min-split-size option. If geom is given, at the beginning aria2 selects piece which has minimum index like inorder, but it exponen‐ tially 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",
"timeout" : "Set timeout in seconds. Default: 60",
"uri-selector" : "Specify URI selection algorithm. The possible values are inorder, feedback and adaptive.If inorder is given, URI is tried inthe order appearedin 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",
"server-stat-if" : "If adaptive is given, selects one of the best mirrors for the first and reserved connec‐ tions. For supplementary ones, it returns mirrors which has not been tested yet, and if each of them has already been tested, returns mir‐ rors which hasto be tested again. Otherwise, it doesn't select anymore mirrors. Like feedback, it uses a performance profile of servers. Default: feedback",
"server-stat-of" : "If adaptive is given, selects one of the best mirrors for the first and reserved connec‐ tions. For supplementary ones, it returns mirrors which has not been tested yet, and if each of them has already been tested, returns mir‐ rors which hasto be tested again. Otherwise, it doesn't select anymore mirrors. Like feedback, it uses a performance profile of servers. Default: feedback",
"ca-certificate" : "Use the certificate authorities in FILE to verify the peers. The certificate file must be in PEM format and can containmultiple CA cer‐ tificates. Use --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.",
"certificate" : "Use the client certificate in FILE. The certificate must be in PEM format. You may use --private-key option to specify the private key.",
"check-certificate" : "Verify the peer using certificates specified in --ca-certificate option.Default: true",
"http-accept-gzip" : "Send Accept: deflate, gzip request header and inflate response if remote server responds with Content-Encoding: gzip or Content-Encoding: deflate.Default: false. Note: Some server responds with Content-Encoding: gzip for files which itself is gzipped file. aria2 inflates them anyway because of the response header.",
"http-auth-challenge" : "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 username and password are embedded in URI, authorization header is always sent to the server regardless of this option. Default: false",
"http-no-cache" : "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 --header option. Default: false",
"http-user" : "Set HTTP user. This affects all URIs.",
"http-passwd" : "Set HTTP password. This affects all URIs.",
"http-proxy" : "Use this proxy server for HTTP.To erase previously defined proxy, use ''. See also --all-proxy option. This affects all URIs. The for‐ mat of PROXY is [http://][USER:PASSWORD@]HOST[:PORT]",
"http-proxy-passwd" : "Set password for --http-proxy option.",
"http-proxy-user" : "Set user for --http-proxy option.",
"https-proxy" : "Use this proxy server for HTTPS. To erase previously defined proxy, use ''. See also --all-proxy option.This affects all URIs.The format of PROXY is [http://][USER:PASSWORD@]HOST[:PORT]",
"https-proxy-passwd" : "Set password for --https-proxy option.",
"https-proxy-user" : "Set user for --https-proxy option.",
"private-key" : "Use theprivate key in FILE. The private key must be decrypted and in PEM format. The behavior when encrypted one is given is undefined. See also --certificate option.",
"referer" : "Set Referer. This affects all URIs. If * is given, each request URI is used as areferer. This may be useful whenused with",
"enable-http-keep-alive" : "Enable HTTP/1.1 persistent connection. Default: true",
"enable-http-pipelining" : "Enable HTTP/1.1 pipelining. Default: false. Note: In performance perspective, there is usually no advantage to enable this option.",
"header" : "Append HEADER to HTTP request header. You can use this option repeatedly to specify more than one header:",
"load-cookies" : "Load Cookies from FILE using the Firefox3 format (SQLite3), Chromium/Google Chrome (SQLite3) and the Mozilla/Firefox(1.x/2.x)/Netscape for‐ mat. Note: If aria2 is built without libsqlite3, then it doesn't support Firefox3 and Chromium/Google Chrome cookie format.",
"save-cookies" : "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",
"use-head" : "Use HEAD method for the first request to the HTTP server. Default: false",
"user-agent" : "Set user agent for HTTP(S) downloads. Default: aria2/$VERSION, $VERSION is replaced by package version.",
"ftp-user" : "Set FTP user. This affects all URIs. Default: anonymous",
"ftp-passwd" : "Set FTPpassword. 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-pasv" : "Use the passive mode in FTP. If false is given, the active mode will be used. Default: true",
"ftp-proxy" : "Use this proxy server for FTP. To erase previously defined proxy, use ''. See also --all-proxy option.This affects all URIs.The format of PROXY is [http://][USER:PASSWORD@]HOST[:PORT]",
"ftp-proxy-passwd" : "Set password for --ftp-proxy option.",
"ftp-proxy-user" : "Set user for --ftp-proxy option.",
"ftp-type" : "Set FTP transfer type. TYPE is either binary or ascii. Default: binary",
"ftp-reuse-connection" : "Reuse connection in FTP.Default: true",
"select-file" : "Set file to download by specifying its index. You can find the file index using the --show-files option. Multiple indexes can be specified by using ,, for example: 3,6. You can also use - to specify a range: 1-5. , and - can be used together: 1-5,8,9. When used with the-M option, index may vary depending on the query (see --metalink-* options). Note: In multi file torrent, the adjacent files specified by this option may also be downloaded. This is by design, not a bug.A single piece may include several files or part of files, and aria2 writes the piece to the appropriate files.",
"show-files" : "Print file listing of '.torrent', '.meta4' and '.metalink' file and exit. In case of '.torrent' file, additional information(infohash, piece length, etc) is also printed.",
"bt-enable-lpd" : "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-exclude-tracker" : "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 --bt-tracker option.",
"bt-external-ip" : "Specify the external IP address to report to a BitTorrent tracker. Although this function is named external, it can accept any kind of IP addresses. IPADDRESS must be a numeric IP address.",
"bt-hash-check-seed" : "If true is given, after hash check using --check-integrity option and file is complete, continue to seed file. If you want to check file and downloadit only when it is damaged or incomplete, set this option to false. This option has effect only on BitTorrent download. Default: true",
"bt-lpd-interface" : "Use given interface for Local Peer Discovery. If this option is not specified, the default interface is chosen. You canspecify interface name and IP address. Possible Values: interface, IP addres",
"bt-max-open-files" : "Specify maximum number of files to open in each BitTorrent download. Default: 100",
"bt-max-peers" : "Specify the maximum number of peers per torrent.0 means unlimited. See also --bt-request-peer-speed-limit option. Default: 55",
"bt-metadata-only" : "Downloadmetadata only. The file(s) described in metadata will not be downloaded. This option has effect only when BitTorrent Magnet URI is used. See also --bt-save-metadata option. Default: false",
"bt-min-crypto-level" : "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-prioritize-piece" : "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-remove-unselected-file" : "Removes the unselected files when download is completed in BitTorrent. To select files, use --select-file option. If it is notused, 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-require-crypto" : "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-request-peer-speed-limit" : "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-save-metadata" : "Save metadata as '.torrent' file. This option has effect only when BitTorrent Magnet URI is used. The filename is hex encodedinfo 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 --bt-metadata-only option. Default: false",
"bt-seed-unverified" : "Seed previously downloaded files without verifying piece hashes.Default: false",
"bt-stop-timeout" : "Stop BitTorrent download if download speed is 0 in consecutive SEC seconds. If 0 is given, this feature is disabled. Default: 0",
"bt-tracker" : "Comma separated list of additional BitTorrent tracker's announce URI. These URIs are not affected by --bt-exclude-tracker option because they are added after URIs in --bt-exclude-tracker option are removed.",
"bt-tracker-connect-timeout" : "Set the connect timeout in seconds to establish connection to tracker. After the connection is established, this option makes no effect and --bt-tracker-timeout option is used instead. Default: 60",
"bt-tracker-interval" : "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-timeout" : "Set timeout in seconds. Default: 60",
"dht-entry-point" : "Set host and port as an entry point to IPv4 DHT network.",
"dht-entry-point6" : "Set host and port as an entry point to IPv6 DHT network.",
"dht-file-path" : "Change the IPv4 DHT routing table file to PATH. Default: $HOME/.aria2/dht.dat",
"dht-file-path6" : " Change the IPv6 DHT routing table file to PATH. Default: $HOME/.aria2/dht6.dat",
"dht-listen-addr6" : "Specify address to bind socket for IPv6 DHT. It should be a global unicast IPv6 address of the host.",
"dht-listen-port" : "Set UDP listening port used by DHT(IPv4, IPv6) and UDP tracker. Multiple ports can be specified by using ,, forexample: 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-message-timeout" : "Set timeout in seconds. Default: 10",
"enable-dht" : "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-dht6" : "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 --dht-listen-port option to specify port number to listen on. See also --dht-listen-addr6 option.",
"enable-peer-exchange" : "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",
"follow-torrent" : "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 action mentioned above is not taken.Default: true",
"index-out" : "Set file path for file with index=INDEX. You can find the file index using the --show-files option. PATH is a relative path to the path specified in --dir option. You can use this option multiple times. Using this option, you can specify the output filenames of BitTorrent downloads.",
"listen-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: 6881-6889,6999. Default: 6881-6999 Note: Make sure that the specified ports are open for incoming TCP traffic.",
"max-overall-upload-limit" : "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. Default: 0",
"max-upload-limit" : "Set max upload speed per each torrent in bytes/sec. 0 means unrestricted. You can append K or M (1K = 1024, 1M = 1024K). Tolimit the overall upload speed, use --max-overall-upload-limit option. Default: 0",
"peer-id-prefix" : "Specify the prefix ofpeer 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: aria2/$VERSION-, $VERSIONis replaced by package version.",
"seed-ratio" : "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 --seed-time option is specified along with this option, seeding ends when at least one of the conditions is satisfied. Default: 1.0",
"seed-time" : "Specify seeding time in minutes. Also see the --seed-ratio option. Note: Specifying --seed-time=0 disables seeding after download completed.",
"torrent-file" : "The path to the '.torrent' file.You are not required to use this option because you can specify '.torrent' files without --torrent-file.",
"follow-metalink" : "If trueor mem is specified, when a file whose suffix is .meta4 or .metalink or content type of application/metalink4+xml or applica‐ tion/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 action mentioned above is not taken. Default: true",
"metalink-base-uri" : "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-file" : "The file path to '.meta4' and '.metalink' file. Reads input from stdin when - is specified. You are not required to use this option because you can specify '.metalink' files without --metalink-file.",
"metalink-language" : "The language of the file to download.",
"metalink-location" : "The location of the preferred server. A comma-delimited list of locations is acceptable, for example, jp,us.",
"metalink-os" : "The operating system of the file to download.",
"metalink-version" : "The version of the file to download.",
"metalink-preferred-protocol" : "Specify preferred protocol. The possible values are http, https, ftp and none. Specify none to disable this feature. Default: none",
"metalink-enable-unique-protocol" : "If true is given and several protocols are available for a mirror in ametalink file, aria2uses one of them. Use --metalink-preferred-protocol option to specify the preference of protocol. Default: true",
"enable-rpc" : "Enable JSON-RPC/XML-RPC server. It is strongly recommended to set username and password using --rpc-user and --rpc-passwd option. See also --rpc-listen-port option. Default: false",
"pause" : "Pause download after added. This option is effective only when --enable-rpc=true is given. Default: false",
"rpc-allow-origin-all" : "Add Access-Control-Allow-Origin header field with value * to the RPC response. Default: false",
"rpc-certificate" : "Use the certificate in FILE for RPC server. The certificate must be in PEM format. Use --rpc-private-key option to specify the private key. Use --rpc-secure option to enable encryption.",
"rpc-listen-all" : "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-port" : "Specify a port number for JSON-RPC/XML-RPC server to listen to. Possible Values: 1024 -65535 Default: 6800",
"rpc-max-request-size" : "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-passwd" : "Set JSON-RPC/XML-RPC password.",
"rpc-private-key" : "Use the private key in FILE for RPC server. The private key must be decrypted and in PEM format. Use --rpc-secure option to enable encryp‐ tion. See also --rpc-certificate option.",
"rpc-save-upload-metadata" : "Save the uploaded torrent or metalink metadata in the directory specified by --dir option. The filename consists of SHA-1 hash hex string of metadataplus extension. For torrent, the extension is '.torrent'. For metalink, it is '.meta4'. If false is given to this option, the downloads added by aria2.addTorrent() or aria2.addMetalink() will not be saved by --save-session option. Default: false",
"rpc-secure" : "RPC transport will be encrypted by SSL/TLS. The RPC clients must use https scheme to access theserver. For WebSocket client, use wss scheme. Use --rpc-certificate and --rpc-private-key options to specify the server certificate and private key.",
"rpc-user" : "Set JSON-RPC/XML-RPC user.",
"allow-overwrite" : "Restart download from scratch if the corresponding control file doesn't exist. See also --auto-file-renaming option. Default: false",
"allow-piece-length-change" : "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",
"always-resume" : "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. Default: true",
"async-dns" : "Enable asynchronous DNS.Default: true",
"async-dns-server" : "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 permis‐ sion to create it.",
"auto-file-renaming" : "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 num‐ ber(1..9999) appended. Default: true",
"auto-save-interval" : "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. The possible values are between 0 to 600. Default: 60",
"conditional-get" : "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, thisoptionwill 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 filename(see --out option) or filename part in URI if --out is not specified. To overwrite existing file, --allow-overwriteis required. Default: false",
"conf-path" : "Change the configuration file path to PATH. Default: $HOME/.aria2/aria2.conf",
"console-log-level" : "Set log level to output to console. LEVEL is either debug, info, notice, warn or error.Default: notice",
"daemon" : "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",
"deferred-input" : "If true is given, aria2 does not read all URIs and options from file specified by --input-file 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. Default: false",
"disk-cache" : "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). Default: 0",
"download-result" : "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. Default: default",
"enable-mmap" : "Map files into memory. This option may not work if the file space is not pre-allocated. See --file-allocation.",
"event-poll" : "Specify the method for polling events. The possible values are epoll, kqueue, port, poll and select. For eachepoll,kqueue, port and poll, it is available if system supports it. epoll is available on recent Linux. kqueue is available on various *BSD systems including Mac OS X. port is available on Open Solaris. The default value may vary depending on the system you use.",
"file-allocation" : "Specify file allocation method. none doesn't pre-allocate file space. prealloc pre-allocates file space before downloadbegins. This may take some timedepending 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 fallocwith 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(3) function. trunc uses ftruncate(2) system call or platform-specific counterpart to truncate a file to a specified length. Possible Values: none, prealloc, trunc, falloc Default: prealloc",
"force-save" : "Save download with --save-session option even if the download is completed or removed. This may be useful to save BitTorrent seeding which is recognized as completed state. Default: false",
"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.",
"hash-check-only" : "If true is given, after hash check using --check-integrity option, abort download whether or not download is complete. Default: false",
"human-readable" : "Print sizes and speed in human readable format (e.g., 1.2Ki, 3.4Mi) in the console readout. Default: true",
"interface" : "Bind sockets to given interface. You can specify interface name, IP address and hostname. Possible Values: interface, IP address, hostname Note: If an interface has multiple addresses, it is highly recommended to specify IP address explicitly. See also --disable-ipv6. If your system doesn't have getifaddrs(3), this option doesn't accept interface name.",
"max-download-result" : "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. Default: 1000",
"max-resume-failure-tries" : "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. Default: 0",
"log-level" : "Set log level to output.LEVEL is either debug, info, notice, warn or error. Default: debug",
"on-bt-download-complete" : "For BitTorrent, a command specified in --on-download-complete is called after download completed and seeding is over. On the other hand, this option set the command to be executed after download completed but before seeding. See Event Hook for more details about COMMAND. Possible Values: /path/to/command",
"on-download-complete" : "Set the command to be executed after download completed.See See Event Hook for more details about COMMAND. See also--on-download-stop option. Possible Values: /path/to/command",
"on-download-error" : "Set thecommand to be executed after download aborted due to error. See Event Hook for more details about COMMAND. See also --on-download-stop option. Possible Values: /path/to/command",
"on-download-pause" : "Set the command to be executed after download was paused. See Event Hook for more details about COMMAND. Possible Values: /path/to/command",
"on-download-start" : "Set the command to be executed after download got started. See Event Hook for more details about COMMAND. Possible Values: /path/to/com‐ mand",
"on-download-stop" : "Set thecommand 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 Event Hook for more details about COMMAND. Possible Values: /path/to/command",
"piece-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.Default: 1M Note: The possible usecase of --piece-length option is change the request range in one HTTP pipelined request. To enable HTTP pipelining use",
"show-console-readout" : "Show console readout. Default: true",
"summary-interval" : "Set interval in seconds to output download progress summary. Setting 0 suppresses the output. Default: 60 Note: In multi file torrent downloads, the files adjacent forward to the specified files are also allocated if they share the same piece.",
"force-sequential" : "Fetch URIs in the command-line sequentially and download each URI in a separate session, like the usual command-line download utilities. Default: false",
"max-overall-download-limit" : "Set max overall download speed in bytes/sec. 0 means unrestricted. You can append K or M (1K = 1024, 1M = 1024K). To limit the download speed per download, use --max-download-limit option. Default: 0",
"max-download-limit" : "Set maxdownload speed per each download in bytes/sec. 0 means unrestricted. You can append K or M (1K = 1024, 1M = 1024K). To limit the overall download speed, use --max-overall-download-limit option.Default: 0",
"no-conf" : "Disable loading aria2.conf file.",
"no-file-allocation-limit" : "No file allocation is made for files whose size is smaller than SIZE. You can append K or M (1K = 1024, 1M = 1024K). Default: 5M",
"parameterized-uri" : "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 sec‐ ond example above, -Z option is required. Default: false",
"quiet" : "Make aria2 quiet (no console output). Default: false",
"realtime-chunk-checksum" : "Validate chunk of data by calculating checksum while downloading a file if chunk checksums are provided.Default: true",
"remove-control-file" : "Remove control file before download. Using with --allow-overwrite=true, download always starts from scratch. This will be usefulfor users behind proxy server which disables resume.",
"save-session" : "Save error/unfinished downloads to FILE on exit. You can pass this output file to aria2c with --input-file option on restart. If you like the output to be gzipped append a .gz extension to the file name. Please note that downloadsadded by aria2.addTorrent() and aria2.addMetalink() RPCmethodand whose metadata could not be saved as a file are not saved.Downloads removed using aria2.remove() and aria2.forceRemove() will not be saved. GID is also saved with gid, but there are some restrictions, see below. Note: Normally, GID of the download itself is saved. But some downloads use metadata (e.g., BitTorrent and Metalink).",
"save-session-interval" : "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. Default: 0",
"stop" : "Stop application after SEC seconds has passed. If 0 is given, this feature is disabled.Default: 0",
"stop-with-process" : "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.",
"truncate-console-readout" : "Truncate console readout to fit in a single line. Default: true",
"version" : "Print the version number, copyright and the configuration information and exit."
}