From 09abccfa7729b53d057c9c0a7836367d6cc0233d Mon Sep 17 00:00:00 2001 From: willcl-ark Date: Wed, 20 Mar 2024 22:01:30 +0000 Subject: [PATCH 1/6] doc: add bitcoind man description --- src/bitcoind.cpp | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/src/bitcoind.cpp b/src/bitcoind.cpp index e9d78f2888..09a35d4bad 100644 --- a/src/bitcoind.cpp +++ b/src/bitcoind.cpp @@ -136,12 +136,18 @@ static bool ProcessInitCommands(ArgsManager& args) { // Process help and version before taking care about datadir if (HelpRequested(args) || args.IsArgSet("-version")) { - std::string strUsage = CLIENT_NAME " version " + FormatFullVersion() + "\n"; + std::string strUsage = CLIENT_NAME " daemon version " + FormatFullVersion() + "\n"; if (args.IsArgSet("-version")) { strUsage += FormatParagraph(LicenseInfo()); } else { - strUsage += "\nUsage: bitcoind [options] Start " CLIENT_NAME "\n" + strUsage += "\n" + "The " CLIENT_NAME " daemon (bitcoind) is a headless program that connects to the Bitcoin network to validate and relay transactions and blocks, as well as relaying addresses.\n\n" + "It provides the backbone of the Bitcoin network and its RPC, REST and ZMQ services can provide various transaction, block and address-related services.\n\n" + "There is an optional wallet component which provides transaction services.\n\n" + "It can be used in a headless environment or as part of a server setup.\n" + "\n" + "Usage: bitcoind [options]\n" "\n"; strUsage += args.GetHelpMessage(); } From d8c0bb23ef83f207394a3f714f4498ab8abf88c1 Mon Sep 17 00:00:00 2001 From: willcl-ark Date: Thu, 21 Mar 2024 09:17:48 +0000 Subject: [PATCH 2/6] doc: add bitcoin-cli man description --- src/bitcoin-cli.cpp | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/src/bitcoin-cli.cpp b/src/bitcoin-cli.cpp index 8a4c174616..65d9c64322 100644 --- a/src/bitcoin-cli.cpp +++ b/src/bitcoin-cli.cpp @@ -151,10 +151,16 @@ static int AppInitRPC(int argc, char* argv[]) strUsage += FormatParagraph(LicenseInfo()); } else { strUsage += "\n" - "Usage: bitcoin-cli [options] [params] Send command to " CLIENT_NAME "\n" - "or: bitcoin-cli [options] -named [name=value]... Send command to " CLIENT_NAME " (with named arguments)\n" - "or: bitcoin-cli [options] help List commands\n" - "or: bitcoin-cli [options] help Get help for a command\n"; + "The bitcoin-cli utility provides a command line interface to interact with a " CLIENT_NAME " RPC server.\n" + "\nIt can be used to query network information, manage wallets, create or broadcast transactions, and control the " CLIENT_NAME " server.\n" + "\nUse the \"help\" command to list all commands. Use \"help \" to show help for that command.\n" + "The -named option allows you to specify parameters using the key=value format, eliminating the need to pass unused positional parameters.\n" + "\n" + "Usage: bitcoin-cli [options] [params]\n" + "or: bitcoin-cli [options] -named [name=value]...\n" + "or: bitcoin-cli [options] help\n" + "or: bitcoin-cli [options] help \n" + "\n"; strUsage += "\n" + gArgs.GetHelpMessage(); } From 3f9a5168323070a18b6c8b7bffeafe1d2965f50b Mon Sep 17 00:00:00 2001 From: willcl-ark Date: Wed, 20 Mar 2024 22:23:15 +0000 Subject: [PATCH 3/6] doc: add bitcoin-wallet man description --- src/bitcoin-wallet.cpp | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/src/bitcoin-wallet.cpp b/src/bitcoin-wallet.cpp index c469fbda76..de6e6544ed 100644 --- a/src/bitcoin-wallet.cpp +++ b/src/bitcoin-wallet.cpp @@ -61,17 +61,18 @@ static std::optional WalletAppInit(ArgsManager& args, int argc, char* argv[ } const bool missing_args{argc < 2}; if (missing_args || HelpRequested(args) || args.IsArgSet("-version")) { - std::string strUsage = strprintf("%s bitcoin-wallet version", CLIENT_NAME) + " " + FormatFullVersion() + "\n"; + std::string strUsage = strprintf("%s bitcoin-wallet utility version", CLIENT_NAME) + " " + FormatFullVersion() + "\n"; if (args.IsArgSet("-version")) { strUsage += FormatParagraph(LicenseInfo()); } else { strUsage += "\n" - "bitcoin-wallet is an offline tool for creating and interacting with " CLIENT_NAME " wallet files.\n" - "By default bitcoin-wallet will act on wallets in the default mainnet wallet directory in the datadir.\n" - "To change the target wallet, use the -datadir, -wallet and -regtest/-signet/-testnet/-testnet4 arguments.\n\n" - "Usage:\n" - " bitcoin-wallet [options] \n"; + "bitcoin-wallet is an offline tool for creating and interacting with " CLIENT_NAME " wallet files.\n\n" + "By default bitcoin-wallet will act on wallets in the default mainnet wallet directory in the datadir.\n\n" + "To change the target wallet, use the -datadir, -wallet and -regtest / -signet / -testnet arguments.\n" + "\n" + "Usage: bitcoin-wallet [options] \n" + "\n"; strUsage += "\n" + args.GetHelpMessage(); } tfm::format(std::cout, "%s", strUsage); From a7bf80f3a2db17ca6cbbaf45c49fbd6011633fa5 Mon Sep 17 00:00:00 2001 From: willcl-ark Date: Wed, 20 Mar 2024 23:05:01 +0000 Subject: [PATCH 4/6] doc: add bitcoin-tx man description --- src/bitcoin-tx.cpp | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/src/bitcoin-tx.cpp b/src/bitcoin-tx.cpp index 1aff914792..1561510db8 100644 --- a/src/bitcoin-tx.cpp +++ b/src/bitcoin-tx.cpp @@ -113,8 +113,11 @@ static int AppInitRawTx(int argc, char* argv[]) strUsage += FormatParagraph(LicenseInfo()); } else { strUsage += "\n" - "Usage: bitcoin-tx [options] [commands] Update hex-encoded bitcoin transaction\n" - "or: bitcoin-tx [options] -create [commands] Create hex-encoded bitcoin transaction\n" + "The bitcoin-tx tool is used for creating and modifying bitcoin transactions.\n\n" + "bitcoin-tx can be used with \" [commands]\" to update a hex-encoded bitcoin transaction, or with \"-create [commands]\" to create a hex-encoded bitcoin transaction.\n" + "\n" + "Usage: bitcoin-tx [options] [commands]\n" + "or: bitcoin-tx [options] -create [commands]\n" "\n"; strUsage += gArgs.GetHelpMessage(); } From 40b82e3ab0a1889ddb816ca66f80512bdba93ef6 Mon Sep 17 00:00:00 2001 From: willcl-ark Date: Wed, 20 Mar 2024 23:12:02 +0000 Subject: [PATCH 5/6] doc: add bitcoin-util man description --- src/bitcoin-util.cpp | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/src/bitcoin-util.cpp b/src/bitcoin-util.cpp index 657de544b3..c7d10b6622 100644 --- a/src/bitcoin-util.cpp +++ b/src/bitcoin-util.cpp @@ -58,7 +58,10 @@ static int AppInitUtil(ArgsManager& args, int argc, char* argv[]) strUsage += FormatParagraph(LicenseInfo()); } else { strUsage += "\n" - "Usage: bitcoin-util [options] [commands] Do stuff\n"; + "The bitcoin-util tool provides bitcoin related functionality that does not rely on the ability to access a running node. Available [commands] are listed below.\n" + "\n" + "Usage: bitcoin-util [options] [command]\n" + "or: bitcoin-util [options] grind \n"; strUsage += "\n" + args.GetHelpMessage(); } From 47f50c7af5572520fd986b313a63a44a76d3c859 Mon Sep 17 00:00:00 2001 From: willcl-ark Date: Sat, 23 Mar 2024 09:32:47 +0000 Subject: [PATCH 6/6] doc: add bitcoin-qt man description --- src/qt/utilitydialog.cpp | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/src/qt/utilitydialog.cpp b/src/qt/utilitydialog.cpp index 4e4fb02972..86c3770407 100644 --- a/src/qt/utilitydialog.cpp +++ b/src/qt/utilitydialog.cpp @@ -56,8 +56,11 @@ HelpMessageDialog::HelpMessageDialog(QWidget *parent, bool about) : ui->helpMessage->setVisible(false); } else { setWindowTitle(tr("Command-line options")); - QString header = "Usage: bitcoin-qt [command-line options] [URI]\n\n" - "Optional URI is a Bitcoin address in BIP21 URI format.\n"; + QString header = "The bitcoin-qt application provides a graphical interface for interacting with " CLIENT_NAME ".\n\n" + "It combines the core functionalities of bitcoind with a user-friendly interface for wallet management, transaction history, and network statistics.\n\n" + "It is suitable for users who prefer a graphical over a command-line interface.\n\n" + "You can optionally specify a payment [URI], in e.g. the BIP21 URI format.\n\n" + "Usage: bitcoin-qt [options] [URI]\n\n"; QTextCursor cursor(ui->helpMessage->document()); cursor.insertText(version); cursor.insertBlock();