X-Git-Url: https://git.distorted.org.uk/~mdw/tig/blobdiff_plain/0847af4b4e35bc5564bc9efed7774ed6edfbec18..42afc55b25b10e3eb15a0fbdabc6fee17e2ff8fa:/tig.1.html diff --git a/tig.1.html b/tig.1.html index 6a834f1..5c34111 100644 --- a/tig.1.html +++ b/tig.1.html @@ -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. +

+
+
--
@@ -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
@@ -494,439 +440,124 @@ TIG_MAIN_CMD
-

The viewer

+

FILES

-

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.

-The main view +~/.tigrc

- 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. + User configuration file. See tigrc(5) for examples.

-The log view +.git/config

- 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. + Repository config file. Read on startup with the help of + git-repo-config(1).

-

KEYS

+

BUGS

-

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

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

-
-
-Tab -
-
-

- Switch to next view. -

-
-
-

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

Known bugs and problems:

+
    +
  • - Scroll view one line up. +In it's current state tig is pretty much UTF-8 only.

    -
-
-Delete -
-
+ +
  • - Scroll view one line down. +If the screen width is very small the main view can draw + outside the current view causing bad wrapping. Same goes + for title and status windows.

    -
  • -
    -w -
    -
    + +
  • - Scroll view one page up. +The cursor can wrap-around on the last line and cause the + window to scroll.

    -
  • -
    -s -
    -
    + +
  • - Scroll view one page down. +The prompt doesn't work while loading.

    -
  • -
    -

    Misc

    -
    -
    -q -
    -
    + + +
    +

    COPYRIGHT

    +
    +

    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 +(at your option) any later version.

    +
    +

    SEE ALSO

    +
    + +

    Other git repository browsers:

    + +

    Sites:

    +
    -

    Revision specification

    -
    -

    This section describes various ways to specify what revisions to display -or otherwise limit the view to. tig(1) does not itself parse the described -revision options so refer to the relevant git man pages for futher -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 -variables described in the "View commands" section.

    -

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

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

    -

    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
    -
    The dot (".") is used as a separator instead of a space to avoid -having to quote the option value. If you prefer use --after="May 5th" -instead of --after="May 5th".
    -
    -

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

    -

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

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

    BUGS

    -
    -

    Known bugs and problems:

    - -
    -

    TODO

    -
    -

    Features that should be explored.

    -
    -

    COPYRIGHT

    -
    -

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

    -

    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.

    -
    -

    SEE ALSO

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