Skip to content

Commit d8c0bb2

Browse files
committed
doc: add bitcoin-cli man description
1 parent 09abccf commit d8c0bb2

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

src/bitcoin-cli.cpp

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -151,10 +151,16 @@ static int AppInitRPC(int argc, char* argv[])
151151
strUsage += FormatParagraph(LicenseInfo());
152152
} else {
153153
strUsage += "\n"
154-
"Usage: bitcoin-cli [options] <command> [params] Send command to " CLIENT_NAME "\n"
155-
"or: bitcoin-cli [options] -named <command> [name=value]... Send command to " CLIENT_NAME " (with named arguments)\n"
156-
"or: bitcoin-cli [options] help List commands\n"
157-
"or: bitcoin-cli [options] help <command> Get help for a command\n";
154+
"The bitcoin-cli utility provides a command line interface to interact with a " CLIENT_NAME " RPC server.\n"
155+
"\nIt can be used to query network information, manage wallets, create or broadcast transactions, and control the " CLIENT_NAME " server.\n"
156+
"\nUse the \"help\" command to list all commands. Use \"help <command>\" to show help for that command.\n"
157+
"The -named option allows you to specify parameters using the key=value format, eliminating the need to pass unused positional parameters.\n"
158+
"\n"
159+
"Usage: bitcoin-cli [options] <command> [params]\n"
160+
"or: bitcoin-cli [options] -named <command> [name=value]...\n"
161+
"or: bitcoin-cli [options] help\n"
162+
"or: bitcoin-cli [options] help <command>\n"
163+
"\n";
158164
strUsage += "\n" + gArgs.GetHelpMessage();
159165
}
160166

0 commit comments

Comments
 (0)