bitcoin/src/qt
Ava Chow f842d0801e
Merge bitcoin/bitcoin#29686: Update manpage descriptions
47f50c7af5 doc: add bitcoin-qt man description (willcl-ark)
40b82e3ab0 doc: add bitcoin-util man description (willcl-ark)
a7bf80f3a2 doc: add bitcoin-tx man description (willcl-ark)
3f9a516832 doc: add bitcoin-wallet man description (willcl-ark)
d8c0bb23ef doc: add bitcoin-cli man description (willcl-ark)
09abccfa77 doc: add bitcoind man description (willcl-ark)

Pull request description:

  Closes #29552

  Add better descriptions to help string for all binaries. Use format which is correctly detected by help2man when generating manpages.

  Examples:

  Before:

  ![image](https://github.com/bitcoin/bitcoin/assets/6606587/9f6a5dbd-b18b-416b-827b-1c260d7a1274)

  After:
  ![image](https://github.com/bitcoin/bitcoin/assets/6606587/179082a1-1082-4204-bad7-56260d0fdefc)

  Demonstration using `bitcoin-cli` also highlights removal of inline usage explanations which were being incorrectly formatted by `help2man`. This results in the following changed format to `bitcoin-cli --help`:

  ![image](https://github.com/bitcoin/bitcoin/assets/6606587/dbebb99f-e419-40cd-a82d-e87f33351fea)

ACKs for top commit:
  achow101:
    ACK 47f50c7af5
  tdb3:
    re ACK 47f50c7af5
  rkrux:
    tACK 47f50c7af5
  maflcko:
    ACK 47f50c7af5 📠

Tree-SHA512: 124a8877077b7d47758ea970949d472b2444e3ba65d2bfeb47ebbdb1f5f8d3bf0abe2c88714bb6c92ba0e36583f0b36aa6f016ea88b65f011c610096ea872182
2024-11-08 13:34:59 -05:00
..
forms qt: remove UPnP settings 2024-10-24 18:23:29 +02:00
locale qt: Translations update 2024-09-13 17:26:39 +01:00
res scripted-diff: Rename PACKAGE_* variables to CLIENT_* 2024-10-28 12:36:19 +00:00
test scripted-diff: Rename PACKAGE_* variables to CLIENT_* 2024-10-28 12:36:19 +00:00
addressbookpage.cpp scripted-diff: Fix bitcoin_config_h includes 2024-02-13 20:10:44 +00:00
addressbookpage.h gui: Add wallet name to address book page 2023-10-04 17:01:49 -03:00
addresstablemodel.cpp refactor: Drop util::Result operator= 2024-04-25 16:08:24 -04:00
addresstablemodel.h gui: Add wallet name to address book page 2023-10-04 17:01:49 -03:00
askpassphrasedialog.cpp gui: Use wallet name for wallet migration rather than WalletModel 2024-08-13 11:25:38 -04:00
askpassphrasedialog.h gui: Use wallet name for wallet migration rather than WalletModel 2024-08-13 11:25:38 -04:00
bantablemodel.cpp gui: fix comments for BanTableModel and BanTablePriv::refreshBanlist() 2023-03-06 16:07:08 +01:00
bantablemodel.h gui: fix comments for BanTableModel and BanTablePriv::refreshBanlist() 2023-03-06 16:07:08 +01:00
bitcoin.cpp scripted-diff: Rename PACKAGE_* variables to CLIENT_* 2024-10-28 12:36:19 +00:00
bitcoin.h scripted-diff: drop config/ subdir for bitcoin-config.h, rename to bitcoin-build-config.h 2024-10-10 12:22:12 +02:00
bitcoin.qrc gui: Add Roboto Mono font 2021-02-21 21:01:02 +02:00
bitcoin_locale.qrc qt: 28.0 translations update 2024-08-26 08:38:58 +01:00
bitcoinaddressvalidator.cpp Update copyright headers to 2018 2018-07-27 07:15:02 -04:00
bitcoinaddressvalidator.h scripted-diff: Bump copyright headers 2020-12-31 09:45:41 +01:00
bitcoinamountfield.cpp Merge bitcoin-core/gui#686: clang-tidy: Force checks for headers in src/qt 2023-01-17 09:54:56 +00:00
bitcoinamountfield.h clang-tidy, qt: Fix modernize-use-default-member-init in headers 2022-12-16 11:58:38 +00:00
bitcoingui.cpp scripted-diff: Rename PACKAGE_* variables to CLIENT_* 2024-10-28 12:36:19 +00:00
bitcoingui.h scripted-diff: drop config/ subdir for bitcoin-config.h, rename to bitcoin-build-config.h 2024-10-10 12:22:12 +02:00
bitcoinstrings.cpp qt: Update translation source file for v28.0 string freeze 2024-08-14 14:14:10 +01:00
bitcoinunits.cpp qt, refactor: Remove default cases for scoped enum 2022-02-22 13:50:30 -08:00
bitcoinunits.h qt, refactor: Remove BitcoinUnits::valid function 2022-02-22 13:50:30 -08:00
clientmodel.cpp scripted-diff: drop config/ subdir for bitcoin-config.h, rename to bitcoin-build-config.h 2024-10-10 12:22:12 +02:00
clientmodel.h Merge bitcoin-core/gui#626: Showing Local Addresses in Node Window 2024-08-02 14:19:02 +01:00
CMakeLists.txt cmake: Add FindQRencode module 2024-11-05 16:38:19 +00:00
coincontroldialog.cpp refactor: remove TxidFromString 2024-07-31 16:47:39 +01:00
coincontroldialog.h qt: remove confusing "Dust" label from coincontrol / sendcoins dialog 2023-07-03 18:06:48 +02:00
coincontroltreewidget.cpp Update copyright headers to 2018 2018-07-27 07:15:02 -04:00
coincontroltreewidget.h refactor: Use override for non-final overriders 2020-05-08 10:36:58 +03:00
createwalletdialog.cpp scripted-diff: drop config/ subdir for bitcoin-config.h, rename to bitcoin-build-config.h 2024-10-10 12:22:12 +02:00
createwalletdialog.h gui: remove legacy wallet creation 2023-10-06 17:20:54 -03:00
csvmodelwriter.cpp clang-tidy, qt: Fix modernize-use-default-member-init in headers 2022-12-16 11:58:38 +00:00
csvmodelwriter.h clang-tidy, qt: Fix modernize-use-default-member-init in headers 2022-12-16 11:58:38 +00:00
editaddressdialog.cpp wallet: Replace use of purpose strings with an enum 2023-04-11 15:55:31 -04:00
editaddressdialog.h clang-tidy, qt: Fix modernize-use-default-member-init in headers 2022-12-16 11:58:38 +00:00
guiconstants.h testnet: Introduce Testnet4 2024-08-06 01:38:10 +02:00
guiutil.cpp gui: Consolidate wallet display name to GUIUtil function 2024-08-13 11:25:38 -04:00
guiutil.h gui: Consolidate wallet display name to GUIUtil function 2024-08-13 11:25:38 -04:00
initexecutor.cpp refactor: Extract util/exception from util/system 2023-03-13 17:09:47 +01:00
initexecutor.h qt: Keep InitExecutor in main gui thread 2021-09-27 13:05:40 +01:00
intro.cpp scripted-diff: Rename PACKAGE_* variables to CLIENT_* 2024-10-28 12:36:19 +00:00
intro.h GUI/Intro: Never change the prune checkbox after the user has touched it 2023-06-29 23:24:39 +00:00
macdockiconhandler.h Remove obj_c for macOS Dock icon menu 2018-11-04 02:42:18 +02:00
macdockiconhandler.mm qt: Replace objc_msgSend with native syntax 2019-08-31 12:25:34 +03:00
macnotificationhandler.h convert C-style (void) parameter lists to C++ style () 2018-09-13 10:36:41 -07:00
macnotificationhandler.mm scripted-diff: Bump copyright headers 2020-04-16 13:33:09 -04:00
macos_appnap.h macOS: disable AppNap during sync 2018-11-01 18:22:06 +03:00
macos_appnap.mm macOS: disable AppNap during sync 2018-11-01 18:22:06 +03:00
main.cpp refactor: Remove hooking code for urlDecode 2024-04-24 23:23:38 +02:00
modaloverlay.cpp scripted-diff: Rename PACKAGE_* variables to CLIENT_* 2024-10-28 12:36:19 +00:00
modaloverlay.h Merge bitcoin-core/gui#686: clang-tidy: Force checks for headers in src/qt 2023-01-17 09:54:56 +00:00
networkstyle.cpp testnet: Introduce Testnet4 2024-08-06 01:38:10 +02:00
networkstyle.h refactor: Replace string chain name constants with ChainTypes 2023-05-09 15:49:14 +02:00
notificator.cpp scripted-diff: drop config/ subdir for bitcoin-config.h, rename to bitcoin-build-config.h 2024-10-10 12:22:12 +02:00
notificator.h scripted-diff: drop config/ subdir for bitcoin-config.h, rename to bitcoin-build-config.h 2024-10-10 12:22:12 +02:00
openuridialog.cpp scripted-diff: Bump copyright headers 2021-12-30 19:36:57 +02:00
openuridialog.h scripted-diff: Bump copyright headers 2021-12-30 19:36:57 +02:00
optionsdialog.cpp scripted-diff: Rename PACKAGE_* variables to CLIENT_* 2024-10-28 12:36:19 +00:00
optionsdialog.h Merge bitcoin-core/gui#686: clang-tidy: Force checks for headers in src/qt 2023-01-17 09:54:56 +00:00
optionsmodel.cpp interfaces: remove now unused 'use_upnp' arg from 'mapPort' 2024-10-24 18:23:30 +02:00
optionsmodel.h qt: remove UPnP settings 2024-10-24 18:23:29 +02:00
overviewpage.cpp GUI: Move "embedded font or not" decision into new OptionsModel::getFontForMoney method 2023-07-21 17:45:21 +00:00
overviewpage.h GUI: Move "embedded font or not" decision into new OptionsModel::getFontForMoney method 2023-07-21 17:45:21 +00:00
paymentserver.cpp scripted-diff: Fix bitcoin_config_h includes 2024-02-13 20:10:44 +00:00
paymentserver.h scripted-diff: Fix bitcoin_config_h includes 2024-02-13 20:10:44 +00:00
peertablemodel.cpp Merge bitcoin-core/gui#686: clang-tidy: Force checks for headers in src/qt 2023-01-17 09:54:56 +00:00
peertablemodel.h Merge bitcoin-core/gui#686: clang-tidy: Force checks for headers in src/qt 2023-01-17 09:54:56 +00:00
peertablesortproxy.cpp scripted-diff: Bump copyright headers 2022-12-24 23:49:50 +00:00
peertablesortproxy.h scripted-diff: Bump copyright headers 2021-12-30 19:36:57 +02:00
platformstyle.cpp clang-tidy: Add performance-no-automatic-move check 2022-12-27 15:25:51 +00:00
platformstyle.h scripted-diff: Bump copyright headers 2021-12-30 19:36:57 +02:00
psbtoperationsdialog.cpp util: add TransactionError includes and namespace declarations 2024-05-16 10:16:08 -05:00
psbtoperationsdialog.h qt, refactor: Drop superfluous type conversions 2023-10-23 15:06:29 +01:00
qrimagewidget.cpp scripted-diff: drop config/ subdir for bitcoin-config.h, rename to bitcoin-build-config.h 2024-10-10 12:22:12 +02:00
qrimagewidget.h clang-tidy, qt: Fix modernize-use-default-member-init in headers 2022-12-16 11:58:38 +00:00
qvalidatedlineedit.cpp Merge bitcoin-core/gui#686: clang-tidy: Force checks for headers in src/qt 2023-01-17 09:54:56 +00:00
qvalidatedlineedit.h Merge bitcoin-core/gui#686: clang-tidy: Force checks for headers in src/qt 2023-01-17 09:54:56 +00:00
qvaluecombobox.cpp clang-tidy, qt: Fix modernize-use-default-member-init in headers 2022-12-16 11:58:38 +00:00
qvaluecombobox.h clang-tidy, qt: Fix modernize-use-default-member-init in headers 2022-12-16 11:58:38 +00:00
README.md doc: Updating docs from autotools to cmake 2024-09-18 11:04:52 -04:00
receivecoinsdialog.cpp GUI: Support translating address type dropdown entries 2023-03-31 12:21:11 +01:00
receivecoinsdialog.h clang-tidy, qt: Fix modernize-use-default-member-init in headers 2022-12-16 11:58:38 +00:00
receiverequestdialog.cpp scripted-diff: drop config/ subdir for bitcoin-config.h, rename to bitcoin-build-config.h 2024-10-10 12:22:12 +02:00
receiverequestdialog.h clang-tidy, qt: Fix modernize-use-default-member-init in headers 2022-12-16 11:58:38 +00:00
recentrequeststablemodel.cpp util: Move util/string.h functions to util namespace 2024-05-16 10:16:08 -05:00
recentrequeststablemodel.h clang-tidy, qt: Fix modernize-use-default-member-init in headers 2022-12-16 11:58:38 +00:00
rpcconsole.cpp scripted-diff: Rename PACKAGE_* variables to CLIENT_* 2024-10-28 12:36:19 +00:00
rpcconsole.h scripted-diff: drop config/ subdir for bitcoin-config.h, rename to bitcoin-build-config.h 2024-10-10 12:22:12 +02:00
sendcoinsdialog.cpp scripted-diff: Rename PACKAGE_* variables to CLIENT_* 2024-10-28 12:36:19 +00:00
sendcoinsdialog.h Merge bitcoin-core/gui#719: Remove confusing "Dust" label from coincontrol / sendcoins dialog 2023-07-04 16:03:30 +01:00
sendcoinsentry.cpp scripted-diff: Fix bitcoin_config_h includes 2024-02-13 20:10:44 +00:00
sendcoinsentry.h Merge bitcoin-core/gui#686: clang-tidy: Force checks for headers in src/qt 2023-01-17 09:54:56 +00:00
sendcoinsrecipient.h scripted-diff: Fix bitcoin_config_h includes 2024-02-13 20:10:44 +00:00
signverifymessagedialog.cpp scripted-diff: Rename PACKAGE_* variables to CLIENT_* 2024-10-28 12:36:19 +00:00
signverifymessagedialog.h clang-tidy, qt: Fix modernize-use-default-member-init in headers 2022-12-16 11:58:38 +00:00
splashscreen.cpp scripted-diff: Rename PACKAGE_* variables to CLIENT_* 2024-10-28 12:36:19 +00:00
splashscreen.h Merge bitcoin-core/gui#686: clang-tidy: Force checks for headers in src/qt 2023-01-17 09:54:56 +00:00
trafficgraphwidget.cpp clang-tidy: Add performance-type-promotion-in-math-fn check 2023-03-26 20:18:03 +01:00
trafficgraphwidget.h Merge bitcoin-core/gui#686: clang-tidy: Force checks for headers in src/qt 2023-01-17 09:54:56 +00:00
transactiondesc.cpp scripted-diff: Fix bitcoin_config_h includes 2024-02-13 20:10:44 +00:00
transactiondesc.h tidy: modernize-use-equals-default 2024-07-08 11:12:01 +02:00
transactiondescdialog.cpp scripted-diff: Bump copyright headers 2021-12-30 19:36:57 +02:00
transactiondescdialog.h scripted-diff: Bump copyright headers 2020-04-16 13:33:09 -04:00
transactionfilterproxy.cpp Correctly limit overview transaction list 2023-01-26 14:56:12 -05:00
transactionfilterproxy.h Correctly limit overview transaction list 2023-01-26 14:56:12 -05:00
transactionoverviewwidget.cpp scripted-diff: Bump copyright headers 2022-12-24 23:49:50 +00:00
transactionoverviewwidget.h scripted-diff: Bump copyright headers 2022-12-24 23:49:50 +00:00
transactionrecord.cpp Merge bitcoin-core/gui#119: Replace send-to-self with dual send+receive entries 2023-09-22 18:29:51 +01:00
transactionrecord.h Merge bitcoin-core/gui#119: Replace send-to-self with dual send+receive entries 2023-09-22 18:29:51 +01:00
transactiontablemodel.cpp scripted-diff: Rename SetHex to SetHexDeprecated 2024-07-24 09:15:34 +02:00
transactiontablemodel.h clang-tidy, qt: Fix modernize-use-default-member-init in headers 2022-12-16 11:58:38 +00:00
transactionview.cpp scripted-diff: Rename SetHex to SetHexDeprecated 2024-07-24 09:15:34 +02:00
transactionview.h qt: mask values on transactions view 2023-03-10 14:52:01 -03:00
utilitydialog.cpp doc: add bitcoin-qt man description 2024-10-30 10:18:43 +00:00
utilitydialog.h gui: Remove unused interfaces::Node references 2020-08-26 05:52:31 -04:00
walletcontroller.cpp gui: fix crash when closing wallet 2024-09-12 19:25:45 -03:00
walletcontroller.h gui: fix crash when closing wallet 2024-09-12 19:25:45 -03:00
walletframe.cpp refactor: Move fs.* to util/fs.* 2023-03-23 12:55:18 +01:00
walletframe.h scripted-diff: Bump copyright headers 2021-12-30 19:36:57 +02:00
walletmodel.cpp gui: Consolidate wallet display name to GUIUtil function 2024-08-13 11:25:38 -04:00
walletmodel.h wallet: return and display signer error 2024-04-16 17:47:43 +02:00
walletmodeltransaction.cpp scripted-diff: Fix bitcoin_config_h includes 2024-02-13 20:10:44 +00:00
walletmodeltransaction.h clang-tidy, qt: Fix modernize-use-default-member-init in headers 2022-12-16 11:58:38 +00:00
walletview.cpp refactor: Avoid implicit-integer-sign-change in processNewTransaction 2024-03-21 19:40:55 +01:00
walletview.h qt: mask values on transactions view 2023-03-10 14:52:01 -03:00
winshutdownmonitor.cpp qt6: Handle different signatures of QANEF::nativeEventFilter 2024-10-04 12:58:04 +01:00
winshutdownmonitor.h qt6: Handle different signatures of QANEF::nativeEventFilter 2024-10-04 12:58:04 +01:00

This directory contains the source code for the Bitcoin Core graphical user interface (GUI). It uses the Qt cross-platform framework.

The current precise version for Qt 5 is specified in qt.mk.

Compile and run

See build instructions: Unix, macOS, Windows, FreeBSD, NetBSD, OpenBSD

When following your systems build instructions, make sure to install the Qt dependencies.

To run:

./build/src/qt/bitcoin-qt

Files and Directories

forms/

  • A directory that contains Designer UI files. These files specify the characteristics of form elements in XML. Qt UI files can be edited with Qt Creator or using any text editor.

locale/

  • Contains translations. They are periodically updated and an effort is made to support as many languages as possible. The process of contributing translations is described in doc/translation_process.md.

res/

  • Contains graphical resources used to enhance the UI experience.

test/

  • Functional tests used to ensure proper functionality of the GUI. Significant changes to the GUI code normally require new or updated tests.

bitcoingui.(h/cpp)

  • Represents the main window of the Bitcoin UI.

*model.(h/cpp)

  • The model. When it has a corresponding controller, it generally inherits from QAbstractTableModel. Models that are used by controllers as helpers inherit from other Qt classes like QValidator.
  • ClientModel is used by the main application bitcoingui and several models like peertablemodel.

*page.(h/cpp)

  • A controller. :NAMEpage.cpp generally includes :NAMEmodel.h and forms/:NAME.page.ui with a similar :NAME.

*dialog.(h/cpp)

  • Various dialogs, e.g. to open a URL. Inherit from QDialog.

paymentserver.(h/cpp)

  • (Deprecated) Used to process BIP21 payment URI requests. Also handles URI-based application switching (e.g. when following a bitcoin:... link from a browser).

walletview.(h/cpp)

  • Represents the view to a single wallet.

Other .h/cpp files

  • UI elements like BitcoinAmountField, which inherit from QWidget.
  • bitcoinstrings.cpp: automatically generated
  • bitcoinunits.(h/cpp): BTC / mBTC / etc. handling
  • callback.h
  • guiconstants.h: UI colors, app name, etc.
  • guiutil.h: several helper functions
  • macdockiconhandler.(h/mm): macOS dock icon handler
  • macnotificationhandler.(h/mm): display notifications in macOS

Contribute

See CONTRIBUTING.md for general guidelines.

Note: Do not change local/bitcoin_en.ts. It is updated automatically.

Using Qt Creator as an IDE

Qt Creator is a powerful tool which packages a UI designer tool (Qt Designer) and a C++ IDE into one application. This is especially useful if you want to change the UI layout.

Download Qt Creator

On Unix and macOS, Qt Creator can be installed through your package manager. Alternatively, you can download a binary from the Qt Website.

Note: If installing from a binary grabbed from the Qt Website: During the installation process, uncheck everything except for Qt Creator.

macOS
brew install qt-creator
Ubuntu & Debian
sudo apt-get install qtcreator

Setup Qt Creator

  1. Make sure you've installed all dependencies specified in your systems build instructions
  2. Follow the compile instructions for your system, adding the -DCMAKE_BUILD_TYPE=Debug build flag
  3. Start Qt Creator. At the start page, do: New -> Import Project -> Import Existing Project
  4. Enter bitcoin-qt as the Project Name and enter the absolute path to src/qt as Location
  5. Check over the file selection, you may need to select the forms directory (necessary if you intend to edit *.ui files)
  6. Confirm the Summary page
  7. In the Projects tab, select Manage Kits...

macOS

  • Under Kits: select the default "Desktop" kit
  • Under Compilers: select "Clang (x86 64bit in /usr/bin)"
  • Under Debuggers: select "LLDB" as debugger (you might need to set the path to your LLDB installation)

Ubuntu & Debian

Note: Some of these options may already be set

  • Under Kits: select the default "Desktop" kit
  • Under Compilers: select "GCC (x86 64bit in /usr/bin)"
  • Under Debuggers: select "GDB" as debugger
  1. While in the Projects tab, ensure that you have the bitcoin-qt executable specified under Run
  • If the executable is not specified: click "Choose...", navigate to src/qt, and select bitcoin-qt
  1. You're all set! Start developing, building, and debugging the Bitcoin Core GUI