متغیرها (Variables)

متغیرهای زیر قابل تنظیم هستند:

diff-options (string)

blame-options (string)

log-options (string)

main-options (string)

reference-format (string)

line-graphics (mixed) [ascii|default|utf-8|auto|<bool>]

truncation-delimiter (mixed) [utf-8|<string>]

horizontal-scroll (mixed)

git-colors (list)

show-notes (mixed) [<reference>|<bool>]

show-changes (bool)

show-untracked (bool)

vertical-split (mixed) [auto|<bool>]

split-view-height (mixed)

split-view-width (mixed)

status-show-untracked-dirs (bool)

status-show-untracked-files (bool)

tab-size (int)

diff-context (int)

word-diff (bool)

diff-highlight (mixed)

diff-indicator (bool)

ignore-space (mixed) [no|all|some|at-eol|<bool>]

commit-order (enum) [auto|default|topo|date|author-date|reverse]

ignore-case (enum) [no|yes|smart-case]

mailmap (bool)

wrap-lines (bool)

wrap-search (bool)

focus-child (bool)

send-child-enter (bool)

editor-line-number (bool)

history-size (int)

mouse (bool)

mouse-scroll (int)

mouse-wheel-cursor (bool)

pager-autoscroll (bool)

recurse-tree (bool)

pgrp (bool)

start-on-head (bool)

refresh-mode (mixed) [manual|auto|after-command|periodic|<bool>]

refresh-interval (int)

file-args (args)

rev-args (args)

تنظیمات نما (View settings)

تنظیمات نما ترتیب و گزینه‌های ستون‌های مختلف یک نما را مشخص می‌کنند. هر تنظیم نما انتظار فهرستی جداشده با فاصله از مشخصات ستون‌ها را دارد. مشخصات ستون با نوع ستون شروع می‌شود و به صورت اختیاری می‌تواند یک دونقطه (:) و فهرستی از گزینه‌های ستون به دنبال آن بیاید. به عنوان مثال، مشخصه ستون زیر یک ستون author (نویسنده) را تعریف می‌کند که ایمیل نویسنده را با عرض ثابت ۲۰ نویسه نمایش می‌دهد: author:email,width=20.

اولین مقدار گزینه در یک مشخصه ستون همیشه گزینه display است. هنگامی که هیچ مقداری برای display داده نشود، مقدار yes فرض می‌شود. برای گزینه‌های display که انتظار یک مقدار شمارشی دارند، این مقدار به طور خودکار به مقدار شمارشی پیش‌فرض تبدیل می‌شود. به عنوان مثال، تنظیم display برای file-name به طور خودکار به auto تبدیل خواهد شد.

مشخصات را می‌توان برای یک ستون واحد نیز ارائه داد، به عنوان مثال برای بازنویسی پیش‌فرض‌ها در پرونده tigrc سیستم. برای بازنویسی یک ستون واحد، از نام ستون به عنوان پسوند پس از نام تنظیمات نما استفاده کنید، مثلاً main-view-date امکان تنظیم تاریخ در نمای اصلی (main) را فراهم می‌کند.

مثال‌ها:

# فعال کردن هم شناسه و هم شماره خطوط در نمای blame
set blame-view = date:default author:full committer:no file-name:auto \
                 id:yes,color line-number:yes,interval=5 text
# تغییر نمای grep به شکلی مشابه با قالب `git grep`
set grep-view = file-name:yes line-number:yes,interval=1 text
# نمایش اندازه فایل‌ها به صورت واحد
set tree-view = line-number:no,interval=5 mode author:full committer:no \
                file-size:units date:default id:no file-name
# نمایش شماره خطوط به ازای هر ۱۰ خط در نمای صفحه‌بندی
set pager-view = line-number:yes,interval=10 text
# میان‌برهایی برای تغییر تنظیمات نما برای ستونی که قبلاً تعریف شده است
set main-view-date = custom
set main-view-date-format = "%Y-%m-%d %H:%M"
set blame-view-line-number = no
# استفاده از ترتیب کامیت پیش‌فرض گیت، حتی در صورت فعال بودن گراف کامیت.
set commit-order = default

فهرست زیر تنظیمات نمای موجود و انواع ستون‌های پشتیبانی‌شده توسط آن‌ها را نشان می‌دهد:

blob-view, diff-view, log-view, pager-view, stage-view

blame-view

grep-view

main-view, reflog-view

refs-view

stash-view

status-view

tree-view

انواع ستون‌های پشتیبانی‌شده و گزینه‌های مربوط به هر ستون:

author, committer

commit-title

date

file-name

file-size

id

line-number

mode

ref

status

text

تمام گزینه‌های ستون قابل تغییر وضعیت هستند. برای گزینه‌های display، از نام گزینه به عنوان پیشوند همراه با یک خط تیره و نام ستون استفاده کنید. مثلاً :toggle author-display گزینه display را در ستون author تغییر وضعیت می‌دهد. برای تمام گزینه‌های دیگر از نام ستون به همراه یک خط تیره و سپس نام گزینه به عنوان پسوند استفاده کنید. مثلاً :toggle commit-title-graph گزینه graph را در ستون commit-title تغییر وضعیت می‌دهد. همچنین می‌توانید از منوی گزینه‌ها برای تغییر گزینه‌ها استفاده کنید.

دستورات خارجی تعریف‌شده توسط کاربر (External user-defined command)

این عملیات‌ها با یک یا چند مورد از فلگ‌های گزینه‌ای زیر شروع می‌شوند که پس از آن‌ها دستور مورد نظر برای اجرا قرار می‌گیرد.

