forked from bitcoin/bitcoin
-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
doc: Remove generated manual pages from master branch
Replace the generated manual pages on the master branch with placeholders with instructions. The master branch is too much in flux for anything generated from command output to be kept up to date, and having pages from versions ago looks silly. We can't remove them completely because `make dist` relies on the files being present. Resolves bitcoin#20031.
- Loading branch information
Showing
5 changed files
with
15 additions
and
1,477 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,115 +1,5 @@ | ||
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.6. | ||
.TH BITCOIN-CLI "1" "February 2019" "bitcoin-cli v0.17.99.0" "User Commands" | ||
.TH BITCOIN-CLI "1" | ||
.SH NAME | ||
bitcoin-cli \- manual page for bitcoin-cli v0.17.99.0 | ||
.SH SYNOPSIS | ||
.B bitcoin-cli | ||
[\fI\,options\/\fR] \fI\,<command> \/\fR[\fI\,params\/\fR] \fI\,Send command to Bitcoin Core\/\fR | ||
.br | ||
.B bitcoin-cli | ||
[\fI\,options\/\fR] \fI\,-named <command> \/\fR[\fI\,name=value\/\fR]... \fI\,Send command to Bitcoin Core (with named arguments)\/\fR | ||
.br | ||
.B bitcoin-cli | ||
[\fI\,options\/\fR] \fI\,help List commands\/\fR | ||
.br | ||
.B bitcoin-cli | ||
[\fI\,options\/\fR] \fI\,help <command> Get help for a command\/\fR | ||
.SH DESCRIPTION | ||
Bitcoin Core RPC client version v0.17.99.0 | ||
.SH OPTIONS | ||
.HP | ||
\-? | ||
.IP | ||
Print this help message and exit | ||
.HP | ||
\fB\-conf=\fR<file> | ||
.IP | ||
Specify configuration file. Relative paths will be prefixed by datadir | ||
location. (default: bitcoin.conf) | ||
.HP | ||
\fB\-datadir=\fR<dir> | ||
.IP | ||
Specify data directory | ||
.HP | ||
\fB\-getinfo\fR | ||
.IP | ||
Get general information from the remote server. Note that unlike | ||
server\-side RPC calls, the results of \fB\-getinfo\fR is the result of | ||
multiple non\-atomic requests. Some entries in the result may | ||
represent results from different states (e.g. wallet balance may | ||
be as of a different block from the chain state reported) | ||
.HP | ||
\fB\-named\fR | ||
.IP | ||
Pass named instead of positional arguments (default: false) | ||
.HP | ||
\fB\-rpcclienttimeout=\fR<n> | ||
.IP | ||
Timeout in seconds during HTTP requests, or 0 for no timeout. (default: | ||
900) | ||
.HP | ||
\fB\-rpcconnect=\fR<ip> | ||
.IP | ||
Send commands to node running on <ip> (default: 127.0.0.1) | ||
.HP | ||
\fB\-rpccookiefile=\fR<loc> | ||
.IP | ||
Location of the auth cookie. Relative paths will be prefixed by a | ||
net\-specific datadir location. (default: data dir) | ||
.HP | ||
\fB\-rpcpassword=\fR<pw> | ||
.IP | ||
Password for JSON\-RPC connections | ||
.HP | ||
\fB\-rpcport=\fR<port> | ||
.IP | ||
Connect to JSON\-RPC on <port> (default: 8332, testnet: 18332, regtest: | ||
18443) | ||
.HP | ||
\fB\-rpcuser=\fR<user> | ||
.IP | ||
Username for JSON\-RPC connections | ||
.HP | ||
\fB\-rpcwait\fR | ||
.IP | ||
Wait for RPC server to start | ||
.HP | ||
\fB\-rpcwallet=\fR<walletname> | ||
.IP | ||
Send RPC for non\-default wallet on RPC server (needs to exactly match | ||
corresponding \fB\-wallet\fR option passed to bitcoind). This changes | ||
the RPC endpoint used, e.g. | ||
http://127.0.0.1:8332/wallet/<walletname> | ||
.HP | ||
\fB\-stdin\fR | ||
.IP | ||
Read extra arguments from standard input, one per line until EOF/Ctrl\-D | ||
(recommended for sensitive information such as passphrases). When | ||
combined with \fB\-stdinrpcpass\fR, the first line from standard input | ||
is used for the RPC password. | ||
.HP | ||
\fB\-stdinrpcpass\fR | ||
.IP | ||
Read RPC password from standard input as a single line. When combined | ||
with \fB\-stdin\fR, the first line from standard input is used for the | ||
RPC password. | ||
.HP | ||
\fB\-version\fR | ||
.IP | ||
Print version and exit | ||
.PP | ||
Chain selection options: | ||
.HP | ||
\fB\-testnet\fR | ||
.IP | ||
Use the test chain | ||
.SH COPYRIGHT | ||
Copyright (C) 2009-2019 The Bitcoin Core developers | ||
bitcoin-cli \- manual page for bitcoin-cli | ||
|
||
Please contribute if you find Bitcoin Core useful. Visit | ||
<https://bitcoincore.org> for further information about the software. | ||
The source code is available from <https://github.com/bitcoin/bitcoin>. | ||
|
||
This is experimental software. | ||
Distributed under the MIT software license, see the accompanying file COPYING | ||
or <https://opensource.org/licenses/MIT> | ||
This is a placefolder file. Please follow the instructions in \fIcontrib/devtools/README.md\fR to generate the manual pages after a release. |
Oops, something went wrong.