doc: update manpages

Author: Sjors

contrib/devtools/gen-manpages.py

@@ -9,10 +9,7 @@
 import argparse
 
 BINARIES = [
-'bin/bitcoind',
-'bin/bitcoin-cli',
 'bin/sv2-tp',
-'bin/bitcoin-util',
 ]
 
 parser = argparse.ArgumentParser(

doc/man/sv2-tp.1

@@ -1,5 +1,173 @@
-.TH sv2-tp "1"
+.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.49.3.
+.TH SV2-TP "1" "August 2025" "sv2-tp v1.0.0" "User Commands"
 .SH NAME
-sv2-tp \- manual page for sv2-tp
+sv2-tp \- manual page for sv2-tp v1.0.0
+.SH DESCRIPTION
+Sv2 Template Provider sv2\-tp version v1.0.0
+.PP
+sv2\-tp implements the Stratum v2 Template Provider role. It connects to Bitcoin
+Core via IPC.
+.SS "Usage:"
+.IP
+sv2\-tp [options]
+.SH OPTIONS
+.HP
+\fB\-datadir=\fR<dir>
+.IP
+Specify non\-default Bitcoin Core data directory
+.HP
+\fB\-debuglogfile=\fR<file>
+.IP
+Specify location of debug log file (default: debug.log). Relative paths
+will be prefixed by a net\-specific datadir location. Pass
+\fB\-nodebuglogfile\fR to disable writing the log to a file.
+.HP
+\fB\-help\fR
+.IP
+Print this help message and exit (also \fB\-h\fR or \-?)
+.HP
+\fB\-version\fR
+.IP
+Print version and exit
+.PP
+Connection options:
+.HP
+\fB\-sv2bind=\fR<addr>[:<port>]
+.IP
+Bind to given address and always listen on it (default: 127.0.0.1). Use
+[host]:port notation for IPv6.
+.HP
+\fB\-sv2port=\fR<port>
+.IP
+Listen for Stratum v2 connections on <port> (default: 8336, testnet3:
+18336, testnet4: 48336, signet: 38336, regtest: 18447).
+.PP
+Debugging/Testing options:
+.HP
+\fB\-debug=\fR<category>
+.IP
+Output debug and trace logging (default: \fB\-nodebug\fR, supplying <category>
+is optional). If <category> is not supplied or if <category> is 1
+or "all", output all debug logging. If <category> is 0 or "none",
+any other categories are ignored. Other valid values for
+<category> are: addrman, bench, blockstorage, cmpctblock, coindb,
+estimatefee, http, i2p, ipc, leveldb, mempool, mempoolrej, net,
+proxy, prune, qt, rand, reindex, rpc, scan, selectcoins, sv2,
+tor, txpackages, validation, walletdb. This option can be
+specified multiple times to output multiple categories.
+.HP
+\fB\-debugexclude=\fR<category>
+.IP
+Exclude debug and trace logging for a category. Can be used in
+conjunction with \fB\-debug\fR=\fI\,1\/\fR to output debug and trace logging for
+all categories except the specified category. This option can be
+specified multiple times to exclude multiple categories. This
+takes priority over "\-debug"
+.HP
+\fB\-logips\fR
+.IP
+Include IP addresses in debug output (default: 0)
+.HP
+\fB\-loglevelalways\fR
+.IP
+Always prepend a category and level (default: 0)
+.HP
+\fB\-logsourcelocations\fR
+.IP
+Prepend debug output with name of the originating source location
+(source file, line number and function name) (default: 0)
+.HP
+\fB\-logthreadnames\fR
+.IP
+Prepend debug output with name of the originating thread (default: 0)
+.HP
+\fB\-logtimestamps\fR
+.IP
+Prepend debug output with timestamp (default: 1)
+.HP
+\fB\-printtoconsole\fR
+.IP
+Send trace/debug info to console (default: 1 when no \fB\-daemon\fR. To disable
+logging to file, set \fB\-nodebuglogfile\fR)
+.HP
+\fB\-shrinkdebugfile\fR
+.IP
+Shrink debug.log file on client startup (default: 1 when no \fB\-debug\fR)
+.PP
+Chain selection options:
+.HP
+\fB\-chain=\fR<chain>
+.IP
+Use the chain <chain> (default: main). Allowed values: main, test,
+testnet4, signet, regtest
+.HP
+\fB\-signet\fR
+.IP
+Use the signet chain. Equivalent to \fB\-chain\fR=\fI\,signet\/\fR. Note that the network
+is defined by the \fB\-signetchallenge\fR parameter
+.HP
+\fB\-signetchallenge\fR
+.IP
+Blocks must satisfy the given script to be considered valid (only for
+signet networks; defaults to the global default signet test
+network challenge)
+.HP
+\fB\-signetseednode\fR
+.IP
+Specify a seed node for the signet network, in the hostname[:port]
+format, e.g. sig.net:1234 (may be used multiple times to specify
+multiple seed nodes; defaults to the global default signet test
+network seed node(s))
+.HP
+\fB\-testnet\fR
+.IP
+Use the testnet3 chain. Equivalent to \fB\-chain\fR=\fI\,test\/\fR. Support for testnet3
+is deprecated and will be removed in an upcoming release.
+Consider moving to testnet4 now by using \fB\-testnet4\fR.
+.HP
+\fB\-testnet4\fR
+.IP
+Use the testnet4 chain. Equivalent to \fB\-chain\fR=\fI\,testnet4\/\fR.
+.PP
+Block creation options:
+.HP
+\fB\-sv2feedelta\fR
+.IP
+Minimum fee delta for Template Provider to send update upstream
+(default: 1000 sat)
+.HP
+\fB\-sv2interval\fR
+.IP
+Template Provider block template update interval (default: 30 seconds)
+.PP
+IPC interprocess connection options:
+.HP
+\fB\-ipcconnect=\fR<address>
+.IP
+Connect to bitcoin\-node process in the background to perform online
+operations. Valid <address> values are 'unix' to connect to the
+default socket, 'unix:<socket path>' to connect to a socket at a
+nonstandard path. Default value: unix
+.SH EXAMPLES
+.IP
+# Start separate bitcoin node that sv2\-tp can connect to.
+bitcoin \-m node \-testnet4 \-ipcbind=unix
+.IP
+# Connect to the node:
+sv2\-tp \-testnet4 \-debug=sv2 \-loglevel=sv2:trace
+.IP
+# Now start the SRI Job Declarator Client of Pool role, you should see
+# it connect in the logs.
+.SH COPYRIGHT
+Copyright (C) 2009-2025 The Bitcoin Core developers
+Copyright (C) 2025-2025 The Sv2 Template Provider developers
 
-This is a placeholder file. Please follow the instructions in \fIcontrib/devtools/README.md\fR to generate the manual pages after a release.
+Please contribute if you find Sv2 Template Provider useful. Visit
+<https://github.com/sjors/sv2-tp> for further information about the software.
+The source code is available from <https://github.com/sjors/sv2-tp>.
+
+This is experimental software.
+Distributed under the MIT software license, see the accompanying file COPYING
+or <https://opensource.org/license/MIT>
+.SH "SEE ALSO"
+sv2-tp(1)