doc.go 6.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120
  1. // Copyright (c) 2013-2017 The btcsuite developers
  2. // Use of this source code is governed by an ISC
  3. // license that can be found in the LICENSE file.
  4. /*
  5. pktd is a full-node bitcoin implementation written in Go.
  6. The default options are sane for most users. This means pktd will work 'out of
  7. the box' for most users. However, there are also a wide variety of flags that
  8. can be used to control it.
  9. The following section provides a usage overview which enumerates the flags. An
  10. interesting point to note is that the long form of all of these options
  11. (except -C) can be specified in a configuration file that is automatically
  12. parsed when pktd starts up. By default, the configuration file is located at
  13. ~/.pktd/pktd.conf on POSIX-style operating systems and %LOCALAPPDATA%\pktd\pktd.conf
  14. on Windows. The -C (--configfile) flag, as shown below, can be used to override
  15. this location.
  16. Usage:
  17. pktd [OPTIONS]
  18. Application Options:
  19. -V, --version Display version information and exit
  20. -C, --configfile= Path to configuration file
  21. -b, --datadir= Directory to store data
  22. --logdir= Directory to log output.
  23. -a, --addpeer= Add a peer to connect with at startup
  24. --connect= Connect only to the specified peers at startup
  25. --nolisten Disable listening for incoming connections -- NOTE:
  26. Listening is automatically disabled if the --connect
  27. option is used without also specifying listening
  28. interfaces via --listen
  29. --listen= Add an interface/port to listen for connections
  30. (default all interfaces port: 8333, testnet: 18333)
  31. --maxpeers= Max number of inbound and outbound peers (125)
  32. --nobanning Disable banning of misbehaving peers
  33. --banduration= How long to ban misbehaving peers. Valid time units
  34. are {s, m, h}. Minimum 1 second (24h0m0s)
  35. --banthreshold= Maximum allowed ban score before disconnecting and
  36. banning misbehaving peers.
  37. --whitelist= Add an IP network or IP that will not be banned.
  38. (eg. 192.168.1.0/24 or ::1)
  39. -u, --rpcuser= Username for RPC connections
  40. -P, --rpcpass= Password for RPC connections
  41. --rpclimituser= Username for limited RPC connections
  42. --rpclimitpass= Password for limited RPC connections
  43. --rpclisten= Add an interface/port to listen for RPC connections
  44. (default port: 8334, testnet: 18334)
  45. --rpccert= File containing the certificate file
  46. --rpckey= File containing the certificate key
  47. --rpcmaxclients= Max number of RPC clients for standard connections
  48. (10)
  49. --rpcmaxwebsockets= Max number of RPC websocket connections (25)
  50. --rpcquirks Mirror some JSON-RPC quirks of Bitcoin Core -- NOTE:
  51. Discouraged unless interoperability issues need to
  52. be worked around
  53. --norpc Disable built-in RPC server -- NOTE: The RPC server
  54. is disabled by default if no rpcuser/rpcpass or
  55. rpclimituser/rpclimitpass is specified
  56. --notls Disable TLS for the RPC server -- NOTE: This is only
  57. allowed if the RPC server is bound to localhost
  58. --nodnsseed Disable DNS seeding for peers
  59. --externalip= Add an ip to the list of local addresses we claim to
  60. listen on to peers
  61. --homedir= Creates this directory at startup
  62. --testnet Use the test network
  63. --regtest Use the regression test network
  64. --simnet Use the simulation test network
  65. --addcheckpoint= Add a custom checkpoint. Format: '<height>:<hash>'
  66. --nocheckpoints Disable built-in checkpoints. Don't do this unless
  67. you know what you're doing.
  68. --uacomment= Comment to add to the user agent --
  69. See BIP 14 for more information.
  70. --dbtype= Database backend to use for the Block Chain (ffldb)
  71. --profile= Enable HTTP profiling on given port -- NOTE port
  72. must be between 1024 and 65536
  73. --cpuprofile= Write CPU profile to the specified file
  74. -d, --debuglevel= Logging level for all subsystems {trace, debug,
  75. info, warn, error, critical} -- You may also specify
  76. <subsystem>=<level>,<subsystem2>=<level>,... to set
  77. the log level for individual subsystems -- Use show
  78. to list available subsystems (info)
  79. --upnp Use UPnP to map our listening port outside of NAT
  80. --minrelaytxfee= The minimum transaction fee in BTC/kB to be
  81. considered a non-zero fee.
  82. --limitfreerelay= Limit relay of transactions with no transaction fee
  83. to the given amount in thousands of bytes per
  84. minute (15)
  85. --norelaypriority Do not require free or low-fee transactions to have
  86. high priority for relaying
  87. --maxorphantx= Max number of orphan transactions to keep in memory
  88. (100)
  89. --generate Generate (mine) bitcoins using the CPU
  90. --miningaddr= Add the specified payment address to the list of
  91. addresses to use for generated blocks -- At least
  92. one address is required if the generate option is
  93. set
  94. --blockminsize= Mininum block size in bytes to be used when creating
  95. a block
  96. --blockmaxsize= Maximum block size in bytes to be used when creating
  97. a block (750000)
  98. --blockprioritysize= Size in bytes for high-priority/low-fee transactions
  99. when creating a block (50000)
  100. --nopeerbloomfilters Disable bloom filtering support.
  101. --nocfilters Disable committed filtering (CF) support.
  102. --sigcachemaxsize= The maximum number of entries in the signature
  103. verification cache.
  104. --blocksonly Do not accept transactions from remote peers.
  105. --relaynonstd Relay non-standard transactions regardless of the
  106. default settings for the active network.
  107. --rejectnonstd Reject non-standard transactions regardless of the
  108. default settings for the active network.
  109. Help Options:
  110. -h, --help Show this help message
  111. */
  112. package main