X-Git-Url: https://git.distorted.org.uk/~mdw/tig/blobdiff_plain/511147de010477fc7808df7fc535a32dd59fae31..4ef1bf121de1697c9d54e10addcd34a4d19d3526:/tig.1.txt

diff --git a/tig.1.txt b/tig.1.txt
index b0cafd8..30508ea 100644
--- a/tig.1.txt
+++ b/tig.1.txt
@@ -1,4 +1,4 @@
-TIG(1)
+tig(1)
 ======
 
 NAME
@@ -9,10 +9,10 @@ SYNOPSIS
 --------
 [verse]
 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
@@ -36,6 +36,9 @@ OPTIONS
 -d::
 	Start up in diff view using the internal diff command.
 
+-S::
+	Start up in status view.
+
 -n[INTERVAL], --line-number[=INTERVAL]::
 	Prefix line numbers in log and diff view.
 	Optionally, with interval different than each line.
@@ -52,29 +55,70 @@ OPTIONS
 \--::
 	End of tig(1) options. Useful when specifying command
 	options for the main view. Example:
++
+----------------------------------------------------------------------------
+$ tig -- --since=1.month
+-----------------------------------------------------------------------------
 
-		$ tig -- --since=1.month
-
-log [git log options]::
+log::
 	Open log view using the given git log options.
 
-diff [git diff options]::
+diff::
 	Open diff view using the given git diff options.
 
-show [git show options]::
+show::
 	Open diff view using the given git show options.
 
-[git log 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
+--------
+
+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
+-----------------------------------------------------------------------------
 
-	$ tig tag-1.0..HEAD
+Display changes for a single file:
+-----------------------------------------------------------------------------
+$ tig -- README
+-----------------------------------------------------------------------------
+
+Display revisions between two dates for a specific file:
+-----------------------------------------------------------------------------
+$ 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:
+
 TIG_LS_REMOTE::
 	Set command for retrieving all repository references. The command
 	should output data in the same format as git-ls-remote(1).
@@ -93,20 +137,31 @@ TIG_MAIN_CMD::
 	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.
+
 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).
+'$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-2007 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
@@ -116,17 +171,9 @@ the Free Software Foundation; either version 2 of the License, or
 SEE ALSO
 --------
 
-- gitlink:tigrc[5]
-- link:http://jonas.nitro.dk/tig/manual.html[The tig manual],
-- link:http://www.kernel.org/pub/software/scm/git/docs/[git(7)],
-- link:http://www.kernel.org/pub/software/scm/cogito/docs/[cogito(7)]
-
-Other git repository browsers:
-
-- gitk(1)
-- qgit(1)
-- gitview(1)
+gitlink:tigrc[5], git(7), cogito(7), as well as other git repository browsers:
+gitk(1), qgit(1), gitview(1).
 
-Sites:
+Online resources:
 
 include::SITES[]