Add system-wide configuration file and new config file environment vars

[tig] / manual.txt

diff --git a/manual.txt b/manual.txt
index cf7b83f..efdb079 100644 (file)
--- a/manual.txt
+++ b/manual.txt
@@ -65,6 +65,21 @@ Environment Variables
 Several options related to the interface with git can be configured via
 environment options.
 
+[[configuration-files]]
+Configuration Files
+~~~~~~~~~~~~~~~~~~~
+
+Upon startup, tig first reads the system wide configuration file
+(`{sysconfdir}/tigrc` by default) and then proceeds to read the user's
+configuration file (`~/.tigrc` by default). The paths to either of these files
+can be overridden through the following environment variables:
+
+TIGRC_USER::
+       Path of the user configuration file.
+
+TIGRC_SYSTEM::
+       Path of the system wide configuration file.
+
 [[repo-refs]]
 Repository References
 ~~~~~~~~~~~~~~~~~~~~~
@@ -120,6 +135,19 @@ TIG_MAIN_CMD::
        the option: `--pretty=raw` since the main view parser expects to
        read that format.
 
+[[tree-commands]]
+Tree Commands
+~~~~~~~~~~~~~
+
+TIG_TREE_CMD::
+       The command used for the tree view. Takes two arguments, the first
+       is the revision ID and the second is the path of the directory tree,
+       empty for the root directory. Defaults to "git ls-tree %s %s".
+
+TIG_BLOB_CMD::
+       The command used for the blob view. Takes one argument which is
+       the blob ID. Defaults to "git cat-file blob %s".
+
 [[viewer]]
 The Viewer
 ----------
@@ -182,6 +210,14 @@ The blob view::
        Displays the file content or "blob" of data associated with a file
        name.
 
+The status view::
+       Displays status of files in the working tree and allows changes to be
+       staged/unstaged as well as adding of untracked files.
+
+The stage view::
+       Displays diff changes for staged or unstanged files being tracked or
+       file content of untracked files.
+
 The pager view::
        Is used for displaying both input from stdin and output from git
        commands entered in the internal prompt.
@@ -226,7 +262,9 @@ l   Switch to log view.
 p      Switch to pager view.
 t      Switch to (directory) tree view.
 f      Switch to (file) blob view.
-h      Show man page.
+h      Switch to help view
+S      Switch to status view
+c      Switch to stage view
 -----------------------------------------------------------------------------
 
 [[view-manipulation]]
@@ -244,6 +282,7 @@ Enter       This key is "context sensitive" depending on what view you are \
        view, split the view and show the commit diff. In the diff view \
        pressing Enter will simply scroll the view one line down.
 Tab    Switch to next view.
+R      Reload and refresh the current view.
 Up     This key is "context sensitive" and will move the cursor one \
        line up. However, if you opened a diff view from the main view \
        (split- or full-screen) it will change the cursor to point to \
@@ -311,6 +350,31 @@ v  Show version.
 g      Toggle revision graph visualization on/off.
 ':'    Open prompt. This allows you to specify what git command \
        to run. Example `:log -p`
+u      Update status of file. In the status view, this allows you to add an \
+       untracked file or stage changes to a file for next commit (similar to \
+       running git-add <filename>). In the stage view, when pressing this on \
+       a diff chunk line stages only that chunk for next commit, when not on \
+       a diff chunk line all changes in the displayed diff is staged.
+M      Resolve unmerged file by launching git-mergetool(1). Note, to work \
+       correctly this might require some initial configuration of your \
+       preferred merge tool. See the manpage of git-mergetool(1).
+','    Move tree view to the parent tree.
+e      Open file in editor.
+-----------------------------------------------------------------------------
+
+[[external-commands]]
+External Commands
+~~~~~~~~~~~~~~~~~
+
+Tig also comes with a few builtin external commands. These are simple shell
+commands that are run and can take arguments from the current browsing state,
+such as the current commit ID. The default commands are:
+
+`-------`--------------------------------------------------------------------
+Key    Action
+-----------------------------------------------------------------------------
+C      git cherry-pick %(commit)
+G      git gc
 -----------------------------------------------------------------------------
 
 [[refspec]]
@@ -441,7 +505,7 @@ 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
@@ -461,11 +525,6 @@ Online resources:
 
 include::SITES[]
 
-Git porcelains:
-
- - link:http://www.kernel.org/pub/software/scm/git/docs/[git],
- - link:http://www.kernel.org/pub/software/scm/cogito/docs/[Cogito]
-
 Other git repository browsers:
 
  - gitk(1)