Skip to content

Commit

Permalink
Improve -netinfo help based on feedback from users and devs
Browse files Browse the repository at this point in the history
- clarify that the peer counts table is of reachable networks

- a few other clarifications
  • Loading branch information
jonatack committed Feb 16, 2022
1 parent 7164e00 commit a4da16f
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions src/bitcoin-cli.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -606,8 +606,9 @@ class NetinfoRequestHandler : public BaseRequestHandler
"Suggestion: use with the Linux watch(1) command for a live dashboard; see example below.\n\n"
"Arguments:\n"
+ strprintf("1. level (integer 0-%d, optional) Specify the info level of the peers dashboard (default 0):\n", MAX_DETAIL_LEVEL) +
" 0 - Connection counts and local addresses\n"
" 1 - Like 0 but with a peers listing (without address or version columns)\n"
" 0 - Peer counts for each reachable network as well as for block relay peers\n"
" and manual peers, and the list of local addresses and ports\n"
" 1 - Like 0 but preceded by a peers listing (without address and version columns)\n"
" 2 - Like 1 but with an address column\n"
" 3 - Like 1 but with a version column\n"
" 4 - Like 1 but with both address and version columns\n"
Expand Down Expand Up @@ -645,13 +646,13 @@ class NetinfoRequestHandler : public BaseRequestHandler
" id Peer index, in increasing order of peer connections since node startup\n"
" address IP address and port of the peer\n"
" version Peer version and subversion concatenated, e.g. \"70016/Satoshi:21.0.0/\"\n\n"
"* The connection counts table displays the number of peers by direction, network, and the totals\n"
" for each, as well as two special outbound columns for block relay peers and manual peers.\n\n"
"* The peer counts table displays the number of peers for each reachable network as well as\n"
" the number of block relay peers and manual peers.\n\n"
"* The local addresses table lists each local address broadcast by the node, the port, and the score.\n\n"
"Examples:\n\n"
"Connection counts and local addresses only\n"
"Peer counts table of reachable networks and list of local addresses\n"
"> bitcoin-cli -netinfo\n\n"
"Compact peers listing\n"
"The same, preceded by a peers listing without address and version columns\n"
"> bitcoin-cli -netinfo 1\n\n"
"Full dashboard\n"
+ strprintf("> bitcoin-cli -netinfo %d\n\n", MAX_DETAIL_LEVEL) +
Expand Down

0 comments on commit a4da16f

Please sign in to comment.