GIT-HELP(1) Git Manual GIT-HELP(1)

git-help - نمایش اطلاعات راهنما درباره گیت

git help [-a|--all] [--[no-]verbose] [--[no-]external-commands] [--[no-]aliases]
git help [[-i|--info] [-m|--man] [-w|--web]] [<command>|<doc>]
git help [-g|--guides]
git help [-c|--config]
git help [--user-interfaces]
git help [--developer-interfaces]

بدون هیچ گزینه‌ای و بدون مشخص کردن <command> یا <doc>، خلاصه‌ای از نحوه استفاده دستور git و فهرستی از پرکاربردترین دستورات گیت در خروجی استاندارد چاپ می‌شود.

اگر گزینه --all یا -a مشخص شود، تمام دستورات موجود در خروجی استاندارد چاپ می‌شوند.

اگر گزینه --guides یا -g داده شود، فهرستی از راهنماهای مفهومی گیت نیز در خروجی استاندارد چاپ می‌شود.

اگر یک دستور یا مستند دیگری مشخص شود، صفحه راهنمای مربوطه باز می‌شود. برنامه man به‌طور پیش‌فرض برای این منظور استفاده می‌شود، اما این رفتار را می‌توان با گزینه‌های دیگر یا متغیرهای پیکربندی بازنویسی کرد.

اگر یک نام مستعار (alias) داده شود، گیت تعریف آن نام مستعار را در خروجی استاندارد نمایش می‌دهد. برای دریافت صفحه راهنمای دستور مربوط به نام مستعار، از git <command> --help استفاده کنید.

توجه داشته باشید که ... git --help دقیقاً مشابه ... git help است؛ چرا که اولی در داخل برنامه به دومی تبدیل می‌شود.

برای نمایش صفحه راهنمای git(1)، از git help git استفاده کنید.

این صفحه را می‌توان با git help help یا git help --help نمایش داد.

-a, --all

تمام دستورات موجود را در خروجی استاندارد چاپ می‌کند.

--no-external-commands

هنگامی که همراه با --all استفاده شود، فهرست کردن دستورات خارجی "git-*" موجود در $PATH را حذف می‌کند.

--no-aliases

هنگامی که همراه با --all استفاده شود، فهرست کردن نام‌های مستعار پیکربندی‌شده را حذف می‌کند.

--verbose

هنگامی که همراه با --all استفاده شود، توضیحات تمام دستورات شناخته‌شده را چاپ می‌کند. این حالت پیش‌فرض است.

-c, --config

تمام متغیرهای پیکربندی موجود را فهرست می‌کند. این یک خلاصه کوتاه از فهرست موجود در git-config(1) است.

-g, --guides

فهرستی از راهنماهای مفهومی گیت را در خروجی استاندارد چاپ می‌کند.

--user-interfaces

فهرستی از مستندات رابط‌های مخزن، دستور و فایل را در خروجی استاندارد چاپ می‌کند.

رابط‌های فایلی درون مخزن مانند .git/info/exclude در اینجا مستند شده‌اند (به gitrepository-layout(5) مراجعه کنید)، و همچنین پیکربندی‌های درون‌درختی مانند .mailmap (به gitmailmap(5) مراجعه کنید).

