Skip to content
Bitcoin Roots

v31.1-roots.1 · Commit 8: [PATCH 08/17] chore(roots): integrate v31 identity and maintenance tooling

doc/man/bitcoind.1

Before: doc/man/bitcoind.1 · After: doc/man/bitcoind.1

File metadata
index d5c9dcc9be4c33f301165fcfc6b32a6d8b9be7d3..f70838d2c25c8c7abf1f0df76711454d9de5e619 100644

Download original patch · Release notes

Diff rows 1–296 of 296. Line numbers refer to the original before/after files.

+ Added− RemovedUnmarked lines are context.

Scroll the code area horizontally to read long lines. Before is on the left; after is on the right. Unified view fits narrow screens more easily.

doc/man/bitcoind.1 CHANGED
@@ -1,14 +1,14 @@
1
  .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3.
2
- .TH BITCOIND "1" "July 2026" "bitcoind v31.1.0" "User Commands"
3
  .SH NAME
4
- bitcoind \- manual page for bitcoind v31.1.0
5
  .SH SYNOPSIS
6
  .B bitcoind
7
  [\fI\,options\/\fR]
8
  .SH DESCRIPTION
9
- Bitcoin Core daemon version v31.1.0 bitcoind
10
  .PP
11
- The Bitcoin Core daemon (bitcoind) is a headless program that connects to the Bitcoin network to validate and relay transactions and blocks, as well as relaying addresses.
12
  .PP
13
  It provides the backbone of the Bitcoin network and its RPC, REST and ZMQ services can provide various transaction, block and address\-related services.
14
  .PP
@@ -54,7 +54,12 @@ block hash)
54
  \fB\-blockreconstructionextratxn=\fR<n>
55
  .IP
56
  Extra transactions to keep in memory for compact block reconstructions
57
- (default: 100)
 
 
 
 
 
58
  .HP
59
  \fB\-blocksdir=\fR<dir>
60
  .IP
@@ -84,6 +89,12 @@ Specify path to read\-only configuration file. Relative paths will be
84
  prefixed by datadir location (only useable from command line, not
85
  configuration file) (default: bitcoin.conf)
86
  .HP
 
 
 
 
 
 
87
  \fB\-daemon\fR
88
  .IP
89
  Run in the background as a daemon and accept commands (default: 0)
