X-Git-Url: https://git.distorted.org.uk/~mdw/tig/blobdiff_plain/e733ee54428dadd0566f81150423735f50da711a..22d9b77cc7819b2dfce44f968c3df3ee4c2ccdae:/tig.1.txt

diff --git a/tig.1.txt b/tig.1.txt
index 94fa5a3..ee96a97 100644
--- a/tig.1.txt
+++ b/tig.1.txt
@@ -1,4 +1,4 @@
-TIG(1)
+tig(1)
 ======
 
 NAME
@@ -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,18 +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.
+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.
@@ -49,32 +52,57 @@ 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
+EXAMPLES
+--------
 
-log::
-	Open log view using the given git log options.
+Display the current branch:
+-----------------------------------------------------------------------------
+$ tig
+-----------------------------------------------------------------------------
+
+Display one or more specific branches:
+-----------------------------------------------------------------------------
+$ tig test master
+-----------------------------------------------------------------------------
+
+Display all branches:
+-----------------------------------------------------------------------------
+$ tig --all
+-----------------------------------------------------------------------------
+
+Display differences between two branches:
+-----------------------------------------------------------------------------
+$ tig test..master
+-----------------------------------------------------------------------------
+
+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
+-----------------------------------------------------------------------------
 
-diff::
-	Open diff view using the given git diff options.
+ENVIRONMENT VARIABLES
+---------------------
 
-show::
-	Open diff view using the given git show options.
+In addition to environment variables used by git (e.g. GIT_DIR), tig defines
+the following:
 
-[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:
+TIGRC_USER::
+	Path of the user configuration file (defaults to `~/.tigrc`).
 
-	$ tig tag-1.0..HEAD
+TIGRC_SYSTEM::
+	Path of the system wide configuration file (defaults to
+	`{sysconfdir}/tigrc`).
 
-ENVIRONMENT VARIABLES
----------------------
 TIG_LS_REMOTE::
 	Set command for retrieving all repository references. The command
 	should output data in the same format as git-ls-remote(1).
@@ -99,7 +127,7 @@ 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.
@@ -109,15 +137,18 @@ FILES
 '~/.tigrc'::
 	User configuration file. See gitlink:tigrc[5] for examples.
 
-'.git/config'::
-	Repository config file. Read on startup with the help of
-	git-repo-config(1).
+'{sysconfdir}/tigrc'::
+	System wide configuration file.
+
+'$GIT_DIR/config'::
+	Repository config file. Read on start-up with the help of
+	git-config(1).
 
 include::BUGS[]
 
 COPYRIGHT
 ---------
-Copyright (c) 2006 Jonas Fonseca <fonseca@diku.dk>
+Copyright (c) 2006-2008 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