X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=tig.1.txt;h=96c7c9c6b1eeaeae643cc3ac6c5eb3cf28fa8a65;hb=154c248585aa6895f9a6604ea37ed310722dec73;hp=30508ea50a6973e70b6b628bc3262f69fdab3f7c;hpb=c3c24b0b819eb1bf56822c53752d6bddcda9d236;p=tig.git

diff --git a/tig.1.txt b/tig.1.txt
index 30508ea..96c7c9c 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  [rev] path
+tig status
+tig <      [git command output]
 
 DESCRIPTION
 -----------
@@ -30,21 +29,22 @@ 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 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 or blamed by commits.
+	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 +52,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 +67,7 @@ $ tig test master
 
 Display all branches:
 -----------------------------------------------------------------------------
-$ tig -- --all
+$ tig --all
 -----------------------------------------------------------------------------
 
 Display differences between two branches:
@@ -108,16 +80,30 @@ 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`).
+
+TIGRC_SYSTEM::
+	Path of the system wide configuration file (defaults to
+	`{sysconfdir}/tigrc`).
 
 TIG_LS_REMOTE::
 	Set command for retrieving all repository references. The command
@@ -141,27 +127,31 @@ 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.
+    used.
 
 TIG_BLOB_CMD::
     The command used for the blob view. By default, git-cat-file(1) is
-    used. The command gets the blob ID.
+    used.
 
 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 <fonseca@diku.dk>
+Copyright (c) 2006-2009 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
@@ -171,8 +161,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: