share/doc/git-cola/git-cola.txt

   1 git-cola(1)
   2 ===========
   3
   4 NAME
   5 ----
   6 git-cola - A highly caffeinated Git GUI
   7
   8 SYNOPSIS
   9 --------
  10 'git cola' [options]
  11
  12 DESCRIPTION
  13 -----------
  14 'git-cola' is a powerful Git GUI written in Python.
  15 It has many unique features that make Git's advanced
  16 features simple and accessible.
  17
  18 See below for a full list of options and usage information.
  19
  20 OPTIONS
  21 -------
  22
  23 --repo=<path>::
  24         Run 'git-cola' on the git repository in <path>.
  25
  26 --style=<style>::
  27         Launch 'git-cola' with a different stylesheet.
  28
  29 --classic::
  30         Launch the standalone 'cola classic' tool.
  31
  32 GUI STYLES
  33 ----------
  34 'git-cola' ships with an alternate "dark" stylesheet.
  35 Specify `--style=dark` or provide an external stylesheet with `--style=PATH`.
  36
  37 CONFIG VARIABLES
  38 ----------------
  39
  40 cola.savewindowsettings::
  41         Whether 'git-cola' should remember its window settings.
  42
  43 cola.geometry::
  44         Specifies information about 'git-cola''s window size and position.
  45
  46 cola.fontdiff::
  47         Specifies the font to use for 'git-cola''s diff display.
  48
  49 gui.diffcontext::
  50         The number of diff context lines used and displayed by 'git-cola'
  51
  52 gui.editor::
  53         The default text editor is controlled by gui.editor.
  54         The config variable overrides the EDITOR environment variable.
  55
  56 gui.historybrowser::
  57         Specifies the history browser to use when visualizing history.
  58
  59 diff.tool::
  60         The default diff tool to use.
  61         The config variable overrides the GIT_DIFF_TOOL environment variable.
  62
  63 merge.tool::
  64         The default merge tool to use.
  65         The config variable overrides the GIT_MERGE_TOOL environment variable.
  66
  67 user.email::
  68         Your email address to be recorded in any newly created commits.
  69         Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
  70         'EMAIL' environment variables.  See linkgit:git-commit-tree[1].
  71
  72 user.name::
  73         Your full name to be recorded in any newly created commits.
  74         Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
  75         environment variables.  See linkgit:git-commit-tree[1].
  76
  77
  78 See linkgit:git-config[1] for more details.
  79
  80
  81 ENVIRONMENT VARIABLES
  82 ---------------------
  83
  84 EDITOR::
  85         Specifies the default editor to use.
  86         This is ignored when the git config variable `gui.editor` is defined.
  87
  88 GIT_DIFF_TOOL::
  89         Specifies the default diff tool to use.
  90         This is ignored when the git config variable `diff.tool` is defined.
  91
  92 GIT_MERGE_TOOL::
  93         Specifies the default merge tool to use.
  94         This is ignored when the git config variable `merge.tool` is defined.
  95
  96
  97 SOURCE
  98 ------
  99
 100 A 'git-cola' development repository can be obtained via git:
 101
 102         git clone git://github.com/davvid/git-cola.git
 103
 104
 105 STYLESHEETS
 106 -----------
 107
 108 git-cola ships with an alternative stylesheet called 'dark'.
 109 You can use this stylesheet by running `git cola --style=dark`.
 110
 111 You can also skin git-cola by providing your own Qt stylesheet.
 112 E.g. `git cola --style=/path/to/style.qss`.
 113
 114 Built-in styles can be found in `/usr/share/git-cola/styles`.
 115
 116
 117 LINKS
 118 -----
 119 'git-cola' homepage::
 120         http://cola.tuxfamily.org/
 121
 122 'git-cola' sources on github::
 123         http://github.com/davvid/git-cola/tree/master
 124
 125
 126 SEE ALSO
 127 --------
 128 linkgit:git-difftool[1]::
 129         Compare changes using common merge tools.
 130         (New in git-1.6.3).
 131
 132 linkgit:gitk[1]::
 133         The git repository browser.  Shows branches, commit history
 134         and file differences.  gitk is the utility started by
 135         'git-cola''s Repository Visualize actions.
 136
 137 GIT
 138 ---
 139 'git-cola' is independently developed from the linkgit:git[7] suite,
 140 but you can use it just like any other git command, e.g. `git cola`.
 141
 142 AUTHOR
 143 ------
 144 Written by David Aguilar <davvid@gmail.com>.
 145