usage_text.h 82 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092
  1. /* <!-- copyright */
  2. /*
  3. * aria2 - The high speed download utility
  4. *
  5. * Copyright (C) 2006 Tatsuhiro Tsujikawa
  6. *
  7. * This program is free software; you can redistribute it and/or modify
  8. * it under the terms of the GNU General Public License as published by
  9. * the Free Software Foundation; either version 2 of the License, or
  10. * (at your option) any later version.
  11. *
  12. * This program is distributed in the hope that it will be useful,
  13. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  15. * GNU General Public License for more details.
  16. *
  17. * You should have received a copy of the GNU General Public License
  18. * along with this program; if not, write to the Free Software
  19. * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  20. *
  21. * In addition, as a special exception, the copyright holders give
  22. * permission to link the code of portions of this program with the
  23. * OpenSSL library under certain conditions as described in each
  24. * individual source file, and distribute linked combinations
  25. * including the two.
  26. * You must obey the GNU General Public License in all respects
  27. * for all of the code used other than OpenSSL. If you modify
  28. * file(s) with this exception, you may extend this exception to your
  29. * version of the file(s), but you are not obligated to do so. If you
  30. * do not wish to do so, delete this exception statement from your
  31. * version. If you delete this exception statement from all source
  32. * files in the program, then also delete it here.
  33. */
  34. /* copyright --> */
  35. // clang-format off
  36. #define TEXT_DIR \
  37. _(" -d, --dir=DIR The directory to store the downloaded file.")
  38. #define TEXT_OUT \
  39. _(" -o, --out=FILE The file name of the downloaded file. When \n" \
  40. " the -Z option is used, this option will be \n" \
  41. " ignored.")
  42. #define TEXT_LOG \
  43. _(" -l, --log=LOG The file name of the log file. If '-' is\n" \
  44. " specified, log is written to stdout.")
  45. #define TEXT_DAEMON \
  46. _(" -D, --daemon[=true|false] Run as daemon. The current working directory will\n" \
  47. " be changed to \"/\" and standard input, standard\n" \
  48. " output and standard error will be redirected to\n" \
  49. " \"/dev/null\".")
  50. #define TEXT_SPLIT \
  51. _(" -s, --split=N Download a file using N connections. If more\n" \
  52. " than N URIs are given, first N URIs are used and\n" \
  53. " remaining URLs are used for backup. If less than\n" \
  54. " N URIs are given, those URLs are used more than\n" \
  55. " once so that N connections total are made\n" \
  56. " simultaneously. The number of connections to the\n" \
  57. " same host is restricted by the \n" \
  58. " --max-connection-per-server option. See also the\n" \
  59. " --min-split-size option.")
  60. #define TEXT_RETRY_WAIT \
  61. _(" --retry-wait=SEC Set the seconds to wait between retries. \n" \
  62. " With SEC > 0, aria2 will retry download when the\n" \
  63. " HTTP server returns 503 response.")
  64. #define TEXT_TIMEOUT \
  65. _(" -t, --timeout=SEC Set timeout in seconds.")
  66. #define TEXT_MAX_TRIES \
  67. _(" -m, --max-tries=N Set number of tries. 0 means unlimited.")
  68. #define TEXT_HTTP_PROXY \
  69. _(" --http-proxy=PROXY Use a proxy server for HTTP. To override a\n"\
  70. " previously defined proxy, use \"\".\n" \
  71. " See also the --all-proxy option.\n" \
  72. " This affects all http downloads.")
  73. #define TEXT_HTTPS_PROXY \
  74. _(" --https-proxy=PROXY Use a proxy server for HTTPS. To override a \n" \
  75. " previously defined proxy, use \"\".\n" \
  76. " See also the --all-proxy option.\n" \
  77. " This affects all https downloads.")
  78. #define TEXT_FTP_PROXY \
  79. _(" --ftp-proxy=PROXY Use a proxy server for FTP. To override a \n" \
  80. " previously defined proxy, use \"\".\n" \
  81. " See also the --all-proxy option.\n" \
  82. " This affects all ftp downloads.")
  83. #define TEXT_ALL_PROXY \
  84. _(" --all-proxy=PROXY Use a proxy server for all protocols. To override\n" \
  85. " a previously defined proxy, use \"\".\n" \
  86. " You also can override this setting and specify a\n" \
  87. " proxy server for a particular protocol using the\n" \
  88. " --http-proxy, --https-proxy and --ftp-proxy\n" \
  89. " options.\n" \
  90. " This affects all downloads.")
  91. #define TEXT_HTTP_USER \
  92. _(" --http-user=USER Set HTTP user. This affects all URLs.")
  93. #define TEXT_HTTP_PASSWD \
  94. _(" --http-passwd=PASSWD Set HTTP password. This affects all URLs.")
  95. #define TEXT_PROXY_METHOD \
  96. _(" --proxy-method=METHOD Set the method to use in proxy request.")
  97. #define TEXT_REFERER \
  98. _(" --referer=REFERER Set an http referrrer (Referer). This affects\n" \
  99. " all http/https downloads. If \"*\" is given,\n" \
  100. " the download URI is also used as the referrer.\n" \
  101. " This may be useful when used together with\n" \
  102. " the -P option.")
  103. #define TEXT_FTP_USER \
  104. _(" --ftp-user=USER Set FTP user. This affects all URLs.")
  105. #define TEXT_FTP_PASSWD \
  106. _(" --ftp-passwd=PASSWD Set FTP password. This affects all URLs.")
  107. #define TEXT_FTP_TYPE \
  108. _(" --ftp-type=TYPE Set FTP transfer type.")
  109. #define TEXT_FTP_PASV \
  110. _(" -p, --ftp-pasv[=true|false] Use the passive mode in FTP. If false is given,\n" \
  111. " the active mode will be used.")
  112. #define TEXT_LOWEST_SPEED_LIMIT \
  113. _(" --lowest-speed-limit=SPEED Close connection if download speed is lower than\n" \
  114. " or equal to this value(bytes per sec).\n" \
  115. " 0 means aria2 does not have a lowest speed limit.\n" \
  116. " You can append K or M(1K = 1024, 1M = 1024K).\n" \
  117. " This option does not affect BitTorrent downloads.")
  118. #define TEXT_MAX_OVERALL_DOWNLOAD_LIMIT \
  119. _(" --max-overall-download-limit=SPEED Set max overall download speed in bytes/sec.\n" \
  120. " 0 means unrestricted.\n" \
  121. " You can append K or M(1K = 1024, 1M = 1024K).\n" \
  122. " To limit the download speed per download, use\n" \
  123. " --max-download-limit option.")
  124. #define TEXT_MAX_DOWNLOAD_LIMIT \
  125. _(" --max-download-limit=SPEED Set max download speed per each download in\n" \
  126. " bytes/sec. 0 means unrestricted.\n" \
  127. " You can append K or M(1K = 1024, 1M = 1024K).\n" \
  128. " To limit the overall download speed, use\n" \
  129. " --max-overall-download-limit option.")
  130. #define TEXT_FILE_ALLOCATION \
  131. _(" --file-allocation=METHOD Specify file allocation method.\n" \
  132. " 'none' doesn't pre-allocate file space. 'prealloc'\n" \
  133. " pre-allocates file space before download begins.\n" \
  134. " This may take some time depending on the size of\n" \
  135. " the file.\n" \
  136. " If you are using newer file systems such as ext4\n" \
  137. " (with extents support), btrfs, xfs or NTFS\n" \
  138. " (MinGW build only), 'falloc' is your best\n" \
  139. " choice. It allocates large(few GiB) files\n" \
  140. " almost instantly. Don't use 'falloc' with legacy\n" \
  141. " file systems such as ext3 and FAT32 because it\n" \
  142. " takes almost same time as 'prealloc' and it\n" \
  143. " blocks aria2 entirely until allocation finishes.\n" \
  144. " 'falloc' may not be available if your system\n" \
  145. " doesn't have posix_fallocate() function.\n" \
  146. " 'trunc' uses ftruncate() system call or\n" \
  147. " platform-specific counterpart to truncate a file\n" \
  148. " to a specified length.")
  149. #define TEXT_NO_FILE_ALLOCATION_LIMIT \
  150. _(" --no-file-allocation-limit=SIZE No file allocation is made for files whose\n" \
  151. " size is smaller than SIZE.\n" \
  152. " You can append K or M(1K = 1024, 1M = 1024K).")
  153. #define TEXT_ENABLE_DIRECT_IO \
  154. _(" --enable-direct-io[=true|false] Enable directI/O, which lowers cpu usage while\n" \
  155. " allocating files.\n" \
  156. " Turn off if you encounter any error")
  157. #define TEXT_ALLOW_OVERWRITE \
  158. _(" --allow-overwrite[=true|false] Restart download from scratch if the\n" \
  159. " corresponding control file doesn't exist. See\n" \
  160. " also --auto-file-renaming option.")
  161. #define TEXT_ALLOW_PIECE_LENGTH_CHANGE \
  162. _(" --allow-piece-length-change[=true|false] If false is given, aria2 aborts\n" \
  163. " download when a piece length is different from\n" \
  164. " one in a control file. If true is given, you can\n" \
  165. " proceed but some download progress will be lost.")
  166. #define TEXT_FORCE_SEQUENTIAL \
  167. _(" -Z, --force-sequential[=true|false] Fetch URIs in the command-line sequentially\n" \
  168. " and download each URI in a separate session, like\n" \
  169. " the usual command-line download utilities.")
  170. #define TEXT_AUTO_FILE_RENAMING \
  171. _(" --auto-file-renaming[=true|false] Rename file name if the same file already\n" \
  172. " exists. This option works only in http(s)/ftp\n" \
  173. " download.\n" \
  174. " The new file name has a dot and a number(1..9999)\n" \
  175. " appended.")
  176. #define TEXT_PARAMETERIZED_URI \
  177. _(" -P, --parameterized-uri[=true|false] Enable parameterized URI support.\n" \
  178. " You can specify set of parts:\n" \
  179. " http://{sv1,sv2,sv3}/foo.iso\n" \
  180. " Also you can specify numeric sequences with step\n" \
  181. " counter:\n" \
  182. " http://host/image[000-100:2].img\n" \
  183. " A step counter can be omitted.\n" \
  184. " If all URIs do not point to the same file, such\n" \
  185. " as the second example above, -Z option is\n" \
  186. " required.")
  187. #define TEXT_ENABLE_HTTP_KEEP_ALIVE \
  188. _(" --enable-http-keep-alive[=true|false] Enable HTTP/1.1 persistent connection.")
  189. #define TEXT_ENABLE_HTTP_PIPELINING \
  190. _(" --enable-http-pipelining[=true|false] Enable HTTP/1.1 pipelining.")
  191. #define TEXT_CHECK_INTEGRITY \
  192. _(" -V, --check-integrity[=true|false] Check file integrity by validating piece\n" \
  193. " hashes or a hash of entire file. This option has\n" \
  194. " effect only in BitTorrent, Metalink downloads\n" \
  195. " with checksums or HTTP(S)/FTP downloads with\n" \
  196. " --checksum option. If piece hashes are provided,\n" \
  197. " this option can detect damaged portions of a file\n" \
  198. " and re-download them. If a hash of entire file is\n" \
  199. " provided, hash check is only done when file has\n" \
  200. " been already download. This is determined by file\n" \
  201. " length. If hash check fails, file is\n" \
  202. " re-downloaded from scratch. If both piece hashes\n" \
  203. " and a hash of entire file are provided, only\n" \
  204. " piece hashes are used.")
  205. #define TEXT_BT_HASH_CHECK_SEED \
  206. _(" --bt-hash-check-seed[=true|false] If true is given, after hash check using\n" \
  207. " --check-integrity option and file is complete,\n" \
  208. " continue to seed file. If you want to check file\n" \
  209. " and download it only when it is damaged or\n" \
  210. " incomplete, set this option to false.\n" \
  211. " This option has effect only on BitTorrent\n" \
  212. " download.")
  213. #define TEXT_REALTIME_CHUNK_CHECKSUM \
  214. _(" --realtime-chunk-checksum[=true|false] Validate chunk of data by calculating\n" \
  215. " checksum while downloading a file if chunk\n" \
  216. " checksums are provided.")
  217. #define TEXT_CONTINUE \
  218. _(" -c, --continue[=true|false] Continue downloading a partially downloaded\n" \
  219. " file. Use this option to resume a download\n" \
  220. " started by a web browser or another program\n" \
  221. " which downloads files sequentially from the\n" \
  222. " beginning. Currently this option is only\n" \
  223. " applicable to http(s)/ftp downloads.")
  224. #define TEXT_USER_AGENT \
  225. _(" -U, --user-agent=USER_AGENT Set user agent for http(s) downloads.")
  226. #define TEXT_NO_NETRC \
  227. _(" -n, --no-netrc[=true|false] Disables netrc support.")
  228. #define TEXT_NETRC_PATH \
  229. _(" --netrc-path=FILE Specify the path to the netrc file.")
  230. #define TEXT_INPUT_FILE \
  231. _(" -i, --input-file=FILE Downloads URIs found in FILE. You can specify\n" \
  232. " multiple URIs for a single entity: separate\n" \
  233. " URIs on a single line using the TAB character.\n" \
  234. " Reads input from stdin when '-' is specified.\n" \
  235. " Additionally, options can be specified after each\n" \
  236. " line of URI. This optional line must start with\n" \
  237. " one or more white spaces and have one option per\n" \
  238. " single line. See INPUT FILE section of man page\n" \
  239. " for details. See also --deferred-input option.")
  240. #define TEXT_MAX_CONCURRENT_DOWNLOADS \
  241. _(" -j, --max-concurrent-downloads=N Set maximum number of parallel downloads for\n" \
  242. " every static (HTTP/FTP) URL, torrent and metalink.\n" \
  243. " See also --split and --optimize-concurrent-downloads options.")
  244. #define TEXT_OPTIMIZE_CONCURRENT_DOWNLOADS\
  245. _(" --optimize-concurrent-downloads[=true|false|A:B] Optimizes the number of\n" \
  246. " concurrent downloads according to the bandwidth\n" \
  247. " available. aria2 uses the download speed observed\n" \
  248. " in the previous downloads to adapt the number of\n" \
  249. " downloads launched in parallel according to the\n" \
  250. " rule N = A + B Log10(speed in Mbps). The\n" \
  251. " coefficients A and B can be customized in the\n" \
  252. " option arguments with A and B separated by a\n" \
  253. " colon. The default values (A=5,B=25) lead to\n" \
  254. " using typically 5 parallel downloads on 1Mbps\n" \
  255. " networks and above 50 on 100Mbps networks. The\n" \
  256. " number of parallel downloads remains constrained\n" \
  257. " under the maximum defined by the\n" \
  258. " max-concurrent-downloads parameter.")
  259. #define TEXT_LOAD_COOKIES \
  260. _(" --load-cookies=FILE Load Cookies from FILE using the Firefox3 format\n" \
  261. " and Mozilla/Firefox(1.x/2.x)/Netscape format.")
  262. #define TEXT_SAVE_COOKIES \
  263. _(" --save-cookies=FILE Save Cookies to FILE in Mozilla/Firefox(1.x/2.x)/\n" \
  264. " Netscape format. If FILE already exists, it is\n" \
  265. " overwritten. Session Cookies are also saved and\n" \
  266. " their expiry values are treated as 0.")
  267. #define TEXT_SHOW_FILES \
  268. _(" -S, --show-files[=true|false] Print file listing of .torrent, .meta4 and\n" \
  269. " .metalink file and exit. More detailed\n" \
  270. " information will be listed in case of torrent\n" \
  271. " file.")
  272. #define TEXT_SELECT_FILE \
  273. _(" --select-file=INDEX... Set file to download by specifying its index.\n" \
  274. " You can find the file index using the\n" \
  275. " --show-files option. Multiple indexes can be\n" \
  276. " specified by using ',', for example: \"3,6\".\n" \
  277. " You can also use '-' to specify a range: \"1-5\".\n" \
  278. " ',' and '-' can be used together.\n" \
  279. " When used with the -M option, index may vary\n" \
  280. " depending on the query(see --metalink-* options).")
  281. #define TEXT_TORRENT_FILE \
  282. _(" -T, --torrent-file=TORRENT_FILE The path to the .torrent file.")
  283. #define TEXT_FOLLOW_TORRENT \
  284. _(" --follow-torrent=true|false|mem If true or mem is specified, when a file\n" \
  285. " whose suffix is .torrent or content type is\n" \
  286. " application/x-bittorrent is downloaded, aria2\n" \
  287. " parses it as a torrent file and downloads files\n" \
  288. " mentioned in it.\n" \
  289. " If mem is specified, a torrent file is not\n" \
  290. " written to the disk, but is just kept in memory.\n" \
  291. " If false is specified, the .torrent file is\n" \
  292. " downloaded to the disk, but is not parsed as a\n" \
  293. " torrent and its contents are not downloaded.")
  294. #define TEXT_LISTEN_PORT \
  295. _(" --listen-port=PORT... Set TCP port number for BitTorrent downloads.\n" \
  296. " Multiple ports can be specified by using ',',\n" \
  297. " for example: \"6881,6885\". You can also use '-'\n" \
  298. " to specify a range: \"6881-6999\". ',' and '-' can\n" \
  299. " be used together.")
  300. #define TEXT_MAX_OVERALL_UPLOAD_LIMIT \
  301. _(" --max-overall-upload-limit=SPEED Set max overall upload speed in bytes/sec.\n" \
  302. " 0 means unrestricted.\n" \
  303. " You can append K or M(1K = 1024, 1M = 1024K).\n" \
  304. " To limit the upload speed per torrent, use\n" \
  305. " --max-upload-limit option.")
  306. #define TEXT_MAX_UPLOAD_LIMIT \
  307. _(" -u, --max-upload-limit=SPEED Set max upload speed per each torrent in\n" \
  308. " bytes/sec. 0 means unrestricted.\n" \
  309. " You can append K or M(1K = 1024, 1M = 1024K).\n" \
  310. " To limit the overall upload speed, use\n" \
  311. " --max-overall-upload-limit option.")
  312. #define TEXT_SEED_TIME \
  313. _(" --seed-time=MINUTES Specify seeding time in minutes. Also see the\n" \
  314. " --seed-ratio option.")
  315. #define TEXT_SEED_RATIO \
  316. _(" --seed-ratio=RATIO Specify share ratio. Seed completed torrents\n" \
  317. " until share ratio reaches RATIO.\n" \
  318. " You are strongly encouraged to specify equals or\n" \
  319. " more than 1.0 here. Specify 0.0 if you intend to\n" \
  320. " do seeding regardless of share ratio.\n" \
  321. " If --seed-time option is specified along with\n" \
  322. " this option, seeding ends when at least one of\n" \
  323. " the conditions is satisfied.")
  324. #define TEXT_PEER_ID_PREFIX \
  325. _(" --peer-id-prefix=PEER_ID_PREFIX Specify the prefix of peer ID. The peer ID in\n" \
  326. " BitTorrent is 20 byte length. If more than 20\n" \
  327. " bytes are specified, only first 20 bytes are\n" \
  328. " used. If less than 20 bytes are specified, random\n" \
  329. " byte data are added to make its length 20 bytes.")
  330. #define TEXT_ENABLE_PEER_EXCHANGE \
  331. _(" --enable-peer-exchange[=true|false] Enable Peer Exchange extension.")
  332. #define TEXT_ENABLE_DHT \
  333. _(" --enable-dht[=true|false] Enable IPv4 DHT functionality. It also enables\n" \
  334. " UDP tracker support. If a private flag is set\n" \
  335. " in a torrent, aria2 doesn't use DHT for that\n" \
  336. " download even if ``true`` is given.")
  337. #define TEXT_DHT_LISTEN_PORT \
  338. _(" --dht-listen-port=PORT... Set UDP listening port used by DHT(IPv4, IPv6)\n" \
  339. " and UDP tracker. Multiple ports can be specified\n" \
  340. " by using ',', for example: \"6881,6885\". You can\n" \
  341. " also use '-' to specify a range: \"6881-6999\".\n" \
  342. " ',' and '-' can be used together.")
  343. #define TEXT_DHT_ENTRY_POINT \
  344. _(" --dht-entry-point=HOST:PORT Set host and port as an entry point to IPv4 DHT\n" \
  345. " network.")
  346. #define TEXT_DHT_FILE_PATH \
  347. _(" --dht-file-path=PATH Change the IPv4 DHT routing table file to PATH.")
  348. #define TEXT_BT_MIN_CRYPTO_LEVEL \
  349. _(" --bt-min-crypto-level=plain|arc4 Set minimum level of encryption method.\n" \
  350. " If several encryption methods are provided by a\n" \
  351. " peer, aria2 chooses the lowest one which satisfies\n" \
  352. " the given level.")
  353. #define TEXT_BT_REQUIRE_CRYPTO \
  354. _(" --bt-require-crypto[=true|false] If true is given, aria2 doesn't accept and\n" \
  355. " establish connection with legacy BitTorrent\n" \
  356. " handshake. Thus aria2 always uses Obfuscation\n" \
  357. " handshake.")
  358. #define TEXT_BT_REQUEST_PEER_SPEED_LIMIT \
  359. _(" --bt-request-peer-speed-limit=SPEED If the whole download speed of every\n" \
  360. " torrent is lower than SPEED, aria2 temporarily\n" \
  361. " increases the number of peers to try for more\n" \
  362. " download speed. Configuring this option with your\n" \
  363. " preferred download speed can increase your\n" \
  364. " download speed in some cases.\n" \
  365. " You can append K or M(1K = 1024, 1M = 1024K).")
  366. #define TEXT_BT_MAX_OPEN_FILES \
  367. _(" --bt-max-open-files=NUM Specify maximum number of files to open in\n" \
  368. " multi-file BitTorrent/Metalink downloads\n" \
  369. " globally.")
  370. #define TEXT_BT_SEED_UNVERIFIED \
  371. _(" --bt-seed-unverified[=true|false] Seed previously downloaded files without\n" \
  372. " verifying piece hashes.")
  373. #define TEXT_BT_MAX_PEERS \
  374. _(" --bt-max-peers=NUM Specify the maximum number of peers per torrent.\n" \
  375. " 0 means unlimited.\n" \
  376. " See also --bt-request-peer-speed-limit option.")
  377. #define TEXT_METALINK_FILE \
  378. _(" -M, --metalink-file=METALINK_FILE The file path to the .meta4 and .metalink\n" \
  379. " file. Reads input from stdin when '-' is\n" \
  380. " specified.")
  381. #define TEXT_METALINK_SERVERS \
  382. _(" -C, --metalink-servers=NUM_SERVERS The number of servers to connect to\n" \
  383. " simultaneously. Some Metalinks regulate the\n" \
  384. " number of servers to connect. aria2 strictly\n" \
  385. " respects them. This means that if Metalink defines\n" \
  386. " the maxconnections attribute lower than\n" \
  387. " NUM_SERVERS, then aria2 uses the value of\n" \
  388. " maxconnections attribute instead of NUM_SERVERS.\n" \
  389. " See also -s and -j options.")
  390. #define TEXT_METALINK_VERSION \
  391. _(" --metalink-version=VERSION The version of the file to download.")
  392. #define TEXT_METALINK_LANGUAGE \
  393. _(" --metalink-language=LANGUAGE The language of the file to download.")
  394. #define TEXT_METALINK_OS \
  395. _(" --metalink-os=OS The operating system of the file to download.")
  396. #define TEXT_METALINK_LOCATION \
  397. _(" --metalink-location=LOCATION[,...] The location of the preferred server.\n" \
  398. " A comma-delimited list of locations is\n" \
  399. " acceptable.")
  400. #define TEXT_METALINK_PREFERRED_PROTOCOL \
  401. _(" --metalink-preferred-protocol=PROTO Specify preferred protocol. Specify 'none'\n" \
  402. " if you don't have any preferred protocol.")
  403. #define TEXT_FOLLOW_METALINK \
  404. _(" --follow-metalink=true|false|mem If true or mem is specified, when a file\n" \
  405. " whose suffix is .meta4 or .metalink, or content\n" \
  406. " type of application/metalink4+xml or\n" \
  407. " application/metalink+xml is downloaded, aria2\n" \
  408. " parses it as a metalink file and downloads files\n" \
  409. " mentioned in it.\n" \
  410. " If mem is specified, a metalink file is not\n" \
  411. " written to the disk, but is just kept in memory.\n" \
  412. " If false is specified, the .metalink file is\n" \
  413. " downloaded to the disk, but is not parsed as a\n" \
  414. " metalink file and its contents are not\n" \
  415. " downloaded.")
  416. #define TEXT_METALINK_ENABLE_UNIQUE_PROTOCOL \
  417. _(" --metalink-enable-unique-protocol[=true|false] If true is given and several\n" \
  418. " protocols are available for a mirror in a metalink\n" \
  419. " file, aria2 uses one of them.\n" \
  420. " Use --metalink-preferred-protocol option to\n" \
  421. " specify the preference of protocol.")
  422. #define TEXT_VERSION \
  423. _(" -v, --version Print the version number and exit.")
  424. #define TEXT_HELP \
  425. _(" -h, --help[=TAG|KEYWORD] Print usage and exit.\n" \
  426. " The help messages are classified with tags. A tag\n" \
  427. " starts with \"#\". For example, type \"--help=#http\"\n" \
  428. " to get the usage for the options tagged with\n" \
  429. " \"#http\". If non-tag word is given, print the usage\n" \
  430. " for the options whose name includes that word.")
  431. #define TEXT_NO_CONF \
  432. _(" --no-conf[=true|false] Disable loading aria2.conf file.")
  433. #define TEXT_CONF_PATH \
  434. _(" --conf-path=PATH Change the configuration file path to PATH.")
  435. #define TEXT_STOP \
  436. _(" --stop=SEC Stop application after SEC seconds has passed.\n" \
  437. " If 0 is given, this feature is disabled.")
  438. #define TEXT_HEADER \
  439. _(" --header=HEADER Append HEADER to HTTP request header. You can use\n" \
  440. " this option repeatedly to specify more than one\n" \
  441. " header:\n" \
  442. " aria2c --header=\"X-A: b78\" --header=\"X-B: 9J1\"\n" \
  443. " http://host/file")
  444. #define TEXT_QUIET \
  445. _(" -q, --quiet[=true|false] Make aria2 quiet(no console output).")
  446. #define TEXT_ASYNC_DNS \
  447. _(" --async-dns[=true|false] Enable asynchronous DNS.")
  448. #define TEXT_FTP_REUSE_CONNECTION \
  449. _(" --ftp-reuse-connection[=true|false] Reuse connection in FTP.")
  450. #define TEXT_SUMMARY_INTERVAL \
  451. _(" --summary-interval=SEC Set interval to output download progress summary.\n" \
  452. " Setting 0 suppresses the output.")
  453. #define TEXT_LOG_LEVEL \
  454. _(" --log-level=LEVEL Set log level to output to file specified using\n" \
  455. " --log option.")
  456. #define TEXT_REMOTE_TIME \
  457. _(" -R, --remote-time[=true|false] Retrieve timestamp of the remote file from the\n" \
  458. " remote HTTP/FTP server and if it is available,\n" \
  459. " apply it to the local file.")
  460. #define TEXT_CONNECT_TIMEOUT \
  461. _(" --connect-timeout=SEC Set the connect timeout in seconds to establish\n" \
  462. " connection to HTTP/FTP/proxy server. After the\n" \
  463. " connection is established, this option makes no\n" \
  464. " effect and --timeout option is used instead.")
  465. #define TEXT_MAX_FILE_NOT_FOUND \
  466. _(" --max-file-not-found=NUM If aria2 receives `file not found' status from the\n" \
  467. " remote HTTP/FTP servers NUM times without getting\n" \
  468. " a single byte, then force the download to fail.\n" \
  469. " Specify 0 to disable this option.\n" \
  470. " This options is effective only when using\n" \
  471. " HTTP/FTP servers. The number of retry attempt is\n" \
  472. " counted toward --max-tries, so it should be\n" \
  473. " configured too.")
  474. #define TEXT_URI_SELECTOR \
  475. _(" --uri-selector=SELECTOR Specify URI selection algorithm.\n" \
  476. " If 'inorder' is given, URI is tried in the order\n" \
  477. " appeared in the URI list.\n" \
  478. " If 'feedback' is given, aria2 uses download speed\n" \
  479. " observed in the previous downloads and choose\n" \
  480. " fastest server in the URI list. This also\n" \
  481. " effectively skips dead mirrors. The observed\n" \
  482. " download speed is a part of performance profile\n" \
  483. " of servers mentioned in --server-stat-of and\n" \
  484. " --server-stat-if options.\n" \
  485. " If 'adaptive' is given, selects one of the best\n" \
  486. " mirrors for the first and reserved connections.\n" \
  487. " For supplementary ones, it returns mirrors which\n" \
  488. " has not been tested yet, and if each of them has\n" \
  489. " already been tested, returns mirrors which has to\n" \
  490. " be tested again. Otherwise, it doesn't select\n" \
  491. " anymore mirrors. Like 'feedback', it uses a\n" \
  492. " performance profile of servers.")
  493. #define TEXT_SERVER_STAT_OF \
  494. _(" --server-stat-of=FILE Specify the filename to which performance profile\n" \
  495. " of the servers is saved. You can load saved data\n" \
  496. " using --server-stat-if option.")
  497. #define TEXT_SERVER_STAT_IF \
  498. _(" --server-stat-if=FILE Specify the filename to load performance profile\n" \
  499. " of the servers. The loaded data will be used in\n" \
  500. " some URI selector such as 'feedback'.\n" \
  501. " See also --uri-selector option")
  502. #define TEXT_SERVER_STAT_TIMEOUT \
  503. _(" --server-stat-timeout=SEC Specifies timeout in seconds to invalidate\n" \
  504. " performance profile of the servers since the last\n" \
  505. " contact to them.")
  506. #define TEXT_AUTO_SAVE_INTERVAL \
  507. _(" --auto-save-interval=SEC Save a control file(*.aria2) every SEC seconds.\n" \
  508. " If 0 is given, a control file is not saved during\n" \
  509. " download. aria2 saves a control file when it stops\n" \
  510. " regardless of the value.")
  511. #define TEXT_CERTIFICATE \
  512. _(" --certificate=FILE Use the client certificate in FILE.\n" \
  513. " The certificate must be in PEM format.\n" \
  514. " You may use --private-key option to specify the\n" \
  515. " private key.")
  516. #define TEXT_PRIVATE_KEY \
  517. _(" --private-key=FILE Use the private key in FILE.\n" \
  518. " The private key must be decrypted and in PEM\n" \
  519. " format. See also --certificate option.")
  520. #define TEXT_CA_CERTIFICATE \
  521. _(" --ca-certificate=FILE Use the certificate authorities in FILE to verify\n" \
  522. " the peers. The certificate file must be in PEM\n" \
  523. " format and can contain multiple CA certificates.\n" \
  524. " Use --check-certificate option to enable\n" \
  525. " verification.")
  526. #define TEXT_CHECK_CERTIFICATE \
  527. _(" --check-certificate[=true|false] Verify the peer using certificates specified\n" \
  528. " in --ca-certificate option.")
  529. #define TEXT_NO_PROXY \
  530. _(" --no-proxy=DOMAINS Specify comma separated hostnames, domains or\n" \
  531. " network address with or without CIDR block where\n" \
  532. " proxy should not be used.")
  533. #define TEXT_USE_HEAD \
  534. _(" --use-head[=true|false] Use HEAD method for the first request to the HTTP\n" \
  535. " server.")
  536. #define TEXT_EVENT_POLL \
  537. _(" --event-poll=POLL Specify the method for polling events.")
  538. #define TEXT_BT_EXTERNAL_IP \
  539. _(" --bt-external-ip=IPADDRESS Specify the external IP address to report to a\n" \
  540. " BitTorrent tracker. Although this function is\n" \
  541. " named 'external', it can accept any kind of IP\n" \
  542. " addresses.")
  543. #define TEXT_HTTP_AUTH_CHALLENGE \
  544. _(" --http-auth-challenge[=true|false] Send HTTP authorization header only when it\n" \
  545. " is requested by the server. If false is set, then\n" \
  546. " authorization header is always sent to the server.\n" \
  547. " There is an exception: if username and password\n" \
  548. " are embedded in URI, authorization header is\n" \
  549. " always sent to the server regardless of this\n" \
  550. " option.")
  551. #define TEXT_INDEX_OUT \
  552. _(" -O, --index-out=INDEX=PATH Set file path for file with index=INDEX. You can\n" \
  553. " find the file index using the --show-files option.\n" \
  554. " PATH is a relative path to the path specified in\n" \
  555. " --dir option. You can use this option multiple\n" \
  556. " times.")
  557. #define TEXT_DRY_RUN \
  558. _(" --dry-run[=true|false] If true is given, aria2 just checks whether the\n" \
  559. " remote file is available and doesn't download\n" \
  560. " data. This option has effect on HTTP/FTP download.\n" \
  561. " BitTorrent downloads are canceled if true is\n" \
  562. " specified.")
  563. #define TEXT_BT_TRACKER_INTERVAL \
  564. _(" --bt-tracker-interval=SEC Set the interval in seconds between tracker\n" \
  565. " requests. This completely overrides interval value\n" \
  566. " and aria2 just uses this value and ignores the\n" \
  567. " min interval and interval value in the response of\n" \
  568. " tracker. If 0 is set, aria2 determines interval\n" \
  569. " based on the response of tracker and the download\n" \
  570. " progress.")
  571. #define TEXT_ON_DOWNLOAD_COMPLETE \
  572. _(" --on-download-complete=COMMAND Set the command to be executed after download\n" \
  573. " completed.\n" \
  574. " See --on-download-start option for the\n" \
  575. " requirement of COMMAND.\n" \
  576. " See also --on-download-stop option.")
  577. #define TEXT_ON_DOWNLOAD_START \
  578. _(" --on-download-start=COMMAND Set the command to be executed after download\n" \
  579. " got started. aria2 passes 3 arguments to COMMAND:\n" \
  580. " GID, the nubmer of files and file path. See Event\n" \
  581. " Hook in man page for more details.")
  582. #define TEXT_ON_DOWNLOAD_PAUSE \
  583. _(" --on-download-pause=COMMAND Set the command to be executed after download\n" \
  584. " was paused.\n"\
  585. " See --on-download-start option for the\n" \
  586. " requirement of COMMAND.")
  587. #define TEXT_ON_DOWNLOAD_ERROR \
  588. _(" --on-download-error=COMMAND Set the command to be executed after download\n" \
  589. " aborted due to error.\n" \
  590. " See --on-download-start option for the\n" \
  591. " requirement of COMMAND.\n" \
  592. " See also --on-download-stop option.")
  593. #define TEXT_ON_DOWNLOAD_STOP \
  594. _(" --on-download-stop=COMMAND Set the command to be executed after download\n" \
  595. " stopped. You can override the command to be\n" \
  596. " executed for particular download result using\n" \
  597. " --on-download-complete and --on-download-error. If\n" \
  598. " they are specified, command specified in this\n" \
  599. " option is not executed.\n" \
  600. " See --on-download-start option for the\n" \
  601. " requirement of COMMAND.")
  602. #define TEXT_BT_STOP_TIMEOUT \
  603. _(" --bt-stop-timeout=SEC Stop BitTorrent download if download speed is 0 in\n" \
  604. " consecutive SEC seconds. If 0 is given, this\n" \
  605. " feature is disabled.")
  606. #define TEXT_BT_PRIORITIZE_PIECE \
  607. _(" --bt-prioritize-piece=head[=SIZE],tail[=SIZE] Try to download first and last\n" \
  608. " pieces of each file first. This is useful for\n" \
  609. " previewing files. The argument can contain 2\n" \
  610. " keywords:head and tail. To include both keywords,\n" \
  611. " they must be separated by comma. These keywords\n" \
  612. " can take one parameter, SIZE. For example, if\n" \
  613. " head=SIZE is specified, pieces in the range of\n" \
  614. " first SIZE bytes of each file get higher priority.\n" \
  615. " tail=SIZE means the range of last SIZE bytes of\n" \
  616. " each file. SIZE can include K or M(1K = 1024, 1M =\n" \
  617. " 1024K). If SIZE is omitted, SIZE=1M is used.")
  618. #define TEXT_INTERFACE \
  619. _(" --interface=INTERFACE Bind sockets to given interface. You can specify\n" \
  620. " interface name, IP address and hostname.")
  621. #define TEXT_MULTIPLE_INTERFACE \
  622. _(" --multiple-interface=INTERFACES Comma separated list of interfaces to bind\n" \
  623. " sockets to. Requests will be splited among the\n" \
  624. " interfaces to achieve link aggregation. You can\n" \
  625. " specify interface name, IP address and hostname.\n" \
  626. " If --interface is used, this option will be\n" \
  627. " ignored.")
  628. #define TEXT_DISABLE_IPV6 \
  629. _(" --disable-ipv6[=true|false] Disable IPv6.")
  630. #define TEXT_BT_SAVE_METADATA \
  631. _(" --bt-save-metadata[=true|false] Save metadata as .torrent file. This option has\n" \
  632. " effect only when BitTorrent Magnet URI is used.\n" \
  633. " The filename is hex encoded info hash with suffix\n" \
  634. " .torrent. The directory to be saved is the same\n" \
  635. " directory where download file is saved. If the\n" \
  636. " same file already exists, metadata is not saved.\n" \
  637. " See also --bt-metadata-only option.")
  638. #define TEXT_HTTP_NO_CACHE \
  639. _(" --http-no-cache[=true|false] Send Cache-Control: no-cache and Pragma: no-cache\n" \
  640. " header to avoid cached content. If false is\n" \
  641. " given, these headers are not sent and you can add\n" \
  642. " Cache-Control header with a directive you like\n" \
  643. " using --header option.")
  644. #define TEXT_BT_METADATA_ONLY \
  645. _(" --bt-metadata-only[=true|false] Download metadata only. The file(s) described\n" \
  646. " in metadata will not be downloaded. This option\n" \
  647. " has effect only when BitTorrent Magnet URI is\n" \
  648. " used. See also --bt-save-metadata option.")
  649. #define TEXT_HUMAN_READABLE \
  650. _(" --human-readable[=true|false] Print sizes and speed in human readable format\n" \
  651. " (e.g., 1.2Ki, 3.4Mi) in the console readout.")
  652. #define TEXT_BT_ENABLE_LPD \
  653. _(" --bt-enable-lpd[=true|false] Enable Local Peer Discovery.")
  654. #define TEXT_BT_LPD_INTERFACE \
  655. _(" --bt-lpd-interface=INTERFACE Use given interface for Local Peer Discovery. If\n" \
  656. " this option is not specified, the default\n" \
  657. " interface is chosen. You can specify interface\n" \
  658. " name and IP address.")
  659. #define TEXT_REUSE_URI \
  660. _(" --reuse-uri[=true|false] Reuse already used URIs if no unused URIs are\n" \
  661. " left.")
  662. #define TEXT_ALL_PROXY_USER \
  663. _(" --all-proxy-user=USER Set user for --all-proxy.")
  664. #define TEXT_ALL_PROXY_PASSWD \
  665. _(" --all-proxy-passwd=PASSWD Set password for --all-proxy.")
  666. #define TEXT_HTTP_PROXY_USER \
  667. _(" --http-proxy-user=USER Set user for --http-proxy.")
  668. #define TEXT_HTTP_PROXY_PASSWD \
  669. _(" --http-proxy-passwd=PASSWD Set password for --http-proxy.")
  670. #define TEXT_HTTPS_PROXY_USER \
  671. _(" --https-proxy-user=USER Set user for --https-proxy.")
  672. #define TEXT_HTTPS_PROXY_PASSWD \
  673. _(" --https-proxy-passwd=PASSWD Set password for --https-proxy.")
  674. #define TEXT_FTP_PROXY_USER \
  675. _(" --ftp-proxy-user=USER Set user for --ftp-proxy.")
  676. #define TEXT_FTP_PROXY_PASSWD \
  677. _(" --ftp-proxy-passwd=PASSWD Set password for --ftp-proxy.")
  678. #define TEXT_REMOVE_CONTROL_FILE \
  679. _(" --remove-control-file[=true|false] Remove control file before download. Using\n" \
  680. " with --allow-overwrite=true, download always\n" \
  681. " starts from scratch. This will be useful for\n" \
  682. " users behind proxy server which disables resume.")
  683. #define TEXT_ALWAYS_RESUME \
  684. _(" --always-resume[=true|false] Always resume download. If true is given, aria2\n" \
  685. " always tries to resume download and if resume is\n" \
  686. " not possible, aborts download. If false is given,\n" \
  687. " when all given URIs do not support resume or\n" \
  688. " aria2 encounters N URIs which does not support\n" \
  689. " resume (N is the value specified using\n" \
  690. " --max-resume-failure-tries option), aria2\n" \
  691. " downloads file from scratch.\n" \
  692. " See --max-resume-failure-tries option.")
  693. #define TEXT_MAX_RESUME_FAILURE_TRIES \
  694. _(" --max-resume-failure-tries=N When used with --always-resume=false, aria2\n" \
  695. " downloads file from scratch when aria2 detects N\n" \
  696. " number of URIs that does not support resume. If N\n" \
  697. " is 0, aria2 downloads file from scratch when all\n" \
  698. " given URIs do not support resume.\n" \
  699. " See --always-resume option.")
  700. #define TEXT_BT_TRACKER_TIMEOUT \
  701. _(" --bt-tracker-timeout=SEC Set timeout in seconds.")
  702. #define TEXT_BT_TRACKER_CONNECT_TIMEOUT \
  703. _(" --bt-tracker-connect-timeout=SEC Set the connect timeout in seconds to\n" \
  704. " establish connection to tracker. After the\n" \
  705. " connection is established, this option makes no\n" \
  706. " effect and --bt-tracker-timeout option is used\n" \
  707. " instead.")
  708. #define TEXT_DHT_MESSAGE_TIMEOUT \
  709. _(" --dht-message-timeout=SEC Set timeout in seconds.")
  710. #define TEXT_HTTP_ACCEPT_GZIP \
  711. _(" --http-accept-gzip[=true|false] Send 'Accept: deflate, gzip' request header\n" \
  712. " and inflate response if remote server responds\n" \
  713. " with 'Content-Encoding: gzip' or\n" \
  714. " 'Content-Encoding: deflate'.")
  715. #define TEXT_SAVE_SESSION \
  716. _(" --save-session=FILE Save error/unfinished downloads to FILE on exit.\n" \
  717. " You can pass this output file to aria2c with -i\n" \
  718. " option on restart. Please note that downloads\n" \
  719. " added by aria2.addTorrent and aria2.addMetalink\n" \
  720. " RPC method and whose metadata could not be saved\n" \
  721. " as a file will not be saved. Downloads removed\n" \
  722. " using aria2.remove and aria2.forceRemove will not\n" \
  723. " be saved.")
  724. #define TEXT_MAX_CONNECTION_PER_SERVER \
  725. _(" -x, --max-connection-per-server=NUM The maximum number of connections to one\n" \
  726. " server for each download.")
  727. #define TEXT_MIN_SPLIT_SIZE \
  728. _(" -k, --min-split-size=SIZE aria2 does not split less than 2*SIZE byte range.\n" \
  729. " For example, let's consider downloading 20MiB\n" \
  730. " file. If SIZE is 10M, aria2 can split file into 2\n" \
  731. " range [0-10MiB) and [10MiB-20MiB) and download it\n" \
  732. " using 2 sources(if --split >= 2, of course).\n" \
  733. " If SIZE is 15M, since 2*15M > 20MiB, aria2 does\n" \
  734. " not split file and download it using 1 source.\n" \
  735. " You can append K or M(1K = 1024, 1M = 1024K).")
  736. #define TEXT_CONDITIONAL_GET \
  737. _(" --conditional-get[=true|false] Download file only when the local file is older\n" \
  738. " than remote file. Currently, this function has\n" \
  739. " many limitations. See man page for details.")
  740. #define TEXT_ON_BT_DOWNLOAD_COMPLETE \
  741. _(" --on-bt-download-complete=COMMAND For BitTorrent, a command specified in\n" \
  742. " --on-download-complete is called after download\n" \
  743. " completed and seeding is over. On the other hand,\n" \
  744. " this option sets the command to be executed after\n" \
  745. " download completed but before seeding.\n" \
  746. " See --on-download-start option for the\n" \
  747. " requirement of COMMAND.")
  748. #define TEXT_ENABLE_ASYNC_DNS6 \
  749. _(" --enable-async-dns6[=true|false] Enable IPv6 name resolution in asynchronous\n" \
  750. " DNS resolver. This option will be ignored when\n" \
  751. " --async-dns=false.")
  752. #define TEXT_ENABLE_DHT6 \
  753. _(" --enable-dht6[=true|false] Enable IPv6 DHT functionality.\n" \
  754. " Use --dht-listen-port option to specify port\n" \
  755. " number to listen on. See also --dht-listen-addr6\n" \
  756. " option.")
  757. #define TEXT_DHT_LISTEN_ADDR6 \
  758. _(" --dht-listen-addr6=ADDR Specify address to bind socket for IPv6 DHT. \n" \
  759. " It should be a global unicast IPv6 address of the\n" \
  760. " host.")
  761. #define TEXT_DHT_ENTRY_POINT6 \
  762. _(" --dht-entry-point6=HOST:PORT Set host and port as an entry point to IPv6 DHT\n" \
  763. " network.")
  764. #define TEXT_DHT_FILE_PATH6 \
  765. _(" --dht-file-path6=PATH Change the IPv6 DHT routing table file to PATH.")
  766. #define TEXT_BT_TRACKER \
  767. _(" --bt-tracker=URI[,...] Comma separated list of additional BitTorrent\n" \
  768. " tracker's announce URI. These URIs are not\n" \
  769. " affected by --bt-exclude-tracker option because\n" \
  770. " they are added after URIs in --bt-exclude-tracker\n" \
  771. " option are removed.")
  772. #define TEXT_BT_EXCLUDE_TRACKER \
  773. _(" --bt-exclude-tracker=URI[,...] Comma separated list of BitTorrent tracker's\n" \
  774. " announce URI to remove. You can use special value\n" \
  775. " '*' which matches all URIs, thus removes all\n" \
  776. " announce URIs. When specifying '*' in shell\n" \
  777. " command-line, don't forget to escape or quote it.\n" \
  778. " See also --bt-tracker option.")
  779. #define TEXT_MAX_DOWNLOAD_RESULT \
  780. _(" --max-download-result=NUM Set maximum number of download result kept in\n" \
  781. " memory. The download results are completed/error/\n" \
  782. " removed downloads. The download results are stored\n" \
  783. " in FIFO queue and it can store at most NUM\n" \
  784. " download results. When queue is full and new\n" \
  785. " download result is created, oldest download result\n" \
  786. " is removed from the front of the queue and new one\n" \
  787. " is pushed to the back. Setting big number in this\n" \
  788. " option may result high memory consumption after\n" \
  789. " thousands of downloads. Specifying 0 means no\n" \
  790. " download result is kept.")
  791. #define TEXT_ASYNC_DNS_SERVER \
  792. _(" --async-dns-server=IPADDRESS[,...] Comma separated list of DNS server address\n" \
  793. " used in asynchronous DNS resolver. Usually\n" \
  794. " asynchronous DNS resolver reads DNS server\n" \
  795. " addresses from /etc/resolv.conf. When this option\n" \
  796. " is used, it uses DNS servers specified in this\n" \
  797. " option instead of ones in /etc/resolv.conf. You\n" \
  798. " can specify both IPv4 and IPv6 address. This\n" \
  799. " option is useful when the system does not have\n" \
  800. " /etc/resolv.conf and user does not have the\n" \
  801. " permission to create it.")
  802. #define TEXT_ENABLE_RPC \
  803. _(" --enable-rpc[=true|false] Enable JSON-RPC/XML-RPC server.\n" \
  804. " It is strongly recommended to set secret\n" \
  805. " authorization token using --rpc-secret option.\n" \
  806. " See also --rpc-listen-port option.")
  807. #define TEXT_RPC_MAX_REQUEST_SIZE \
  808. _(" --rpc-max-request-size=SIZE Set max size of JSON-RPC/XML-RPC request. If aria2\n" \
  809. " detects the request is more than SIZE bytes, it\n" \
  810. " drops connection.")
  811. #define TEXT_RPC_USER \
  812. _(" --rpc-user=USER Set JSON-RPC/XML-RPC user. This option will be\n" \
  813. " deprecated in the future release. Migrate to\n" \
  814. " --rpc-secret option as soon as possible.")
  815. #define TEXT_RPC_PASSWD \
  816. _(" --rpc-passwd=PASSWD Set JSON-RPC/XML-RPC password. This option will\n" \
  817. " be deprecated in the future release. Migrate to\n" \
  818. " --rpc-secret option as soon as possible.")
  819. #define TEXT_RPC_LISTEN_ALL \
  820. _(" --rpc-listen-all[=true|false] Listen incoming JSON-RPC/XML-RPC requests on all\n" \
  821. " network interfaces. If false is given, listen only\n" \
  822. " on local loopback interface.")
  823. #define TEXT_RPC_LISTEN_PORT \
  824. _(" --rpc-listen-port=PORT Specify a port number for JSON-RPC/XML-RPC server\n" \
  825. " to listen to.")
  826. #define TEXT_SHOW_CONSOLE_READOUT \
  827. _(" --show-console-readout[=true|false] Show console readout.")
  828. #define TEXT_METALINK_BASE_URI \
  829. _(" --metalink-base-uri=URI Specify base URI to resolve relative URI in\n" \
  830. " metalink:url and metalink:metaurl element in a\n" \
  831. " metalink file stored in local disk. If URI points\n" \
  832. " to a directory, URI must end with '/'.")
  833. #define TEXT_STREAM_PIECE_SELECTOR \
  834. _(" --stream-piece-selector=SELECTOR Specify piece selection algorithm\n" \
  835. " used in HTTP/FTP download. Piece means fixed\n" \
  836. " length segment which is downloaded in parallel\n" \
  837. " in segmented download. If 'default' is given,\n" \
  838. " aria2 selects piece so that it reduces the\n" \
  839. " number of establishing connection. This is\n" \
  840. " reasonable default behaviour because\n" \
  841. " establishing connection is an expensive\n" \
  842. " operation.\n" \
  843. " If 'inorder' is given, aria2 selects piece which\n" \
  844. " has minimum index. Index=0 means first of the\n" \
  845. " file. This will be useful to view movie while\n" \
  846. " downloading it. --enable-http-pipelining option\n" \
  847. " may be useful to reduce reconnection overhead.\n" \
  848. " Please note that aria2 honors\n" \
  849. " --min-split-size option, so it will be necessary\n" \
  850. " to specify a reasonable value to\n" \
  851. " --min-split-size option.\n" \
  852. " If 'random' is given, aria2 selects piece\n" \
  853. " randomly. Like 'inorder', --min-split-size\n" \
  854. " option is honored.\n" \
  855. " If 'geom' is given, at the beginning aria2\n" \
  856. " selects piece which has minimum index like\n" \
  857. " 'inorder', but it exponentially increasingly\n" \
  858. " keeps space from previously selected piece. This\n" \
  859. " will reduce the number of establishing connection\n" \
  860. " and at the same time it will download the\n" \
  861. " beginning part of the file first. This will be\n" \
  862. " useful to view movie while downloading it.")
  863. #define TEXT_TRUNCATE_CONSOLE_READOUT \
  864. _(" --truncate-console-readout[=true|false] Truncate console readout to fit in\n"\
  865. " a single line.")
  866. #define TEXT_PAUSE \
  867. _(" --pause[=true|false] Pause download after added. This option is\n" \
  868. " effective only when --enable-rpc=true is given.")
  869. #define TEXT_RPC_ALLOW_ORIGIN_ALL \
  870. _(" --rpc-allow-origin-all[=true|false] Add Access-Control-Allow-Origin header\n" \
  871. " field with value '*' to the RPC response.")
  872. #define TEXT_DOWNLOAD_RESULT \
  873. _(" --download-result=OPT This option changes the way \"Download Results\"\n" \
  874. " is formatted. If OPT is 'default', print GID,\n" \
  875. " status, average download speed and path/URI. If\n" \
  876. " multiple files are involved, path/URI of first\n" \
  877. " requested file is printed and remaining ones are\n" \
  878. " omitted.\n" \
  879. " If OPT is 'full', print GID, status, average\n" \
  880. " download speed, percentage of progress and\n" \
  881. " path/URI. The percentage of progress and\n" \
  882. " path/URI are printed for each requested file in\n" \
  883. " each row.\n" \
  884. " If OPT is 'hide', \"Download Results\" is hidden.")
  885. #define TEXT_HASH_CHECK_ONLY \
  886. _(" --hash-check-only[=true|false] If true is given, after hash check using\n" \
  887. " --check-integrity option, abort download whether\n" \
  888. " or not download is complete.")
  889. #define TEXT_CHECKSUM \
  890. _(" --checksum=TYPE=DIGEST Set checksum. TYPE is hash type. The supported\n" \
  891. " hash type is listed in \"Hash Algorithms\" in\n" \
  892. " \"aria2c -v\". DIGEST is hex digest.\n" \
  893. " For example, setting sha-1 digest looks like\n" \
  894. " this:\n" \
  895. " sha-1=0192ba11326fe2298c8cb4de616f4d4140213838\n" \
  896. " This option applies only to HTTP(S)/FTP\n" \
  897. " downloads.")
  898. #define TEXT_PIECE_LENGTH \
  899. _(" --piece-length=LENGTH Set a piece length for HTTP/FTP downloads. This\n" \
  900. " is the boundary when aria2 splits a file. All\n" \
  901. " splits occur at multiple of this length. This\n" \
  902. " option will be ignored in BitTorrent downloads.\n" \
  903. " It will be also ignored if Metalink file\n" \
  904. " contains piece hashes.")
  905. #define TEXT_STOP_WITH_PROCESS \
  906. _(" --stop-with-process=PID Stop application when process PID is not running.\n" \
  907. " This is useful if aria2 process is forked from a\n" \
  908. " parent process. The parent process can fork aria2\n" \
  909. " with its own pid and when parent process exits\n" \
  910. " for some reason, aria2 can detect it and shutdown\n" \
  911. " itself.")
  912. #define TEXT_DEFERRED_INPUT \
  913. _(" --deferred-input[=true|false] If true is given, aria2 does not read all URIs\n" \
  914. " and options from file specified by -i option at\n" \
  915. " startup, but it reads one by one when it needs\n" \
  916. " later. This may reduce memory usage if input\n" \
  917. " file contains a lot of URIs to download.\n" \
  918. " If false is given, aria2 reads all URIs and\n" \
  919. " options at startup.")
  920. #define TEXT_BT_REMOVE_UNSELECTED_FILE \
  921. _(" --bt-remove-unselected-file[=true|false] Removes the unselected files when\n" \
  922. " download is completed in BitTorrent. To\n" \
  923. " select files, use --select-file option. If\n" \
  924. " it is not used, all files are assumed to be\n" \
  925. " selected. Please use this option with care\n" \
  926. " because it will actually remove files from\n" \
  927. " your disk.")
  928. #define TEXT_ENABLE_MMAP \
  929. _(" --enable-mmap[=true|false] Map files into memory.")
  930. #define TEXT_RPC_CERTIFICATE \
  931. _(" --rpc-certificate=FILE Use the certificate in FILE for RPC server.\n" \
  932. " The certificate must be in PEM format.\n" \
  933. " Use --rpc-private-key option to specify the\n" \
  934. " private key. Use --rpc-secure option to enable\n" \
  935. " encryption.")
  936. #define TEXT_RPC_PRIVATE_KEY \
  937. _(" --rpc-private-key=FILE Use the private key in FILE for RPC server.\n" \
  938. " The private key must be decrypted and in PEM\n" \
  939. " format. Use --rpc-secure option to enable\n" \
  940. " encryption. See also --rpc-certificate option.")
  941. #define TEXT_RPC_SECURE \
  942. _(" --rpc-secure[=true|false] RPC transport will be encrypted by SSL/TLS.\n" \
  943. " The RPC clients must use https scheme to access\n" \
  944. " the server. For WebSocket client, use wss\n" \
  945. " scheme. Use --rpc-certificate and\n" \
  946. " --rpc-private-key options to specify the\n" \
  947. " server certificate and private key.")
  948. #define TEXT_RPC_SAVE_UPLOAD_METADATA \
  949. _(" --rpc-save-upload-metadata[=true|false] Save the uploaded torrent or\n" \
  950. " metalink metadata in the directory specified\n" \
  951. " by --dir option. The filename consists of\n" \
  952. " SHA-1 hash hex string of metadata plus\n" \
  953. " extension. For torrent, the extension is\n" \
  954. " '.torrent'. For metalink, it is '.meta4'.\n" \
  955. " If false is given to this option, the\n" \
  956. " downloads added by aria2.addTorrent or\n" \
  957. " aria2.addMetalink will not be saved by\n" \
  958. " --save-session option.")
  959. #define TEXT_FORCE_SAVE \
  960. _(" --force-save[=true|false] Save download with --save-session option even\n" \
  961. " if the download is completed or removed. This\n" \
  962. " option also saves control file in that\n" \
  963. " situations. This may be useful to save\n" \
  964. " BitTorrent seeding which is recognized as\n" \
  965. " completed state.")
  966. #define TEXT_DISK_CACHE \
  967. _(" --disk-cache=SIZE Enable disk cache. If SIZE is 0, the disk cache\n" \
  968. " is disabled. This feature caches the downloaded\n" \
  969. " data in memory, which grows to at most SIZE\n" \
  970. " bytes. The cache storage is created for aria2\n" \
  971. " instance and shared by all downloads. The one\n" \
  972. " advantage of the disk cache is reduce the disk\n" \
  973. " I/O because the data are written in larger unit\n" \
  974. " and it is reordered by the offset of the file.\n" \
  975. " If hash checking is involved and the data are\n" \
  976. " cached in memory, we don't need to read them\n" \
  977. " from the disk.\n" \
  978. " SIZE can include K or M(1K = 1024, 1M = 1024K).")
  979. #define TEXT_GID \
  980. _(" --gid=GID Set GID manually. aria2 identifies each\n" \
  981. " download by the ID called GID. The GID must be\n" \
  982. " hex string of 16 characters, thus [0-9a-zA-Z]\n" \
  983. " are allowed and leading zeros must not be\n" \
  984. " stripped. The GID all 0 is reserved and must\n" \
  985. " not be used. The GID must be unique, otherwise\n" \
  986. " error is reported and the download is not added.\n" \
  987. " This option is useful when restoring the\n" \
  988. " sessions saved using --save-session option. If\n" \
  989. " this option is not used, new GID is generated\n" \
  990. " by aria2.")
  991. #define TEXT_CONSOLE_LOG_LEVEL \
  992. _(" --console-log-level=LEVEL Set log level to output to console.")
  993. #define TEXT_SAVE_SESSION_INTERVAL \
  994. _(" --save-session-interval=SEC Save error/unfinished downloads to a file\n" \
  995. " specified by --save-session option every SEC\n" \
  996. " seconds. If 0 is given, file will be saved only\n" \
  997. " when aria2 exits.")
  998. #define TEXT_ENABLE_COLOR \
  999. _(" --enable-color[=true|false] Enable color output for a terminal.")
  1000. #define TEXT_RPC_SECRET \
  1001. _(" --rpc-secret=TOKEN Set RPC secret authorization token.")
  1002. #define TEXT_DSCP \
  1003. _(" --dscp=DSCP Set DSCP value in outgoing IP packets of\n" \
  1004. " BitTorrent traffic for QoS. This parameter sets\n" \
  1005. " only DSCP bits in TOS field of IP packets,\n" \
  1006. " not the whole field. If you take values\n" \
  1007. " from /usr/include/netinet/ip.h divide them by 4\n" \
  1008. " (otherwise values would be incorrect, e.g. your\n" \
  1009. " CS1 class would turn into CS4). If you take\n" \
  1010. " commonly used values from RFC, network vendors'\n" \
  1011. " documentation, Wikipedia or any other source,\n" \
  1012. " use them as they are.")
  1013. #define TEXT_RLIMIT_NOFILE \
  1014. _(" --rlimit-nofile=NUM Set the soft limit of open file descriptors.\n" \
  1015. " This open will only have effect when:\n" \
  1016. " a) The system supports it (posix)\n" \
  1017. " b) The limit does not exceed the hard limit.\n" \
  1018. " c) The specified limit is larger than the\n" \
  1019. " current soft limit.\n" \
  1020. " This is equivalent to setting nofile via ulimit,\n" \
  1021. " except that it will never decrease the limit.")
  1022. #define TEXT_PAUSE_METADATA \
  1023. _(" --pause-metadata[=true|false]\n" \
  1024. " Pause downloads created as a result of metadata\n" \
  1025. " download. There are 3 types of metadata\n" \
  1026. " downloads in aria2: (1) downloading .torrent\n" \
  1027. " file. (2) downloading torrent metadata using\n" \
  1028. " magnet link. (3) downloading metalink file.\n" \
  1029. " These metadata downloads will generate downloads\n" \
  1030. " using their metadata. This option pauses these\n" \
  1031. " subsequent downloads. This option is effective\n" \
  1032. " only when --enable-rpc=true is given.")
  1033. #define TEXT_BT_DETACH_SEED_ONLY \
  1034. _(" --bt-detach-seed-only[=true|false]\n" \
  1035. " Exclude seed only downloads when counting\n" \
  1036. " concurrent active downloads (See -j option).\n" \
  1037. " This means that if -j3 is given and this option\n" \
  1038. " is turned on and 3 downloads are active and one\n" \
  1039. " of those enters seed mode, then it is excluded\n" \
  1040. " from active download count (thus it becomes 2),\n" \
  1041. " and the next download waiting in queue gets\n" \
  1042. " started. But be aware that seeding item is still\n" \
  1043. " recognized as active download in RPC method.")
  1044. #define TEXT_MIN_TLS_VERSION \
  1045. _(" --min-tls-version=VERSION Specify minimum SSL/TLS version to enable.")
  1046. #define TEXT_BT_FORCE_ENCRYPTION \
  1047. _(" --bt-force-encryption[=true|false]\n" \
  1048. " Requires BitTorrent message payload encryption\n" \
  1049. " with arc4. This is a shorthand of\n" \
  1050. " --bt-require-crypto --bt-min-crypto-level=arc4.\n" \
  1051. " If true is given, deny legacy BitTorrent\n" \
  1052. " handshake and only use Obfuscation handshake and\n" \
  1053. " always encrypt message payload.")
  1054. #define TEXT_SSH_HOST_KEY_MD \
  1055. _(" --ssh-host-key-md=TYPE=DIGEST\n" \
  1056. " Set checksum for SSH host public key. TYPE is\n" \
  1057. " hash type. The supported hash type is sha-1 or\n" \
  1058. " md5. DIGEST is hex digest. For example:\n" \
  1059. " sha-1=b030503d4de4539dc7885e6f0f5e256704edf4c3\n" \
  1060. " This option can be used to validate server's\n" \
  1061. " public key when SFTP is used. If this option is\n" \
  1062. " not set, which is default, no validation takes\n" \
  1063. " place.")
  1064. #define TEXT_SOCKET_RECV_BUFFER_SIZE \
  1065. _(" --socket-recv-buffer-size=SIZE\n" \
  1066. " Set the maximum socket receive buffer in bytes.\n" \
  1067. " Specifing 0 will disable this option. This value\n" \
  1068. " will be set to socket file descriptor using\n" \
  1069. " SO_RCVBUF socket option with setsockopt() call.")
  1070. #define TEXT_BT_ENABLE_HOOK_AFTER_HASH_CHECK \
  1071. _(" --bt-enable-hook-after-hash-check[=true|false] Allow hook command invocation\n" \
  1072. " after hash check (see -V option) in BitTorrent\n" \
  1073. " download. By default, when hash check succeeds,\n" \
  1074. " the command given by --on-bt-download-complete\n" \
  1075. " is executed. To disable this action, give false\n" \
  1076. " to this option.")
  1077. #define TEXT_MAX_MMAP_LIMIT \
  1078. _(" --max-mmap-limit=SIZE Set the maximum file size to enable mmap (see\n" \
  1079. " --enable-mmap option). The file size is\n" \
  1080. " determined by the sum of all files contained in\n" \
  1081. " one download. For example, if a download\n" \
  1082. " contains 5 files, then file size is the total\n" \
  1083. " size of those files. If file size is strictly\n" \
  1084. " greater than the size specified in this option,\n" \
  1085. " mmap will be disabled.")
  1086. #define TEXT_STDERR \
  1087. _(" --stderr[=true|false] Redirect all console output that would be\n" \
  1088. " otherwise printed in stdout to stderr.")
  1089. // clang-format on