Skip to content

Commit 410c2fa

Browse files
laanwjlaanwj
committed
Merge pull request #3619
7398f4a improve command-line options output (Cozz Lovan)
2 parents 7f3c4f0 + 7398f4a commit 410c2fa

File tree

3 files changed

+94
-64
lines changed

3 files changed

+94
-64
lines changed

‎src/init.cpp

Lines changed: 86 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -190,98 +190,126 @@ std::string HelpMessage(HelpMessageMode hmm)
190190
{
191191
string strUsage = _("Options:") + "\n";
192192
strUsage += " -? " + _("This help message") + "\n";
193+
strUsage += " -alertnotify=<cmd> " + _("Execute command when a relevant alert is received or we see a really long fork (%s in cmd is replaced by message)") + "\n";
194+
strUsage += " -blocknotify=<cmd> " + _("Execute command when the best block changes (%s in cmd is replaced by block hash)") + "\n";
195+
strUsage += " -checkblocks=<n> " + _("How many blocks to check at startup (default: 288, 0 = all)") + "\n";
196+
strUsage += " -checklevel=<n> " + _("How thorough the block verification of -checkblocks is (0-4, default: 3)") + "\n";
193197
strUsage += " -conf=<file> " + _("Specify configuration file (default: bitcoin.conf)") + "\n";
198+
if (hmm == HMM_BITCOIND)
199+
{
200+
#if !defined(WIN32)
201+
strUsage += " -daemon " + _("Run in the background as a daemon and accept commands") + "\n";
202+
#endif
203+
}
194204
strUsage += " -datadir=<dir> " + _("Specify data directory") + "\n";
195-
strUsage += " -testnet " + _("Use the test network") + "\n";
196-
strUsage += " -pid=<file> " + _("Specify pid file (default: bitcoind.pid)") + "\n";
197-
strUsage += " -gen " + _("Generate coins (default: 0)") + "\n";
198205
strUsage += " -dbcache=<n> " + strprintf(_("Set database cache size in megabytes (%d to %d, default: %d)"), nMinDbCache, nMaxDbCache, nDefaultDbCache) + "\n";
199-
strUsage += " -timeout=<n> " + _("Specify connection timeout in milliseconds (default: 5000)") + "\n";
200-
strUsage += " -proxy=<ip:port> " + _("Connect through SOCKS proxy") + "\n";
201-
strUsage += " -socks=<n> " + _("Select SOCKS version for -proxy (4 or 5, default: 5)") + "\n";
202-
strUsage += " -onion=<ip:port> " + _("Use separate SOCKS5 proxy to reach peers via Tor hidden services (default: -proxy)") + "\n";
203-
strUsage += " -dns " + _("Allow DNS lookups for -addnode, -seednode and -connect") + "\n";
204-
strUsage += " -port=<port> " + _("Listen for connections on <port> (default: 8333 or testnet: 18333)") + "\n";
205-
strUsage += " -maxconnections=<n> " + _("Maintain at most <n> connections to peers (default: 125)") + "\n";
206+
strUsage += " -keypool=<n> " + _("Set key pool size to <n> (default: 100)") + "\n";
207+
strUsage += " -loadblock=<file> " + _("Imports blocks from external blk000??.dat file") + " " + _("on startup") + "\n";
208+
strUsage += " -par=<n> " + _("Set the number of script verification threads (up to 16, 0 = auto, <0 = leave that many cores free, default: 0)") + "\n";
209+
strUsage += " -pid=<file> " + _("Specify pid file (default: bitcoind.pid)") + "\n";
210+
strUsage += " -reindex " + _("Rebuild block chain index from current blk000??.dat files") + " " + _("on startup") + "\n";
211+
strUsage += " -txindex " + _("Maintain a full transaction index (default: 0)") + "\n";
212+
213+
strUsage += "\n" + _("Connection options:") + "\n";
206214
strUsage += " -addnode=<ip> " + _("Add a node to connect to and attempt to keep the connection open") + "\n";
215+
strUsage += " -banscore=<n> " + _("Threshold for disconnecting misbehaving peers (default: 100)") + "\n";
216+
strUsage += " -bantime=<n> " + _("Number of seconds to keep misbehaving peers from reconnecting (default: 86400)") + "\n";
217+
strUsage += " -bind=<addr> " + _("Bind to given address and always listen on it. Use [host]:port notation for IPv6") + "\n";
207218
strUsage += " -connect=<ip> " + _("Connect only to the specified node(s)") + "\n";
208-
strUsage += " -seednode=<ip> " + _("Connect to a node to retrieve peer addresses, and disconnect") + "\n";
209-
strUsage += " -externalip=<ip> " + _("Specify your own public address") + "\n";
210-
strUsage += " -onlynet=<net> " + _("Only connect to nodes in network <net> (IPv4, IPv6 or Tor)") + "\n";
211219
strUsage += " -discover " + _("Discover own IP address (default: 1 when listening and no -externalip)") + "\n";
212-
strUsage += " -checkpoints " + _("Only accept block chain matching built-in checkpoints (default: 1)") + "\n";
213-
strUsage += " -listen " + _("Accept connections from outside (default: 1 if no -proxy or -connect)") + "\n";
214-
strUsage += " -bind=<addr> " + _("Bind to given address and always listen on it. Use [host]:port notation for IPv6") + "\n";
220+
strUsage += " -dns " + _("Allow DNS lookups for -addnode, -seednode and -connect") + " " + _("(default: 1)") + "\n";
215221
strUsage += " -dnsseed " + _("Find peers using DNS lookup (default: 1 unless -connect)") + "\n";
216-
strUsage += " -banscore=<n> " + _("Threshold for disconnecting misbehaving peers (default: 100)") + "\n";
217-
strUsage += " -bantime=<n> " + _("Number of seconds to keep misbehaving peers from reconnecting (default: 86400)") + "\n";
222+
strUsage += " -externalip=<ip> " + _("Specify your own public address") + "\n";
223+
strUsage += " -listen " + _("Accept connections from outside (default: 1 if no -proxy or -connect)") + "\n";
224+
strUsage += " -maxconnections=<n> " + _("Maintain at most <n> connections to peers (default: 125)") + "\n";
218225
strUsage += " -maxreceivebuffer=<n> " + _("Maximum per-connection receive buffer, <n>*1000 bytes (default: 5000)") + "\n";
219226
strUsage += " -maxsendbuffer=<n> " + _("Maximum per-connection send buffer, <n>*1000 bytes (default: 1000)") + "\n";
227+
strUsage += " -onion=<ip:port> " + _("Use separate SOCKS5 proxy to reach peers via Tor hidden services (default: -proxy)") + "\n";
228+
strUsage += " -onlynet=<net> " + _("Only connect to nodes in network <net> (IPv4, IPv6 or Tor)") + "\n";
229+
strUsage += " -port=<port> " + _("Listen for connections on <port> (default: 8333 or testnet: 18333)") + "\n";
230+
strUsage += " -proxy=<ip:port> " + _("Connect through SOCKS proxy") + "\n";
231+
strUsage += " -seednode=<ip> " + _("Connect to a node to retrieve peer addresses, and disconnect") + "\n";
232+
strUsage += " -socks=<n> " + _("Select SOCKS version for -proxy (4 or 5, default: 5)") + "\n";
233+
strUsage += " -timeout=<n> " + _("Specify connection timeout in milliseconds (default: 5000)") + "\n";
220234
#ifdef USE_UPNP
221235
#if USE_UPNP
222236
strUsage += " -upnp " + _("Use UPnP to map the listening port (default: 1 when listening)") + "\n";
223237
#else
224238
strUsage += " -upnp " + _("Use UPnP to map the listening port (default: 0)") + "\n";
225239
#endif
226240
#endif
241+
242+
#ifdef ENABLE_WALLET
243+
strUsage += "\n" + _("Wallet options:") + "\n";
244+
strUsage += " -disablewallet " + _("Do not load the wallet and disable wallet RPC calls") + "\n";
245+
strUsage += " -paytxfee=<amt> " + _("Fee per kB to add to transactions you send") + "\n";
246+
strUsage += " -rescan " + _("Rescan the block chain for missing wallet transactions") + " " + _("on startup") + "\n";
247+
strUsage += " -salvagewallet " + _("Attempt to recover private keys from a corrupt wallet.dat") + " " + _("on startup") + "\n";
248+
strUsage += " -spendzeroconfchange " + _("Spend unconfirmed change when sending transactions (default: 1)") + "\n";
249+
strUsage += " -upgradewallet " + _("Upgrade wallet to latest format") + " " + _("on startup") + "\n";
250+
strUsage += " -wallet=<file> " + _("Specify wallet file (within data directory)") + " " + _("(default: wallet.dat)") + "\n";
251+
strUsage += " -walletnotify=<cmd> " + _("Execute command when a wallet transaction changes (%s in cmd is replaced by TxID)") + "\n";
252+
strUsage += " -zapwallettxes " + _("Clear list of wallet transactions (diagnostic tool; implies -rescan)") + "\n";
253+
#endif
254+
255+
strUsage += "\n" + _("Debugging/Testing options:") + "\n";
256+
if (GetBoolArg("-help-debug", false))
257+
{
258+
strUsage += " -benchmark " + _("Show benchmark information (default: 0)") + "\n";
259+
strUsage += " -checkpoints " + _("Only accept block chain matching built-in checkpoints (default: 1)") + "\n";
260+
strUsage += " -dblogsize=<n> " + _("Flush database activity from memory pool to disk log every <n> megabytes (default: 100)") + "\n";
261+
strUsage += " -disablesafemode " + _("Disable safemode, override a real safe mode event (default: 0)") + "\n";
262+
strUsage += " -testsafemode " + _("Force safe mode (default: 0)") + "\n";
263+
strUsage += " -dropmessagestest=<n> " + _("Randomly drop 1 of every <n> network messages") + "\n";
264+
strUsage += " -fuzzmessagestest=<n> " + _("Randomly fuzz 1 of every <n> network messages") + "\n";
265+
strUsage += " -flushwallet " + _("Run a thread to flush wallet periodically (default: 1)") + "\n";
266+
}
227267
strUsage += " -debug=<category> " + _("Output debugging information (default: 0, supplying <category> is optional)") + "\n";
228268
strUsage += " " + _("If <category> is not supplied, output all debugging information.") + "\n";
229269
strUsage += " " + _("<category> can be:");
230270
strUsage += " addrman, alert, coindb, db, lock, rand, rpc, selectcoins, mempool, net"; // Don't translate these and qt below
231271
if (hmm == HMM_BITCOIN_QT)
272+
strUsage += ", qt";
273+
strUsage += ".\n";
274+
strUsage += " -gen " + _("Generate coins (default: 0)") + "\n";
275+
strUsage += " -genproclimit=<n> " + _("Set the processor limit for when generation is on (-1 = unlimited, default: -1)") + "\n";
276+
strUsage += " -help-debug " + _("Show all debugging options (usage: --help -help-debug)") + "\n";
277+
strUsage += " -logtimestamps " + _("Prepend debug output with timestamp (default: 1)") + "\n";
278+
if (GetBoolArg("-help-debug", false))
232279
{
233-
strUsage += ", qt.\n";
280+
strUsage += " -limitfreerelay=<n> " + _("Continuously rate-limit free transactions to <n>*1000 bytes per minute (default:15)") + "\n";
281+
strUsage += " -maxsigcachesize=<n> " + _("Limit size of signature cache to <n> entries (default: 50000)") + "\n";
234282
}
235-
else
283+
strUsage += " -mintxfee=<amt> " + _("Fees smaller than this are considered zero fee (for transaction creation) (default:") + " " + FormatMoney(CTransaction::nMinTxFee) + ")" + "\n";
284+
strUsage += " -minrelaytxfee=<amt> " + _("Fees smaller than this are considered zero fee (for relaying) (default:") + " " + FormatMoney(CTransaction::nMinRelayTxFee) + ")" + "\n";
285+
strUsage += " -printtoconsole " + _("Send trace/debug info to console instead of debug.log file") + "\n";
286+
if (GetBoolArg("-help-debug", false))
236287
{
237-
strUsage += ".\n";
288+
strUsage += " -printblock=<hash> " + _("Print block on startup, if found in block index") + "\n";
289+
strUsage += " -printblocktree " + _("Print block tree on startup (default: 0)") + "\n";
290+
strUsage += " -printpriority " + _("Log transaction priority and fee per kB when mining blocks (default: 0)") + "\n";
291+
strUsage += " -privdb " + _("Sets the DB_PRIVATE flag in the wallet db environment (default: 1)") + "\n";
292+
strUsage += " -regtest " + _("Enter regression test mode, which uses a special chain in which blocks can be solved instantly.") + "\n";
293+
strUsage += " " + _("This is intended for regression testing tools and app development.") + "\n";
294+
strUsage += " " + _("In this mode -genproclimit controls how many blocks are generated immediately.") + "\n";
238295
}
239-
strUsage += " -logtimestamps " + _("Prepend debug output with timestamp (default: 1)") + "\n";
240296
strUsage += " -shrinkdebugfile " + _("Shrink debug.log file on client startup (default: 1 when no -debug)") + "\n";
241-
strUsage += " -printtoconsole " + _("Send trace/debug info to console instead of debug.log file") + "\n";
242-
strUsage += " -regtest " + _("Enter regression test mode, which uses a special chain in which blocks can be solved instantly.") + "\n";
243-
strUsage += " " + _("This is intended for regression testing tools and app development.") + "\n";
244-
strUsage += " -server " + _("Accept command line and JSON-RPC commands") + "\n";
297+
strUsage += " -testnet " + _("Use the test network") + "\n";
245298

246-
if (hmm == HMM_BITCOIND)
247-
{
248-
#if !defined(WIN32)
249-
strUsage += " -daemon " + _("Run in the background as a daemon and accept commands") + "\n";
250-
#endif
251-
}
299+
strUsage += "\n" + _("Block creation options:") + "\n";
300+
strUsage += " -blockminsize=<n> " + _("Set minimum block size in bytes (default: 0)") + "\n";
301+
strUsage += " -blockmaxsize=<n> " + strprintf(_("Set maximum block size in bytes (default: %d)"), DEFAULT_BLOCK_MAX_SIZE) + "\n";
302+
strUsage += " -blockprioritysize=<n> " + strprintf(_("Set maximum size of high-priority/low-fee transactions in bytes (default: %d)"), DEFAULT_BLOCK_PRIORITY_SIZE) + "\n";
252303

304+
strUsage += "\n" + _("RPC server options:") + "\n";
305+
strUsage += " -server " + _("Accept command line and JSON-RPC commands") + "\n";
253306
strUsage += " -rpcuser=<user> " + _("Username for JSON-RPC connections") + "\n";
254307
strUsage += " -rpcpassword=<pw> " + _("Password for JSON-RPC connections") + "\n";
255308
strUsage += " -rpcport=<port> " + _("Listen for JSON-RPC connections on <port> (default: 8332 or testnet: 18332)") + "\n";
256309
strUsage += " -rpcallowip=<ip> " + _("Allow JSON-RPC connections from specified IP address") + "\n";
257310
strUsage += " -rpcthreads=<n> " + _("Set the number of threads to service RPC calls (default: 4)") + "\n";
258-
strUsage += " -blocknotify=<cmd> " + _("Execute command when the best block changes (%s in cmd is replaced by block hash)") + "\n";
259-
strUsage += " -alertnotify=<cmd> " + _("Execute command when a relevant alert is received or we see a really long fork (%s in cmd is replaced by message)") + "\n";
260-
strUsage += " -keypool=<n> " + _("Set key pool size to <n> (default: 100)") + "\n";
261-
strUsage += " -checkblocks=<n> " + _("How many blocks to check at startup (default: 288, 0 = all)") + "\n";
262-
strUsage += " -checklevel=<n> " + _("How thorough the block verification is (0-4, default: 3)") + "\n";
263-
strUsage += " -txindex " + _("Maintain a full transaction index (default: 0)") + "\n";
264-
strUsage += " -loadblock=<file> " + _("Imports blocks from external blk000??.dat file") + "\n";
265-
strUsage += " -reindex " + _("Rebuild block chain index from current blk000??.dat files") + "\n";
266-
strUsage += " -par=<n> " + _("Set the number of script verification threads (up to 16, 0 = auto, <0 = leave that many cores free, default: 0)") + "\n";
267-
#ifdef ENABLE_WALLET
268-
strUsage += "\n" + _("Wallet options:") + "\n";
269-
strUsage += " -disablewallet " + _("Do not load the wallet and disable wallet RPC calls") + "\n";
270-
strUsage += " -paytxfee=<amt> " + _("Fee per kB to add to transactions you send") + "\n";
271-
strUsage += " -rescan " + _("Rescan the block chain for missing wallet transactions") + "\n";
272-
strUsage += " -zapwallettxes " + _("Clear list of wallet transactions (diagnostic tool; implies -rescan)") + "\n";
273-
strUsage += " -salvagewallet " + _("Attempt to recover private keys from a corrupt wallet.dat") + "\n";
274-
strUsage += " -upgradewallet " + _("Upgrade wallet to latest format") + "\n";
275-
strUsage += " -wallet=<file> " + _("Specify wallet file (within data directory)") + "\n";
276-
strUsage += " -walletnotify=<cmd> " + _("Execute command when a wallet transaction changes (%s in cmd is replaced by TxID)") + "\n";
277-
strUsage += " -spendzeroconfchange " + _("Spend unconfirmed change when sending transactions (default: 1)") + "\n";
278-
#endif
279-
strUsage += "\n" + _("Block creation options:") + "\n";
280-
strUsage += " -blockminsize=<n> " + _("Set minimum block size in bytes (default: 0)") + "\n";
281-
strUsage += " -blockmaxsize=<n> " + strprintf(_("Set maximum block size in bytes (default: %d)"), DEFAULT_BLOCK_MAX_SIZE) + "\n";
282-
strUsage += " -blockprioritysize=<n> " + strprintf(_("Set maximum size of high-priority/low-fee transactions in bytes (default: %d)"), DEFAULT_BLOCK_PRIORITY_SIZE) + "\n";
283311

284-
strUsage += "\n" + _("SSL options: (see the Bitcoin Wiki for SSL setup instructions)") + "\n";
312+
strUsage += "\n" + _("RPC SSL options: (see the Bitcoin Wiki for SSL setup instructions)") + "\n";
285313
strUsage += " -rpcssl " + _("Use OpenSSL (https) for JSON-RPC connections") + "\n";
286314
strUsage += " -rpcsslcertificatechainfile=<file.cert> " + _("Server certificate file (default: server.cert)") + "\n";
287315
strUsage += " -rpcsslprivatekeyfile=<file.pem> " + _("Server private key (default: server.pem)") + "\n";

‎src/qt/utilitydialog.cpp

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -72,10 +72,11 @@ HelpMessageDialog::HelpMessageDialog(QWidget *parent) :
7272
coreOptions = QString::fromStdString(HelpMessage(HMM_BITCOIN_QT));
7373

7474
uiOptions = tr("UI options") + ":\n" +
75-
" -lang=<lang> " + tr("Set language, for example \"de_DE\" (default: system locale)") + "\n" +
76-
" -min " + tr("Start minimized") + "\n" +
77-
" -splash " + tr("Show splash screen on startup (default: 1)") + "\n" +
78-
" -choosedatadir " + tr("Choose data directory on startup (default: 0)");
75+
" -choosedatadir " + tr("Choose data directory on startup (default: 0)") + "\n" +
76+
" -lang=<lang> " + tr("Set language, for example \"de_DE\" (default: system locale)") + "\n" +
77+
" -min " + tr("Start minimized") + "\n" +
78+
" -rootcertificates=<file> " + tr("Set SSL root certificates for payment request (default: -system-)") + "\n" +
79+
" -splash " + tr("Show splash screen on startup (default: 1)");
7980

8081
ui->helpMessageLabel->setFont(GUIUtil::bitcoinAddressFont());
8182

‎src/rpcclient.cpp

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -265,11 +265,12 @@ std::string HelpMessageCli(bool mainProgram)
265265
strUsage += " -rpcconnect=<ip> " + _("Send commands to node running on <ip> (default: 127.0.0.1)") + "\n";
266266
strUsage += " -rpcport=<port> " + _("Connect to JSON-RPC on <port> (default: 8332 or testnet: 18332)") + "\n";
267267
strUsage += " -rpcwait " + _("Wait for RPC server to start") + "\n";
268-
strUsage += " -rpcuser=<user> " + _("Username for JSON-RPC connections") + "\n";
269-
strUsage += " -rpcpassword=<pw> " + _("Password for JSON-RPC connections") + "\n";
270268

271269
if(mainProgram)
272270
{
271+
strUsage += " -rpcuser=<user> " + _("Username for JSON-RPC connections") + "\n";
272+
strUsage += " -rpcpassword=<pw> " + _("Password for JSON-RPC connections") + "\n";
273+
273274
strUsage += "\n" + _("SSL options: (see the Bitcoin Wiki for SSL setup instructions)") + "\n";
274275
strUsage += " -rpcssl " + _("Use OpenSSL (https) for JSON-RPC connections") + "\n";
275276
}

0 commit comments

Comments
 (0)