PageRenderTime 44ms CodeModel.GetById 19ms RepoModel.GetById 1ms app.codeStats 0ms

/tig-1.0/tig.1

#
Unknown | 312 lines | 312 code | 0 blank | 0 comment | 0 complexity | 3728d1724e3d67ee0530636b7fd39d71 MD5 | raw file
Possible License(s): GPL-2.0
  1. '\" t
  2. .\" Title: tig
  3. .\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
  4. .\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
  5. .\" Date: 05/10/2012
  6. .\" Manual: Tig Manual
  7. .\" Source: Tig 1.0
  8. .\" Language: English
  9. .\"
  10. .TH "TIG" "1" "05/10/2012" "Tig 1\&.0" "Tig Manual"
  11. .\" -----------------------------------------------------------------
  12. .\" * Define some portability stuff
  13. .\" -----------------------------------------------------------------
  14. .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  15. .\" http://bugs.debian.org/507673
  16. .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  17. .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18. .ie \n(.g .ds Aq \(aq
  19. .el .ds Aq '
  20. .\" -----------------------------------------------------------------
  21. .\" * set default formatting
  22. .\" -----------------------------------------------------------------
  23. .\" disable hyphenation
  24. .nh
  25. .\" disable justification (adjust text to left margin only)
  26. .ad l
  27. .\" -----------------------------------------------------------------
  28. .\" * MAIN CONTENT STARTS HERE *
  29. .\" -----------------------------------------------------------------
  30. .SH "NAME"
  31. tig \- text\-mode interface for git
  32. .SH "SYNOPSIS"
  33. .sp
  34. .nf
  35. tig [options] [revisions] [\-\-] [paths]
  36. tig show [options] [revisions] [\-\-] [paths]
  37. tig blame [options] [rev] [\-\-] path
  38. tig status
  39. tig < [git command output]
  40. .fi
  41. .sp
  42. .SH "DESCRIPTION"
  43. .sp
  44. Browse changes in a git repository\&. Additionally, tig(1) can also act as a pager for output of various git commands\&.
  45. .sp
  46. When browsing repositories, tig(1) uses the underlying git commands to present the user with various views, such as summarized commit log and showing the commit with the log message, diffstat, and the diff\&.
  47. .sp
  48. Using tig(1) as a pager, it will display input from stdin and try to colorize it\&.
  49. .SH "OPTIONS"
  50. .sp
  51. Command line options recognized by tig include all valid git\-log(1) and git\-diff(1) options, as well as the following subcommands and tig specific options\&. The first command line parameter not starting with "\-" is interpreted as being either a revision specification or a path and will end the option parsing\&. All following options will be passed untouched to the underlying git command\&.
  52. .PP
  53. show
  54. .RS 4
  55. Open diff view using the given git\-show(1) options\&.
  56. .RE
  57. .PP
  58. blame
  59. .RS 4
  60. Show given file annotated by commits\&. Takes zero or more git\-blame(1) options\&. Optionally limited from given revision\&.
  61. .RE
  62. .PP
  63. status
  64. .RS 4
  65. Start up in status view\&.
  66. .RE
  67. .PP
  68. +<number>
  69. .RS 4
  70. Show the first view with line <number> visible and selected\&.
  71. .RE
  72. .PP
  73. \-v, \-\-version
  74. .RS 4
  75. Show version and exit\&.
  76. .RE
  77. .PP
  78. \-h, \-\-help
  79. .RS 4
  80. Show help message and exit\&.
  81. .RE
  82. .SH "EXAMPLES"
  83. .sp
  84. Display the current branch:
  85. .sp
  86. .if n \{\
  87. .RS 4
  88. .\}
  89. .nf
  90. $ tig
  91. .fi
  92. .if n \{\
  93. .RE
  94. .\}
  95. .sp
  96. .sp
  97. Display one or more specific branches:
  98. .sp
  99. .if n \{\
  100. .RS 4
  101. .\}
  102. .nf
  103. $ tig test master
  104. .fi
  105. .if n \{\
  106. .RE
  107. .\}
  108. .sp
  109. .sp
  110. Display all branches:
  111. .sp
  112. .if n \{\
  113. .RS 4
  114. .\}
  115. .nf
  116. $ tig \-\-all
  117. .fi
  118. .if n \{\
  119. .RE
  120. .\}
  121. .sp
  122. .sp
  123. Display differences between two branches:
  124. .sp
  125. .if n \{\
  126. .RS 4
  127. .\}
  128. .nf
  129. $ tig test\&.\&.master
  130. .fi
  131. .if n \{\
  132. .RE
  133. .\}
  134. .sp
  135. .sp
  136. Display changes for a single file:
  137. .sp
  138. .if n \{\
  139. .RS 4
  140. .\}
  141. .nf
  142. $ tig \-\- README
  143. .fi
  144. .if n \{\
  145. .RE
  146. .\}
  147. .sp
  148. .sp
  149. Display contents of the README file in a specific revision:
  150. .sp
  151. .if n \{\
  152. .RS 4
  153. .\}
  154. .nf
  155. $ tig show tig\-0\&.8:README
  156. .fi
  157. .if n \{\
  158. .RE
  159. .\}
  160. .sp
  161. .sp
  162. Display revisions between two dates for a specific file:
  163. .sp
  164. .if n \{\
  165. .RS 4
  166. .\}
  167. .nf
  168. $ tig \-\-after="2004\-01\-01" \-\-before="2006\-05\-16" \-\- README
  169. .fi
  170. .if n \{\
  171. .RE
  172. .\}
  173. .sp
  174. .sp
  175. Blame file with copy detection enabled:
  176. .sp
  177. .if n \{\
  178. .RS 4
  179. .\}
  180. .nf
  181. $ tig blame \-C README
  182. .fi
  183. .if n \{\
  184. .RE
  185. .\}
  186. .sp
  187. .SH "ENVIRONMENT VARIABLES"
  188. .sp
  189. In addition to environment variables used by git (e\&.g\&. GIT_DIR), tig defines the ones below\&. The command related environment variables have access to the internal state of tig via replacement variables, such as %(commit) and %(blob)\&. See \fBtigrc\fR(5) for a full list\&.
  190. .PP
  191. TIGRC_USER
  192. .RS 4
  193. Path of the user configuration file (defaults to
  194. ~/\&.tigrc)\&.
  195. .RE
  196. .PP
  197. TIGRC_SYSTEM
  198. .RS 4
  199. Path of the system wide configuration file (defaults to
  200. {sysconfdir}/tigrc)\&.
  201. .RE
  202. .PP
  203. TIG_LS_REMOTE
  204. .RS 4
  205. Set command for retrieving all repository references\&. The command should output data in the same format as git\-ls\-remote(1)\&.
  206. .RE
  207. .PP
  208. TIG_DIFF_OPTS
  209. .RS 4
  210. The diff options to use in the diff view\&. The diff view uses git\-show(1) for formatting and always passes \-\-patch\-with\-stat, \-\-find\-copies\-harder, and \-C\&.
  211. .RE
  212. .PP
  213. TIG_TRACE
  214. .RS 4
  215. Path for trace file where information about git commands are logged\&.
  216. .RE
  217. .SH "FILES"
  218. .PP
  219. \fI~/\&.tigrc\fR
  220. .RS 4
  221. User configuration file\&. See
  222. \fBtigrc\fR(5)
  223. for examples\&.
  224. .RE
  225. .PP
  226. \fI++SYSCONFDIR++/tigrc\fR
  227. .RS 4
  228. System wide configuration file\&.
  229. .RE
  230. .PP
  231. \fI$GIT_DIR/config\fR, \*(Aq~/\&.gitconfig, \*(Aq++SYSCONFDIR++/etc/gitconfig
  232. .RS 4
  233. Git configuration files\&. Read on start\-up with the help of git\-config(1)\&.
  234. .RE
  235. .SH "BUGS"
  236. .sp
  237. Bugs and feature requests can be reported using the issue tracker at \m[blue]\fBhttps://github\&.com/jonas/tig/issues\fR\m[] or by mail to either the git mailing list or directly to the maintainer\&. Ensure that the word "tig" is in the subject\&.
  238. .SH "COPYRIGHT"
  239. .sp
  240. Copyright (c) 2006\-2012 Jonas Fonseca <\m[blue]\fBfonseca@diku\&.dk\fR\m[]\&\s-2\u[1]\d\s+2>
  241. .sp
  242. This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version\&.
  243. .SH "SEE ALSO"
  244. .sp
  245. \fBtigrc\fR(5), \fBtigmanual\fR(7), git(7), gitk(1)
  246. .sp
  247. Online resources:
  248. .sp
  249. .RS 4
  250. .ie n \{\
  251. \h'-04'\(bu\h'+03'\c
  252. .\}
  253. .el \{\
  254. .sp -1
  255. .IP \(bu 2.3
  256. .\}
  257. Homepage:
  258. \m[blue]\fBhttp://jonas\&.nitro\&.dk/tig/\fR\m[]
  259. .RE
  260. .sp
  261. .RS 4
  262. .ie n \{\
  263. \h'-04'\(bu\h'+03'\c
  264. .\}
  265. .el \{\
  266. .sp -1
  267. .IP \(bu 2.3
  268. .\}
  269. Manual:
  270. \m[blue]\fBhttp://jonas\&.nitro\&.dk/tig/manual\&.html\fR\m[]
  271. .RE
  272. .sp
  273. .RS 4
  274. .ie n \{\
  275. \h'-04'\(bu\h'+03'\c
  276. .\}
  277. .el \{\
  278. .sp -1
  279. .IP \(bu 2.3
  280. .\}
  281. Tarballs:
  282. \m[blue]\fBhttp://jonas\&.nitro\&.dk/tig/releases/\fR\m[]
  283. .RE
  284. .sp
  285. .RS 4
  286. .ie n \{\
  287. \h'-04'\(bu\h'+03'\c
  288. .\}
  289. .el \{\
  290. .sp -1
  291. .IP \(bu 2.3
  292. .\}
  293. Git URL: git://github\&.com/jonas/tig\&.git (master) or git://repo\&.or\&.cz/tig\&.git (mirror)
  294. .RE
  295. .sp
  296. .RS 4
  297. .ie n \{\
  298. \h'-04'\(bu\h'+03'\c
  299. .\}
  300. .el \{\
  301. .sp -1
  302. .IP \(bu 2.3
  303. .\}
  304. Gitweb:
  305. \m[blue]\fBhttp://repo\&.or\&.cz/w/tig\&.git\fR\m[]
  306. .RE
  307. .SH "NOTES"
  308. .IP " 1." 4
  309. fonseca@diku.dk
  310. .RS 4
  311. \%mailto:fonseca@diku.dk
  312. .RE