Skip to content

Commit c810b16

Browse files
committed
doc: Add description of installed files to files.md
1 parent 94ffd01 commit c810b16

File tree

1 file changed

+34
-2
lines changed

1 file changed

+34
-2
lines changed

doc/files.md

Lines changed: 34 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616

1717
- [Berkeley DB database based wallets](#berkeley-db-database-based-wallets)
1818

19-
- [Notes](#notes)
19+
- [Installed Files](#installed-files)
2020

2121
## Data directory location
2222

@@ -123,8 +123,40 @@ Subdirectory | File(s) | Description
123123
`./` | `wallet.dat` | Personal wallet (a BDB database) with keys and transactions
124124
`./` | `.walletlock` | BDB wallet lock file
125125

126-
## Notes
126+
### Notes
127127

128128
<a name="note1">1</a>. The `/` (slash, U+002F) is used as the platform-independent path component separator in this document.
129129

130130
<a name="note2">2</a>. `NNNNN` matches `[0-9]{5}` regex.
131+
132+
## Installed Files
133+
134+
This table describes the files installed by Bitcoin Core across different platforms.
135+
136+
| **Path** | **Description** |
137+
|------------------------------------------------------------|-----------------------------------------------------------------------------|
138+
| [README.md](README.md) or [readme.txt](README_windows.txt) | Project information and instructions |
139+
| bitcoin.conf | [Generated](../contrib/devtools/gen-bitcoin-conf.sh) configuration file |
140+
| bin/bitcoin | Command-line tool for interacting with Bitcoin. Calls other binaries below. |
141+
| bin/bitcoin-cli | Tool for making node and wallet RPC calls. |
142+
| bin/bitcoin-qt | Bitcoin node and wallet GUI |
143+
| bin/bitcoin-tx | Tool for creating and modifying transactions |
144+
| bin/bitcoin-util | Miscellaneous utilities |
145+
| bin/bitcoin-wallet | Bitcoin wallet tool |
146+
| bin/bitcoind | Bitcoin node and wallet daemon |
147+
| *lib/libbitcoinkernel.so* | Shared library containing core consensus and validation code |
148+
| *lib/pkgconfig/libbitcoinkernel.pc* | Pkg-config metadata for linking to `libbitcoinkernel` |
149+
| *libexec/bench_bitcoin* | Benchmarking tool for measuring node performance |
150+
| *libexec/bitcoin-chainstate* | Tool to validate and connect blocks |
151+
| *libexec/bitcoin-gui* | IPC-enabled alternative to `bitcoin-qt` |
152+
| *libexec/bitcoin-node* | IPC-enabled alternative to `bitcoind` |
153+
| libexec/test_bitcoin | Unit test binary |
154+
| *libexec/test_bitcoin-qt* | GUI-specific unit tests |
155+
| share/man/man1/ | Man pages for command-line tools like `bitcoin-cli`, `bitcoind`, and others |
156+
| share/rpcauth/ | Documentation and scripts for RPC authentication setup |
157+
158+
### Notes
159+
160+
- *Italicized* files are only installed in source builds if relevant CMake options are enabled. They are not included in binary releases.
161+
- README and bitcoin.conf files are included in binary releases but not installed in source builds.
162+
- On Windows, binaries have a `.exe` suffix (e.g., `bitcoin-cli.exe`).

0 commit comments

Comments
 (0)