Sync docs
[tig] / tig.1.txt
index fdd7c62..1d2d1eb 100644 (file)
--- a/tig.1.txt
+++ b/tig.1.txt
@@ -159,7 +159,7 @@ from an external command, most often 'git log', 'git diff', or 'git show'.
 
 The main view::
        Is the default view, and it shows a one line summary of each commit
-       in the chosen list of revision. The summary includes commit date,
+       in the chosen list of revisions. The summary includes commit date,
        author, and the first line of the log message. Additionally, any
        repository references, such as tags, will be shown.
 
@@ -256,14 +256,20 @@ n::
        :log -p
 
 [[refspec]]
-Specifying revisions
---------------------
+Revision specification
+----------------------
 This section describes various ways to specify what revisions to display
-or otherwise limit the view to. Note, that tig(1) does not itself parse
-the described revision options.
+or otherwise limit the view to. tig(1) does not itself parse the described
+revision options so refer to the relevant git man pages for futher
+information. Relevant man pages besides git-log(1) are git-diff(1) and
+git-rev-list(1).
 
-File history
-------------
+You can tune the interaction with git by making use of the options
+explained in this section. For example, by configuring the environment
+variables described in the  <<view-commands, "View commands">> section.
+
+Limit by path name
+~~~~~~~~~~~~~~~~~~
 If you are interested only in those revisions that made changes to a
 specific file (or even several files) list the files like this:
 
@@ -274,7 +280,7 @@ to separate file names from other git options using "\--". So if you
 have a file named 'master' it will clash with the reference named
 'master', and thus you will have to use:
 
-       $ tag log -- master
+       $ tig log -- master
 
 NOTE: For the main view, avoiding ambiguity will in some cases require
 you to specify two "\--" options. The first will make tig(1) stop
@@ -286,12 +292,17 @@ To speed up interaction with git, you can limit the amount of commits
 to show both for the log and main view. Either limit by date using
 e.g. `--since=1.month` or limit by the number of commits using `-n400`.
 
-NOTE: You can tune the interaction with git by making use of the options
-explained in this section. For example, by configuring the environment
-variables described in the  <<view-commands, "View commands">> section.
+If you are only interested in changed that happened between two dates
+you can use:
+
+       $ tig -- --after=May.5th --before=2006-05-16.15:44
 
-Ranges
-~~~~~~
+NOTE: The dot (".") is used as a separator instead of a space to avoid
+having to quote the option value. If you prefer use `--after="May 5th"`
+instead of `--after="May 5th"`.
+
+Limiting by commit ranges
+~~~~~~~~~~~~~~~~~~~~~~~~~
 Alternatively, commits can be limited to a specific range, such as
 "all commits between 'tag-1.0' and 'tag-2.0'". For example:
 
@@ -310,6 +321,9 @@ Limiting by reachability
 ~~~~~~~~~~~~~~~~~~~~~~~~
 Git interprets the range specifier "tag-1.0..tag-2.0" as
 "all commits reachable from 'tag-2.0' but not from 'tag-1.0'".
+Where reachability refers to what commits are ancestors (or part of the
+history) of the branch or tagged revision in question.
+
 If you prefer to specify which commit to preview in this way use the
 following:
 
@@ -319,6 +333,23 @@ You can think of '^' as a negation operator. Using this alternate syntax,
 it is possible to further prune commits by specifying multiple branch
 cut offs.
 
+Combining revisions specification
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Revisions options can to some degree be combined, which makes it possible
+to say "show at most 20 commits from within the last month that changed
+files under the Documentation/ directory."
+
+       $ tig -- --since=1.month -n20 -- Documentation/
+
+Examining all repository references
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+In some cases, it can be useful to query changes across all references
+in a repository. An example is to ask "did any line of development in
+this repository change a particular file within the last week". This
+can be accomplished using:
+
+       $ tig -- --all --since=1.week -- Makefile
+
 BUGS
 ----
 Known bugs and problems:
@@ -350,5 +381,6 @@ SEE ALSO
 link:http://www.kernel.org/pub/software/scm/git/docs/[git(7)],
 link:http://www.kernel.org/pub/software/scm/cogito/docs/[cogito(7)]
 gitk(1): git repository browser written using tcl/tk,
+qgit(1): git repository browser written using c++/Qt,
 gitview(1): git repository browser written using python/gtk.