این بخش از مستندات همچنین قراردادهای عمومی یا فراگیر رابط کاربری (مانند gitcli(7)) و شبه‌پیکربندی‌هایی مانند رابط مبتنی بر فایل .git/hooks/* شرح داده شده در githooks(5) را پوشش می‌دهد.

--developer-interfaces

فهرستی از مستندات قالب‌های فایل، پروتکل‌ها و سایر رابط‌های توسعه‌دهنده را در خروجی استاندارد چاپ می‌کند.

-i, --info

صفحه راهنمای دستور را در قالب info نمایش می‌دهد. برنامه info برای این منظور استفاده خواهد شد.

-m, --man

صفحه راهنمای دستور را در قالب man نمایش می‌دهد. این گزینه می‌تواند برای نادیده گرفتن مقدار تنظیم‌شده در متغیر پیکربندی help.format استفاده شود.

به‌طور پیش‌فرض از برنامه man برای نمایش صفحه راهنما استفاده می‌شود، اما می‌توان از متغیر پیکربندی man.viewer برای انتخاب سایر برنامه‌های نمایشگر استفاده کرد (پایین را ببینید).

-w, --web

صفحه راهنمای دستور را در قالب web (HTML) نمایش می‌دهد. یک مرورگر وب برای این منظور استفاده خواهد شد.

مرورگر وب را می‌توان با استفاده از متغیر پیکربندی help.browser یا اگر متغیر قبلی تنظیم نشده باشد با web.browser مشخص کرد. اگر هیچ‌یک از این متغیرهای پیکربندی تنظیم نشده باشند، اسکریپت کمکی git web--browse (که توسط git help فراخوانی می‌شود) یک گزینه پیش‌فرض مناسب را انتخاب خواهد کرد. برای اطلاعات بیشتر در این مورد به git-web--browse(1) مراجعه کنید.

اگر هیچ گزینه‌ای در خط فرمان داده نشود، متغیر پیکربندی help.format بررسی خواهد شد. مقادیر زیر برای این متغیر پشتیبانی می‌شوند؛ آن‌ها باعث می‌شوند git help همانند گزینه خط فرمان متناظر خود عمل کند:

"man" متناظر است با -m|--man،
"info" متناظر است با -i|--info،
"web" یا "html" متناظر است با -w|--web.

در صورتی که قالب web انتخاب شده باشد (چه از طریق گزینه خط فرمان یا متغیر پیکربندی)، متغیرهای help.browser، web.browser و browser.<tool>.path نیز بررسی خواهند شد. به -w|--web در بخش OPTIONS بالا و git-web--browse(1) مراجعه کنید.

اگر قالب man انتخاب شده باشد، متغیر پیکربندی man.viewer بررسی خواهد شد. در حال حاضر مقادیر زیر پشتیبانی می‌شوند:

"man": استفاده از برنامه man طبق معمول،
"woman": استفاده از emacsclient برای اجرای حالت "woman" در ایمکس (این مورد تنها از نسخه ۲۲ به بعد emacsclient کار می‌کند)،
"konqueror": استفاده از kfmclient برای باز کردن صفحه راهنما در یک تب جدید konqueror (به Note about konqueror در پایین مراجعه کنید).

در صورتی که مدخل پیکربندی متناظر man.<tool>.cmd وجود داشته باشد، می‌توان از مقادیر مربوط به سایر ابزارها نیز استفاده کرد (پایین را ببینید).

می‌توان چندین مقدار برای متغیر پیکربندی man.viewer تعیین کرد. برنامه‌های متناظر آن‌ها به ترتیبی که در فایل پیکربندی آمده‌اند امتحان خواهند شد.

برای مثال، این پیکربندی:

[man]
        viewer = konqueror
        viewer = woman

ابتدا تلاش می‌کند از konqueror استفاده کند. اما این ممکن است با شکست مواجه شود (برای مثال، اگر DISPLAY تنظیم نشده باشد) و در آن صورت حالت woman در emacs امتحان خواهد شد.

اگر همه چیز ناموفق بود، یا اگر هیچ نمایشگری پیکربندی نشده باشد، نمایشگر مشخص‌شده در متغیر محیطی GIT_MAN_VIEWER امتحان می‌شود. اگر آن هم ناموفق باشد، برنامه man در هر صورت امتحان خواهد شد.

می‌توانید با تنظیم متغیر پیکربندی man.<tool>.path صراحتاً یک مسیر کامل به نمایشگر راهنمای ترجیحی خود ارائه دهید. برای مثال، می‌توانید مسیر مطلق konqueror را با تنظیم man.konqueror.path تعیین کنید. در غیر این صورت، git help فرض می‌کند که این ابزار در PATH موجود است.

هنگامی که نمایشگر راهنمای مشخص‌شده توسط متغیرهای پیکربندی man.viewer در میان موارد پشتیبانی‌شده نباشد، متغیر پیکربندی متناظر man.<tool>.cmd جستجو می‌شود. اگر این متغیر وجود داشته باشد، ابزار مشخص‌شده به عنوان یک دستور سفارشی تلقی شده و از یک eval پوسته برای اجرای دستور با ارسال صفحه راهنما به عنوان آرگومان استفاده می‌شود.

هنگامی که konqueror در متغیر پیکربندی man.viewer مشخص می‌شود، ما kfmclient را اجرا می‌کنیم تا در صورت امکان صفحه راهنما را در یک تب جدید از یک konquerorِ از پیش بازشده باز کنیم.

برای یکدستی، اگر man.konqueror.path روی چیزی شبیه به A_PATH_TO/konqueror تنظیم شده باشد نیز از چنین ترفندی استفاده می‌کنیم. این یعنی به جای آن تلاش خواهیم کرد A_PATH_TO/kfmclient را اجرا کنیم.

اگر واقعاً می‌خواهید از konqueror استفاده کنید، می‌توانید از چیزی شبیه به پیکربندی زیر استفاده کنید:

[man]
        viewer = konq
[man "konq"]
        cmd = A_PATH_TO/konqueror

توجه داشته باشید که تمام این متغیرهای پیکربندی احتمالاً باید با استفاده از فلگ --global تنظیم شوند، برای مثال مانند این:

$ git config --global help.format web
$ git config --global web.browser firefox

چرا که این متغیرها بیشتر مختص کاربر هستند تا مختص یک مخزن خاص. برای اطلاعات بیشتر در این مورد به git-config(1) مراجعه کنید.

بخشی از مجموعه git(1)

2026-06-29 Git 2.55.0