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.

starwels-cli.1 3.1KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111
  1. .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.3.
  2. .TH STARWELS-CLI "1" "January 2018" "starwels-cli v0.16.0.0" "User Commands"
  3. .SH NAME
  4. starwels-cli \- manual page for starwels-cli v0.16.0.0
  5. .SH DESCRIPTION
  6. Starwels RPC client version v0.16.0.0
  7. .SS "Usage:"
  8. .TP
  9. starwels\-cli [options] <command> [params]
  10. Send command to Starwels
  11. .IP
  12. starwels\-cli [options] \fB\-named\fR <command> [name=value] ... Send command to Starwels (with named arguments)
  13. starwels\-cli [options] help List commands
  14. starwels\-cli [options] help <command> Get help for a command
  15. .SH OPTIONS
  16. .HP
  17. \-?
  18. .IP
  19. This help message
  20. .HP
  21. \fB\-conf=\fR<file>
  22. .IP
  23. Specify configuration file (default: starwels.conf)
  24. .HP
  25. \fB\-datadir=\fR<dir>
  26. .IP
  27. Specify data directory
  28. .HP
  29. \fB\-getinfo\fR
  30. .IP
  31. Get general information from the remote server. Note that unlike
  32. server\-side RPC calls, the results of \fB\-getinfo\fR is the result of
  33. multiple non\-atomic requests. Some entries in the result may
  34. represent results from different states (e.g. wallet balance may
  35. be as of a different block from the chain state reported)
  36. .PP
  37. Chain selection options:
  38. .HP
  39. \fB\-ai\fR
  40. .IP
  41. Use the test chain
  42. .HP
  43. \fB\-regtest\fR
  44. .IP
  45. Enter regression test mode, which uses a special chain in which blocks
  46. can be solved instantly. This is intended for regression testing
  47. tools and app development.
  48. .HP
  49. \fB\-named\fR
  50. .IP
  51. Pass named instead of positional arguments (default: false)
  52. .HP
  53. \fB\-rpcconnect=\fR<ip>
  54. .IP
  55. Send commands to node running on <ip> (default: 127.0.0.1)
  56. .HP
  57. \fB\-rpcport=\fR<port>
  58. .IP
  59. Connect to JSON\-RPC on <port> (default: 8342 or ai: 8332)
  60. .HP
  61. \fB\-rpcwait\fR
  62. .IP
  63. Wait for RPC server to start
  64. .HP
  65. \fB\-rpcuser=\fR<user>
  66. .IP
  67. Username for JSON\-RPC connections
  68. .HP
  69. \fB\-rpcpassword=\fR<pw>
  70. .IP
  71. Password for JSON\-RPC connections
  72. .HP
  73. \fB\-rpcclienttimeout=\fR<n>
  74. .IP
  75. Timeout in seconds during HTTP requests, or 0 for no timeout. (default:
  76. 900)
  77. .HP
  78. \fB\-stdinrpcpass\fR
  79. .TP
  80. Read RPC password from standard input as a single line.
  81. When combined
  82. .IP
  83. with \fB\-stdin\fR, the first line from standard input is used for the
  84. RPC password.
  85. .HP
  86. \fB\-stdin\fR
  87. .IP
  88. Read extra arguments from standard input, one per line until EOF/Ctrl\-D
  89. (recommended for sensitive information such as passphrases).
  90. When combined with \fB\-stdinrpcpass\fR, the first line from standard
  91. input is used for the RPC password.
  92. .HP
  93. \fB\-rpcwallet=\fR<walletname>
  94. .IP
  95. Send RPC for non\-default wallet on RPC server (argument is wallet
  96. filename in starwelsd directory, required if starwelsd/\-Qt runs
  97. with multiple wallets)
  98. .SH COPYRIGHT
  99. Copyright (C) 2009-2018 The Starwels developers
  100. Please contribute if you find Starwels useful. Visit
  101. <https://github.com/starwels> for further information about the software.
  102. The source code is available from <https://github.com/starwels/starwels>.
  103. This is experimental software.
  104. Distributed under the MIT software license, see the accompanying file COPYING
  105. or <https://opensource.org/licenses/MIT>
  106. This product includes software developed by the OpenSSL Project for use in the
  107. OpenSSL Toolkit <https://www.openssl.org> and cryptographic software written by
  108. Eric Young and UPnP software written by Thomas Bernard.