مگر اینکه طور دیگری مشخص شده باشد، دستورات در پیش‌زمینه همراه با نمایش خروجی کنسول اجرا می‌شوند (همانند حالتی که ! مشخص شده باشد). هنگامی که چندین گزینه دستور مشخص شده باشند رفتار آن‌ها با یکدیگر ترکیب می‌شود، برای مثال "?<git commit" ابتدا از کاربر برای اجرای دستور تایید می‌گیرد و پس از پایان کار، از Tig خارج می‌شود.

توجه داشته باشید که اگر می‌خواهید در دستورات خود از پایپ‌ها یا تغییر مسیر (redirection) استفاده کنید، باید آن‌ها را در یک زیرپوسته اجرا کنید، یعنی دستورات خود را در sh -c '<commands>' قرار دهید.

متغیرهای وضعیت مرور (Browsing state variables)

# ذخیره کامیت فعلی به عنوان یک فایل پچ هنگامی که کاربر یک کامیت را
# در نمای اصلی انتخاب کرده و کلید 'S' را فشار می‌دهد.
bind main S !git format-patch -1 %(commit)
# ایجاد و بررسی یک شاخه جدید؛ همراه با تعیین اعلان سفارشی
bind main B ?git checkout -b "%(prompt Enter new branch name: )"
# نمایش آمار کامیت برای نویسنده زیر مکان‌نما
bind main U +sh -c 'git --0-pager shortlog -s --uthor="$(git show -s --rmat=%aE %(commit))" </dev/tty'

دستورات پیشرفته شبیه به پوسته (Advanced shell-like commands)

bind generic I @sh -c "echo -n %(commit) | xclip -selection c"

[alias]
        gitk-bg = !"gitk HEAD --0t $(git rev-parse --emotes) &"
        publish = !"for i in origin public; do git push $i; done"
[tig "bind"]
        generic = V @git gitk-bg
        generic = > !git publish

دستورات داخلی تعریف‌شده توسط کاربر (Internal user-defined commands)

عملیاتی که با یک : آغاز می‌شوند به عنوان دستورات داخلی اجرا و تفسیر شده و مانند دستورات اجراشده از طریق اعلان خط فرمان Tig عمل می‌کنند. دستورات داخلی معتبر شامل گزینه‌های فایل پیکربندی (همان‌طور که در این سند شرح داده شده است) و دستورات نمای صفحه‌بند (pager view) هستند. مثال‌ها:

# بارگذاری مجدد ~/.tigrc هنگام فشرده شدن 'S'
bind generic S :source .tigrc
# تغییر نمای diff برای نمایش تمام تغییرات کامیت بدون در نظر گرفتن محدودیت‌های فایل
bind diff F :set diff-options = --ll-diff
# نمایش خروجی git-reflog(1) در نمای صفحه‌بند
bind generic W :!git reflog
# جستجو برای تکه (chunk) قبلی diff و سربرگ بعدی diff
bind stage 2 :?^@@
bind stage D :/^diff --(git|cc)
bind main I :toggle id                          # نمایش/پنهان‌سازی ستون شناسه (ID)
bind diff D :toggle diff-options --nimal      # استفاده از الگوریتم diff کمینه
bind diff [ :toggle diff-context -3             # کاهش متن زمینه (آرگومان -U)
bind diff ] :toggle diff-context +3             # افزایش متن زمینه
bind generic V :toggle split-view-height -10%   # کاهش ارتفاع نمای دو نیم‌شده

مشابه دستورات خارجی، دستورات نمای صفحه‌بند می‌توانند حاوی نام‌های متغیری باشند که قبل از اجرای دستور جایگزین می‌شوند.

نام عملیات‌ها (Action names)

نام‌های معتبر عملیات در ادامه شرح داده شده‌اند. توجه داشته باشید که تمامی نام‌های عملیات به حروف بزرگ و کوچک حساس نیستند، و می‌توانید از -، _ و . به جای یکدیگر استفاده کنید؛ برای مثال "view-main"، "View.Main" و "VIEW_MAIN" یکسان هستند.

تعویض نما (View switching)

دستکاری نما (View manipulation)

عملیات‌های ویژه نما (View-specific actions)

پیمایش مکان‌نما (Cursor navigation)

پیمایش صفحه (Scrolling)

جستجو (Searching)

متفرقه (Misc)

رنگ‌های رابط کاربری (UI colors)

رنگ‌ها و صفت‌هایی که باید برای متن‌های فاقد برجسته‌سازی استفاده شوند یا مواردی که استفاده از رنگ‌های پیش‌فرض ترمینال را مشخص می‌کنند، می‌توان با تنظیم گزینه رنگ default کنترل کرد.

جدول ۱. عمومی (General)

جدول ۲. رنگ‌های نمای اصلی (Main view colors)

جدول ۳. نمای وضعیت (Status view)

جدول ۴. نمای راهنما (Help view)

برجسته‌سازی (Highlighting)

علامت‌گذاری Diff (Diff markup)

diff-header, diff-chunk, diff-stat, diff-add, diff-add2, diff-del, diff-del2, diff-add-highlight, diff-del-highlight

علامت‌گذاری پیشرفته Diff گیت (Enhanced Git diff markup)

diff-oldmode, diff-newmode, diff-copy-from, diff-copy-to, diff-similarity, diff-index

قالب‌بندی زیبای سربرگ‌های کامیت (Pretty print commit headers)

pp-refs, pp-reflog, pp-reflogmsg, pp-merge

سربرگ خام کامیت (Raw commit header)

commit, parent, tree, author, committer

پیام کامیت (Commit message)

علامت‌گذاری درخت (Tree markup)

tree-dir, tree-file