X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=tig.1.txt;h=490a0a247008663da6e0fc021150f09255e634ff;hb=28e376e2624f6dd5fa20caacec996e3468d7f45d;hp=7b1c779ebfc2becea792ca0772d51509edd5ce98;hpb=b6607e7e796f5b58d64211c022d3e1af6159bdaa;p=tig.git diff --git a/tig.1.txt b/tig.1.txt index 7b1c779..490a0a2 100644 --- a/tig.1.txt +++ b/tig.1.txt @@ -8,12 +8,11 @@ tig - text-mode interface for git SYNOPSIS -------- [verse] -tig [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] +tig [options] [revisions] [--] [paths] +tig show [options] [revisions] [--] [paths] +tig blame [options] [rev] path +tig status +tig < [git command output] DESCRIPTION ----------- @@ -30,21 +29,23 @@ to colorize it. OPTIONS ------- --l:: - Start up in log view using the internal log command. +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. --d:: - Start up in diff view using the internal diff command. - --S:: - Start up in status view. +show:: + Open diff view using the given git-show(1) options. --n[INTERVAL], --line-number[=INTERVAL]:: - Prefix line numbers in log and diff view. - Optionally, with interval different than each line. +blame:: + Show given file annotated by commits. + Takes zero or more git-blame(1) options. + Optionally limited from given revision. --b[NSPACES], --tab-size[=NSPACES]:: - Set the number of spaces tabs should be expanded to. +status:: + Start up in status view. -v, --version:: Show version and exit. @@ -52,34 +53,6 @@ OPTIONS -h, --help:: Show help message and exit. -\--:: - End of tig(1) options. Useful when specifying command - options for the main view. Example: -+ ----------------------------------------------------------------------------- -$ tig -- --since=1.month ------------------------------------------------------------------------------ - -log:: - Open log view using the given git log options. - -diff:: - Open diff view using the given git diff options. - -show:: - Open diff view using the given git show options. - -[git options]:: - tig(1) will stop the option parsing when the first - command line parameter not starting with "-" is - encountered. All options including this one will be - passed to git log when loading the main view. - This makes it possible to say: -+ ------------------------------------------------------------------------------ -$ tig tag-1.0..HEAD ------------------------------------------------------------------------------ - EXAMPLES -------- @@ -95,7 +68,7 @@ $ tig test master Display all branches: ----------------------------------------------------------------------------- -$ tig -- --all +$ tig --all ----------------------------------------------------------------------------- Display differences between two branches: @@ -108,16 +81,23 @@ Display changes for a single file: $ tig -- README ----------------------------------------------------------------------------- +Display contents of the README file in a specific revision: +----------------------------------------------------------------------------- +$ tig show tig-0.8:README +----------------------------------------------------------------------------- + Display revisions between two dates for a specific file: ----------------------------------------------------------------------------- -$ tig -- --after "2004-01-01" --before="2006-05-16" -- README +$ tig --after="2004-01-01" --before="2006-05-16" -- README ----------------------------------------------------------------------------- ENVIRONMENT VARIABLES --------------------- In addition to environment variables used by git (e.g. GIT_DIR), tig defines -the following: +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 manpage:tigrc[5] for a full list. TIGRC_USER:: Path of the user configuration file (defaults to `~/.tigrc`). @@ -130,48 +110,30 @@ TIG_LS_REMOTE:: Set command for retrieving all repository references. The command should output data in the same format as git-ls-remote(1). -TIG_DIFF_CMD:: - The command used for the diff view. By default, git show is used - as a backend. - -TIG_LOG_CMD:: - The command used for the log view. If you prefer to have both - author and committer shown in the log view be sure to pass - `--pretty=fuller` to git log. - -TIG_MAIN_CMD:: - The command used for the main view. Note, you must always specify - the option: `--pretty=raw` since the main view parser expects to - read that format. - -Tree commands -~~~~~~~~~~~~~ -TIG_TREE_CMD:: - 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. - -TIG_BLOB_CMD:: - The command used for the blob view. By default, git-cat-file(1) is - used. The command gets the blob ID. +TIG_DIFF_OPTS:: + 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. FILES ----- '~/.tigrc':: - User configuration file. See gitlink:tigrc[5] for examples. + User configuration file. See manpage:tigrc[5] for examples. '{sysconfdir}/tigrc':: System wide configuration file. '$GIT_DIR/config':: - Repository config file. Read on start-up with the help of +'~/.gitconfig:: +'{sysconfdir}/etc/gitconfig:: + Git configuration files. Read on start-up with the help of git-config(1). include::BUGS[] COPYRIGHT --------- -Copyright (c) 2006-2007 Jonas Fonseca +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 @@ -181,8 +143,7 @@ the Free Software Foundation; either version 2 of the License, or SEE ALSO -------- -gitlink:tigrc[5], git(7), cogito(7), as well as other git repository browsers: -gitk(1), qgit(1), gitview(1). +manpage:tigrc[5], manpage:tigmanual[7], git(7), gitk(1) Online resources: