'\" t
.\"     Title: git-help
.\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net>
.\"      Date: 2026-06-29
.\"    Manual: Git Manual
.\"    Source: Git 2.55.0
.\"  Language: English
.\"
.TH "GIT\-HELP" "1" "2026\-06\-29" "Git 2\&.55\&.0" "Git Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "نام (NAME)"
git-help \- نمایش اطلاعات راهنما درباره گیت
.SH "خلاصه دستور (SYNOPSIS)"
.sp
.nf
\fIgit help\fR [\-a|\-\-all] [\-\-[no\-]verbose] [\-\-[no\-]external\-commands] [\-\-[no\-]aliases]
\fIgit help\fR [[\-i|\-\-info] [\-m|\-\-man] [\-w|\-\-web]] [<command>|<doc>]
\fIgit help\fR [\-g|\-\-guides]
\fIgit help\fR [\-c|\-\-config]
\fIgit help\fR [\-\-user\-interfaces]
\fIgit help\fR [\-\-developer\-interfaces]
.fi
.sp
.SH "توضیحات (DESCRIPTION)"
.sp
بدون هیچ گزینه‌ای و بدون مشخص کردن \fI<command>\fR یا \fI<doc>\fR، خلاصه‌ای از نحوه استفاده دستور \fIgit\fR و فهرستی از پرکاربردترین دستورات گیت در خروجی استاندارد چاپ می‌شود\&.
.sp
اگر گزینه \fB\-\-all\fR یا \fB\-a\fR مشخص شود، تمام دستورات موجود در خروجی استاندارد چاپ می‌شوند\&.
.sp
اگر گزینه \fB\-\-guides\fR یا \fB\-g\fR داده شود، فهرستی از راهنماهای مفهومی گیت نیز در خروجی استاندارد چاپ می‌شود\&.
.sp
اگر یک دستور یا مستند دیگری مشخص شود، صفحه راهنمای مربوطه باز می‌شود\&. برنامه \fIman\fR به‌طور پیش‌فرض برای این منظور استفاده می‌شود، اما این رفتار را می‌توان با گزینه‌های دیگر یا متغیرهای پیکربندی بازنویسی کرد\&.
.sp
اگر یک نام مستعار (alias) داده شود، گیت تعریف آن نام مستعار را در خروجی استاندارد نمایش می‌دهد\&. برای دریافت صفحه راهنمای دستور مربوط به نام مستعار، از \fBgit\fR \fI<command>\fR \fB\-\-help\fR استفاده کنید\&.
.sp
توجه داشته باشید که \&.\&.\&. \fBgit\fR \fB\-\-help\fR دقیقاً مشابه \&.\&.\&. \fBgit\fR \fBhelp\fR است؛ چرا که اولی در داخل برنامه به دومی تبدیل می‌شود\&.
.sp
برای نمایش صفحه راهنمای \fBgit\fR(1)، از \fBgit\fR \fBhelp\fR \fBgit\fR استفاده کنید\&.
.sp
این صفحه را می‌توان با \fIgit help help\fR یا \fBgit\fR \fBhelp\fR \fB\-\-help\fR نمایش داد\&.
.SH "گزینه‌ها (OPTIONS)"
.PP
\-a, \-\-all
.RS 4
تمام دستورات موجود را در خروجی استاندارد چاپ می‌کند\&.
.RE
.PP
\-\-no\-external\-commands
.RS 4
هنگامی که همراه با
\fB\-\-all\fR
استفاده شود، فهرست کردن دستورات خارجی "git\-*" موجود در
\fB$PATH\fR
را حذف می‌کند\&.
.RE
.PP
\-\-no\-aliases
.RS 4
هنگامی که همراه با
\fB\-\-all\fR
استفاده شود، فهرست کردن نام‌های مستعار پیکربندی‌شده را حذف می‌کند\&.
.RE
.PP
\-\-verbose
.RS 4
هنگامی که همراه با
\fB\-\-all\fR
استفاده شود، توضیحات تمام دستورات شناخته‌شده را چاپ می‌کند\&. این حالت پیش‌فرض است\&.
.RE
.PP
\-c, \-\-config
.RS 4
تمام متغیرهای پیکربندی موجود را فهرست می‌کند\&. این یک خلاصه کوتاه از فهرست موجود در
\fBgit-config\fR(1)
است\&.
.RE
.PP
\-g, \-\-guides
.RS 4
فهرستی از راهنماهای مفهومی گیت را در خروجی استاندارد چاپ می‌کند\&.
.RE
.PP
\-\-user\-interfaces
.RS 4
فهرستی از مستندات رابط‌های مخزن، دستور و فایل را در خروجی استاندارد چاپ می‌کند\&.
.sp
رابط‌های فایلی درون مخزن مانند
\fB\&.git/info/exclude\fR
در اینجا مستند شده‌اند (به
\fBgitrepository-layout\fR(5)
مراجعه کنید)، و همچنین پیکربندی‌های درون‌درختی مانند
\fB\&.mailmap\fR
(به
\fBgitmailmap\fR(5)
مراجعه کنید)\&.
.sp
این بخش از مستندات همچنین قراردادهای عمومی یا فراگیر رابط کاربری (مانند
\fBgitcli\fR(7))
و شبه‌پیکربندی‌هایی مانند رابط مبتنی بر فایل
\fB\&.git/hooks/*\fR
شرح داده شده در
\fBgithooks\fR(5)
را پوشش می‌دهد\&.
.RE
.PP
\-\-developer\-interfaces
.RS 4
فهرستی از مستندات قالب‌های فایل، پروتکل‌ها و سایر رابط‌های توسعه‌دهنده را در خروجی استاندارد چاپ می‌کند\&.
.RE
.PP
\-i, \-\-info
.RS 4
صفحه راهنمای دستور را در قالب
\fIinfo\fR
نمایش می‌دهد\&. برنامه
\fIinfo\fR
برای این منظور استفاده خواهد شد\&.
.RE
.PP
\-m, \-\-man
.RS 4
صفحه راهنمای دستور را در قالب
\fIman\fR
نمایش می‌دهد\&. این گزینه می‌تواند برای نادیده گرفتن مقدار تنظیم‌شده در متغیر پیکربندی
\fBhelp\&.format\fR
استفاده شود\&.
.sp
به‌طور پیش‌فرض از برنامه
\fIman\fR
برای نمایش صفحه راهنما استفاده می‌شود، اما می‌توان از متغیر پیکربندی
\fBman\&.viewer\fR
برای انتخاب سایر برنامه‌های نمایشگر استفاده کرد (پایین را ببینید)\&.
.RE
.PP
\-w, \-\-web
.RS 4
صفحه راهنمای دستور را در قالب
\fIweb\fR
(HTML) نمایش می‌دهد\&. یک مرورگر وب برای این منظور استفاده خواهد شد\&.
.sp
مرورگر وب را می‌توان با استفاده از متغیر پیکربندی
\fBhelp\&.browser\fR
یا اگر متغیر قبلی تنظیم نشده باشد با
\fBweb\&.browser\fR
مشخص کرد\&. اگر هیچ‌یک از این متغیرهای پیکربندی تنظیم نشده باشند، اسکریپت کمکی
\fIgit web\-\-browse\fR
(که توسط
\fIgit help\fR
فراخوانی می‌شود) یک گزینه پیش‌فرض مناسب را انتخاب خواهد کرد\&. برای اطلاعات بیشتر در این مورد به
\fBgit-web--browse\fR(1)
مراجعه کنید\&.
.RE
.SH "متغیرهای پیکربندی (CONFIGURATION VARIABLES)"
.SS "help\&.format"
.sp
اگر هیچ گزینه‌ای در خط فرمان داده نشود، متغیر پیکربندی \fBhelp\&.format\fR بررسی خواهد شد\&. مقادیر زیر برای این متغیر پشتیبانی می‌شوند؛ آن‌ها باعث می‌شوند \fIgit help\fR همانند گزینه خط فرمان متناظر خود عمل کند:
.sp
.RS 4
.ie n \{\
.h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
"man" متناظر است با
\fI\-m|\-\-man\fR،
.RE
.sp
.RS 4
.ie n \{\
.h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
"info" متناظر است با
\fI\-i|\-\-info\fR،
.RE
.sp
.RS 4
.ie n \{\
.h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
"web" یا "html" متناظر است با
\fI\-w|\-\-web\fR\&.
.RE
.SS "help\&.browser، web\&.browser و browser\&.<tool>\&.path"
.sp
در صورتی که قالب \fIweb\fR انتخاب شده باشد (چه از طریق گزینه خط فرمان یا متغیر پیکربندی)، متغیرهای \fBhelp\&.browser\fR، \fBweb\&.browser\fR و \fBbrowser\&.\fR\fI<tool>\fR\fB\&.path\fR نیز بررسی خواهند شد\&. به \fI\-w|\-\-web\fR در بخش OPTIONS بالا و \fBgit-web--browse\fR(1) مراجعه کنید\&.
.SS "man\&.viewer"
.sp
اگر قالب \fIman\fR انتخاب شده باشد، متغیر پیکربندی \fBman\&.viewer\fR بررسی خواهد شد\&. در حال حاضر مقادیر زیر پشتیبانی می‌شوند:
.sp
.RS 4
.ie n \{\
.h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
"man": استفاده از برنامه
\fIman\fR
طبق معمول،
.RE
.sp
.RS 4
.ie n \{\
.h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
"woman": استفاده از
\fIemacsclient\fR
برای اجرای حالت "woman" در ایمکس (این مورد تنها از نسخه ۲۲ به بعد emacsclient کار می‌کند)،
.RE
.sp
.RS 4
.ie n \{\
.h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
"konqueror": استفاده از
\fIkfmclient\fR
برای باز کردن صفحه راهنما در یک تب جدید konqueror (به
\fINote about konqueror\fR
در پایین مراجعه کنید)\&.
.RE
.sp
در صورتی که مدخل پیکربندی متناظر \fBman\&.\fR\fI<tool>\fR\fB\&.cmd\fR وجود داشته باشد، می‌توان از مقادیر مربوط به سایر ابزارها نیز استفاده کرد (پایین را ببینید)\&.
.sp
می‌توان چندین مقدار برای متغیر پیکربندی \fBman\&.viewer\fR تعیین کرد\&. برنامه‌های متناظر آن‌ها به ترتیبی که در فایل پیکربندی آمده‌اند امتحان خواهند شد\&.
.sp
برای مثال، این پیکربندی:
.sp
.if n \{\
.RS 4
.\}
.nf
        [man]
                viewer = konqueror
                viewer = woman
.fi
.if n \{\
.RE
.\}
.sp
.sp
ابتدا تلاش می‌کند از konqueror استفاده کند\&. اما این ممکن است با شکست مواجه شود (برای مثال، اگر DISPLAY تنظیم نشده باشد) و در آن صورت حالت woman در emacs امتحان خواهد شد\&.
.sp
اگر همه چیز ناموفق بود، یا اگر هیچ نمایشگری پیکربندی نشده باشد، نمایشگر مشخص‌شده در متغیر محیطی \fBGIT_MAN_VIEWER\fR امتحان می‌شود\&. اگر آن هم ناموفق باشد، برنامه \fIman\fR در هر صورت امتحان خواهد شد\&.
.SS "man\&.<tool>\&.path"
.sp
می‌توانید با تنظیم متغیر پیکربندی \fBman\&.\fR\fI<tool>\fR\fB\&.path\fR صراحتاً یک مسیر کامل به نمایشگر راهنمای ترجیحی خود ارائه دهید\&. برای مثال، می‌توانید مسیر مطلق konqueror را با تنظیم \fIman\&.konqueror\&.path\fR تعیین کنید\&. در غیر این صورت، \fIgit help\fR فرض می‌کند که این ابزار در PATH موجود است\&.
.SS "man\&.<tool>\&.cmd"
.sp
هنگامی که نمایشگر راهنمای مشخص‌شده توسط متغیرهای پیکربندی \fBman\&.viewer\fR در میان موارد پشتیبانی‌شده نباشد، متغیر پیکربندی متناظر \fBman\&.\fR\fI<tool>\fR\fB\&.cmd\fR جستجو می‌شود\&. اگر این متغیر وجود داشته باشد، ابزار مشخص‌شده به عنوان یک دستور سفارشی تلقی شده و از یک eval پوسته برای اجرای دستور با ارسال صفحه راهنما به عنوان آرگومان استفاده می‌شود\&.
.SS "نکته‌ای درباره konqueror (Note about konqueror)"
.sp
هنگامی که \fIkonqueror\fR در متغیر پیکربندی \fBman\&.viewer\fR مشخص می‌شود، ما \fIkfmclient\fR را اجرا می‌کنیم تا در صورت امکان صفحه راهنما را در یک تب جدید از یک konquerorِ از پیش بازشده باز کنیم\&.
.sp
برای یکدستی، اگر \fIman\&.konqueror\&.path\fR روی چیزی شبیه به \fBA_PATH_TO/konqueror\fR تنظیم شده باشد نیز از چنین ترفندی استفاده می‌کنیم\&. این یعنی به جای آن تلاش خواهیم کرد \fBA_PATH_TO/kfmclient\fR را اجرا کنیم\&.
.sp
اگر واقعاً می‌خواهید از \fIkonqueror\fR استفاده کنید، می‌توانید از چیزی شبیه به پیکربندی زیر استفاده کنید:
.sp
.if n \{\
.RS 4
.\}
.nf
        [man]
                viewer = konq

        [man "konq"]
                cmd = A_PATH_TO/konqueror
.fi
.if n \{\
.RE
.\}
.sp
.SS "نکته‌ای درباره git config \-\-global"
.sp
توجه داشته باشید که تمام این متغیرهای پیکربندی احتمالاً باید با استفاده از فلگ \fB\-\-global\fR تنظیم شوند، برای مثال مانند این:
.sp
.if n \{\
.RS 4
.\}
.nf
$ git config \-\-global help\&.format web
$ git config \-\-global web\&.browser firefox
.fi
.if n \{\
.RE
.\}
.sp
.sp
چرا که این متغیرها بیشتر مختص کاربر هستند تا مختص یک مخزن خاص\&. برای اطلاعات بیشتر در این مورد به \fBgit-config\fR(1) مراجعه کنید\&.
.SH "گیت (GIT)"
.sp
بخشی از مجموعه \fBgit\fR(1)