Make it possible to overwrite the default (terminal) colors
[tig] / tig.1.txt
index 4b8a735..30508ea 100644 (file)
--- a/tig.1.txt
+++ b/tig.1.txt
@@ -1,4 +1,4 @@
-TIG(1)
+tig(1)
 ======
 
 NAME
@@ -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,8 +55,10 @@ 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::
        Open log view using the given git log options.
@@ -70,11 +75,50 @@ show::
        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
+-----------------------------------------------------------------------------
 
-       $ tig tag-1.0..HEAD
+Display all branches:
+-----------------------------------------------------------------------------
+$ tig -- --all
+-----------------------------------------------------------------------------
+
+Display differences between two branches:
+-----------------------------------------------------------------------------
+$ tig test..master
+-----------------------------------------------------------------------------
+
+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).
@@ -99,7 +143,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 +153,15 @@ FILES
 '~/.tigrc'::
        User configuration file. See gitlink:tigrc[5] for examples.
 
-'.git/config'::
+'$GIT_DIR/config'::
        Repository config file. Read on start-up with the help of
-       git-repo-config(1).
+       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