cmake-gui(1)¶
概要¶
cmake-gui [<options>]
cmake-gui [<options>] -B <path-to-build> [-S <path-to-source>]
cmake-gui [<options>] <path-to-source | path-to-existing-build>
cmake-gui [<options>] --browse-manual [<filename>]
描述¶
cmake-gui 執行檔是 CMake GUI。專案組態設定可以互動方式指定。程式執行時,視窗底部會提供簡短說明。
CMake 是跨平台建構系統產生器。專案使用平台獨立的 CMake 清單檔指定其建構流程,這些檔案包含在原始碼樹狀結構的每個目錄中,名稱為 CMakeLists.txt
。使用者透過使用 CMake 為其平台上的原生工具產生建構系統來建構專案。
選項¶
- -S <原始碼路徑>¶
要建構的 CMake 專案根目錄路徑。
- -B <建構路徑>¶
CMake 將用作建構目錄根目錄的路徑。
如果目錄尚不存在,CMake 將會建立它。
- --browse-manual [<檔案名稱>]¶
在瀏覽器中開啟 CMake 參考手冊並立即退出。如果指定了
<檔案名稱>
,則在參考手冊中開啟該檔案而不是index.html
。
- -version [<檔案>], --version [<檔案>], /V [<檔案>]¶
顯示程式名稱/版本標題並退出。輸出會列印到指定的
<檔案>
(如果給定)。
- -h, -H, --help, -help, -usage, /?¶
列印用法資訊並退出。
用法描述了基本命令列介面及其選項。
- --help <關鍵字> [<檔案>]¶
列印一個 CMake 關鍵字的說明。
<關鍵字>
可以是屬性、變數、命令、策略、產生器或模組。以人類可讀的文字格式列印
<關鍵字>
的相關手冊條目。輸出會列印到指定的<檔案>
(如果給定)。在 3.28 版本變更: 在 CMake 3.28 之前,此選項僅支援命令名稱。
- --help-full [<檔案>]¶
列印所有說明手冊並退出。
所有手冊都以人類可讀的文字格式列印。輸出會列印到指定的
<檔案>
(如果給定)。
- --help-manual <手冊> [<檔案>]¶
列印一個說明手冊並退出。
指定的手冊以人類可讀的文字格式列印。輸出會列印到指定的
<檔案>
(如果給定)。
- --help-manual-list [<檔案>]¶
列出可用的說明手冊並退出。
此清單包含所有可以使用
--help-manual
選項後跟手冊名稱取得說明的的手冊。輸出會列印到指定的<檔案>
(如果給定)。
- --help-command <命令> [<檔案>]¶
列印一個命令的說明並退出。
以人類可讀的文字格式列印
<命令>
的cmake-commands(7)
手冊條目。輸出會列印到指定的<檔案>
(如果給定)。
- --help-command-list [<檔案>]¶
列出可用的命令說明並退出。
此清單包含所有可以使用
--help-command
選項後跟命令名稱取得說明的命令。輸出會列印到指定的<檔案>
(如果給定)。
- --help-commands [<檔案>]¶
列印 cmake-commands 手冊並退出。
以人類可讀的文字格式列印
cmake-commands(7)
手冊。輸出會列印到指定的<檔案>
(如果給定)。
- --help-module <模組> [<檔案>]¶
列印一個模組的說明並退出。
以人類可讀的文字格式列印
<模組>
的cmake-modules(7)
手冊條目。輸出會列印到指定的<檔案>
(如果給定)。
- --help-module-list [<檔案>]¶
列出可用的模組說明並退出。
此清單包含所有可以使用
--help-module
選項後跟模組名稱取得說明的模組。輸出會列印到指定的<檔案>
(如果給定)。
- --help-modules [<檔案>]¶
列印 cmake-modules 手冊並退出。
以人類可讀的文字格式列印
cmake-modules(7)
手冊。輸出會列印到指定的<檔案>
(如果給定)。
- --help-policy <策略> [<檔案>]¶
列印一個策略的說明並退出。
以人類可讀的文字格式列印
<策略>
的cmake-policies(7)
手冊條目。輸出會列印到指定的<檔案>
(如果給定)。
- --help-policy-list [<檔案>]¶
列出可用的策略說明並退出。
此清單包含所有可以使用
--help-policy
選項後跟策略名稱取得說明的策略。輸出會列印到指定的<檔案>
(如果給定)。
- --help-policies [<檔案>]¶
列印 cmake-policies 手冊並退出。
以人類可讀的文字格式列印
cmake-policies(7)
手冊。輸出會列印到指定的<檔案>
(如果給定)。
- --help-property <屬性> [<檔案>]¶
列印一個屬性的說明並退出。
以人類可讀的文字格式列印
<屬性>
的cmake-properties(7)
手冊條目。輸出會列印到指定的<檔案>
(如果給定)。
- --help-property-list [<檔案>]¶
列出可用的屬性說明並退出。
此清單包含所有可以使用
--help-property
選項後跟屬性名稱取得說明的屬性。輸出會列印到指定的<檔案>
(如果給定)。
- --help-properties [<檔案>]¶
列印 cmake-properties 手冊並退出。
以人類可讀的文字格式列印
cmake-properties(7)
手冊。輸出會列印到指定的<檔案>
(如果給定)。
- --help-variable <變數> [<檔案>]¶
列印一個變數的說明並退出。
以人類可讀的文字格式列印
<變數>
的cmake-variables(7)
手冊條目。輸出會列印到指定的<檔案>
(如果給定)。
- --help-variable-list [<檔案>]¶
列出可用的變數說明並退出。
此清單包含所有可以使用
--help-variable
選項後跟變數名稱取得說明的變數。輸出會列印到指定的<檔案>
(如果給定)。
- --help-variables [<檔案>]¶
列印 cmake-variables 手冊並退出。
以人類可讀的文字格式列印
cmake-variables(7)
手冊。輸出會列印到指定的<檔案>
(如果給定)。
另請參閱¶
以下資源可用於取得使用 CMake 的協助
- 首頁
-
學習 CMake 的主要起點。
- 線上文件與社群資源
https://cmake.dev.org.tw/documentation
可在本網頁上找到可用文件和社群資源的連結。
- Discourse 論壇
-
Discourse 論壇託管關於 CMake 的討論和問題。