@@ -399,6 +410,11 @@ Tor control host and port to use if onion listening enabled (default:
399
  .IP
400
  Tor control port password (default: empty)
401
  .HP
 
 
 
 
 
402
  \fB\-v2transport\fR
403
  .IP
404
  Support v2 transport (default: 1)
@@ -408,14 +424,17 @@ Support v2 transport (default: 1)
408
  Bind to the given address and add permission flags to the peers
409
  connecting to it. Use [host]:port notation for IPv6. Allowed
410
  permissions: bloomfilter (allow requesting BIP37 filtered blocks
411
- and transactions), noban (do not ban for misbehavior; implies
 
412
  download), forcerelay (relay transactions that are already in the
413
  mempool; implies relay), relay (relay even in \fB\-blocksonly\fR mode,
414
  and unlimited transaction announcements), mempool (allow
415
  requesting BIP35 mempool contents), download (allow getheaders
416
  during IBD, no disconnect after maxuploadtarget limit), addr
417
  (responses to GETADDR avoid hitting the cache and contain random
418
- records with the most up\-to\-date info). Specify multiple
 
 
419
  permissions separated by commas (default:
420
  download,noban,mempool,relay). Can be specified multiple times.
421
  .HP
@@ -539,50 +558,6 @@ to invoke the command.
539
  .IP
540
  Send transactions with full\-RBF opt\-in enabled (RPC only, default: 1)
541
  .PP
542
- ZeroMQ notification options:
543
- .HP
544
- \fB\-zmqpubhashblock=\fR<address>
545
- .IP
546
- Enable publish hash block in <address>
547
- .HP
548
- \fB\-zmqpubhashblockhwm=\fR<n>
549
- .IP
550
- Set publish hash block outbound message high water mark (default: 1000)
551
- .HP
552
- \fB\-zmqpubhashtx=\fR<address>
553
- .IP
554
- Enable publish hash transaction in <address>
555
- .HP
556
- \fB\-zmqpubhashtxhwm=\fR<n>
557
- .IP
558
- Set publish hash transaction outbound message high water mark (default:
559
- 1000)
560
- .HP
561
- \fB\-zmqpubrawblock=\fR<address>
562
- .IP
563
- Enable publish raw block in <address>
564
- .HP
565
- \fB\-zmqpubrawblockhwm=\fR<n>
566
- .IP
567
- Set publish raw block outbound message high water mark (default: 1000)
568
- .HP
569
- \fB\-zmqpubrawtx=\fR<address>
570
- .IP
571
- Enable publish raw transaction in <address>
572
- .HP
573
- \fB\-zmqpubrawtxhwm=\fR<n>
574
- .IP
575
- Set publish raw transaction outbound message high water mark (default:
576
- 1000)
577
- .HP
578
- \fB\-zmqpubsequence=\fR<address>
579
- .IP
580
- Enable publish hash block and tx sequence in <address>
581
- .HP
582
- \fB\-zmqpubsequencehwm=\fR<n>
583
- .IP
584
- Set publish hash sequence message high water mark (default: 1000)
585
- .PP
586
  Debugging/Testing options:
587
  .HP
588
  \fB\-debug=\fR<category>
@@ -686,29 +661,117 @@ Use the testnet4 chain. Equivalent to \fB\-chain\fR=\fI\,testnet4\/\fR.
686
  .PP
687
  Node relay options:
688
  .HP
 
 
 
 
 
 
 
 
 
 
689
  \fB\-bytespersigop\fR
690
  .IP
691
  Equivalent bytes per sigop in transactions for relay and mining
692
  (default: 20)
693
  .HP
 
 
 
 
 
694
  \fB\-datacarrier\fR
695
  .IP
696
  Relay and mine data carrier transactions (default: 1)
697
  .HP
 
 
 
 
 
 
698
  \fB\-datacarriersize\fR
699
  .IP
700
  Relay and mine transactions whose data\-carrying raw scriptPubKeys in
701
- aggregate are of this size or less, allowing multiple outputs
702
- (default: 100000)
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
703
  .HP
704
  \fB\-minrelaytxfee=\fR<amt>
705
  .IP
706
  Fees (in BTC/kvB) smaller than this are considered zero fee for
707
- relaying, mining and transaction creation (default: 0.000001)
 
 
 
 
 
 
 
 
 
 
708
  .HP
709
  \fB\-permitbaremultisig\fR
710
  .IP
711
- Relay transactions creating non\-P2SH multisig outputs (default: 1)
 
 
 
 
 
 
 
 
 
 
 
712
  .HP
713
  \fB\-privatebroadcast\fR
714
  .IP
@@ -717,6 +780,27 @@ short\-lived connections through the Tor or I2P networks, without
717
  putting them in the mempool first. Transactions submitted through
718
  the wallet are not affected by this option (default: 0)
719
  .HP
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
720
  \fB\-whitelistforcerelay\fR
721
  .IP
722
  Add 'forcerelay' permission to whitelisted peers with default
@@ -734,7 +818,7 @@ Block creation options:
734
  \fB\-blockmintxfee=\fR<amt>
735
  .IP
736
  Set lowest fee rate (in BTC/kvB) for transactions to be included in
737
- block creation. (default: 0.00000001)
738
  .HP
739
  \fB\-blockreservedweight=\fR<n>
740
  .IP
@@ -822,11 +906,14 @@ subject to empty whitelists.
822
  .IP
823
  Accept command line and JSON\-RPC commands
824
  .SH COPYRIGHT
 
825
  Copyright (C) 2009-2026 The Bitcoin Core developers
826
 
827
- Please contribute if you find Bitcoin Core useful. Visit
828
- <https://bitcoincore.org/> for further information about the software.
829
- The source code is available from <https://github.com/bitcoin/bitcoin>.
 
 
830
 
831
  This is experimental software.
832
  Distributed under the MIT software license, see the accompanying file COPYING
 
1
  .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3.
2
+ .TH BITCOIND "1" "October 2026" "bitcoind v31.1-roots.1" "User Commands"
3
  .SH NAME
4
+ bitcoind \- manual page for bitcoind v31.1-roots.1
5
  .SH SYNOPSIS
6
  .B bitcoind
7
  [\fI\,options\/\fR]
8
  .SH DESCRIPTION
9
+ Bitcoin Roots daemon version v31.1\-roots.1 bitcoind
10
  .PP
11
+ The Bitcoin Roots daemon (bitcoind) is a headless program that connects to the Bitcoin network to validate and relay transactions and blocks, as well as relaying addresses.
12
  .PP
13
  It provides the backbone of the Bitcoin network and its RPC, REST and ZMQ services can provide various transaction, block and address\-related services.
14
  .PP
 
54
  \fB\-blockreconstructionextratxn=\fR<n>
55
  .IP
56
  Extra transactions to keep in memory for compact block reconstructions
57
+ (default: 32768)
58
+ .HP
59
+ \fB\-blockreconstructionextratxnsize=\fR<n>
60
+ .IP
61
+ Upper limit of memory usage (in decimal megabytes) for compact block
62
+ extra transactions (default: 10)
63
  .HP
64
  \fB\-blocksdir=\fR<dir>
65
  .IP
 
89
  prefixed by datadir location (only useable from command line, not
90
  configuration file) (default: bitcoin.conf)
91
  .HP
92
+ \fB\-confrw=\fR<file>
93
+ .IP
94
+ Specify read/write configuration file. Relative paths will be prefixed
95
+ by the network\-specific datadir location (default:
96
+ bitcoin_rw.conf)
97
+ .HP
98
  \fB\-daemon\fR
99
  .IP
100
  Run in the background as a daemon and accept commands (default: 0)
 
410
  .IP
411
  Tor control port password (default: empty)
412
  .HP
413
+ \fB\-v2onlyclearnet\fR
414
+ .IP
415
+ Disable outbound v1 connections and v1 fallback on IPv4/IPv6 (default:
416
+ 0)
417
+ .HP
418
  \fB\-v2transport\fR
419
  .IP
420
  Support v2 transport (default: 1)
 
424
  Bind to the given address and add permission flags to the peers
425
  connecting to it. Use [host]:port notation for IPv6. Allowed
426
  permissions: bloomfilter (allow requesting BIP37 filtered blocks
427
+ and transactions), blockfilters (serve compact block filters to
428
+ peers per BIP157), noban (do not ban for misbehavior; implies
429
  download), forcerelay (relay transactions that are already in the
430
  mempool; implies relay), relay (relay even in \fB\-blocksonly\fR mode,
431
  and unlimited transaction announcements), mempool (allow
432
  requesting BIP35 mempool contents), download (allow getheaders
433
  during IBD, no disconnect after maxuploadtarget limit), addr
434
  (responses to GETADDR avoid hitting the cache and contain random
435
+ records with the most up\-to\-date info), forceinbound (when
436
+ connections are full, attempt to evict a random unprotected
437
+ inbound peer to open a slot; implies noban). Specify multiple
438
  permissions separated by commas (default:
439
  download,noban,mempool,relay). Can be specified multiple times.
440
  .HP
 
558
  .IP
559
  Send transactions with full\-RBF opt\-in enabled (RPC only, default: 1)
560
  .PP
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
561
  Debugging/Testing options:
562
  .HP
563
  \fB\-debug=\fR<category>
 
661
  .PP
662
  Node relay options:
663
  .HP
664
+ \fB\-acceptnonstddatacarrier\fR
665
+ .IP
666
+ Relay nonstandard data carrier outputs (default: 0) Values: 0 or 1; no
667
+ value means 1.
668
+ .HP
669
+ \fB\-acceptunknownwitness\fR
670
+ .IP
671
+ Relay transactions sending to unknown or future witness script versions
672
+ (default: 1) Values: 0 or 1; no value means 1.
673
+ .HP
674
  \fB\-bytespersigop\fR
675
  .IP
676
  Equivalent bytes per sigop in transactions for relay and mining
677
  (default: 20)
678
  .HP
679
+ \fB\-bytespersigopstrict\fR
680
+ .IP
681
+ Minimum bytes per sigop in transactions we relay and mine (integer 0 to
682
+ 4294967295; default: 20)
683
+ .HP
684
  \fB\-datacarrier\fR
685
  .IP
686
  Relay and mine data carrier transactions (default: 1)
687
  .HP
688
+ \fB\-datacarriercost=\fR<value>
689
+ .IP
690
+ Treat data carrier bytes as at least N vbytes each (0 to 1073741823.75,
691
+ exact hundredths; rounded up to quarter\-vbytes; default: 1). Only
692
+ local policy size changes.
693
+ .HP
694
  \fB\-datacarriersize\fR
695
  .IP
696
  Relay and mine transactions whose data\-carrying raw scriptPubKeys in
697
+ aggregate are of this size or less, allowing one OP_RETURN output
698
+ (default: 83)
699
+ .HP
700
+ \fB\-dustdynamic=\fR<value>
701
+ .IP
702
+ Update the dust rate every 15 minutes using off,
703
+ [multiplier*]target:blocks, or [multiplier*]mempool:kvB (default:
704
+ off). Multiplier defaults to 3; the configured dustrelayfee is
705
+ the floor and fallback when no estimate is available.
706
+ .HP
707
+ \fB\-maxscriptsize=\fR<n>
708
+ .IP
709
+ Maximum size of scripts (including the witness stack) we relay and mine
710
+ (integer 0 to 4294967295; default: 1650)
711
+ .HP
712
+ \fB\-maxtxlegacysigops\fR
713
+ .IP
714
+ Maximum legacy sigops in transactions we relay and mine (integer 0 to
715
+ 4294967295; default: 2500)
716
+ .HP
717
+ \fB\-mempoolfullrbf\fR
718
+ .IP
719
+ Legacy RBF alias: accept replacement without requiring signaling
720
+ (default: 1). Explicit optin or replacement disabling overrides
721
+ this alias.
722
+ .HP
723
+ \fB\-mempoolreplacement=\fR<value>
724
+ .IP
725
+ Set RBF policy: 0 disables, fee,optin honors signaling or TRUC/v3
726
+ replaceability, and fee,\-optin enables full RBF. Tokens are
727
+ separated by ',' or '+'; empty or 1 enables fee\-based replacement
728
+ (default: fee,\-optin).
729
+ .HP
730
+ \fB\-mempooltruc=\fR<value>
731
+ .IP
732
+ Set TRUC policy: reject, accept, enforce/optin, or \fB\-enforce\fR/\-optin.
733
+ Tokens are separated by ',' or '+'; 0 rejects, empty or 1
734
+ enforces (default: enforce).
735
+ .HP
736
+ \fB\-minrelaycoinblocks=\fR<n>
737
+ .IP
738
+ Minimum coin blocks a transaction must spend to be relayed (integer 0 to
739
+ 9223372036854775807; default: 0)
740
+ .HP
741
+ \fB\-minrelaymaturity=\fR<n>
742
+ .IP
743
+ Minimum input maturity before relay (integer 0 to 2147483647; default:
744
+ 0)
745
  .HP
746
  \fB\-minrelaytxfee=\fR<amt>
747
  .IP
748
  Fees (in BTC/kvB) smaller than this are considered zero fee for
749
+ relaying, mining and transaction creation (default: 0.00001)
750
+ .HP
751
+ \fB\-permitbareanchor\fR
752
+ .IP
753
+ Relay transactions that only have ephemeral anchor outputs (default: 1)
754
+ Values: 0 or 1; no value means 1.
755
+ .HP
756
+ \fB\-permitbaredatacarrier\fR
757
+ .IP
758
+ Relay transactions with data carrier outputs and no monetary outputs
759
+ (default: 0) Values: 0 or 1; no value means 1.
760
  .HP
761
  \fB\-permitbaremultisig\fR
762
  .IP
763
+ Relay transactions creating non\-P2SH multisig outputs (default: 0)
764
+ .HP
765
+ \fB\-permitbarepubkey\fR
766
+ .IP
767
+ Relay legacy pubkey outputs (default: 0) Values: 0 or 1; no value means
768
+ 1.
769
+ .HP
770
+ \fB\-permitephemeral\fR
771
+ .IP
772
+ Permit ephemeral policy exceptions: send, dust, anchor, reject, or 0,
773
+ optionally prefixed with '\-'. Tokens are separated by ',' or '+';
774
+ 0 disables all, empty or 1 enables all (default: anchor only)
775
  .HP
776
  \fB\-privatebroadcast\fR
777
  .IP
 
780
  putting them in the mempool first. Transactions submitted through
781
  the wallet are not affected by this option (default: 0)
782
  .HP
783
+ \fB\-rejectparasites\fR
784
+ .IP
785
+ Refuse to relay or mine parasitic overlay protocols (default: 1) Values:
786
+ 0 or 1; no value means 1.
787
+ .HP
788
+ \fB\-rejecttokens\fR
789
+ .IP
790
+ Refuse to relay or mine transactions involving non\-bitcoin tokens
791
+ (default: 0) Values: 0 or 1; no value means 1.
792
+ .HP
793
+ \fB\-spkreuse=\fR<value>
794
+ .IP
795
+ Set local script reuse policy: allow or conflict; empty/1 aliases allow,
796
+ 0 aliases conflict (default: allow).
797
+ .HP
798
+ \fB\-subdustfeepenalty=\fR<value>
799
+ .IP
800
+ Subtract sub\-dust output deficits from modified policy fees (default:
801
+ 1). Values: 0 or 1; no value means 1. Actual fees and consensus
802
+ validity are unchanged.
803
+ .HP
804
  \fB\-whitelistforcerelay\fR
805
  .IP
806
  Add 'forcerelay' permission to whitelisted peers with default
 
818
  \fB\-blockmintxfee=\fR<amt>
819
  .IP
820
  Set lowest fee rate (in BTC/kvB) for transactions to be included in
821
+ block creation. (default: 0.00001)
822
  .HP
823
  \fB\-blockreservedweight=\fR<n>
824
  .IP
 
906
  .IP
907
  Accept command line and JSON\-RPC commands
908
  .SH COPYRIGHT
909
+ Copyright (C) 2009-2026 The Bitcoin Roots developers
910
  Copyright (C) 2009-2026 The Bitcoin Core developers
911
 
912
+ Please contribute if you find Bitcoin Roots useful. Visit
913
+ <https://github.com/luganoplanb/bitcoin-roots/> for further information about
914
+ the software.
915
+ The source code is available from
916
+ <https://github.com/luganoplanb/bitcoin-roots>.
917
 
918
  This is experimental software.
919
  Distributed under the MIT software license, see the accompanying file COPYING