You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

starwelsd.1 14KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560
  1. .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.3.
  2. .TH STARWELSD "1" "January 2018" "starwelsd v0.16.0.0" "User Commands"
  3. .SH NAME
  4. starwelsd \- manual page for starwelsd v0.16.0.0
  5. .SH DESCRIPTION
  6. Starwels Daemon version v0.16.0.0
  7. .SS "Usage:"
  8. .TP
  9. starwelsd [options]
  10. Start Starwels Daemon
  11. .SH OPTIONS
  12. .HP
  13. \-?
  14. .IP
  15. Print this help message and exit
  16. .HP
  17. \fB\-version\fR
  18. .IP
  19. Print version and exit
  20. .HP
  21. \fB\-alertnotify=\fR<cmd>
  22. .IP
  23. Execute command when a relevant alert is received or we see a really
  24. long fork (%s in cmd is replaced by message)
  25. .HP
  26. \fB\-blocknotify=\fR<cmd>
  27. .IP
  28. Execute command when the best block changes (%s in cmd is replaced by
  29. block hash)
  30. .HP
  31. \fB\-assumevalid=\fR<hex>
  32. .IP
  33. If this block is in the chain assume that it and its ancestors are valid
  34. and potentially skip their script verification (0 to verify all,
  35. default:
  36. 00000000764077b29d13e1cb2484f028a24ef2a44486b6e5d3cb17eb4716c465,
  37. ai:
  38. 00000000d7674ad1e7703e7ba02b7611c12fe74de27b6a414cf6e906cc3599e9)
  39. .HP
  40. \fB\-conf=\fR<file>
  41. .IP
  42. Specify configuration file (default: starwels.conf)
  43. .HP
  44. \fB\-daemon\fR
  45. .IP
  46. Run in the background as a daemon and accept commands
  47. .HP
  48. \fB\-datadir=\fR<dir>
  49. .IP
  50. Specify data directory
  51. .HP
  52. \fB\-dbcache=\fR<n>
  53. .IP
  54. Set database cache size in megabytes (4 to 16384, default: 450)
  55. .HP
  56. \fB\-loadblock=\fR<file>
  57. .IP
  58. Imports blocks from external blk000??.dat file on startup
  59. .HP
  60. \fB\-debuglogfile=\fR<file>
  61. .IP
  62. Specify location of debug log file: this can be an absolute path or a
  63. path relative to the data directory (default: debug.log)
  64. .HP
  65. \fB\-maxorphantx=\fR<n>
  66. .IP
  67. Keep at most <n> unconnectable transactions in memory (default: 100)
  68. .HP
  69. \fB\-maxmempool=\fR<n>
  70. .IP
  71. Keep the transaction memory pool below <n> megabytes (default: 300)
  72. .HP
  73. \fB\-mempoolexpiry=\fR<n>
  74. .IP
  75. Do not keep transactions in the mempool longer than <n> hours (default:
  76. 336)
  77. .HP
  78. \fB\-persistmempool\fR
  79. .IP
  80. Whether to save the mempool on shutdown and load on restart (default: 1)
  81. .HP
  82. \fB\-blockreconstructionextratxn=\fR<n>
  83. .IP
  84. Extra transactions to keep in memory for compact block reconstructions
  85. (default: 100)
  86. .HP
  87. \fB\-par=\fR<n>
  88. .IP
  89. Set the number of script verification threads (\fB\-6\fR to 16, 0 = auto, <0 =
  90. leave that many cores free, default: 0)
  91. .HP
  92. \fB\-pid=\fR<file>
  93. .IP
  94. Specify pid file (default: starwelsd.pid)
  95. .HP
  96. \fB\-prune=\fR<n>
  97. .IP
  98. Reduce storage requirements by enabling pruning (deleting) of old
  99. blocks. This allows the pruneblockchain RPC to be called to
  100. delete specific blocks, and enables automatic pruning of old
  101. blocks if a target size in MiB is provided. This mode is
  102. incompatible with \fB\-txindex\fR and \fB\-rescan\fR. Warning: Reverting this
  103. setting requires re\-downloading the entire blockchain. (default:
  104. 0 = disable pruning blocks, 1 = allow manual pruning via RPC,
  105. >550 = automatically prune block files to stay under the
  106. specified target size in MiB)
  107. .HP
  108. \fB\-reindex\-chainstate\fR
  109. .IP
  110. Rebuild chain state from the currently indexed blocks
  111. .HP
  112. \fB\-reindex\fR
  113. .IP
  114. Rebuild chain state and block index from the blk*.dat files on disk
  115. .HP
  116. \fB\-sysperms\fR
  117. .IP
  118. Create new files with system default permissions, instead of umask 077
  119. (only effective with disabled wallet functionality)
  120. .HP
  121. \fB\-txindex\fR
  122. .IP
  123. Maintain a full transaction index, used by the getrawtransaction rpc
  124. call (default: 0)
  125. .PP
  126. Connection options:
  127. .HP
  128. \fB\-addnode=\fR<ip>
  129. .IP
  130. Add a node to connect to and attempt to keep the connection open (see
  131. the `addnode` RPC command help for more info)
  132. .HP
  133. \fB\-banscore=\fR<n>
  134. .IP
  135. Threshold for disconnecting misbehaving peers (default: 100)
  136. .HP
  137. \fB\-bantime=\fR<n>
  138. .IP
  139. Number of seconds to keep misbehaving peers from reconnecting (default:
  140. 86400)
  141. .HP
  142. \fB\-bind=\fR<addr>
  143. .IP
  144. Bind to given address and always listen on it. Use [host]:port notation
  145. for IPv6
  146. .HP
  147. \fB\-connect=\fR<ip>
  148. .IP
  149. Connect only to the specified node(s); \fB\-connect\fR=\fI\,0\/\fR disables automatic
  150. connections (the rules for this peer are the same as for
  151. \fB\-addnode\fR)
  152. .HP
  153. \fB\-discover\fR
  154. .IP
  155. Discover own IP addresses (default: 1 when listening and no \fB\-externalip\fR
  156. or \fB\-proxy\fR)
  157. .HP
  158. \fB\-dns\fR
  159. .IP
  160. Allow DNS lookups for \fB\-addnode\fR, \fB\-seednode\fR and \fB\-connect\fR (default: 1)
  161. .HP
  162. \fB\-dnsseed\fR
  163. .IP
  164. Query for peer addresses via DNS lookup, if low on addresses (default: 1
  165. unless \fB\-connect\fR used)
  166. .HP
  167. \fB\-externalip=\fR<ip>
  168. .IP
  169. Specify your own public address
  170. .HP
  171. \fB\-forcednsseed\fR
  172. .IP
  173. Always query for peer addresses via DNS lookup (default: 0)
  174. .HP
  175. \fB\-listen\fR
  176. .IP
  177. Accept connections from outside (default: 1 if no \fB\-proxy\fR or \fB\-connect\fR)
  178. .HP
  179. \fB\-listenonion\fR
  180. .IP
  181. Automatically create Tor hidden service (default: 1)
  182. .HP
  183. \fB\-maxconnections=\fR<n>
  184. .IP
  185. Maintain at most <n> connections to peers (default: 125)
  186. .HP
  187. \fB\-maxreceivebuffer=\fR<n>
  188. .IP
  189. Maximum per\-connection receive buffer, <n>*1000 bytes (default: 5000)
  190. .HP
  191. \fB\-maxsendbuffer=\fR<n>
  192. .IP
  193. Maximum per\-connection send buffer, <n>*1000 bytes (default: 1000)
  194. .HP
  195. \fB\-maxtimeadjustment\fR
  196. .IP
  197. Maximum allowed median peer time offset adjustment. Local perspective of
  198. time may be influenced by peers forward or backward by this
  199. amount. (default: 4200 seconds)
  200. .HP
  201. \fB\-onion=\fR<ip:port>
  202. .IP
  203. Use separate SOCKS5 proxy to reach peers via Tor hidden services
  204. (default: \fB\-proxy\fR)
  205. .HP
  206. \fB\-onlynet=\fR<net>
  207. .IP
  208. Only connect to nodes in network <net> (ipv4, ipv6 or onion)
  209. .HP
  210. \fB\-permitbaremultisig\fR
  211. .IP
  212. Relay non\-P2SH multisig (default: 1)
  213. .HP
  214. \fB\-peerbloomfilters\fR
  215. .IP
  216. Support filtering of blocks and transaction with bloom filters (default:
  217. 1)
  218. .HP
  219. \fB\-port=\fR<port>
  220. .IP
  221. Listen for connections on <port> (default: 8343 or ai: 8333)
  222. .HP
  223. \fB\-proxy=\fR<ip:port>
  224. .IP
  225. Connect through SOCKS5 proxy
  226. .HP
  227. \fB\-proxyrandomize\fR
  228. .IP
  229. Randomize credentials for every proxy connection. This enables Tor
  230. stream isolation (default: 1)
  231. .HP
  232. \fB\-seednode=\fR<ip>
  233. .IP
  234. Connect to a node to retrieve peer addresses, and disconnect
  235. .HP
  236. \fB\-timeout=\fR<n>
  237. .IP
  238. Specify connection timeout in milliseconds (minimum: 1, default: 5000)
  239. .HP
  240. \fB\-torcontrol=\fR<ip>:<port>
  241. .IP
  242. Tor control port to use if onion listening enabled (default:
  243. 127.0.0.1:9051)
  244. .HP
  245. \fB\-torpassword=\fR<pass>
  246. .IP
  247. Tor control port password (default: empty)
  248. .HP
  249. \fB\-upnp\fR
  250. .IP
  251. Use UPnP to map the listening port (default: 0)
  252. .HP
  253. \fB\-whitebind=\fR<addr>
  254. .IP
  255. Bind to given address and whitelist peers connecting to it. Use
  256. [host]:port notation for IPv6
  257. .HP
  258. \fB\-whitelist=\fR<IP address or network>
  259. .IP
  260. Whitelist peers connecting from the given IP address (e.g. 1.2.3.4) or
  261. CIDR notated network (e.g. 1.2.3.0/24). Can be specified multiple
  262. times. Whitelisted peers cannot be DoS banned and their
  263. transactions are always relayed, even if they are already in the
  264. mempool, useful e.g. for a gateway
  265. .HP
  266. \fB\-maxuploadtarget=\fR<n>
  267. .IP
  268. Tries to keep outbound traffic under the given target (in MiB per 24h),
  269. 0 = no limit (default: 0)
  270. .PP
  271. Wallet options:
  272. .HP
  273. \fB\-addresstype\fR
  274. .IP
  275. What type of addresses to use ("legacy", "p2sh\-segwit", or "bech32",
  276. default: "p2sh\-segwit")
  277. .HP
  278. \fB\-changetype\fR
  279. .IP
  280. What type of change to use ("legacy", "p2sh\-segwit", or "bech32").
  281. Default is same as \fB\-addresstype\fR, except when
  282. \fB\-addresstype\fR=\fI\,p2sh\-segwit\/\fR a native segwit output is used when
  283. sending to a native segwit address)
  284. .HP
  285. \fB\-disablewallet\fR
  286. .IP
  287. Do not load the wallet and disable wallet RPC calls
  288. .HP
  289. \fB\-keypool=\fR<n>
  290. .IP
  291. Set key pool size to <n> (default: 1000)
  292. .HP
  293. \fB\-fallbackfee=\fR<amt>
  294. .IP
  295. A fee rate (in MAI/kB) that will be used when fee estimation has
  296. insufficient data (default: 0.0002)
  297. .HP
  298. \fB\-discardfee=\fR<amt>
  299. .IP
  300. The fee rate (in MAI/kB) that indicates your tolerance for discarding
  301. change by adding it to the fee (default: 0.0001). Note: An output
  302. is discarded if it is dust at this rate, but we will always
  303. discard up to the dust relay fee and a discard fee above that is
  304. limited by the fee estimate for the longest target
  305. .HP
  306. \fB\-mintxfee=\fR<amt>
  307. .IP
  308. Fees (in MAI/kB) smaller than this are considered zero fee for
  309. transaction creation (default: 0.00001)
  310. .HP
  311. \fB\-paytxfee=\fR<amt>
  312. .IP
  313. Fee (in MAI/kB) to add to transactions you send (default: 0.00)
  314. .HP
  315. \fB\-rescan\fR
  316. .IP
  317. Rescan the block chain for missing wallet transactions on startup
  318. .HP
  319. \fB\-salvagewallet\fR
  320. .IP
  321. Attempt to recover private keys from a corrupt wallet on startup
  322. .HP
  323. \fB\-spendzeroconfchange\fR
  324. .IP
  325. Spend unconfirmed change when sending transactions (default: 1)
  326. .HP
  327. \fB\-txconfirmtarget=\fR<n>
  328. .IP
  329. If paytxfee is not set, include enough fee so transactions begin
  330. confirmation on average within n blocks (default: 6)
  331. .HP
  332. \fB\-walletrbf\fR
  333. .IP
  334. Send transactions with full\-RBF opt\-in enabled (RPC only, default: 0)
  335. .HP
  336. \fB\-upgradewallet\fR
  337. .IP
  338. Upgrade wallet to latest format on startup
  339. .HP
  340. \fB\-wallet=\fR<file>
  341. .IP
  342. Specify wallet file (within data directory) (default: wallet.dat)
  343. .HP
  344. \fB\-walletbroadcast\fR
  345. .IP
  346. Make the wallet broadcast transactions (default: 1)
  347. .HP
  348. \fB\-walletdir=\fR<dir>
  349. .IP
  350. Specify directory to hold wallets (default: <datadir>/wallets if it
  351. exists, otherwise <datadir>)
  352. .HP
  353. \fB\-walletnotify=\fR<cmd>
  354. .IP
  355. Execute command when a wallet transaction changes (%s in cmd is replaced
  356. by TxID)
  357. .HP
  358. \fB\-zapwallettxes=\fR<mode>
  359. .IP
  360. Delete all wallet transactions and only recover those parts of the
  361. blockchain through \fB\-rescan\fR on startup (1 = keep tx meta data e.g.
  362. account owner and payment request information, 2 = drop tx meta
  363. data)
  364. .PP
  365. ZeroMQ notification options:
  366. .HP
  367. \fB\-zmqpubhashblock=\fR<address>
  368. .IP
  369. Enable publish hash block in <address>
  370. .HP
  371. \fB\-zmqpubhashtx=\fR<address>
  372. .IP
  373. Enable publish hash transaction in <address>
  374. .HP
  375. \fB\-zmqpubrawblock=\fR<address>
  376. .IP
  377. Enable publish raw block in <address>
  378. .HP
  379. \fB\-zmqpubrawtx=\fR<address>
  380. .IP
  381. Enable publish raw transaction in <address>
  382. .PP
  383. Debugging/Testing options:
  384. .HP
  385. \fB\-uacomment=\fR<cmt>
  386. .IP
  387. Append comment to the user agent string
  388. .HP
  389. \fB\-debug=\fR<category>
  390. .IP
  391. Output debugging information (default: 0, supplying <category> is
  392. optional). If <category> is not supplied or if <category> = 1,
  393. output all debugging information. <category> can be: net, tor,
  394. mempool, http, bench, zmq, db, rpc, estimatefee, addrman,
  395. selectcoins, reindex, cmpctblock, rand, prune, proxy, mempoolrej,
  396. libevent, coindb, qt, leveldb.
  397. .HP
  398. \fB\-debugexclude=\fR<category>
  399. .IP
  400. Exclude debugging information for a category. Can be used in conjunction
  401. with \fB\-debug\fR=\fI\,1\/\fR to output debug logs for all categories except one
  402. or more specified categories.
  403. .HP
  404. \fB\-help\-debug\fR
  405. .IP
  406. Show all debugging options (usage: \fB\-\-help\fR \fB\-help\-debug\fR)
  407. .HP
  408. \fB\-logips\fR
  409. .IP
  410. Include IP addresses in debug output (default: 0)
  411. .HP
  412. \fB\-logtimestamps\fR
  413. .IP
  414. Prepend debug output with timestamp (default: 1)
  415. .HP
  416. \fB\-maxtxfee=\fR<amt>
  417. .IP
  418. Maximum total fees (in MAI) to use in a single wallet transaction or raw
  419. transaction; setting this too low may abort large transactions
  420. (default: 0.10)
  421. .HP
  422. \fB\-printtoconsole\fR
  423. .IP
  424. Send trace/debug info to console instead of debug.log file
  425. .HP
  426. \fB\-shrinkdebugfile\fR
  427. .IP
  428. Shrink debug.log file on client startup (default: 1 when no \fB\-debug\fR)
  429. .PP
  430. Chain selection options:
  431. .HP
  432. \fB\-ai\fR
  433. .IP
  434. Use the test chain
  435. .PP
  436. Node relay options:
  437. .HP
  438. \fB\-bytespersigop\fR
  439. .IP
  440. Equivalent bytes per sigop in transactions for relay and mining
  441. (default: 20)
  442. .HP
  443. \fB\-datacarrier\fR
  444. .IP
  445. Relay and mine data carrier transactions (default: 1)
  446. .HP
  447. \fB\-datacarriersize\fR
  448. .IP
  449. Maximum size of data in data carrier transactions we relay and mine
  450. (default: 83)
  451. .HP
  452. \fB\-mempoolreplacement\fR
  453. .IP
  454. Enable transaction replacement in the memory pool (default: 1)
  455. .HP
  456. \fB\-minrelaytxfee=\fR<amt>
  457. .IP
  458. Fees (in MAI/kB) smaller than this are considered zero fee for relaying,
  459. mining and transaction creation (default: 0.00001)
  460. .HP
  461. \fB\-whitelistrelay\fR
  462. .IP
  463. Accept relayed transactions received from whitelisted peers even when
  464. not relaying transactions (default: 1)
  465. .HP
  466. \fB\-whitelistforcerelay\fR
  467. .IP
  468. Force relay of transactions from whitelisted peers even if they violate
  469. local relay policy (default: 1)
  470. .PP
  471. Block creation options:
  472. .HP
  473. \fB\-blockmaxweight=\fR<n>
  474. .IP
  475. Set maximum BIP141 block weight (default: 3996000)
  476. .HP
  477. \fB\-blockmaxsize=\fR<n>
  478. .IP
  479. Set maximum BIP141 block weight to this * 4. Deprecated, use
  480. blockmaxweight
  481. .HP
  482. \fB\-blockmintxfee=\fR<amt>
  483. .IP
  484. Set lowest fee rate (in MAI/kB) for transactions to be included in block
  485. creation. (default: 0.00001)
  486. .PP
  487. RPC server options:
  488. .HP
  489. \fB\-server\fR
  490. .IP
  491. Accept command line and JSON\-RPC commands
  492. .HP
  493. \fB\-rest\fR
  494. .IP
  495. Accept public REST requests (default: 0)
  496. .HP
  497. \fB\-rpcbind=\fR<addr>[:port]
  498. .IP
  499. Bind to given address to listen for JSON\-RPC connections. This option is
  500. ignored unless \fB\-rpcallowip\fR is also passed. Port is optional and
  501. overrides \fB\-rpcport\fR. Use [host]:port notation for IPv6. This
  502. option can be specified multiple times (default: 127.0.0.1 and
  503. ::1 i.e., localhost, or if \fB\-rpcallowip\fR has been specified,
  504. 0.0.0.0 and :: i.e., all addresses)
  505. .HP
  506. \fB\-rpccookiefile=\fR<loc>
  507. .IP
  508. Location of the auth cookie (default: data dir)
  509. .HP
  510. \fB\-rpcuser=\fR<user>
  511. .IP
  512. Username for JSON\-RPC connections
  513. .HP
  514. \fB\-rpcpassword=\fR<pw>
  515. .IP
  516. Password for JSON\-RPC connections
  517. .HP
  518. \fB\-rpcauth=\fR<userpw>
  519. .IP
  520. Username and hashed password for JSON\-RPC connections. The field
  521. <userpw> comes in the format: <USERNAME>:<SALT>$<HASH>. A
  522. canonical python script is included in share/rpcuser. The client
  523. then connects normally using the
  524. rpcuser=<USERNAME>/rpcpassword=<PASSWORD> pair of arguments. This
  525. option can be specified multiple times
  526. .HP
  527. \fB\-rpcport=\fR<port>
  528. .IP
  529. Listen for JSON\-RPC connections on <port> (default: 8342 or ai:
  530. 8332)
  531. .HP
  532. \fB\-rpcallowip=\fR<ip>
  533. .IP
  534. Allow JSON\-RPC connections from specified source. Valid for <ip> are a
  535. single IP (e.g. 1.2.3.4), a network/netmask (e.g.
  536. 1.2.3.4/255.255.255.0) or a network/CIDR (e.g. 1.2.3.4/24). This
  537. option can be specified multiple times
  538. .HP
  539. \fB\-rpcserialversion\fR
  540. .IP
  541. Sets the serialization of raw transaction or block hex returned in
  542. non\-verbose mode, non\-segwit(0) or segwit(1) (default: 1)
  543. .HP
  544. \fB\-rpcthreads=\fR<n>
  545. .IP
  546. Set the number of threads to service RPC calls (default: 4)
  547. .SH COPYRIGHT
  548. Copyright (C) 2009-2018 The Starwels developers
  549. Please contribute if you find Starwels useful. Visit
  550. <https://github.com/starwels> for further information about the software.
  551. The source code is available from <https://github.com/starwels/starwels>.
  552. This is experimental software.
  553. Distributed under the MIT software license, see the accompanying file COPYING
  554. or <https://opensource.org/licenses/MIT>
  555. This product includes software developed by the OpenSSL Project for use in the
  556. OpenSSL Toolkit <https://www.openssl.org> and cryptographic software written by
  557. Eric Young and UPnP software written by Thomas Bernard.