From 115d830f93cf7d9e2fb1b08786ea3dac124651ce Mon Sep 17 00:00:00 2001 From: matthawkins90 Date: Tue, 12 Apr 2022 17:57:59 -0400 Subject: [PATCH] docs: Update doc.go with latest arguments. --- config.go | 4 ++-- doc.go | 16 ++++++++++++---- 2 files changed, 14 insertions(+), 6 deletions(-) diff --git a/config.go b/config.go index 8eb6b3d607..d70cf6a7d6 100644 --- a/config.go +++ b/config.go @@ -139,7 +139,7 @@ type config struct { RegNet bool `long:"regnet" description:"Use the regression test network"` DebugLevel string `short:"d" long:"debuglevel" description:"Logging level for all subsystems {trace, debug, info, warn, error, critical} -- You may also specify =,=,... to set the log level for individual subsystems -- Use show to list available subsystems"` SigCacheMaxSize uint `long:"sigcachemaxsize" description:"The maximum number of entries in the signature verification cache"` - UtxoCacheMaxSize uint `long:"utxocachemaxsize" description:"The maximum size in MiB of the utxo cache"` + UtxoCacheMaxSize uint `long:"utxocachemaxsize" description:"The maximum size in MiB of the utxo cache; (min: 25, max: 32768)"` // RPC server options and policy. DisableRPC bool `long:"norpc" description:"Disable built-in RPC server -- NOTE: The RPC server is disabled by default if no rpcuser/rpcpass or rpclimituser/rpclimitpass is specified"` @@ -182,7 +182,7 @@ type config struct { // P2P network discovery options. DisableSeeders bool `long:"noseeders" description:"Disable seeding for peer discovery"` DisableDNSSeed bool `long:"nodnsseed" description:"DEPRECATED: use --noseeders"` - ExternalIPs []string `long:"externalip" description:"Add an ip to the list of local addresses we claim to listen on to peers"` + ExternalIPs []string `long:"externalip" description:"Add a public-facing IP to the list of local external IPs that dcrd will advertise to other peers"` NoDiscoverIP bool `long:"nodiscoverip" description:"Disable automatic network address discovery of local external IPs"` Upnp bool `long:"upnp" description:"Use UPnP to map our listening port outside of NAT"` diff --git a/doc.go b/doc.go index 7ab940dafd..4008298ad5 100644 --- a/doc.go +++ b/doc.go @@ -1,5 +1,5 @@ // Copyright (c) 2013-2016 The btcsuite developers -// Copyright (c) 2015-2021 The Decred developers +// Copyright (c) 2015-2022 The Decred developers // Use of this source code is governed by an ISC // license that can be found in the LICENSE file. @@ -27,7 +27,9 @@ Application Options: -C, --configfile= Path to configuration file -b, --datadir= Directory to store data --logdir= Directory to log output - --nofilelogging= Disable file logging + --logsize= Maximum size of log file before it is rotated + (default: 10 MiB) + --nofilelogging Disable file logging --dbtype= Database backend to use for the block chain (default: ffldb) --profile= Enable HTTP profiling on given [addr:]port -- @@ -55,6 +57,11 @@ Application Options: connections (default port: 9109, testnet: 19109) -u, --rpcuser= Username for RPC connections -P, --rpcpass= Password for RPC connections + --authtype= Method for RPC client authentication + (basic or clientcert) + --clientcafile= File containing Certificate Authorities to verify + TLS client certificates; + requires authtype=clientcert --rpclimituser= Username for limited RPC connections --rpclimitpass= Password for limited RPC connections --rpccert= File containing the certificate file @@ -104,8 +111,9 @@ Application Options: seconds (default: 2m0s) --noseeders Disable seeding for peer discovery --nodnsseed DEPRECATED: use --noseeders - --externalip= Add an ip to the list of local addresses we claim - to listen on to peers + --externalip= Add a public-facing IP to the list of local + external IPs that dcrd will advertise to other + peers --nodiscoverip Disable automatic network address discovery of local external IPs --upnp Use UPnP to map our listening port outside of NAT