ifndef::doctype-manpage[] The tig Manual ============== Jonas Fonseca endif::doctype-manpage[] This is the manual for tig, the ncurses-based text-mode interface for git. Tig allows you to browse changes in a git repository and can additionally act as a pager for output of various git commands. When used as a pager, it will display input from stdin and colorize it. When browsing repositories, tig 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. ifndef::backend-docbook[] *Table of Contents* include::manual.toc[] endif::backend-docbook[] [[calling-conventions]] Calling Conventions ------------------- [[pager-mode]] Pager Mode ~~~~~~~~~~ If stdin is a pipe, any log or diff options will be ignored and the pager view will be opened loading data from stdin. The pager mode can be used for colorizing output from various git commands. Example on how to colorize the output of git-show(1): ----------------------------------------------------------------------------- $ git show | tig ----------------------------------------------------------------------------- [[cmd-options]] Git Command Options ~~~~~~~~~~~~~~~~~~~ All git command options specified on the command line will be passed to the given command and all will be shell quoted before they are passed to the shell. NOTE: If you specify options for the main view, you should not use the `--pretty` option as this option will be set automatically to the format expected by the main view. Example on how to view a commit and show both author and committer information: ----------------------------------------------------------------------------- $ tig show --pretty=fuller ----------------------------------------------------------------------------- See the section on <> for an introduction to revision options supported by the git commands. For details on specific git command options, refer to the man page of the command in question. [[viewer]] The Viewer ---------- The display consists of a status window on the last line of the screen and one or more views. The default is to only show one view at the time but it is possible to split both the main and log view to also show the commit diff. If you are in the log view and press 'Enter' when the current line is a commit line, such as: ----------------------------------------------------------------------------- commit 4d55caff4cc89335192f3e566004b4ceef572521 ----------------------------------------------------------------------------- You will split the view so that the log view is displayed in the top window and the diff view in the bottom window. You can switch between the two views by pressing 'Tab'. To maximize the log view again, simply press 'l'. [[views]] Views ~~~~~ Various 'views' of a repository is presented. Each view is based on output from an external command, most often 'git log', 'git diff', or 'git show'. The main view:: Is the default view, and it shows a one line summary of each commit in the chosen list of revisions. The summary includes commit date, author, and the first line of the log message. Additionally, any repository references, such as tags, will be shown. The log view:: Presents a more rich view of the revision log showing the whole log message and the diffstat. The diff view:: Shows either the diff of the current working tree, that is, what has changed since the last commit, or the commit diff complete with log message, diffstat and diff. The tree view:: Lists directory trees associated with the current revision allowing subdirectories to be descended or ascended and file blobs to be viewed. The blob view:: Displays the file content or "blob" of data associated with a file name. The blame view:: Displays the file content annotated or blamed by commits. The branch view:: Displays the branches in the repository. The status view:: Displays status of files in the working tree and allows changes to be staged/unstaged as well as adding of untracked files. The stage view:: Displays diff changes for staged or unstanged files being tracked or file content of untracked files. The pager view:: Is used for displaying both input from stdin and output from git commands entered in the internal prompt. The help view:: Displays a quick reference of key bindings. [[commit-id]] Browsing State and User-defined Commands ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ The viewer keeps track of both what head and commit ID you are currently viewing. The commit ID will follow the cursor line and change every time you highlight a different commit. Whenever you reopen the diff view it will be reloaded, if the commit ID changed. The head ID is used when opening the main and log view to indicate from what revision to show history. Some of the commands used or provided by tig can be configured. This goes for some of the <> as well as the <>. These user-defined commands can use arguments that refer to the current browsing state by using one of the following variables. .Browsing state variables [frame="none",grid="none",cols="25). In the stage view, when pressing this on a diff chunk line stages only that chunk for next commit, when not on a diff chunk line all changes in the displayed diff is staged. |M |Resolve unmerged file by launching git-mergetool(1). Note, to work correctly this might require some initial configuration of your preferred merge tool. See the manpage of git-mergetool(1). |! |Checkout file with unstaged changes. This will reset the file to contain the content it had at last commit. |@ |Move to next chunk in the stage view. |============================================================================= [[cursor-nav]] Cursor Navigation ~~~~~~~~~~~~~~~~~ [frame="none",grid="none",cols="2<,8<",options="header"] |============================================================================= |Key |Action |k |Move cursor one line up. |j |Move cursor one line down. |PgUp,-,a |Move cursor one page up. |PgDown, Space |Move cursor one page down. |End |Jump to last line. |Home |Jump to first line. |============================================================================= [[view-scrolling]] Scrolling ~~~~~~~~~ [frame="none",grid="none",cols="2<,8<",options="header"] |============================================================================= |Key |Action |Insert |Scroll view one line up. |Delete |Scroll view one line down. |w |Scroll view one page up. |s |Scroll view one page down. |Left |Scroll view one column left. |Right |Scroll view one column right. |\| |Scroll view to the first column. |============================================================================= [[searching]] Searching ~~~~~~~~~ [frame="none",grid="none",cols="2<,8<",options="header"] |============================================================================= |Key |Action |/ |Search the view. Opens a prompt for entering search regexp to use. |? |Search backwards in the view. Also prompts for regexp. |n |Find next match for the current search regexp. |N |Find previous match for the current search regexp. |============================================================================= [[misc-keys]] Misc ~~~~ [frame="none",grid="none",cols="2<,8<",options="header"] |============================================================================= |Key |Action |Q |Quit. |r |Redraw screen. |z |Stop all background loading. This can be useful if you use tig in a repository with a long history without limiting the revision log. |v |Show version. |o |Open option menu |. |Toggle line numbers on/off. |D |Toggle date display on/off/short/relative/local. |A |Toggle author display on/off/abbreviated. |g |Toggle revision graph visualization on/off. |~ |Toggle (line) graphics mode |F |Toggle reference display on/off (tag and branch names). |: |Open prompt. This allows you to specify what git command to run. Example `:log -p`. You can also use this to jump to a specific line by typing `:`, e.g. `:80`. |e |Open file in editor. |============================================================================= [[external-commands]] External Commands ~~~~~~~~~~~~~~~~~ For more custom needs, external commands provide a way to easily execute a script or program. They are bound to keys and use information from the current browsing state, such as the current commit ID. Tig comes with the following built-in external commands: [frame="none",grid="none",cols="1<,1<,8<",options="header"] |============================================================================= |Keymap |Key |Action |main |C |git cherry-pick %(commit) |status |C |git commit |generic|G |git gc |============================================================================= [[refspec]] Revision Specification ---------------------- This section describes various ways to specify what revisions to display or otherwise limit the view to. Tig does not itself parse the described revision options so refer to the relevant git man pages for further information. Relevant man pages besides git-log(1) are git-diff(1) and git-rev-list(1). You can tune the interaction with git by making use of the options explained in this section. For example, by configuring the environment variable described in the section on <>. [[path-limiting]] Limit by Path Name ~~~~~~~~~~~~~~~~~~ If you are interested only in those revisions that made changes to a specific file (or even several files) list the files like this: ----------------------------------------------------------------------------- $ tig Makefile README ----------------------------------------------------------------------------- To avoid ambiguity with tig's subcommands or repository references such as tag name, be sure to separate file names from other git options using "`--`". So if you have a file named 'status' it will clash with the 'status' subcommand, and thus you will have to use: ----------------------------------------------------------------------------- $ tig -- status ----------------------------------------------------------------------------- [[date-number-limiting]] Limit by Date or Number ~~~~~~~~~~~~~~~~~~~~~~~ To speed up interaction with git, you can limit the amount of commits to show both for the log and main view. Either limit by date using e.g. `--since=1.month` or limit by the number of commits using `-n400`. If you are only interested in changed that happened between two dates you can use: ----------------------------------------------------------------------------- $ tig --after="May 5th" --before="2006-05-16 15:44" ----------------------------------------------------------------------------- NOTE: If you want to avoid having to quote dates containing spaces you can use "." instead, e.g. `--after=May.5th`. [[commit-range-limiting]] Limiting by Commit Ranges ~~~~~~~~~~~~~~~~~~~~~~~~~ Alternatively, commits can be limited to a specific range, such as "all commits between 'tag-1.0' and 'tag-2.0'". For example: ----------------------------------------------------------------------------- $ tig tag-1.0..tag-2.0 ----------------------------------------------------------------------------- This way of commit limiting makes it trivial to only browse the commits which haven't been pushed to a remote branch. Assuming 'origin' is your upstream remote branch, using: ----------------------------------------------------------------------------- $ tig origin..HEAD ----------------------------------------------------------------------------- will list what will be pushed to the remote branch. Optionally, the ending 'HEAD' can be left out since it is implied. [[reachability-limiting]] Limiting by Reachability ~~~~~~~~~~~~~~~~~~~~~~~~ Git interprets the range specifier "tag-1.0..tag-2.0" as "all commits reachable from 'tag-2.0' but not from 'tag-1.0'". Where reachability refers to what commits are ancestors (or part of the history) of the branch or tagged revision in question. If you prefer to specify which commit to preview in this way use the following: ----------------------------------------------------------------------------- $ tig tag-2.0 ^tag-1.0 ----------------------------------------------------------------------------- You can think of '^' as a negation operator. Using this alternate syntax, it is possible to further prune commits by specifying multiple branch cut offs. [[refspec-combi]] Combining Revisions Specification ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Revisions options can to some degree be combined, which makes it possible to say "show at most 20 commits from within the last month that changed files under the Documentation/ directory." ----------------------------------------------------------------------------- $ tig --since=1.month -n20 -- Documentation/ ----------------------------------------------------------------------------- [[refspec-all]] Examining All Repository References ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ In some cases, it can be useful to query changes across all references in a repository. An example is to ask "did any line of development in this repository change a particular file within the last week". This can be accomplished using: ----------------------------------------------------------------------------- $ tig --all --since=1.week -- Makefile ----------------------------------------------------------------------------- include::BUGS[] [[copy-right]] Copyright --------- Copyright (c) 2006-2010 Jonas Fonseca 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. [[references]] References and Related Tools ---------------------------- Manpages: - manpage:tig[1] - manpage:tigrc[5] Online resources: include::SITES[]