usage_text.h 72 KB

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