7 git cola [options] [sub-command]
11 git cola is a sleek and powerful Git GUI.
18 Start `git cola` in amend mode.
22 Prompt for a Git repository. Defaults to the current directory.
26 Open the Git repository at `<path>`. Defaults to the current directory.
28 -s, --status-filter <filter>
29 ----------------------------
30 Apply the path filter to the status widget.
34 Print the `git cola` version and exit.
38 Show usage and optional arguments.
42 Show available sub-commands.
53 Export tarballs from Git.
69 Start the `git dag` Git history browser.
77 Fetch history from remote repositories.
81 Use `git grep` to search for content.
89 Fetch and merge remote branches.
93 Push branches to remotes.
97 Start an interactive rebase.
101 Create and edit remotes.
109 Stash uncommitted modifications.
117 Print the `git cola` version.
119 CONFIGURE YOUR EDITOR
120 =====================
121 The editor used by `Ctrl-e` is configured from the Preferences screen.
122 The environment variable `$VISUAL` is consulted when no editor has been
125 *ProTip*: Configuring your editor to `gvim -f -p` will open multiple tabs
126 when editing files. `gvim -f -o` uses splits.
128 `git cola` is {vim, emacs, textpad, notepad++}-aware.
129 When you select a line in the `grep` screen and press any of
130 `Enter`, `Ctrl-e`, or the `Edit` button, you are taken to that exact line.
132 The editor preference is saved in the `gui.editor` variable using
133 `git config <http://git-scm.com/docs/git-config>`_.
137 `git cola` has many useful keyboard shortcuts.
139 You can see the available shortcuts by pressing the ``?`` key,
140 choosing ``Help -> Keyboard shortcuts`` from the main menu,
141 or by consulting the `git cola keyboard shortcuts reference <https://git-cola.github.io/share/doc/git-cola/hotkeys.html>`_.
145 The `git cola` interface is composed of various cooperating tools.
146 Double-clicking a tool opens it in its own subwindow.
147 Dragging it around moves and places it within the window.
149 Tools can be hidden and rearranged however you like.
150 `git cola` carefully remembers your window layout and restores
151 it the next time it is launched.
153 The `Control-{1, 2, 3, ...}` hotkey gives focus to a specific tool.
154 A hidden tool can be re-opened using the `Tools` menu or
155 the `Shift+Control-{1, 2, 3, ...}` shortcut keys.
157 The Diff editor can be focused with `Ctrl-j`.
158 the Status tool can be focused with `Ctrl-k`.
159 the Commit tool can be focused with `Ctrl-l`.
165 The `Status` tool provides a visual analog to the
166 `git status <http://git-scm.com/docs/git-status>`_ command.
168 `Status` displays files that are `modified` relative to the staging area,
169 `staged` for the next commit, `unmerged` files from an in-progress merge,
170 and files that are `untracked` to git.
172 These are the same categories one sees when running
173 `git status <http://git-scm.com/docs/git-status>`_
176 You can navigate through the list of files using keyboard arrows as well
177 as the ergonomical and vim-like `j` and `k` shortcut keys.
179 There are several convenient ways to interact with files in the `Status` tool.
181 Selecting a file displays its diff in the :ref:`Diff` viewer.
182 Double-clicking a file stages its contents, as does the
183 the `Ctrl-s` shortcut key.
185 `Ctrl-e` opens selected files in the conifgured editor, and
186 `Ctrl-d` opens selected files using `git difftool <http://git-scm.com/docs/git-difftool>`_
188 Additional actions can be performed using the right-click context menu.
192 Clicking the `Staged` folder shows a diffstat for the index.
194 Clicking the `Modified` folder shows a diffstat for the worktree.
196 Clicking individual files sends diffs to the `Diff Display`.
198 Double-clicking individual files adds and removes their content from the index.
200 Various actions are available through the right-click context menu.
201 Different actions are available depending a file's status.
205 Add to the staging area using `git add <http://git-scm.com/docs/git-add>`_
206 Marks unmerged files as resolved.
210 Launches the configured visual text editor
214 Visualize changes using `git difftool`.
216 Revert Unstaged Edits
217 ~~~~~~~~~~~~~~~~~~~~~
218 Reverts unstaged content by checking out selected paths
219 from the index/staging area
221 Revert Uncommitted Edits
222 ~~~~~~~~~~~~~~~~~~~~~~~~
223 Throws away uncommitted edits
227 Remove from the index/staging area with
228 `git reset <http://git-scm.com/docs/git-reset>`_
232 Resolve conflicts using `git mergetool <http://git-scm.com/docs/git-mergetool>`_.
236 Delete untracked files from the filesystem.
240 Adds untracked files to to the .gitignore file.
246 The diff viewer/editor displays diffs for selected files.
247 Additions are shown in green and removals are displayed in light red.
248 Extraneous whitespace is shown with a pure-red background.
250 Right-clicking in the diff provides access to additional actions
251 that use either the cursor location or text selection.
253 Staging content for commit
254 --------------------------
255 The ``@@`` patterns denote a new diff hunk. Selecting lines of diff
256 and using the `Stage Selected Lines` command will stage just the selected
257 lines. Clicking within a diff hunk and selecting `Stage Diff Hunk` stages the
258 entire patch diff hunk.
260 The corresponding opposite commands can be performed on staged files as well,
261 e.g. staged content can be selectively removed from the index when we are
262 viewing diffs for staged content.
264 COMMIT MESSAGE EDITOR
265 =====================
267 The commit message editor is a simple text widget
268 for entering commit messages.
270 You can navigate between the `Subject` and `Extended description...`
271 fields using the keyboard arrow keys.
273 Pressing enter when inside the `Subject` field jumps down to the
274 extended description field.
276 The `Options` button menu to the left of the subject field
277 provides access to the additional actions.
279 The `Ctrl+i` keyboard shortcut adds a standard "Signed-off-by: " line,
280 and `Ctrl+Enter` creates a new commit using the commit message and
285 The `Sign Off` button adds a standard::
287 Signed-off-by: A. U. Thor <a.u.thor@example.com>
289 line to the bottom of the commit message.
291 Invoking this action is equivalent to passing the ``-s`` option
292 to `git commit <http://git-scm.com/docs/git-commit>`_.
296 The commit button runs
297 `git commit <http://git-scm.com/docs/git-commit>`_.
298 The contents of the commit message editor is provided as the commit message.
300 Only staged files are included in the commit -- this is the same behavior
301 as running ``git commit`` on the command-line.
303 Line and Column Display
304 -----------------------
305 The current line and column number is displayed by the editor.
306 E.g. a ``5,0`` display means that the cursor is located at
307 line five, column zero.
309 The display changes colors when lines get too long.
310 Yellow indicates the safe boundary for sending patches to a mailing list
311 while keeping space for inline reply markers.
313 Orange indicates that the line is starting to run a bit long and should
316 Red indicates that the line is running up against the standard
317 80-column limit for commit messages.
319 Keeping commit messages less than 76-characters wide is encouraged.
320 `git log <http://git-scm.com/docs/git-log>`_
321 is a great tool but long lines mess up its formatting for everyone else,
322 so please be mindful when writing commit messages.
327 Clicking on `Amend Last Commit` makes `git cola` amend the previous commit
328 instead of creating a new one. `git cola` loads the previous commit message
329 into the commit message editor when this option is selected.
331 The `Status` tool will display all of the changes for the amended commit.
335 Tell `git commit` and `git merge` to sign commits using GPG.
337 Using this option is equivalent to passing the ``--gpg-sign`` option to
338 `git commit <http://git-scm.com/docs/git-commit>`_ and
339 `git merge <http://git-scm.com/docs/git-merge>`_.
341 This option's default value can be configured using the `cola.signcommits`
342 configuration variable.
344 Prepare Commit Message
345 ----------------------
346 The ``Commit -> Prepare Commit Message`` action or `Ctrl-Shift-Return` keyboard shortcut
347 runs the `cola-prepare-commit-msg` hook if it is available in `.git/hooks/`.
348 This is a `git cola`-specific hook that takes the same parameters
349 as Git's `prepare-commit-msg hook <https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks>`_
351 The hook is passed the path to `.git/GIT_COLA_MSG` as the first argument and the hook is expected to write
352 an updated commit message to specified path. After running this action, the
353 commit message editor is updated with the new commit message.
355 To override the default path to this hook set the
356 `cola.prepareCommitMessageHook` `git config` variable to the path to the
357 hook script. This is useful if you would like to use a common hook
358 across all repositories.
363 The `Branches` tool provides a visual tree to navigate through the branches.
364 The tree has three main nodes `Local Branch`, `Remote Branch` and `Tags`.
365 Branches are grouped by their name divided by the character '/'.Ex::
379 Current branch will display a star icon. If current branch has commits
380 ahead/behind it will display an up/down arrow with its number.
384 Various actions are available through the right-click context menu.
385 Different actions are available depending of selected branch status.
389 The checkout action runs
390 `git checkout [<branchname>] <https://git-scm.com/docs/git-checkout>`_.
392 Merge in current branch
393 ~~~~~~~~~~~~~~~~~~~~~~~
394 The merge action runs
395 `git merge --no-commit [<branchname>] <https://git-scm.com/docs/git-merge>`_.
400 `git pull --no-ff [<remote>] [<branchname>] <https://git-scm.com/docs/git-pull>`_.
405 `git push [<remote>] [<branchname>] <https://git-scm.com/docs/git-push>`_.
409 The rename branch action runs
410 `git branch -M [<branchname>] <https://git-scm.com/docs/git-push>`_.
414 The delete branch branch action runs
415 `git branch -D [<branchname>] <https://git-scm.com/docs/git-branch>`_.
419 The remote branch action runs
420 `git push --delete [<remote>] [<branchname>] <https://git-scm.com/docs/git-push>`_.
425 Use the ``File -> Apply Patches`` menu item to begin applying patches.
427 Dragging and dropping patches onto the `git cola` interface
428 adds the patches to the list of patches to apply using
429 `git am <http://git-scm.com/docs/git-am>`_.
431 You can drag either a set of patches or a directory containing patches.
432 Patches can be sorted using in the interface and are applied in the
433 same order as is listed in the list.
435 When a directory is dropped `git cola` walks the directory
436 tree in search of patches. `git cola` sorts the list of
437 patches after they have all been found. This allows you
438 to control the order in which patchs are applied by placing
439 patchsets into alphanumerically-sorted directories.
441 CUSTOM WINDOW SETTINGS
442 ======================
443 `git cola` remembers modifications to the layout and arrangement
444 of tools within the `git cola` interface. Changes are saved
445 and restored at application shutdown/startup.
447 `git cola` can be configured to not save custom layouts by unsetting
448 the `Save Window Settings` option in the `git cola` preferences.
450 CONFIGURATION VARIABLES
451 =======================
452 These variables can be set using `git config` or from the settings.
456 The command used to blame files. Defaults to `git gui blame`.
460 Whether to create a dock widget with the `Browser` tool.
461 Defaults to `false` to speedup startup time.
465 Inspect unmerged files for conflict markers before staging them.
466 This feature helps prevent accidental staging of unresolved merge conflicts.
471 `git cola`, when run outside of a Git repository, prompts the user for a
472 repository. Set `cola.defaultrepo` to the path of a Git repository to make
473 `git cola` attempt to use that repository before falling back to prompting
474 the user for a repository.
478 Specifies an additional dictionary for `git cola` to use in its spell checker.
479 This should be configured to the path of a newline-separated list of words.
483 Expand tabs into spaces in the commit message editor. When set to `true`,
484 `git cola` will insert a configurable number of spaces when tab is pressed.
485 The number of spaces is determined by `cola.tabwidth`.
490 Enables per-file gitattributes encoding support when set to `true`.
491 This tells `git cola` to honor the configured encoding when displaying
496 Specifies the font to use for `git cola`'s diff display.
500 Specifies the High DPI displays scale factor. Set `0` to automatically scaled.
501 Setting value between 0 and 1 is undefined.
502 This option requires at least Qt 5.6 to work.
503 See `Qt QT_SCALE_FACTOR documentation <https://doc.qt.io/qt-5/highdpi.html>`_
504 for more information.
508 Specifies the icon themes to use throughout `git cola`. The theme specified
509 must be the name of the subdirectory containing the icons, which in turn must
510 be placed in the inside the main "icons" directory in `git cola`'s
513 If unset, or set either "light" or "default", then the default style will be
514 used. If set to "dark" then the built-in "dark" icon theme, which is
515 suitable for a dark window manager theme, will be used.
517 If set to an absolute directory path then icons in that directory will be used.
518 This value can be set to multiple values using,
519 ``git config --add cola.icontheme $theme``.
521 This setting can be overridden by the `GIT_COLA_ICON_THEME` environment
522 variable, which can specify multiple themes using a colon-separated value.
524 The icon theme can also be specified by passing ``--icon-theme=<theme>`` on the
525 command line, once for each icon theme, in the order that they should be
526 searched. This can be used to override a subset of the icons, and fallback
527 to the built-in icons for the remainder.
531 Set to `false` to disable file system change monitoring. Defaults to `true`,
532 but also requires either Linux with inotify support or Windows with `pywin32`
533 installed for file system change monitoring to actually function.
537 Set to `true` to automatically refresh when `git cola` gains focus. Defaults
538 to `false` because this can cause a pause whenever switching to `git cola` from
543 Whether to automatically break long lines while editing commit messages.
544 Defaults to `true`. This setting is configured using the `Preferences`
545 dialog, but it can be toggled for one-off usage using the commit message
546 editor's options sub-menu.
550 `git cola` caps the number of recent repositories to avoid cluttering
551 the start and recent repositories menu. The maximum number of repositories to
552 remember is controlled by `cola.maxrecent` and defaults to `8`.
556 `git cola` encodes paths dragged from its widgets into `utf-16` when adding
557 them to the drag-and-drop mime data (specifically, the `text/x-moz-url` entry).
558 `utf-16` is used to make `gnome-terminal` see the right paths, but other
559 terminals may expect a different encoding. If you are using a terminal that
560 expects a modern encoding, e.g. `terminator`, then set this value to `utf-8`.
564 `git cola` avoids reading large binary untracked files.
565 The maximum size to read is controlled by `cola.readsize`
566 and defaults to `2048`.
570 The "Stage" button in the `git cola` Actions panel stages all files when it is
571 activated and no files are selected. This can be problematic if it is
572 accidentally triggered after carefully preparing the index with staged
573 changes. "Safe Mode" is enabled by setting `cola.safemode` to `true`.
574 When enabled, `git cola` will do nothing when "Stage" is activated without a
575 selection. Defaults to `false`.
577 cola.savewindowsettings
578 -----------------------
579 `git cola` will remember its window settings when set to `true`.
580 Window settings and X11 sessions are saved in `$HOME/.config/git-cola`.
584 `git cola` displays the absolute path of the repository in the window title.
585 This can be disabled by setting `cola.showpath` to `false`.
590 `git cola` will sign commits by default when set `true`. Defaults to `false`.
591 See the section below on setting up GPG for more details.
595 Set to `true` to indent files in the Status widget. Files in the `Staged`,
596 `Modified`, etc. categories will be grouped in a tree-like structure.
599 cola.statusshowtotals
600 ---------------------
601 Set to `true` to display files counts in the Status widget's category titles.
606 The number of columns occupied by a tab character. Defaults to 8.
610 The command to use when launching commands within a graphical terminal.
612 `cola.terminal` defaults to `xterm -e` when unset.
613 e.g. when opening a shell, `git cola` will run `xterm -e $SHELL`.
615 `git cola` has built-in support for `xterm`, `gnome-terminal`, `konsole`.
616 If either `gnome-terminal`, `xfce4-terminal`, or `konsole` are installed
617 then they will be preferred over `xterm` when `cola.terminal` is unset.
619 The table below shows the built-in values that are used for the respective
620 terminal. You can force the use of a specific terminal by configuring cola
623 cola.terminalshellquote
624 -----------------------
625 Some terminal require that the command string get passed as a string.
626 For example, ``xfce4-terminal -e "git difftool"`` requires shellquoting,
627 whereas ``gnome-terminal -- git difftool`` does not.
629 You should not need to set this variable for the built-in terminals
630 cola knows about -- it will behave correctly without configuration.
631 For example, when unconfigured, cola already knows that xfce4-terminal
632 requires shellquoting.
634 This configuration variable is for custom terminals outside of the builtin set.
635 The table below shows the builtin configuration.
637 Terminal cola.terminal cola.terminalshellquote
638 -------- ------------- -----------------------
639 gnome-terminal gnome-terminal -- false
640 konsole konsole -e false
641 xfce4-terminal xfce4-terminal -e true
646 The number of columns used for line wrapping.
647 Tabs are counted according to `cola.tabwidth`.
651 Specifies the GUI theme to use throughout `git cola`. The theme specified
652 must be one of the following values:
654 * `default` – default Qt theme, may appear different on various systems
664 If unset, or set wrong value, then the default style will be
665 used. The `default` theme is generated by Qt internal engine and should look
666 most native but may look noticeable differently on various systems. The flat
667 themes on the other hand should look similar (but not identical) on various
670 The GUI theme can also be specified by passing ``--theme=<name>`` on the
673 On Linux, you may want Qt to use the theme configured using the ``qt5ct``
674 Qt5 configuration tool. You can do this by exporting `QT_QPA_PLATFORMTHEME`
675 in your `~/.bash_profile` to a value of ``qt5ct``::
677 # Use the style configured using the qt5ct tool
678 QT_QPA_PLATFORMTHEME=qt5ct
679 export QT_QPA_PLATFORMTHEME
681 This only work with the `default` theme. The other themes replace the color
682 palette with a specific configuration.
686 Set to `true` to enables "turbo" mode. "Turbo" mode disables some
687 features that can slow things down when operating on huge repositories.
688 "Turbo" mode will skip loading Git commit messages, author details, status
689 information, and commit date details in the `File Browser` tool.
694 The default diff text color, in hexadecimal #RRGGBB notation.
695 Defaults to "#030303"::
697 git config cola.color.text '#030303'
701 The default diff "add" background color, in hexadecimal #RRGGBB notation.
702 Defaults to "#d2ffe4"::
704 git config cola.color.add '#d2ffe4'
708 The default diff "remove" background color, in hexadecimal #RRGGBB notation.
709 Defaults to "#fee0e4"::
711 git config cola.color.remove '#fee0e4'
715 The default diff header text color, in hexadecimal #RRGGBB notation.
716 Defaults to "#bbbbbb"::
718 git config cola.color.header '#bbbbbb'
722 The number of diff context lines to display.
726 `git cola` avoids showing untracked files when set to `false`.
730 The default text editor to use is defined in `gui.editor`.
731 The config variable overrides the VISUAL environment variable.
736 The history browser to use when visualizing history.
741 The default diff tool to use.
745 The default merge tool to use.
749 Your email address to be recorded in any newly created commits.
750 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
751 'EMAIL' environment variables.
755 Your full name to be recorded in any newly created commits.
756 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
757 environment variables.
760 ENVIRONMENT VARIABLES
761 =====================
765 When set in the environment, `GIT_COLA_ICON_THEME` overrides the
766 theme specified in the `cola.icontheme` configuration.
767 Read the section on `cola.icontheme` above for more details.
771 .. Important:: `GIT_COLA_SCALE` should not be used with newer versions of Qt.
773 Set `QT_AUTO_SCREEN_SCALE_FACTOR` to `1` and Qt will automatically
774 scale the interface to the correct size based on the display DPI.
775 This option is also available by setting `cola.hidpi` configuration.
777 See the `Qt High DPI documentation <https://doc.qt.io/qt-5/highdpi.html>`_
780 `git cola` can be made to scale its interface for HiDPI displays.
781 When defined, `git cola` will scale icons, radioboxes, and checkboxes
782 according to the scale factor. The default value is `1`.
783 A good value is `2` for high-resolution displays.
785 Fonts are not scaled, as their size can already be set in the settings.
789 When defined, `git cola` logs `git` commands to stdout.
790 When set to `full`, `git cola` also logs the exit status and output.
791 When set to `trace`, `git cola` logs to the `Console` widget.
795 Specifies the default editor to use.
796 This is ignored when the `gui.editor` configuration variable is defined.
800 `git cola` automatically detects your language and presents some
801 translations when available. This may not be desired, or you
802 may want `git cola` to use a specific language.
804 You can make `git cola` use an alternative language by creating a
805 `~/.config/git-cola/language` file containing the standard two-letter
806 gettext language code, e.g. "en", "de", "ja", "zh", etc.::
808 mkdir -p ~/.config/git-cola &&
809 echo en >~/.config/git-cola/language
811 Alternatively you may also use LANGUAGE environmental variable to temporarily
812 change `git cola`'s language just like any other gettext-based program. For
813 example to temporarily change `git cola`'s language to English::
817 To make `git cola` use the zh_TW translation with zh_HK, zh, and en as a
820 LANGUAGE=zh_TW:zh_HK:zh:en git cola
825 `git cola` allows you to define custom GUI actions by setting `git config`
826 variables. The "name" of the command appears in the "Actions" menu.
830 Specifies the shell command line to execute when the corresponding item of the
831 Tools menu is invoked. This option is mandatory for every tool. The command is
832 executed from the root of the working directory, and in the environment it
833 receives the name of the tool as GIT_GUITOOL, the name of the currently
834 selected file as FILENAME, and the name of the current branch as CUR_BRANCH
835 (if the head is detached, CUR_BRANCH is empty).
837 guitool.<name>.background
838 -------------------------
839 Run the command in the background (similar to editing and difftool actions).
840 This avoids blocking the GUI. Setting `background` to `true` implies
841 `noconsole` and `norescan`.
843 guitool.<name>.needsfile
844 ------------------------
845 Run the tool only if a diff is selected in the GUI. It guarantees that
846 FILENAME is not empty.
848 guitool.<name>.noconsole
849 ------------------------
850 Run the command silently, without creating a window to display its output.
852 guitool.<name>.norescan
853 -----------------------
854 Don’t rescan the working directory for changes after the tool finishes
857 guitool.<name>.confirm
858 ----------------------
859 Show a confirmation dialog before actually running the tool.
861 guitool.<name>.argprompt
862 ------------------------
863 Request a string argument from the user, and pass it to the tool through the
864 ARGS environment variable. Since requesting an argument implies confirmation,
865 the confirm option has no effect if this is enabled. If the option is set to
866 true, yes, or 1, the dialog uses a built-in generic prompt; otherwise the
867 exact value of the variable is used.
869 guitool.<name>.revprompt
870 ------------------------
871 Request a single valid revision from the user, and set the REVISION
872 environment variable. In other aspects this option is similar to argprompt,
873 and can be used together with it.
875 guitool.<name>.revunmerged
876 --------------------------
877 Show only unmerged branches in the revprompt subdialog. This is useful for
878 tools similar to merge or rebase, but not for things like checkout or reset.
882 Specifies the title to use for the prompt dialog.
883 Defaults to the tool name.
885 guitool.<name>.prompt
886 ---------------------
887 Specifies the general prompt string to display at the top of the dialog,
888 before subsections for argprompt and revprompt.
889 The default value includes the actual command.
891 guitool.<name>.shortcut
892 -----------------------
893 Specifies a keyboard shortcut for the custom tool.
895 The value must be a valid string understood by the `QAction::setShortcut()` API.
896 See http://qt-project.org/doc/qt-4.8/qkeysequence.html#QKeySequence-2
897 for more details about the supported values.
899 Avoid creating shortcuts that conflict with existing built-in `git cola`
900 shortcuts. Creating a conflict will result in no action when the shortcut
903 SETTING UP GPG FOR SIGNED COMMITS
904 =================================
905 When creating signed commits `gpg` will attempt to read your password from the
906 terminal from which `git cola` was launched.
907 The way to make this work smoothly is to use a GPG agent so that you can avoid
908 needing to re-enter your password every time you commit.
910 This also gets you a graphical passphrase prompt instead of getting prompted
911 for your password in the terminal.
913 Install gpg-agent and friends
914 -----------------------------
915 On Mac OS X, you may need to `brew install gpg-agent` and install the
916 `Mac GPG Suite <https://gpgtools.org/macgpg2/>`_.
918 On Linux use your package manager to install gnupg2,
919 gnupg-agent and pinentry-qt, e.g.::
921 sudo apt-get install gnupg2 gnupg-agent pinentry-qt
923 On Linux, you should also configure Git so that it uses gpg2 (gnupg2),
924 otherwise you will get errors mentioning, "unable to open /dev/tty".
925 Set Git's `gpg.program` to `gpg2`::
927 git config --global gpg.program gpg2
929 Configure gpg-agent and a pin-entry program
930 -------------------------------------------
931 On Mac OS X, edit `~/.gnupg/gpg.conf` to include the line,::
935 This is typically not needed on Linux, where `gpg2` is used, as
936 this is the default value when using `gpg2`.
938 Next, edit `~/.gnupg/gpg-agent.conf` to contain a pinentry-program line
939 pointing to the pinentry program for your platform.
941 The following example `~/.gnupg/gpg-agent.conf` shows how to use
942 pinentry-gtk-2 on Linux::
944 pinentry-program /usr/bin/pinentry-gtk-2
945 default-cache-ttl 3600
947 This following example `.gnupg/gpg-agent.conf` shows how to use MacGPG2's
948 pinentry app on On Mac OS X::
950 pinentry-program /usr/local/MacGPG2/libexec/pinentry-mac.app/Contents/MacOS/pinentry-mac
951 default-cache-ttl 3600
955 Once this has been setup then you will need to reload your gpg-agent config.::
957 echo RELOADAGENT | gpg-connect-agent
959 If you see the following output::
963 Then the daemon is already running, and you do not need to start it yourself.
965 If it is not running, eval the output of ``gpg-agent --daemon`` in your shell
966 prior to launching `git cola`.::
968 eval $(gpg-agent --daemon)
976 If Git is installed in a custom location, e.g. not installed in `C:/Git` or
977 Program Files, then the path to Git must be configured by creating a file in
978 your home directory `~/.config/git-cola/git-bindir` that points to your git
986 Git Cola's Git Repository
987 -------------------------
988 https://github.com/git-cola/git-cola/
992 https://git-cola.github.io/
996 https://groups.google.com/group/git-cola