نام (NAME)

cmake-gui - رابط گرافیکی تعاملی برای پیکربندی پروژه‌های CMake

خلاصه دستور (SYNOPSIS)

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>]

توضیحات (DESCRIPTION)

فایل اجرایی cmake-gui رابط گرافیکی کاربر (GUI) برای CMake است. تنظیمات پیکربندی پروژه را می‌توان به صورت تعاملی مشخص کرد. دستورالعمل‌های مختصری هنگام اجرای برنامه در پایین پنجره ارائه شده است.

ابزار CMake یک تولیدکننده چندسکویی سیستم ساخت است. پروژه‌ها فرآیند ساخت خود را با فایل‌های لیست CMake مستقل از سکو که با نام CMakeLists.txt در هر دایرکتوری از درخت سورس قرار دارند، مشخص می‌کنند. کاربران با استفاده از CMake برای تولید یک سیستم ساخت متناسب با ابزار بومی سکوی خود، پروژه را می‌سازند.

گزینه‌ها (OPTIONS)

-S <path-to-source>: مسیر دایرکتوری ریشه پروژه CMake برای ساخت.

-B <path-to-build>: مسیر دایرکتوری که CMake از آن به عنوان ریشه دایرکتوری ساخت استفاده خواهد کرد.
اگر دایرکتوری از قبل وجود نداشته باشد، CMake آن را خواهد ساخت.

--preset=<preset-name>: نام پیش‌تنظیم مورد استفاده از فایل‌های presets <#manual:cmake-presets(7)> پروژه، در صورت وجود.

--browse-manual [<filename>]: کتابچه راهنمای مرجع CMake را در یک مرورگر باز کرده و بلافاصله خارج می‌شود. اگر <filename> مشخص شده باشد، به جای index.html، آن فایل را در کتابچه راهنمای مرجع باز می‌کند.

-version[=json-v1] [<file>], --version[=json-v1] [<file>], /V[=json-v1] [<file>], /version[=json-v1] [<file>]: بنر نام و نسخه برنامه را نمایش داده و خارج می‌شود. اگر json-v1 مشخص شده باشد، اطلاعات تفصیلی نسخه را در قالب JSON چاپ می‌کند. خروجی JSON حاوی نسخه‌های CMake و وابستگی‌های آن است. در صورت ارائه نام <file>، خروجی در آن نوشته می‌شود.
قالب خروجی JSON به شکل خوانا برای ماشین در this JSON schema توصیف شده است.

-h, -H, --help, -help, -usage, /?: اطلاعات نحوه استفاده را چاپ کرده و خارج می‌شود.
نحوه استفاده، رابط خط فرمان پایه و گزینه‌های آن را شرح می‌دهد.

--help <keyword> [<file>]

راهنما را برای یک کلیدواژه CMake چاپ می‌کند.

کلیدواژه <keyword> می‌تواند یک ویژگی (property)، متغیر، دستور، خط‌مشی (policy)، تولیدکننده (generator) یا ماژول باشد.

مدخل مربوطه در کتابچه راهنما برای <keyword> در یک قالب متنی خوانا برای انسان چاپ می‌شود. در صورت ارائه نام <file>، خروجی در آن نوشته می‌شود.

تغییریافته در نسخه 3.28: پیش از CMake 3.28، این گزینه تنها از نام دستورات پشتیبانی می‌کرد.

--help-full [<file>]: تمام کتابچه‌های راهنما را چاپ کرده و خارج می‌شود.
تمام کتابچه‌های راهنما در یک قالب متنی خوانا برای انسان چاپ می‌شوند. در صورت ارائه نام <file>، خروجی در آن نوشته می‌شود.

--help-manual <man> [<file>]: یک کتابچه راهنما را چاپ کرده و خارج می‌شود.
کتابچه راهنمای مشخص‌شده در یک قالب متنی خوانا برای انسان چاپ می‌شود. در صورت ارائه نام <file>، خروجی در آن نوشته می‌شود.

--help-manual-list [<file>]: کتابچه‌های راهنمای موجود را فهرست کرده و خارج می‌شود.
این فهرست شامل تمام کتابچه‌های راهنمایی است که می‌توان با استفاده از گزینه --help-manual همراه با نام کتابچه به راهنمای آن‌ها دست یافت. در صورت ارائه نام <file>، خروجی در آن نوشته می‌شود.

--help-command <cmd> [<file>]: راهنما را برای یک دستور چاپ کرده و خارج می‌شود.
مدخل کتابچه راهنمای cmake-commands(7) <#manual:cmake-commands(7)> برای <cmd> در یک قالب متنی خوانا برای انسان چاپ می‌شود. در صورت ارائه نام <file>، خروجی در آن نوشته می‌شود.

--help-command-list [<file>]: دستوراتی را که راهنمای آن‌ها موجود است فهرست کرده و خارج می‌شود.
این فهرست شامل تمام دستوراتی است که می‌توان با استفاده از گزینه --help-command همراه با نام دستور به راهنمای آن‌ها دست یافت. در صورت ارائه نام <file>، خروجی در آن نوشته می‌شود.

--help-commands [<file>]: کتابچه راهنمای cmake-commands را چاپ کرده و خارج می‌شود.
کتابچه راهنمای cmake-commands(7) <#manual:cmake-commands(7)> در یک قالب متنی خوانا برای انسان چاپ می‌شود. در صورت ارائه نام <file>، خروجی در آن نوشته می‌شود.

