mdw@git.distorted.org.uk Git - tig/blob - tigrc.5

   1 .\"Generated by db2man.xsl. Don't modify this, modify the source.
   2 .de Sh \" Subsection
   3 .br
   4 .if t .Sp
   5 .ne 5
   6 .PP
   7 \fB\\$1\fR
   8 .PP
   9 ..
  10 .de Sp \" Vertical space (when we can't use .PP)
  11 .if t .sp .5v
  12 .if n .sp
  13 ..
  14 .de Ip \" List item
  15 .br
  16 .ie \\n(.$>=3 .ne \\$3
  17 .el .ne 3
  18 .IP "\\$1" \\$2
  19 ..
  20 .TH "TIGRC" 5 "" "" ""
  21 .SH NAME
  22 tigrc \- tig user configuration file
  23 .SH "SYNOPSIS"
  24
  25 .nf
  26 \fIcolor\fR \fIfgcolor\fR \fIbgcolor\fR \fI[attributes]\fR
  27 .fi
  28
  29 .SH "DESCRIPTION"
  30
  31
  32 You can permanently set an option by putting it in the ~/\&.tigrc file\&. The file consists of a series of \fIcommands\fR\&. Each line of the file may contain only one command\&.
  33
  34
  35 The hash mark (\fI#\fR), or semi\-colon (\fI;\fR) is used as a \fIcomment\fR character\&. All text after the comment character to the end of the line is ignored\&. You can use comments to annotate your initialization file\&.
  36
  37 .SH "COLOR OPTIONS"
  38
  39
  40 Color options control highlighting and the user interface styles\&. If your terminal supports color, these commands can be used to assign foreground/backgound combinations to certain areas\&. Optionally, an attribute can be given as the last parameter\&. The syntax is:
  41
  42 .nf
  43         \fIcolor\fR \fIarea\fR \fIfgcolor\fR \fIbgcolor\fR \fI[attributes]\fR
  44 .fi
  45
  46
  47 Valid colors include: \fIwhite\fR, \fIblack\fR, \fIgreen\fR, \fImagenta\fR, \fIblue\fR, \fIcyan\fR, \fIyellow\fR, \fIred\fR, \fIdefault\fR\&. Use \fIdefault\fR to refer to the default terminal colors\&.
  48
  49
  50 Valid attributes include: \fInormal\fR, \fIblink\fR, \fIbold\fR, \fIdim\fR, \fIreverse\fR, \fIstandout\fR, and \fIunderline\fR\&. Note, not all attributes may be supported by the terminal\&.
  51
  52
  53 Valid area names are described below\&. Note, all names are case\-insensitive, and you may use \fI\-\fR, \fI_\fR, and \fI\&.\fR interchangeably\&. So "Diff\-Header", "DIFF_HEADER", and "diff\&.header" are the same\&.
  54
  55 .SS "Diff markup"
  56
  57
  58 Options concerning diff start, chunks and lines added and deleted\&.
  59
  60
  61 \fIdiff\-header\fR, \fIdiff\-chunk\fR, \fIdiff\-add\fR, \fIdiff\-del\fR
  62
  63 .SS "Enhanced git diff markup"
  64
  65
  66 Extra diff information emitted by the git diff machinery, such as mode changes, rename detection, and similarity\&.
  67
  68
  69 \fIdiff\-oldmode\fR, \fIdiff\-newmode\fR, \fIdiff\-copy\-from\fR, \fIdiff\-copy\-to\fR, \fIdiff\-rename\-from\fR, \fIdiff\-rename\-to\fR, \fIdiff\-similarity\fR \fIdiff\-dissimilarity\fR \fIdiff\-tree\fR, \fIdiff\-index\fR
  70
  71 .SS "Pretty print commit headers"
  72
  73
  74 Commit diffs and the revision logs are usually formatted using pretty printed headers , unless \-\-pretty=raw was given\&. This includes lines, such as merge info, commit ID, and author and comitter date\&.
  75
  76
  77 \fIpp\-author\fR, \fIpp\-commit\fR, \fIpp\-merge\fR, \fIpp\-date\fR, \fIpp\-adate\fR, \fIpp\-cdate\fR
  78
  79 .SS "Raw commit header"
  80
  81
  82 Usually shown when \-\-pretty=raw is given, however \fIcommit\fR is pretty much omnipresent\&.
  83
  84
  85 \fIcommit\fR, \fIparent\fR, \fItree\fR, \fIauthor\fR, \fIcommitter\fR
  86
  87 .SS "Commit message"
  88
  89
  90 For now only Signed\-off\-by lines are colorized\&.
  91
  92
  93 \fIsignoff\fR
  94
  95 .SS "UI colors"
  96
  97
  98 Colors for text not matching any of the above: \fIdefault\fR
  99
 100
 101 Status window colors: \fIstatus\fR
 102
 103
 104 Title window colors: \fItitle\-blur\fR, \fItitle\-focus\fR
 105
 106
 107 Cursor line colors: \fIcursor\fR
 108
 109
 110 Main view specific: \fImain\-date\fR, \fImain\-author\fR, \fImain\-commit\fR, \fImain\-delim\fR, \fImain\-tag\fR, \fImain\-ref\fR
 111
 112 .SH "EXAMPLES"
 113
 114
 115 Some sample options:
 116
 117 .IP
 118
 119 .nf
 120 # Diff colors
 121 color diff\-header       yellow  default
 122 color diff\-index        blue    default
 123 color diff\-chunk        magenta default
 124 # UI colors
 125 color title\-blur        white   blue
 126 color title\-focus       white   blue    bold
 127 .fi
 128
 129 .SH "SEE ALSO"
 130
 131
 132 tig(1)
 133