From c810b168b89dc07017e9feaec1a8746a449a60b1 Mon Sep 17 00:00:00 2001 From: Ryan Ofsky Date: Mon, 14 Apr 2025 09:29:04 -0400 Subject: [PATCH] doc: Add description of installed files to files.md --- doc/files.md | 36 ++++++++++++++++++++++++++++++++++-- 1 file changed, 34 insertions(+), 2 deletions(-) diff --git a/doc/files.md b/doc/files.md index 1b93ab797d1..6d2faa4c8f2 100644 --- a/doc/files.md +++ b/doc/files.md @@ -16,7 +16,7 @@ - [Berkeley DB database based wallets](#berkeley-db-database-based-wallets) -- [Notes](#notes) +- [Installed Files](#installed-files) ## Data directory location @@ -123,8 +123,40 @@ Subdirectory | File(s) | Description `./` | `wallet.dat` | Personal wallet (a BDB database) with keys and transactions `./` | `.walletlock` | BDB wallet lock file -## Notes +### Notes 1. The `/` (slash, U+002F) is used as the platform-independent path component separator in this document. 2. `NNNNN` matches `[0-9]{5}` regex. + +## Installed Files + +This table describes the files installed by Bitcoin Core across different platforms. + +| **Path** | **Description** | +|------------------------------------------------------------|-----------------------------------------------------------------------------| +| [README.md](README.md) or [readme.txt](README_windows.txt) | Project information and instructions | +| bitcoin.conf | [Generated](../contrib/devtools/gen-bitcoin-conf.sh) configuration file | +| bin/bitcoin | Command-line tool for interacting with Bitcoin. Calls other binaries below. | +| bin/bitcoin-cli | Tool for making node and wallet RPC calls. | +| bin/bitcoin-qt | Bitcoin node and wallet GUI | +| bin/bitcoin-tx | Tool for creating and modifying transactions | +| bin/bitcoin-util | Miscellaneous utilities | +| bin/bitcoin-wallet | Bitcoin wallet tool | +| bin/bitcoind | Bitcoin node and wallet daemon | +| *lib/libbitcoinkernel.so* | Shared library containing core consensus and validation code | +| *lib/pkgconfig/libbitcoinkernel.pc* | Pkg-config metadata for linking to `libbitcoinkernel` | +| *libexec/bench_bitcoin* | Benchmarking tool for measuring node performance | +| *libexec/bitcoin-chainstate* | Tool to validate and connect blocks | +| *libexec/bitcoin-gui* | IPC-enabled alternative to `bitcoin-qt` | +| *libexec/bitcoin-node* | IPC-enabled alternative to `bitcoind` | +| libexec/test_bitcoin | Unit test binary | +| *libexec/test_bitcoin-qt* | GUI-specific unit tests | +| share/man/man1/ | Man pages for command-line tools like `bitcoin-cli`, `bitcoind`, and others | +| share/rpcauth/ | Documentation and scripts for RPC authentication setup | + +### Notes + +- *Italicized* files are only installed in source builds if relevant CMake options are enabled. They are not included in binary releases. +- README and bitcoin.conf files are included in binary releases but not installed in source builds. +- On Windows, binaries have a `.exe` suffix (e.g., `bitcoin-cli.exe`).