|
1 |
| -.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.6. |
2 |
| -.TH BITCOIN-CLI "1" "February 2019" "bitcoin-cli v0.17.99.0" "User Commands" |
| 1 | +.TH BITCOIN-CLI "1" |
3 | 2 | .SH NAME
|
4 |
| -bitcoin-cli \- manual page for bitcoin-cli v0.17.99.0 |
5 |
| -.SH SYNOPSIS |
6 |
| -.B bitcoin-cli |
7 |
| -[\fI\,options\/\fR] \fI\,<command> \/\fR[\fI\,params\/\fR] \fI\,Send command to Bitcoin Core\/\fR |
8 |
| -.br |
9 |
| -.B bitcoin-cli |
10 |
| -[\fI\,options\/\fR] \fI\,-named <command> \/\fR[\fI\,name=value\/\fR]... \fI\,Send command to Bitcoin Core (with named arguments)\/\fR |
11 |
| -.br |
12 |
| -.B bitcoin-cli |
13 |
| -[\fI\,options\/\fR] \fI\,help List commands\/\fR |
14 |
| -.br |
15 |
| -.B bitcoin-cli |
16 |
| -[\fI\,options\/\fR] \fI\,help <command> Get help for a command\/\fR |
17 |
| -.SH DESCRIPTION |
18 |
| -Bitcoin Core RPC client version v0.17.99.0 |
19 |
| -.SH OPTIONS |
20 |
| -.HP |
21 |
| -\-? |
22 |
| -.IP |
23 |
| -Print this help message and exit |
24 |
| -.HP |
25 |
| -\fB\-conf=\fR<file> |
26 |
| -.IP |
27 |
| -Specify configuration file. Relative paths will be prefixed by datadir |
28 |
| -location. (default: bitcoin.conf) |
29 |
| -.HP |
30 |
| -\fB\-datadir=\fR<dir> |
31 |
| -.IP |
32 |
| -Specify data directory |
33 |
| -.HP |
34 |
| -\fB\-getinfo\fR |
35 |
| -.IP |
36 |
| -Get general information from the remote server. Note that unlike |
37 |
| -server\-side RPC calls, the results of \fB\-getinfo\fR is the result of |
38 |
| -multiple non\-atomic requests. Some entries in the result may |
39 |
| -represent results from different states (e.g. wallet balance may |
40 |
| -be as of a different block from the chain state reported) |
41 |
| -.HP |
42 |
| -\fB\-named\fR |
43 |
| -.IP |
44 |
| -Pass named instead of positional arguments (default: false) |
45 |
| -.HP |
46 |
| -\fB\-rpcclienttimeout=\fR<n> |
47 |
| -.IP |
48 |
| -Timeout in seconds during HTTP requests, or 0 for no timeout. (default: |
49 |
| -900) |
50 |
| -.HP |
51 |
| -\fB\-rpcconnect=\fR<ip> |
52 |
| -.IP |
53 |
| -Send commands to node running on <ip> (default: 127.0.0.1) |
54 |
| -.HP |
55 |
| -\fB\-rpccookiefile=\fR<loc> |
56 |
| -.IP |
57 |
| -Location of the auth cookie. Relative paths will be prefixed by a |
58 |
| -net\-specific datadir location. (default: data dir) |
59 |
| -.HP |
60 |
| -\fB\-rpcpassword=\fR<pw> |
61 |
| -.IP |
62 |
| -Password for JSON\-RPC connections |
63 |
| -.HP |
64 |
| -\fB\-rpcport=\fR<port> |
65 |
| -.IP |
66 |
| -Connect to JSON\-RPC on <port> (default: 8332, testnet: 18332, regtest: |
67 |
| -18443) |
68 |
| -.HP |
69 |
| -\fB\-rpcuser=\fR<user> |
70 |
| -.IP |
71 |
| -Username for JSON\-RPC connections |
72 |
| -.HP |
73 |
| -\fB\-rpcwait\fR |
74 |
| -.IP |
75 |
| -Wait for RPC server to start |
76 |
| -.HP |
77 |
| -\fB\-rpcwallet=\fR<walletname> |
78 |
| -.IP |
79 |
| -Send RPC for non\-default wallet on RPC server (needs to exactly match |
80 |
| -corresponding \fB\-wallet\fR option passed to bitcoind). This changes |
81 |
| -the RPC endpoint used, e.g. |
82 |
| -http://127.0.0.1:8332/wallet/<walletname> |
83 |
| -.HP |
84 |
| -\fB\-stdin\fR |
85 |
| -.IP |
86 |
| -Read extra arguments from standard input, one per line until EOF/Ctrl\-D |
87 |
| -(recommended for sensitive information such as passphrases). When |
88 |
| -combined with \fB\-stdinrpcpass\fR, the first line from standard input |
89 |
| -is used for the RPC password. |
90 |
| -.HP |
91 |
| -\fB\-stdinrpcpass\fR |
92 |
| -.IP |
93 |
| -Read RPC password from standard input as a single line. When combined |
94 |
| -with \fB\-stdin\fR, the first line from standard input is used for the |
95 |
| -RPC password. |
96 |
| -.HP |
97 |
| -\fB\-version\fR |
98 |
| -.IP |
99 |
| -Print version and exit |
100 |
| -.PP |
101 |
| -Chain selection options: |
102 |
| -.HP |
103 |
| -\fB\-testnet\fR |
104 |
| -.IP |
105 |
| -Use the test chain |
106 |
| -.SH COPYRIGHT |
107 |
| -Copyright (C) 2009-2019 The Bitcoin Core developers |
| 3 | +bitcoin-cli \- manual page for bitcoin-cli |
108 | 4 |
|
109 |
| -Please contribute if you find Bitcoin Core useful. Visit |
110 |
| -<https://bitcoincore.org> for further information about the software. |
111 |
| -The source code is available from <https://github.com/bitcoin/bitcoin>. |
112 |
| - |
113 |
| -This is experimental software. |
114 |
| -Distributed under the MIT software license, see the accompanying file COPYING |
115 |
| -or <https://opensource.org/licenses/MIT> |
| 5 | +This is a placefolder file. Please follow the instructions in \fIcontrib/devtools/README.md\fR to generate the manual pages after a release. |
0 commit comments