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

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