aboutsummaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorTim Ruffing <crypto@timruffing.de>2018-05-08 17:31:21 +0200
committerTim Ruffing <crypto@timruffing.de>2018-08-04 16:17:13 +0200
commit7272fdcfe7370412b34a96bc19f3819e03169ef7 (patch)
treecc2dbbd4653df3a22c3327987129e8e45b671a97 /src
parent2b67354aa584c4aabae049a67767ac7b70e2d01a (diff)
[docs] Reformat -help output for help2man
This commit slightly changes the format of the "Usage" strings in CLI `-help` messages to meet the expection of the help2man tool, which we use to generate man pages. On the way, we remove a few calls to `strprintf()`, which became superficial after commit 32fbfda.
Diffstat (limited to 'src')
-rw-r--r--src/bitcoin-cli.cpp13
-rw-r--r--src/bitcoin-tx.cpp9
-rw-r--r--src/bitcoind.cpp6
-rw-r--r--src/qt/utilitydialog.cpp5
4 files changed, 14 insertions, 19 deletions
diff --git a/src/bitcoin-cli.cpp b/src/bitcoin-cli.cpp
index a77e3d49b8..24a6dc23b2 100644
--- a/src/bitcoin-cli.cpp
+++ b/src/bitcoin-cli.cpp
@@ -104,14 +104,13 @@ static int AppInitRPC(int argc, char* argv[])
return EXIT_FAILURE;
}
if (argc < 2 || HelpRequested(gArgs) || gArgs.IsArgSet("-version")) {
- std::string strUsage = strprintf("%s RPC client version", PACKAGE_NAME) + " " + FormatFullVersion() + "\n";
+ std::string strUsage = PACKAGE_NAME " RPC client version " + FormatFullVersion() + "\n";
if (!gArgs.IsArgSet("-version")) {
- strUsage += "\nUsage:\n"
- " bitcoin-cli [options] <command> [params] " + strprintf("Send command to %s", PACKAGE_NAME) + "\n" +
- " bitcoin-cli [options] -named <command> [name=value] ... " + strprintf("Send command to %s (with named arguments)", PACKAGE_NAME) + "\n" +
- " bitcoin-cli [options] help List commands\n" +
- " bitcoin-cli [options] help <command> Get help for a command\n";
-
+ strUsage += "\n"
+ "Usage: bitcoin-cli [options] <command> [params] Send command to " PACKAGE_NAME "\n"
+ "or: bitcoin-cli [options] -named <command> [name=value]... Send command to " PACKAGE_NAME " (with named arguments)\n"
+ "or: bitcoin-cli [options] help List commands\n"
+ "or: bitcoin-cli [options] help <command> Get help for a command\n";
strUsage += "\n" + gArgs.GetHelpMessage();
}
diff --git a/src/bitcoin-tx.cpp b/src/bitcoin-tx.cpp
index 181e2bb1bc..5fef4724c9 100644
--- a/src/bitcoin-tx.cpp
+++ b/src/bitcoin-tx.cpp
@@ -98,11 +98,10 @@ static int AppInitRawTx(int argc, char* argv[])
if (argc < 2 || HelpRequested(gArgs)) {
// First part of help message is specific to this utility
- std::string strUsage = strprintf("%s bitcoin-tx utility version", PACKAGE_NAME) + " " + FormatFullVersion() + "\n\n" +
- "Usage:\n"
- " bitcoin-tx [options] <hex-tx> [commands] Update hex-encoded bitcoin transaction\n" +
- " bitcoin-tx [options] -create [commands] Create hex-encoded bitcoin transaction\n" +
- "\n";
+ std::string strUsage = PACKAGE_NAME " bitcoin-tx utility version " + FormatFullVersion() + "\n\n" +
+ "Usage: bitcoin-tx [options] <hex-tx> [commands] Update hex-encoded bitcoin transaction\n" +
+ "or: bitcoin-tx [options] -create [commands] Create hex-encoded bitcoin transaction\n" +
+ "\n";
strUsage += gArgs.GetHelpMessage();
fprintf(stdout, "%s", strUsage.c_str());
diff --git a/src/bitcoind.cpp b/src/bitcoind.cpp
index 4d010c0d14..06f8622426 100644
--- a/src/bitcoind.cpp
+++ b/src/bitcoind.cpp
@@ -71,7 +71,7 @@ static bool AppInit(int argc, char* argv[])
// Process help and version before taking care about datadir
if (HelpRequested(gArgs) || gArgs.IsArgSet("-version")) {
- std::string strUsage = strprintf("%s Daemon", PACKAGE_NAME) + " version " + FormatFullVersion() + "\n";
+ std::string strUsage = PACKAGE_NAME " Daemon version " + FormatFullVersion() + "\n";
if (gArgs.IsArgSet("-version"))
{
@@ -79,9 +79,7 @@ static bool AppInit(int argc, char* argv[])
}
else
{
- strUsage += "\nUsage:\n"
- " bitcoind [options] " + strprintf("Start %s Daemon", PACKAGE_NAME) + "\n";
-
+ strUsage += "\nUsage: bitcoind [options] Start " PACKAGE_NAME " Daemon\n";
strUsage += "\n" + gArgs.GetHelpMessage();
}
diff --git a/src/qt/utilitydialog.cpp b/src/qt/utilitydialog.cpp
index 1da25b0761..c9469593a5 100644
--- a/src/qt/utilitydialog.cpp
+++ b/src/qt/utilitydialog.cpp
@@ -70,8 +70,7 @@ HelpMessageDialog::HelpMessageDialog(interfaces::Node& node, QWidget *parent, bo
ui->helpMessage->setVisible(false);
} else {
setWindowTitle(tr("Command-line options"));
- QString header = "Usage:\n"
- " bitcoin-qt [command-line options] \n";
+ QString header = "Usage: bitcoin-qt [command-line options] \n";
QTextCursor cursor(ui->helpMessage->document());
cursor.insertText(version);
cursor.insertBlock();
@@ -80,7 +79,7 @@ HelpMessageDialog::HelpMessageDialog(interfaces::Node& node, QWidget *parent, bo
std::string strUsage = gArgs.GetHelpMessage();
QString coreOptions = QString::fromStdString(strUsage);
- text = version + "\n" + header + "\n" + coreOptions;
+ text = version + "\n\n" + header + "\n" + coreOptions;
QTextTableFormat tf;
tf.setBorderStyle(QTextFrameFormat::BorderStyle_None);