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 <cmd> [<檔案>]¶
列印一個命令的說明並結束。
以人類可讀的文字格式列印
<cmd>的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 <cmp> [<檔案>]¶
列印一個原則的說明並結束。
以人類可讀的文字格式列印
<cmp>的cmake-policies(7)手冊項目。如果已給定，則輸出會列印到指定的<檔案>。
- --help-policy-list [<檔案>]¶
列出具有可用說明的原則並結束。
此列表包含所有可透過使用
--help-policy選項，後接政策名稱來取得說明的政策。如果指定了名稱為<file>的檔案，則輸出會列印至該檔案。
- --help-policies [<file>]¶
列印 cmake-policies 手冊並結束。
cmake-policies(7)手冊會以人類可讀的文字格式列印。如果指定了名稱為<file>的檔案，則輸出會列印至該檔案。
- --help-property <prop> [<file>]¶
列印單一屬性的說明並結束。
針對
<prop>的cmake-properties(7)手冊條目會以人類可讀的文字格式列印。如果指定了名稱為<file>的檔案，則輸出會列印至該檔案。
- --help-property-list [<file>]¶
列出可取得說明的屬性並結束。
此列表包含所有可透過使用
--help-property選項，後接屬性名稱來取得說明的屬性。如果指定了名稱為<file>的檔案，則輸出會列印至該檔案。
- --help-properties [<file>]¶
列印 cmake-properties 手冊並結束。
cmake-properties(7)手冊會以人類可讀的文字格式列印。如果指定了名稱為<file>的檔案，則輸出會列印至該檔案。
- --help-variable <var> [<file>]¶
列印單一變數的說明並結束。
針對
<var>的cmake-variables(7)手冊條目會以人類可讀的文字格式列印。如果指定了名稱為<file>的檔案，則輸出會列印至該檔案。
- --help-variable-list [<file>]¶
列出可取得說明的變數並結束。
此列表包含所有可透過使用
--help-variable選項，後接變數名稱來取得說明的變數。如果指定了名稱為<file>的檔案，則輸出會列印至該檔案。
- --help-variables [<file>]¶
列印 cmake-variables 手冊並結束。
cmake-variables(7)手冊會以人類可讀的文字格式列印。如果指定了名稱為<file>的檔案，則輸出會列印至該檔案。
參見¶
以下資源可用於取得有關使用 CMake 的說明
- 首頁
-
學習 CMake 的主要起點。
- 線上文件和社群資源
https://cmake.dev.org.tw/documentation
在此網頁上可以找到可用的文件和社群資源的連結。
- 論壇
-
論壇託管了有關 CMake 的討論和問題。