usage_text.h 37 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583
  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. #define TEXT_DIR \
  36. _(" -d, --dir=DIR The directory to store the downloaded file.")
  37. #define TEXT_OUT \
  38. _(" -o, --out=FILE The file name of the downloaded file.")
  39. #define TEXT_LOG \
  40. _(" -l, --log=LOG The file name of the log file. If '-' is\n"\
  41. " specified, log is written to stdout.")
  42. #define TEXT_DAEMON \
  43. _(" -D, --daemon Run as daemon. The current working directory will\n"\
  44. " be changed to \"/\" and standard input, standard\n"\
  45. " output and standard error will be redirected to\n"\
  46. " \"/dev/null\".")
  47. #define TEXT_SPLIT \
  48. _(" -s, --split=N Download a file using N connections. If more\n"\
  49. " than N URLs are given, first N URLs are used and\n"\
  50. " remaining URLs are used for backup. If less than\n"\
  51. " N URLs are given, those URLs are used more than\n"\
  52. " once so that N connections total are made\n"\
  53. " simultaneously. Please see -j option too.\n"\
  54. " Please note that in Metalink download, this\n"\
  55. " option has no effect and use -C option instead.")
  56. #define TEXT_RETRY_WAIT \
  57. _(" --retry-wait=SEC Set the seconds to wait to retry after an error\n"\
  58. " has occured.")
  59. #define TEXT_TIMEOUT \
  60. _(" -t, --timeout=SEC Set timeout in seconds.")
  61. #define TEXT_MAX_TRIES \
  62. _(" -m, --max-tries=N Set number of tries. 0 means unlimited.")
  63. #define TEXT_HTTP_PROXY \
  64. _(" --http-proxy=PROXY Use this proxy server for HTTP.\n"\
  65. " See also --all-proxy option.\n"\
  66. " This affects all URLs.")
  67. #define TEXT_HTTPS_PROXY \
  68. _(" --https-proxy=PROXY Use this proxy server for HTTPS.\n"\
  69. " See also --all-proxy option.\n"\
  70. " This affects all URLs.")
  71. #define TEXT_FTP_PROXY \
  72. _(" --ftp-proxy=PROXY Use this proxy server for FTP.\n"\
  73. " See also --all-proxy option.\n"\
  74. " This affects all URLs.")
  75. #define TEXT_ALL_PROXY \
  76. _(" --all-proxy=PROXY Use this proxy server for all protocols.\n"\
  77. " You can override this setting and specify a\n"\
  78. " proxy server for a particular protocol using\n"\
  79. " --http-proxy, --https-proxy and --ftp-proxy\n"\
  80. " options.\n"\
  81. " This affects all URLs.")
  82. #define TEXT_HTTP_USER \
  83. _(" --http-user=USER Set HTTP user. This affects all URLs.")
  84. #define TEXT_HTTP_PASSWD \
  85. _(" --http-passwd=PASSWD Set HTTP password. This affects all URLs.")
  86. #define TEXT_PROXY_METHOD \
  87. _(" --proxy-method=METHOD Set the method to use in proxy request.")
  88. #define TEXT_REFERER \
  89. _(" --referer=REFERER Set Referer. This affects all URLs.")
  90. #define TEXT_FTP_USER \
  91. _(" --ftp-user=USER Set FTP user. This affects all URLs.")
  92. #define TEXT_FTP_PASSWD \
  93. _(" --ftp-passwd=PASSWD Set FTP password. This affects all URLs.")
  94. #define TEXT_FTP_TYPE \
  95. _(" --ftp-type=TYPE Set FTP transfer type.")
  96. #define TEXT_FTP_PASV \
  97. _(" -p, --ftp-pasv[=true|false] Use the passive mode in FTP. If false is given,\n"\
  98. " the active mode will be used.")
  99. #define TEXT_LOWEST_SPEED_LIMIT \
  100. _(" --lowest-speed-limit=SPEED Close connection if download speed is lower than\n"\
  101. " or equal to this value(bytes per sec).\n"\
  102. " 0 means aria2 does not have a lowest speed limit.\n"\
  103. " You can append K or M(1K = 1024, 1M = 1024K).\n"\
  104. " This option does not affect BitTorrent downloads.")
  105. #define TEXT_MAX_OVERALL_DOWNLOAD_LIMIT \
  106. _(" --max-overall-download-limit=SPEED Set max overall download speed in bytes/sec.\n"\
  107. " 0 means unrestricted.\n"\
  108. " You can append K or M(1K = 1024, 1M = 1024K).\n"\
  109. " To limit the download speed per download, use\n"\
  110. " --max-download-limit option.")
  111. #define TEXT_MAX_DOWNLOAD_LIMIT \
  112. _(" --max-download-limit=SPEED Set max download speed per each download in\n"\
  113. " bytes/sec. 0 means unrestricted.\n"\
  114. " You can append K or M(1K = 1024, 1M = 1024K).\n"\
  115. " To limit the overall download speed, use\n"\
  116. " --max-overall-download-limit option.")
  117. #define TEXT_FILE_ALLOCATION \
  118. _(" --file-allocation=METHOD Specify file allocation method.\n"\
  119. " 'none' doesn't pre-allocate file space. 'prealloc'\n"\
  120. " pre-allocates file space before download begins.\n"\
  121. " This may take some time depending on the size of\n"\
  122. " the file.\n"\
  123. " If you are using newer file systems such as ext4\n"\
  124. " (with extents support), btrfs or xfs, 'falloc' is\n"\
  125. " your best choice. It allocates large(few GiB)\n"\
  126. " files almost instantly. Don't use 'falloc' with\n"\
  127. " legacy file systems such as ext3 because it takes\n"\
  128. " almost same time as 'prealloc' and it blocks aria2\n"\
  129. " entirely until allocation finishes. 'falloc' may\n"\
  130. " not be available if your system doesn't have\n"\
  131. " posix_fallocate() function.")
  132. #define TEXT_NO_FILE_ALLOCATION_LIMIT \
  133. _(" --no-file-allocation-limit=SIZE No file allocation is made for files whose\n"\
  134. " size is smaller than SIZE.\n"\
  135. " You can append K or M(1K = 1024, 1M = 1024K).")
  136. # define TEXT_ENABLE_DIRECT_IO \
  137. _(" --enable-direct-io[=true|false] Enable directI/O, which lowers cpu usage while\n"\
  138. " allocating files.\n"\
  139. " Turn off if you encounter any error")
  140. #define TEXT_ALLOW_OVERWRITE \
  141. _(" --allow-overwrite=true|false If false is given, and a file already exists but\n"\
  142. " the corresponding control file (filename.aria2)\n"\
  143. " doesn't exist, then aria2 will not re-download\n"\
  144. " the file. See also --auto-file-renaming option.")
  145. #define TEXT_ALLOW_PIECE_LENGTH_CHANGE \
  146. _(" --allow-piece-length-change=true|false If false is given, aria2 aborts download\n"\
  147. " when a piece length is different from one in\n"\
  148. " a control file. If true is given, you can proceed\n"\
  149. " but some download progress will be lost.")
  150. #define TEXT_FORCE_SEQUENTIAL \
  151. _(" -Z, --force-sequential[=true|false] Fetch URIs in the command-line sequentially\n"\
  152. " and download each URI in a separate session, like\n"\
  153. " the usual command-line download utilities.")
  154. #define TEXT_AUTO_FILE_RENAMING \
  155. _(" --auto-file-renaming[=true|false] Rename file name if the same file already\n"\
  156. " exists. This option works only in http(s)/ftp\n"\
  157. " download.\n"\
  158. " The new file name has a dot and a number(1..9999)\n"\
  159. " appended.")
  160. #define TEXT_PARAMETERIZED_URI \
  161. _(" -P, --parameterized-uri[=true|false] Enable parameterized URI support.\n"\
  162. " You can specify set of parts:\n"\
  163. " http://{sv1,sv2,sv3}/foo.iso\n"\
  164. " Also you can specify numeric sequences with step\n"\
  165. " counter:\n"\
  166. " http://host/image[000-100:2].img\n"\
  167. " A step counter can be omitted.\n"\
  168. " If all URIs do not point to the same file, such\n"\
  169. " as the second example above, -Z option is\n"\
  170. " required.")
  171. #define TEXT_ENABLE_HTTP_KEEP_ALIVE \
  172. _(" --enable-http-keep-alive[=true|false] Enable HTTP/1.1 persistent connection.")
  173. #define TEXT_ENABLE_HTTP_PIPELINING \
  174. _(" --enable-http-pipelining[=true|false] Enable HTTP/1.1 pipelining.")
  175. #define TEXT_CHECK_INTEGRITY \
  176. _(" -V, --check-integrity[=true|false] Check file integrity by validating piece\n"\
  177. " hashes. This option has effect only in BitTorrent\n"\
  178. " and Metalink downloads with chunk checksums.\n"\
  179. " Use this option to re-download a damaged portion\n"\
  180. " of a file. See also --bt-hash-check-seed option.")
  181. #define TEXT_BT_HASH_CHECK_SEED \
  182. _(" --bt-hash-check-seed[=true|false] If true is given, after hash check using\n"\
  183. " --check-integrity option and file is complete,\n"\
  184. " continue to seed file. If you want to check file\n"\
  185. " and download it only when it is damaged or\n"\
  186. " incomplete, set this option to false.\n"\
  187. " This option has effect only on BitTorrent\n"\
  188. " download.")
  189. #define TEXT_REALTIME_CHUNK_CHECKSUM \
  190. _(" --realtime-chunk-checksum=true|false Validate chunk of data by calculating\n"\
  191. " checksum while downloading a file if chunk\n"\
  192. " checksums are provided.")
  193. #define TEXT_CONTINUE \
  194. _(" -c, --continue Continue downloading a partially downloaded\n"\
  195. " file. Use this option to resume a download\n"\
  196. " started by a web browser or another program\n"\
  197. " which downloads files sequentially from the\n"\
  198. " beginning. Currently this option is only\n"\
  199. " applicable to http(s)/ftp downloads.")
  200. #define TEXT_USER_AGENT \
  201. _(" -U, --user-agent=USER_AGENT Set user agent for http(s) downloads.")
  202. #define TEXT_NO_NETRC \
  203. _(" -n, --no-netrc Disables netrc support.")
  204. #define TEXT_INPUT_FILE \
  205. _(" -i, --input-file=FILE Downloads URIs found in FILE. You can specify\n"\
  206. " multiple URIs for a single entity: separate\n"\
  207. " URIs on a single line using the TAB character.\n"\
  208. " Reads input from stdin when '-' is specified.\n"\
  209. " The additional out and dir options can be\n"\
  210. " specified after each line of URIs. This optional\n"\
  211. " line must start with white space(s). See INPUT\n"\
  212. " FILE section of man page for details.")
  213. #define TEXT_MAX_CONCURRENT_DOWNLOADS \
  214. _(" -j, --max-concurrent-downloads=N Set maximum number of parallel downloads for\n"\
  215. " every static (HTTP/FTP) URL, torrent and metalink.\n"\
  216. " See also -s and -C options.")
  217. #define TEXT_LOAD_COOKIES \
  218. _(" --load-cookies=FILE Load Cookies from FILE using the Firefox3 format\n"\
  219. " and Mozilla/Firefox(1.x/2.x)/Netscape format.")
  220. #define TEXT_SAVE_COOKIES \
  221. _(" --save-cookies=FILE Save Cookies to FILE in Mozilla/Firefox(1.x/2.x)/\n"\
  222. " Netscape format. If FILE already exists, it is\n"\
  223. " overwritten. Session Cookies are also saved and\n"\
  224. " their expiry values are treated as 0.")
  225. #define TEXT_SHOW_FILES \
  226. _(" -S, --show-files Print file listing of .torrent or .metalink file\n"\
  227. " and exit. More detailed information will be listed\n"\
  228. " in case of torrent file.")
  229. #define TEXT_SELECT_FILE \
  230. _(" --select-file=INDEX... Set file to download by specifying its index.\n"\
  231. " You can find the file index using the\n"\
  232. " --show-files option. Multiple indexes can be\n"\
  233. " specified by using ',', for example: \"3,6\".\n"\
  234. " You can also use '-' to specify a range: \"1-5\".\n"\
  235. " ',' and '-' can be used together.\n"\
  236. " When used with the -M option, index may vary\n"\
  237. " depending on the query(see --metalink-* options).")
  238. #define TEXT_TORRENT_FILE \
  239. _(" -T, --torrent-file=TORRENT_FILE The path to the .torrent file.")
  240. #define TEXT_FOLLOW_TORRENT \
  241. _(" --follow-torrent=true|false|mem If true or mem is specified, when a file\n"\
  242. " whose suffix is .torrent or content type is\n"\
  243. " application/x-bittorrent is downloaded, aria2\n"\
  244. " parses it as a torrent file and downloads files\n"\
  245. " mentioned in it.\n"\
  246. " If mem is specified, a torrent file is not\n"\
  247. " written to the disk, but is just kept in memory.\n"\
  248. " If false is specified, the action mentioned above\n"\
  249. " is not taken.")
  250. #define TEXT_DIRECT_FILE_MAPPING \
  251. _(" --direct-file-mapping=true|false Directly read from and write to each file\n"\
  252. " mentioned in .torrent file.")
  253. #define TEXT_LISTEN_PORT \
  254. _(" --listen-port=PORT... Set TCP port number for BitTorrent downloads.\n"\
  255. " Multiple ports can be specified by using ',',\n"\
  256. " for example: \"6881,6885\". You can also use '-'\n"\
  257. " to specify a range: \"6881-6999\". ',' and '-' can\n"\
  258. " be used together.")
  259. #define TEXT_MAX_OVERALL_UPLOAD_LIMIT \
  260. _(" --max-overall-upload-limit=SPEED Set max overall upload speed in bytes/sec.\n"\
  261. " 0 means unrestricted.\n"\
  262. " You can append K or M(1K = 1024, 1M = 1024K).\n"\
  263. " To limit the upload speed per torrent, use\n"\
  264. " --max-upload-limit option.")
  265. #define TEXT_MAX_UPLOAD_LIMIT \
  266. _(" -u, --max-upload-limit=SPEED Set max upload speed per each torrent in\n"\
  267. " bytes/sec. 0 means unrestricted.\n"\
  268. " You can append K or M(1K = 1024, 1M = 1024K).\n"\
  269. " To limit the overall upload speed, use\n"\
  270. " --max-overall-upload-limit option.")
  271. #define TEXT_SEED_TIME \
  272. _(" --seed-time=MINUTES Specify seeding time in minutes. Also see the\n"\
  273. " --seed-ratio option.")
  274. #define TEXT_SEED_RATIO \
  275. _(" --seed-ratio=RATIO Specify share ratio. Seed completed torrents\n"\
  276. " until share ratio reaches RATIO.\n"\
  277. " You are strongly encouraged to specify equals or\n"\
  278. " more than 1.0 here. Specify 0.0 if you intend to\n"\
  279. " do seeding regardless of share ratio.\n" \
  280. " If --seed-time option is specified along with\n"\
  281. " this option, seeding ends when at least one of\n"\
  282. " the conditions is satisfied.")
  283. #define TEXT_PEER_ID_PREFIX \
  284. _(" --peer-id-prefix=PEER_ID_PREFIX Specify the prefix of peer ID. The peer ID in\n"\
  285. " BitTorrent is 20 byte length. If more than 20\n"\
  286. " bytes are specified, only first 20 bytes are\n"\
  287. " used. If less than 20 bytes are specified, random\n"\
  288. " byte data are added to make its length 20 bytes.")
  289. #define TEXT_ENABLE_PEER_EXCHANGE \
  290. _(" --enable-peer-exchange[=true|false] Enable Peer Exchange extension.")
  291. #define TEXT_ENABLE_DHT \
  292. _(" --enable-dht[=true|false] Enable DHT functionality.")
  293. #define TEXT_DHT_LISTEN_PORT \
  294. _(" --dht-listen-port=PORT... Set UDP listening port for DHT.\n"\
  295. " Multiple ports can be specified by using ',',\n"\
  296. " for example: \"6881,6885\". You can also use '-'\n"\
  297. " to specify a range: \"6881-6999\". ',' and '-' can\n"\
  298. " be used together.")
  299. #define TEXT_DHT_ENTRY_POINT \
  300. _(" --dht-entry-point=HOST:PORT Set host and port as an entry point to DHT\n"\
  301. " network.")
  302. #define TEXT_DHT_FILE_PATH \
  303. _(" --dht-file-path=PATH Change the DHT routing table file to PATH.")
  304. #define TEXT_BT_MIN_CRYPTO_LEVEL \
  305. _(" --bt-min-crypto-level=plain|arc4 Set minimum level of encryption method.\n"\
  306. " If several encryption methods are provided by a\n"\
  307. " peer, aria2 chooses the lowest one which satisfies\n"\
  308. " the given level.")
  309. #define TEXT_BT_REQUIRE_CRYPTO \
  310. _(" --bt-require-crypto=true|false If true is given, aria2 doesn't accept and\n"\
  311. " establish connection with legacy BitTorrent\n"\
  312. " handshake. Thus aria2 always uses Obfuscation\n"\
  313. " handshake.")
  314. #define TEXT_BT_REQUEST_PEER_SPEED_LIMIT \
  315. _(" --bt-request-peer-speed-limit=SPEED If the whole download speed of every\n"\
  316. " torrent is lower than SPEED, aria2 temporarily\n"\
  317. " increases the number of peers to try for more\n"\
  318. " download speed. Configuring this option with your\n"\
  319. " preferred download speed can increase your\n"\
  320. " download speed in some cases.\n"\
  321. " You can append K or M(1K = 1024, 1M = 1024K).")
  322. #define TEXT_BT_MAX_OPEN_FILES \
  323. _(" --bt-max-open-files=NUM Specify maximum number of files to open in each\n"\
  324. " BitTorrent download.")
  325. #define TEXT_BT_SEED_UNVERIFIED \
  326. _(" --bt-seed-unverified[=true|false] Seed previously downloaded files without\n"\
  327. " verifying piece hashes.")
  328. #define TEXT_BT_MAX_PEERS \
  329. _(" --bt-max-peers=NUM Specify the maximum number of peers per torrent.\n"\
  330. " 0 means unlimited.\n"\
  331. " See also --bt-request-peer-speed-limit option.")
  332. #define TEXT_METALINK_FILE \
  333. _(" -M, --metalink-file=METALINK_FILE The file path to the .metalink file.")
  334. #define TEXT_METALINK_SERVERS \
  335. _(" -C, --metalink-servers=NUM_SERVERS The number of servers to connect to\n"\
  336. " simultaneously. Some Metalinks regulate the\n"\
  337. " number of servers to connect. aria2 strictly\n"\
  338. " respects them. This means that if Metalink defines\n"\
  339. " the maxconnections attribute lower than\n"\
  340. " NUM_SERVERS, then aria2 uses the value of\n"\
  341. " maxconnections attribute instead of NUM_SERVERS.\n"\
  342. " See also -s and -j options.")
  343. #define TEXT_METALINK_VERSION \
  344. _(" --metalink-version=VERSION The version of the file to download.")
  345. #define TEXT_METALINK_LANGUAGE \
  346. _(" --metalink-language=LANGUAGE The language of the file to download.")
  347. #define TEXT_METALINK_OS \
  348. _(" --metalink-os=OS The operating system of the file to download.")
  349. #define TEXT_METALINK_LOCATION \
  350. _(" --metalink-location=LOCATION[,...] The location of the preferred server.\n"\
  351. " A comma-delimited list of locations is\n"\
  352. " acceptable.")
  353. #define TEXT_METALINK_PREFERRED_PROTOCOL \
  354. _(" --metalink-preferred-protocol=PROTO Specify preferred protocol. Specify 'none'\n"\
  355. " if you don't have any preferred protocol.")
  356. #define TEXT_FOLLOW_METALINK \
  357. _(" --follow-metalink=true|false|mem If true or mem is specified, when a file\n"\
  358. " whose suffix is .metalink or content type of\n"\
  359. " application/metalink+xml is downloaded, aria2\n"\
  360. " parses it as a metalink file and downloads files\n"\
  361. " mentioned in it.\n"\
  362. " If mem is specified, a metalink file is not\n"\
  363. " written to the disk, but is just kept in memory.\n"\
  364. " If false is specified, the action mentioned above\n"\
  365. " is not taken.")
  366. #define TEXT_METALINK_ENABLE_UNIQUE_PROTOCOL \
  367. _(" --metalink-enable-unique-protocol=true|false If true is given and several\n"\
  368. " protocols are available for a mirror in a metalink\n"\
  369. " file, aria2 uses one of them.\n"\
  370. " Use --metalink-preferred-protocol option to\n"\
  371. " specify the preference of protocol.")
  372. #define TEXT_VERSION \
  373. _(" -v, --version Print the version number and exit.")
  374. #define TEXT_HELP \
  375. _(" -h, --help[=TAG|KEYWORD] Print usage and exit.\n"\
  376. " The help messages are classified with tags. A tag\n"\
  377. " starts with \"#\". For example, type \"--help=#http\"\n"\
  378. " to get the usage for the options tagged with\n"\
  379. " \"#http\". If non-tag word is given, print the usage\n"\
  380. " for the options whose name includes that word.")
  381. #define TEXT_NO_CONF \
  382. _(" --no-conf Disable loading aria2.conf file.")
  383. #define TEXT_CONF_PATH \
  384. _(" --conf-path=PATH Change the configuration file path to PATH.")
  385. #define TEXT_STOP \
  386. _(" --stop=SEC Stop application after SEC seconds has passed.\n" \
  387. " If 0 is given, this feature is disabled.")
  388. #define TEXT_HEADER \
  389. _(" --header=HEADER Append HEADER to HTTP request header. You can use\n"\
  390. " this option repeatedly to specify more than one\n"\
  391. " header:\n"\
  392. " aria2c --header=\"X-A: b78\" --header=\"X-B: 9J1\"\n"\
  393. " http://host/file")
  394. #define TEXT_QUIET \
  395. _(" -q, --quiet[=true|false] Make aria2 quiet(no console output).")
  396. #define TEXT_ASYNC_DNS \
  397. _(" --async-dns[=true|false] Enable asynchronous DNS.")
  398. #define TEXT_FTP_REUSE_CONNECTION \
  399. _(" --ftp-reuse-connection[=true|false] Reuse connection in FTP.")
  400. #define TEXT_SUMMARY_INTERVAL \
  401. _(" --summary-interval=SEC Set interval to output download progress summary.\n"\
  402. " Setting 0 suppresses the output.")
  403. #define TEXT_LOG_LEVEL \
  404. _(" --log-level=LEVEL Set log level to output.")
  405. #define TEXT_REMOTE_TIME \
  406. _(" -R, --remote-time[=true|false] Retrieve timestamp of the remote file from the\n"\
  407. " remote HTTP/FTP server and if it is available,\n"\
  408. " apply it to the local file.")
  409. #define TEXT_CONNECT_TIMEOUT \
  410. _(" --connect-timeout=SEC Set the connect timeout in seconds to establish\n"\
  411. " connection to HTTP/FTP/proxy server. After the\n"\
  412. " connection is established, this option makes no\n"\
  413. " effect and --timeout option is used instead.")
  414. #define TEXT_MAX_FILE_NOT_FOUND \
  415. _(" --max-file-not-found=NUM If aria2 receives `file not found' status from the\n"\
  416. " remote HTTP/FTP servers NUM times without getting\n"\
  417. " a single byte, then force the download to fail.\n"\
  418. " Specify 0 to disable this option.\n"\
  419. " This options is effective only when using\n"\
  420. " HTTP/FTP servers.")
  421. #define TEXT_URI_SELECTOR \
  422. _(" --uri-selector=SELECTOR Specify URI selection algorithm.\n"\
  423. " If 'inorder' is given, URI is tried in the order\n"\
  424. " appeared in the URI list.\n"\
  425. " If 'feedback' is given, aria2 uses download speed\n"\
  426. " observed in the previous downloads and choose\n"\
  427. " fastest server in the URI list. This also\n"\
  428. " effectively skips dead mirrors. The observed\n"\
  429. " download speed is a part of performance profile\n"\
  430. " of servers mentioned in --server-stat-of and\n"\
  431. " --server-stat-if options.\n"\
  432. " If 'adaptive' is given, selects one of the best\n"\
  433. " mirrors for the first and reserved connections.\n"\
  434. " For supplementary ones, it returns mirrors which\n" \
  435. " has not been tested yet, and if each of them has\n"\
  436. " already been tested, returns mirrors which has to\n"\
  437. " be tested again. Otherwise, it doesn't select\n"\
  438. " anymore mirrors. Like 'feedback', it uses a\n"\
  439. " performance profile of servers.")
  440. #define TEXT_SERVER_STAT_OF \
  441. _(" --server-stat-of=FILE Specify the filename to which performance profile\n"\
  442. " of the servers is saved. You can load saved data\n"\
  443. " using --server-stat-if option.")
  444. #define TEXT_SERVER_STAT_IF \
  445. _(" --server-stat-if=FILE Specify the filename to load performance profile\n"\
  446. " of the servers. The loaded data will be used in\n"\
  447. " some URI selector such as 'feedback'.\n"\
  448. " See also --uri-selector option")
  449. #define TEXT_SERVER_STAT_TIMEOUT \
  450. _(" --server-stat-timeout=SEC Specifies timeout in seconds to invalidate\n"\
  451. " performance profile of the servers since the last\n"\
  452. " contact to them.")
  453. #define TEXT_AUTO_SAVE_INTERVAL \
  454. _(" --auto-save-interval=SEC Save a control file(*.aria2) every SEC seconds.\n"\
  455. " If 0 is given, a control file is not saved during\n"\
  456. " download. aria2 saves a control file when it stops\n"\
  457. " regardless of the value.")
  458. #define TEXT_CERTIFICATE \
  459. _(" --certificate=FILE Use the client certificate in FILE.\n"\
  460. " The certificate must be in PEM format.\n"\
  461. " You may use --private-key option to specify the\n"\
  462. " private key.")
  463. #define TEXT_PRIVATE_KEY \
  464. _(" --private-key=FILE Use the private key in FILE.\n"\
  465. " The private key must be decrypted and in PEM\n"\
  466. " format. See also --certificate option.")
  467. #define TEXT_CA_CERTIFICATE \
  468. _(" --ca-certificate=FILE Use the certificate authorities in FILE to verify\n"\
  469. " the peers. The certificate file must be in PEM\n"\
  470. " format and can contain multiple CA certificates.\n"\
  471. " Use --check-certificate option to enable\n"\
  472. " verification.")
  473. #define TEXT_CHECK_CERTIFICATE \
  474. _(" --check-certificate[=true|false] Verify the peer using certificates specified\n"\
  475. " in --ca-certificate option.")
  476. #define TEXT_NO_PROXY \
  477. _(" --no-proxy=DOMAINS Specify comma separated hostnames or domains where\n"\
  478. " proxy should not be used.")
  479. #define TEXT_USE_HEAD \
  480. _(" --use-head[=true|false] Use HEAD method for the first request to the HTTP\n"\
  481. " server.")
  482. #define TEXT_EVENT_POLL \
  483. _(" --event-poll=POLL Specify the method for polling events.")
  484. #define TEXT_XML_RPC_LISTEN_PORT \
  485. _(" --xml-rpc-listen-port=PORT Specify a port number for XML-RPC server to listen\n"\
  486. " to.")
  487. #define TEXT_ENABLE_XML_RPC \
  488. _(" --enable-xml-rpc[=true|false] Enable XML-RPC server.\n"\
  489. " It is strongly recommended to set username and\n"\
  490. " password using --xml-rpc-user and --xml-rpc-passwd\n"\
  491. " option. See also --xml-rpc-listen-port option.")
  492. #define TEXT_XML_RPC_MAX_REQUEST_SIZE \
  493. _(" --xml-rpc-max-request-size=SIZE Set max size of XML-RPC request. If aria2\n"\
  494. " detects the request is more than SIZE bytes, it\n"\
  495. " drops connection.")
  496. #define TEXT_XML_RPC_USER \
  497. _(" --xml-rpc-user=USER Set XML-RPC user.")
  498. #define TEXT_XML_RPC_PASSWD \
  499. _(" --xml-rpc-passwd=PASSWD Set XML-RPC password.")
  500. #define TEXT_BT_EXTERNAL_IP \
  501. _(" --bt-external-ip=IPADDRESS Specify the external IP address to report to a\n"\
  502. " BitTorrent tracker. Although this function is\n"\
  503. " named 'external', it can accept any kind of IP\n"\
  504. " addresses.")
  505. #define TEXT_HTTP_AUTH_CHALLENGE \
  506. _(" --http-auth-challenge[=true|false] Send HTTP authorization header only when it\n"\
  507. " is requested by the server. If false is set, then\n"\
  508. " authorization header is always sent to the server.\n"\
  509. " There is an exception: if username and password\n"\
  510. " are embedded in URI, authorization header is\n"\
  511. " always sent to the server regardless of this\n"\
  512. " option.")
  513. #define TEXT_INDEX_OUT \
  514. _(" -O, --index-out=INDEX=PATH Set file path for file with index=INDEX. You can\n"\
  515. " find the file index using the --show-files option.\n"\
  516. " PATH is a relative path to the path specified in\n"\
  517. " --dir option. You can use this option multiple\n"\
  518. " times.")
  519. #define TEXT_DRY_RUN \
  520. _(" --dry-run[=true|false] If true is given, aria2 just checks whether the\n"\
  521. " remote file is available and doesn't download\n"\
  522. " data. This option has effect on HTTP/FTP download.\n"\
  523. " BitTorrent downloads are canceled if true is\n"\
  524. " specified.")
  525. #define TEXT_BT_TRACKER_INTERVAL \
  526. _(" --bt-tracker-interval=SEC Set the interval in seconds between tracker\n"\
  527. " requests. This completely overrides interval value\n"\
  528. " and aria2 just uses this value and ignores the\n"\
  529. " min interval and interval value in the response of\n"\
  530. " tracker. If 0 is set, aria2 determines interval\n"\
  531. " based on the response of tracker and the download\n"\
  532. " progress.")
  533. #define TEXT_ON_DOWNLOAD_COMPLETE \
  534. _(" --on-download-complete=COMMAND Set the command to be executed when download\n"\
  535. " completes.\n"\
  536. " See --on-download-start option for the\n"\
  537. " requirement of COMMAND.\n"\
  538. " See also --on-download-stop option.")
  539. #define TEXT_ON_DOWNLOAD_START \
  540. _(" --on-download-start=COMMAND Set the command to be executed when download\n"\
  541. " starts up. COMMAND must take just one argument and\n"\
  542. " GID is passed to COMMAND as a first argument.")
  543. #define TEXT_ON_DOWNLOAD_ERROR \
  544. _(" --on-download-error=COMMAND Set the command to be executed when download\n"\
  545. " aborts due to error.\n"\
  546. " See --on-download-start option for the\n"\
  547. " requirement of COMMAND.\n"\
  548. " See also --on-download-stop option.")
  549. #define TEXT_ON_DOWNLOAD_STOP \
  550. _(" --on-download-stop=COMMAND Set the command to be executed when download\n"\
  551. " stops. You can override the command to be executed\n"\
  552. " for particular download result using\n"\
  553. " --on-download-complete and --on-download-error. If\n"\
  554. " they are specified, command specified in this\n"\
  555. " option is not executed.\n"\
  556. " See --on-download-start option for the\n"\
  557. " requirement of COMMAND.")
  558. #define TEXT_BT_STOP_TIMEOUT \
  559. _(" --bt-stop-timeout=SEC Stop BitTorrent download if download speed is 0 in\n"\
  560. " consecutive SEC seconds. If 0 is given, this\n"\
  561. " feature is disabled.")
  562. #define TEXT_XML_RPC_LISTEN_ALL \
  563. _(" --xml-rpc-listen-all[=true|false] Listen incoming XML-RPC requests on all\n"\
  564. " network interfaces. If false is given, listen only\n"\
  565. " on local loopback interface.")
  566. #define TEXT_BT_PRIORITIZE_PIECE \
  567. _(" --bt-prioritize-piece=head[=SIZE],tail[=SIZE] Try to download first and last\n"\
  568. " pieces of each file first. This is useful for\n"\
  569. " previewing files. The argument can contain 2\n"\
  570. " keywords:head and tail. To include both keywords,\n"\
  571. " they must be separated by comma. These keywords\n"\
  572. " can take one parameter, SIZE. For example, if\n"\
  573. " head=SIZE is specified, pieces in the range of\n"\
  574. " first SIZE bytes of each file get higher priority.\n"\
  575. " tail=SIZE means the range of last SIZE bytes of\n"\
  576. " each file. SIZE can include K or M(1K = 1024, 1M =\n"\
  577. " 1024K).")
  578. #define TEXT_INTERFACE \
  579. _(" --interface=INTERFACE Bind sockets to given interface. You can specify\n"\
  580. " interface name, IP address and hostname.")
  581. #define TEXT_DISABLE_IPV6 \
  582. _(" --disable-ipv6[=true|false] Disable IPv6.")