Skip to content

Commit

Permalink
Update manpages & example bitcoin.conf
Browse files Browse the repository at this point in the history
  • Loading branch information
luke-jr committed Aug 1, 2024
1 parent 1365fdf commit 7a47e23
Show file tree
Hide file tree
Showing 7 changed files with 27 additions and 27 deletions.
2 changes: 1 addition & 1 deletion doc/man/bitcoin-cli.1
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3.
.TH BITCOIN-CLI "1" "June 2024" "bitcoin-cli v27.1.0" "User Commands"
.TH BITCOIN-CLI "1" "August 2024" "bitcoin-cli v27.1.0" "User Commands"
.SH NAME
bitcoin-cli \- manual page for bitcoin-cli v27.1.0
.SH SYNOPSIS
Expand Down
16 changes: 8 additions & 8 deletions doc/man/bitcoin-qt.1
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3.
.TH BITCOIN-QT "1" "June 2024" "bitcoin-qt v27.1.0" "User Commands"
.TH BITCOIN-QT "1" "August 2024" "bitcoin-qt v27.1.0" "User Commands"
.SH NAME
bitcoin-qt \- manual page for bitcoin-qt v27.1.0
.SH SYNOPSIS
Expand Down Expand Up @@ -338,8 +338,7 @@ base while uppercase is 1024 base
.HP
\fB\-natpmp\fR
.IP
Use NAT\-PMP to map the listening port (default: 1 when listening and no
\fB\-proxy\fR)
Use NAT\-PMP to map the listening port (default: 0)
.HP
\fB\-networkactive\fR
.IP
Expand Down Expand Up @@ -417,8 +416,7 @@ software embedding)
.HP
\fB\-upnp\fR
.IP
Use UPnP to map the listening port (default: 1 when listening and no
\fB\-proxy\fR)
Use UPnP to map the listening port (default: 0)
.HP
\fB\-v2transport\fR
.IP
Expand Down Expand Up @@ -875,14 +873,16 @@ are a single IP (e.g. 1.2.3.4), a network/netmask (e.g.
ipv4 (0.0.0.0/0), or all ipv6 (::/0). This option can be
specified multiple times
.HP
\fB\-rpcauth=\fR<userpw>
\fB\-rpcauth=\fR<userpw>[:wallet]
.IP
Username and HMAC\-SHA\-256 hashed password for JSON\-RPC connections. The
field <userpw> comes in the format: <USERNAME>:<SALT>$<HASH>. A
canonical python script is included in share/rpcauth. The client
then connects normally using the
rpcuser=<USERNAME>/rpcpassword=<PASSWORD> pair of arguments. This
option can be specified multiple times
rpcuser=<USERNAME>/rpcpassword=<PASSWORD> pair of arguments. A
single wallet name can also be specified to restrict access to
only that wallet, or '\-' to deny all wallet access. This option
can be specified multiple times
.HP
\fB\-rpcauthfile=\fR<userpw>
.IP
Expand Down
2 changes: 1 addition & 1 deletion doc/man/bitcoin-tx.1
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3.
.TH BITCOIN-TX "1" "June 2024" "bitcoin-tx v27.1.0" "User Commands"
.TH BITCOIN-TX "1" "August 2024" "bitcoin-tx v27.1.0" "User Commands"
.SH NAME
bitcoin-tx \- manual page for bitcoin-tx v27.1.0
.SH SYNOPSIS
Expand Down
2 changes: 1 addition & 1 deletion doc/man/bitcoin-util.1
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3.
.TH BITCOIN-UTIL "1" "June 2024" "bitcoin-util v27.1.0" "User Commands"
.TH BITCOIN-UTIL "1" "August 2024" "bitcoin-util v27.1.0" "User Commands"
.SH NAME
bitcoin-util \- manual page for bitcoin-util v27.1.0
.SH SYNOPSIS
Expand Down
2 changes: 1 addition & 1 deletion doc/man/bitcoin-wallet.1
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3.
.TH BITCOIN-WALLET "1" "June 2024" "bitcoin-wallet v27.1.0" "User Commands"
.TH BITCOIN-WALLET "1" "August 2024" "bitcoin-wallet v27.1.0" "User Commands"
.SH NAME
bitcoin-wallet \- manual page for bitcoin-wallet v27.1.0
.SH SYNOPSIS
Expand Down
16 changes: 8 additions & 8 deletions doc/man/bitcoind.1
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3.
.TH BITCOIND "1" "June 2024" "bitcoind v27.1.0" "User Commands"
.TH BITCOIND "1" "August 2024" "bitcoind v27.1.0" "User Commands"
.SH NAME
bitcoind \- manual page for bitcoind v27.1.0
.SH SYNOPSIS
Expand Down Expand Up @@ -338,8 +338,7 @@ base while uppercase is 1024 base
.HP
\fB\-natpmp\fR
.IP
Use NAT\-PMP to map the listening port (default: 1 when listening and no
\fB\-proxy\fR)
Use NAT\-PMP to map the listening port (default: 0)
.HP
\fB\-networkactive\fR
.IP
Expand Down Expand Up @@ -417,8 +416,7 @@ software embedding)
.HP
\fB\-upnp\fR
.IP
Use UPnP to map the listening port (default: 1 when listening and no
\fB\-proxy\fR)
Use UPnP to map the listening port (default: 0)
.HP
\fB\-v2transport\fR
.IP
Expand Down Expand Up @@ -875,14 +873,16 @@ are a single IP (e.g. 1.2.3.4), a network/netmask (e.g.
ipv4 (0.0.0.0/0), or all ipv6 (::/0). This option can be
specified multiple times
.HP
\fB\-rpcauth=\fR<userpw>
\fB\-rpcauth=\fR<userpw>[:wallet]
.IP
Username and HMAC\-SHA\-256 hashed password for JSON\-RPC connections. The
field <userpw> comes in the format: <USERNAME>:<SALT>$<HASH>. A
canonical python script is included in share/rpcauth. The client
then connects normally using the
rpcuser=<USERNAME>/rpcpassword=<PASSWORD> pair of arguments. This
option can be specified multiple times
rpcuser=<USERNAME>/rpcpassword=<PASSWORD> pair of arguments. A
single wallet name can also be specified to restrict access to
only that wallet, or '\-' to deny all wallet access. This option
can be specified multiple times
.HP
\fB\-rpcauthfile=\fR<userpw>
.IP
Expand Down
14 changes: 7 additions & 7 deletions share/examples/bitcoin.conf
Original file line number Diff line number Diff line change
Expand Up @@ -273,8 +273,7 @@
# base while uppercase is 1024 base
#maxuploadtarget=<n>

# Use NAT-PMP to map the listening port (default: 1 when listening and no
# -proxy)
# Use NAT-PMP to map the listening port (default: 0)
#natpmp=1

# Enable all P2P network activity (default: 1). Can be changed by the
Expand Down Expand Up @@ -337,8 +336,7 @@
# software embedding)
#uaappend=<cmt>

# Use UPnP to map the listening port (default: 1 when listening and no
# -proxy)
# Use UPnP to map the listening port (default: 0)
#upnp=1

# Support v2 transport (default: 1)
Expand Down Expand Up @@ -732,9 +730,11 @@
# field <userpw> comes in the format: <USERNAME>:<SALT>$<HASH>. A
# canonical python script is included in share/rpcauth. The client
# then connects normally using the
# rpcuser=<USERNAME>/rpcpassword=<PASSWORD> pair of arguments. This
# option can be specified multiple times
#rpcauth=<userpw>
# rpcuser=<USERNAME>/rpcpassword=<PASSWORD> pair of arguments. A
# single wallet name can also be specified to restrict access to
# only that wallet, or '-' to deny all wallet access. This option
# can be specified multiple times
#rpcauth=<userpw>[:wallet]

# A file with a single lines with same format as rpcauth. This option can
# be specified multiple times
Expand Down

0 comments on commit 7a47e23

Please sign in to comment.