--help-module <mod> [<file>]: راهنما را برای یک ماژول چاپ کرده و خارج می‌شود.
مدخل کتابچه راهنمای cmake-modules(7) <#manual:cmake-modules(7)> برای <mod> در یک قالب متنی خوانا برای انسان چاپ می‌شود. در صورت ارائه نام <file>، خروجی در آن نوشته می‌شود.

--help-module-list [<file>]: ماژول‌هایی را که راهنمای آن‌ها موجود است فهرست کرده و خارج می‌شود.
این فهرست شامل تمام ماژول‌هایی است که می‌توان با استفاده از گزینه --help-module همراه با نام ماژول به راهنمای آن‌ها دست یافت. در صورت ارائه نام <file>، خروجی در آن نوشته می‌شود.

--help-modules [<file>]: کتابچه راهنمای cmake-modules را چاپ کرده و خارج می‌شود.
کتابچه راهنمای cmake-modules(7) <#manual:cmake-modules(7)> در یک قالب متنی خوانا برای انسان چاپ می‌شود. در صورت ارائه نام <file>، خروجی در آن نوشته می‌شود.

--help-policy <cmp> [<file>]: راهنما را برای یک خط‌مشی چاپ کرده و خارج می‌شود.
مدخل کتابچه راهنمای cmake-policies(7) <#manual:cmake-policies(7)> برای <cmp> در یک قالب متنی خوانا برای انسان چاپ می‌شود. در صورت ارائه نام <file>، خروجی در آن نوشته می‌شود.

--help-policy-list [<file>]: خط‌مشی‌هایی را که راهنمای آن‌ها موجود است فهرست کرده و خارج می‌شود.
این فهرست شامل تمام خط‌مشی‌هایی است که می‌توان با استفاده از گزینه --help-policy همراه با نام خط‌مشی به راهنمای آن‌ها دست یافت. در صورت ارائه نام <file>، خروجی در آن نوشته می‌شود.

--help-policies [<file>]: کتابچه راهنمای cmake-policies را چاپ کرده و خارج می‌شود.
کتابچه راهنمای cmake-policies(7) <#manual:cmake-policies(7)> در یک قالب متنی خوانا برای انسان چاپ می‌شود. در صورت ارائه نام <file>، خروجی در آن نوشته می‌شود.

--help-property <prop> [<file>]: راهنما را برای یک ویژگی چاپ کرده و خارج می‌شود.
مدخل‌های کتابچه راهنمای cmake-properties(7) <#manual:cmake-properties(7)> برای <prop> در یک قالب متنی خوانا برای انسان چاپ می‌شوند. در صورت ارائه نام <file>، خروجی در آن نوشته می‌شود.

--help-property-list [<file>]: ویژگی‌هایی را که راهنمای آن‌ها موجود است فهرست کرده و خارج می‌شود.
این فهرست شامل تمام ویژگی‌هایی است که می‌توان با استفاده از گزینه --help-property همراه با نام ویژگی به راهنمای آن‌ها دست یافت. در صورت ارائه نام <file>، خروجی در آن نوشته می‌شود.

--help-properties [<file>]: کتابچه راهنمای cmake-properties را چاپ کرده و خارج می‌شود.
کتابچه راهنمای cmake-properties(7) <#manual:cmake-properties(7)> در یک قالب متنی خوانا برای انسان چاپ می‌شود. در صورت ارائه نام <file>، خروجی در آن نوشته می‌شود.

--help-variable <var> [<file>]: راهنما را برای یک متغیر چاپ کرده و خارج می‌شود.
مدخل کتابچه راهنمای cmake-variables(7) <#manual:cmake-variables(7)> برای <var> در یک قالب متنی خوانا برای انسان چاپ می‌شود. در صورت ارائه نام <file>، خروجی در آن نوشته می‌شود.

--help-variable-list [<file>]: متغیرهایی را که راهنمای آن‌ها موجود است فهرست کرده و خارج می‌شود.
این فهرست شامل تمام متغیرهایی است که می‌توان با استفاده از گزینه --help-variable همراه با نام متغیر به راهنمای آن‌ها دست یافت. در صورت ارائه نام <file>، خروجی در آن نوشته می‌شود.

--help-variables [<file>]: کتابچه راهنمای cmake-variables را چاپ کرده و خارج می‌شود.
کتابچه راهنمای cmake-variables(7) <#manual:cmake-variables(7)> در یک قالب متنی خوانا برای انسان چاپ می‌شود. در صورت ارائه نام <file>، خروجی در آن نوشته می‌شود.

همچنین ببینید (SEE ALSO)

منابع زیر برای دریافت راهنما در استفاده از CMake در دسترس هستند:

Home Page: https://cmake.org
نقطه شروع اصلی برای یادگیری درباره CMake.
Online Documentation and Community Resources: https://cmake.org/documentation
پیوندهای مربوط به مستندات موجود و منابع انجمن را می‌توان در این صفحه وب یافت.
Discourse Forum: https://discourse.cmake.org
تالار گفتگوی Discourse میزبان گفتگوها و پرسش‌ها پیرامون CMake است.

حق نشر (COPYRIGHT)

2000-2026 Kitware, Inc. and Contributors

August 31, 2026

4.4.3