X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~mdw/git/tig/blobdiff_plain/2b9c2ad0cb752490823c2e0ac11a70547103cda3..refs/heads/release:/tig.1.html diff --git a/tig.1.html b/tig.1.html index 9d3f59c..ae14630 100644 --- a/tig.1.html +++ b/tig.1.html @@ -274,10 +274,10 @@ TIG(1) Manual Page
tig [options] -tig [options] [--] [git log options] -tig [options] log [git log options] -tig [options] diff [git diff options] -tig [options] show [git show options] +tig [options] [--] [git options] +tig [options] log [git options] +tig [options] diff [git options] +tig [options] show [git options] tig [options] < [git command output]

DESCRIPTION

@@ -319,7 +319,7 @@ to colorize it.

--t[NSPACES], --tab-size[=NSPACES] +-b[NSPACES], --tab-size[=NSPACES]

@@ -335,6 +335,14 @@ to colorize it.

+-h, --help +
+
+

+ Show help message and exit. +

+
+
--
@@ -348,7 +356,7 @@ to colorize it.

-log [git log options] +log

@@ -356,7 +364,7 @@ log [git log options]

-diff [git diff options] +diff

@@ -364,7 +372,7 @@ diff [git diff options]

-show [git show options] +show

@@ -372,7 +380,7 @@ show [git show options]

-[git log options] +[git options]

@@ -388,58 +396,9 @@ show [git show options]

-

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
-
-

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 open the log view and show both author and -committer information:

-
-
-
$ tig log --pretty=fuller
-
-

See the "Specifying revisions" section below -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.

ENVIRONMENT VARIABLES

-

Several options related to the interface with git can be configured -via environment options.

-

Repository references

-

Commits that are referenced by tags and branch heads will be marked -by the reference name surrounded by [ and ]:

-
-
-
2006-03-26 19:42 Petr Baudis         | [cogito-0.17.1] Cogito 0.17.1
-
-

If you want to filter out certain directories under .git/refs/, say -tmp you can do it by setting the following variable:

-
-
-
$ TIG_LS_REMOTE="git ls-remote . | sed /\/tmp\//d" tig
-
-

Or set the variable permanently in your environment.

TIG_LS_REMOTE @@ -450,19 +409,6 @@ TIG_LS_REMOTE should output data in the same format as git-ls-remote(1).

-
-

View commands

-

It is possible to alter which commands are used for the different views. -If for example you prefer commits in the main view to be sorted by date -and only show 500 commits, use:

-
-
-
$ TIG_MAIN_CMD="git log --date-order -n500 --pretty=raw %s" tig
-
-

Or set the variable permanently in your environment.

-

Notice, how %s is used to specify the commit reference. There can -be a maximum of 5 %s ref specifications.

-
TIG_DIFF_CMD
@@ -493,363 +439,50 @@ TIG_MAIN_CMD

-
-

The viewer

-
-

tig(1) presents various views of a repository. Each view is based on output -from an external command, most often git log, git diff, or git show.

+

Tree commands

-The main view +TIG_TREE_CMD

- Is the default view, and it shows a one line summary of each commit - in the chosen list of revision. 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 command used for the tree view. By default, git-ls-tree(1) is + used. The commands should expect first the commit ID and second + a path.

-The log view +TIG_BLOB_CMD

- 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 pager view -
-
-

- Is used for displaying both input from stdin and output from git - commands entered in the internal prompt. -

-
-
-The help view -
-
-

- Displays the information from the tig(1) man page. For the help view - to work you need to have the tig(1) man page installed. + The command used for the blob view. By default, git-cat-file(1) is + used. The command gets the blob ID.

-

KEYS

+

FILES

-

Below the default key bindings are shown.

-

View switching

-m -
-
-

- Switch to main view. -

-
-
-d -
-
-

- Switch to diff view. -

-
-
-l -
-
-

- Switch to log view. -

-
-
-p -
-
-

- Switch to pager view. -

-
-
-h -
-
-

- Show man page. -

-
-
-Return +~/.tigrc

- If on a commit line show the commit diff. Additionally, if in - main or log view this will split the view. To open the commit - diff in full size view either use d or press Return twice. + User configuration file. See tigrc(5) for examples.

-Tab +.git/config

- Switch to next view. + Repository config file. Read on start-up with the help of + git-repo-config(1).

-

Cursor navigation

-
-
-Up -
-
-

- Move cursor one line up. -

-
-
-Down -
-
-

- Move cursor one line down. -

-
-
-k -
-
-

- Move cursor one line up and enter. When used in the main view - this will always show the diff of the current commit in the - split diff view. -

-
-
-j -
-
-

- Move cursor one line down and enter. -

-
-
-PgUp -
-
-

- Move cursor one page up. -

-
-
-PgDown -
-
-

- Move cursor one page down. -

-
-
-Home -
-
-

- Jump to first line. -

-
-
-End -
-
-

- Jump to last line. -

-
-
-

Scrolling

-
-
-Insert -
-
-

- Scroll view one line up. -

-
-
-Delete -
-
-

- Scroll view one line down. -

-
-
-w -
-
-

- Scroll view one page up. -

-
-
-s -
-
-

- Scroll view one page down. -

-
-
-

Misc

-
-
-q -
-
-

- Quit -

-
-
-r -
-
-

- Redraw screen. -

-
-
-z -
-
-

- Stop all background loading. This can be useful if you use - tig(1) in a repository with a long history without limiting - the revision log. -

-
-
-v -
-
-

- Show version. -

-
-
-n -
-
-

- Toggle line numbers on/off. -

-
-
-: -
-
-

- Open prompt. This allows you to specify what git command - to run. Example: -

-
-
-
:log -p
-
-
-
-
-

Specifying revisions

-
-

This section describes various ways to specify what revisions to display -or otherwise limit the view to. Note, that tig(1) does not itself parse -the described revision options.

-
-

File history

-
-

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 log Makefile
-
-

To avoid ambiguity with repository references such as tag name, be sure -to separate file names from other git options using "--". So if you -have a file named master it will clash with the reference named -master, and thus you will have to use:

-
-
-
$ tag log -- master
-
-
- - - -
-
Note
-
For the main view, avoiding ambiguity will in some cases require -you to specify two "--" options. The first will make tig(1) stop -option processing and the latter will be passed to git log.
-
-

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.

-
- - - -
-
Note
-
You can tune the interaction with git by making use of the options -explained in this section. For example, by configuring the environment -variables described in the "View commands" section.
-
-

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 log 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 log origin..HEAD
-
-

will list what will be pushed to the remote branch. Optionally, the ending -HEAD can be left out since it is implied.

-

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". -If you prefer to specify which commit to preview in this way use the -following:

-
-
-
$ tig log 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.

BUGS

@@ -857,32 +490,19 @@ cut offs.

-
-

TODO

-
-

Features that should be explored.

-

COPYRIGHT

-

Copyright (c) Jonas Fonseca <fonseca@diku.dk>, 2006

+

Copyright (c) 2006 Jonas Fonseca <fonseca@diku.dk>

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 @@ -890,15 +510,41 @@ the Free Software Foundation; either version 2 of the License, or

SEE ALSO

-
-
git(7), -cogito(7) -gitk(1): git repository browser written using tcl/tk, -gitview(1): git repository browser written using python/gtk.
+

tigrc(5), git(7), cogito(7), as well as other git repository browsers: +gitk(1), qgit(1), gitview(1).

+

Online resources:

+