usage_text.h 46 KB

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