1GIT-COLA(1)                        git-cola                        GIT-COLA(1)
2
3
4

NAME

6       git-cola - The highly caffeinated Git GUI
7

SYNOPSIS

9       git cola [options] [sub-command]
10

DESCRIPTION

12       git cola is a sleek and powerful Git GUI.
13

OPTIONS

15   –amend
16       Start git cola in amend mode.
17
18   –prompt
19       Prompt for a Git repository.  Defaults to the current directory.
20
21   -r, –repo <path>
22       Open the Git repository at <path>.  Defaults to the current directory.
23
24   -s, –status-filter <filter>
25       Apply the path filter to the status widget.
26
27   –version
28       Print the git cola version and exit.
29
30   -h, –help
31       Show usage and optional arguments.
32
33   –help-commands
34       Show available sub-commands.
35

SUB-COMMANDS

37   am
38       Apply patches.
39
40   archive
41       Export tarballs from Git.
42
43   branch
44       Create branches.
45
46   browse
47       Browse tracked files.
48
49   config
50       Configure settings.
51
52   dag
53       Start the git dag Git history browser.
54
55   diff
56       Diff changed files.
57
58   fetch
59       Fetch history from remote repositories.
60
61   grep
62       Use git grep to search for content.
63
64   merge
65       Merge branches.
66
67   pull
68       Fetch and merge remote branches.
69
70   push
71       Push branches to remotes.
72
73   rebase
74       Start an interactive rebase.
75
76   remote
77       Create and edit remotes.
78
79   search
80       Search for commits.
81
82   stash
83       Stash uncommitted modifications.
84
85   tag
86       Create tags.
87
88   version
89       Print the git cola version.
90

CONFIGURE YOUR EDITOR

92       The  editor  used  by Ctrl-e is configured from the Preferences screen.
93       The environment variable $VISUAL is consulted when no editor  has  been
94       configured.
95
96       ProTip:  Configuring  your editor to gvim -f -p will open multiple tabs
97       when editing files.  gvim -f -o uses splits.
98
99       git cola is {vim, emacs, textpad, notepad++}-aware.  When you select  a
100       line  in  the  grep  screen and press any of Enter, Ctrl-e, or the Edit
101       button, you are taken to that exact line.
102
103       The editor preference is saved in the  gui.editor  variable  using  git
104       config.
105

KEYBOARD SHORTCUTS

107       git cola has many useful keyboard shortcuts.
108
109       You  can  see  the  available shortcuts by pressing the ? key, choosing
110       Help -> Keyboard shortcuts from the main menu, or by consulting the git
111       cola keyboard shortcuts reference.
112

TOOLS

114       The  git cola interface is composed of various cooperating tools.  Dou‐
115       ble-clicking a tool opens it in its own subwindow.  Dragging it  around
116       moves and places it within the window.
117
118       Tools  can  be  hidden and rearranged however you like.  git cola care‐
119       fully remembers your window layout and restores it the next time it  is
120       launched.
121
122       The Control-{1, 2, 3, …} hotkey gives focus to a specific tool.  A hid‐
123       den tool can be re-opened using the Tools menu or the Shift+Control-{1,
124       2, 3, …} shortcut keys.
125
126       The  Diff  editor  can  be focused with Ctrl-j.  the Status tool can be
127       focused with Ctrl-k.  the Commit tool can be focused with Ctrl-l.
128

STATUS

130       The Status tool provides a visual analog to the git status command.
131
132       Status displays files that are modified relative to the  staging  area,
133       staged  for  the next commit, unmerged files from an in-progress merge,
134       and files that are untracked to git.
135
136       These are the same categories one sees when running git status  on  the
137       command line.
138
139       You  can  navigate  through  the list of files using keyboard arrows as
140       well as the ergonomical and vim-like j and k shortcut keys.
141
142       There are several convenient ways to interact with files in the  Status
143       tool.
144
145       Selecting a file displays its diff in the DIFF viewer.  Double-clicking
146       a file stages its contents, as does the the Ctrl-s shortcut key.
147
148       Ctrl-e opens selected files in the conifgured editor, and Ctrl-d  opens
149       selected files using git difftool
150
151       Additional actions can be performed using the right-click context menu.
152
153   Actions
154       Clicking the Staged folder shows a diffstat for the index.
155
156       Clicking the Modified folder shows a diffstat for the worktree.
157
158       Clicking individual files sends diffs to the Diff Display.
159
160       Double-clicking  individual  files  adds and removes their content from
161       the index.
162
163       Various actions are available through  the  right-click  context  menu.
164       Different actions are available depending a file’s status.
165
166   Stage Selected
167       Add to the staging area using git add Marks unmerged files as resolved.
168
169   Launch Editor
170       Launches the configured visual text editor
171
172   Launch Difftool
173       Visualize changes using git difftool.
174
175   Revert Unstaged Edits
176       Reverts  unstaged  content  by  checking  out  selected  paths from the
177       index/staging area
178
179   Revert Uncommitted Edits
180       Throws away uncommitted edits
181
182   Unstage Selected
183       Remove from the index/staging area with git reset
184
185   Launch Merge Tool
186       Resolve conflicts using git mergetool.
187
188   Delete File(s)
189       Delete untracked files from the filesystem.
190
191   Add to .gitignore
192       Adds untracked files to to the .gitignore file.
193

DIFF

195       The diff viewer/editor displays diffs for  selected  files.   Additions
196       are shown in green and removals are displayed in light red.  Extraneous
197       whitespace is shown with a pure-red background.
198
199       Right-clicking in the diff provides access to additional  actions  that
200       use either the cursor location or text selection.
201
202   Staging content for commit
203       The  @@  patterns  denote a new diff hunk.  Selecting lines of diff and
204       using the Stage Selected Lines command will  stage  just  the  selected
205       lines.   Clicking  within  a  diff  hunk  and selecting Stage Diff Hunk
206       stages the entire patch diff hunk.
207
208       The corresponding opposite commands can be performed on staged files as
209       well,  e.g.  staged  content  can be selectively removed from the index
210       when we are viewing diffs for staged content.
211

COMMIT MESSAGE EDITOR

213       The commit message editor is a simple text widget for  entering  commit
214       messages.
215
216       You  can  navigate between the Subject and Extended description… fields
217       using the keyboard arrow keys.
218
219       Pressing enter when inside the Subject field jumps down to the extended
220       description field.
221
222       The  Options  button  menu  to  the  left of the subject field provides
223       access to the additional actions.
224
225       The Ctrl+i keyboard shortcut adds a standard  “Signed-off-by:  ”  line,
226       and Ctrl+Enter creates a new commit using the commit message and staged
227       content.
228
229   Sign Off
230       The Sign Off button adds a standard:
231
232          Signed-off-by: A. U. Thor <a.u.thor@example.com>
233
234       line to the bottom of the commit message.
235
236       Invoking this action is equivalent to passing the -s option to git com‐
237       mit.
238
239   Commit
240       The  commit button runs git commit.  The contents of the commit message
241       editor is provided as the commit message.
242
243       Only staged files are included in the commit – this is the same  behav‐
244       ior as running git commit on the command-line.
245
246   Line and Column Display
247       The  current line and column number is displayed by the editor.  E.g. a
248       5,0 display means that the cursor is located at line five, column zero.
249
250       The display changes colors when lines get too long.   Yellow  indicates
251       the  safe  boundary for sending patches to a mailing list while keeping
252       space for inline reply markers.
253
254       Orange indicates that the line is starting to run a bit long and should
255       break soon.
256
257       Red  indicates that the line is running up against the standard 80-col‐
258       umn limit for commit messages.
259
260       Keeping commit messages less than  76-characters  wide  is  encouraged.
261       git  log  is  a  great  tool  but long lines mess up its formatting for
262       everyone else, so please be mindful when writing commit messages.
263
264   Amend Last Commit
265       Clicking on Amend Last Commit makes git cola amend the previous  commit
266       instead of creating a new one.  git cola loads the previous commit mes‐
267       sage into the commit message editor when this option is selected.
268
269       The Status tool will display all of the changes for the amended commit.
270
271   Create Signed Commit
272       Tell git commit and git merge to sign commits using GPG.
273
274       Using this option is equivalent to passing the --gpg-sign option to git
275       commit and git merge.
276
277       This  option’s  default value can be configured using the cola.signcom‐
278       mits configuration variable.
279
280   Prepare Commit Message
281       The Commit -> Prepare Commit Message action or  Ctrl-Shift-Return  key‐
282       board shortcut runs the cola-prepare-commit-msg hook if it is available
283       in .git/hooks/.  This is a git cola-specific hook that takes  the  same
284       parameters as Git’s prepare-commit-msg hook
285
286       The  hook is passed the path to .git/GIT_COLA_MSG as the first argument
287       and the hook is expected to write an updated commit message  to  speci‐
288       fied  path.   After  running  this action, the commit message editor is
289       updated with the new commit message.
290
291       To override the default path to  this  hook  set  the  cola.prepareCom‐
292       mitMessageHook  git  config  variable  to  the path to the hook script.
293       This is useful if you would like to use a common hook across all repos‐
294       itories.
295

BRANCHES

297       The  Branches  tool  provides  a  visual  tree  to navigate through the
298       branches.  The tree has three main nodes Local  Branch,  Remote  Branch
299       and  Tags.  Branches are grouped by their name divided by the character
300       ‘/’.Ex:
301
302          branch/feature/foo
303          branch/feature/bar
304          branch/doe
305
306       Will produce:
307
308          branch
309              - doe
310              + feature
311                  - bar
312                  - foo
313
314       Current branch will display a star icon. If current branch has  commits
315       ahead/behind it will display an up/down arrow with its number.
316
317   Actions
318       Various  actions  are  available  through the right-click context menu.
319       Different actions are available depending of selected branch status.
320
321   Checkout
322       The checkout action runs git checkout [<branchname>].
323
324   Merge in current branch
325       The merge action runs git merge –no-commit [<branchname>].
326
327   Pull
328       The pull action runs git pull –no-ff [<remote>] [<branchname>].
329
330   Push
331       The push action runs git push [<remote>] [<branchname>].
332
333   Rename Branch
334       The rename branch action runs git branch -M [<branchname>].
335
336   Delete Branch
337       The delete branch branch action runs git branch -D [<branchname>].
338
339   Delete Remote Branch
340       The remote branch action runs git  push  –delete  [<remote>]  [<branch‐
341       name>].
342

APPLY PATCHES

344       Use the File -> Apply Patches menu item to begin applying patches.
345
346       Dragging  and  dropping  patches  onto  the git cola interface adds the
347       patches to the list of patches to apply using git am.
348
349       You can drag either a set of patches or a directory containing patches.
350       Patches  can  be  sorted  using in the interface and are applied in the
351       same order as is listed in the list.
352
353       When a directory is dropped git cola walks the directory tree in search
354       of  patches.   git  cola  sorts the list of patches after they have all
355       been found.  This allows you to control the order in which  patchs  are
356       applied by placing patchsets into alphanumerically-sorted directories.
357

CUSTOM WINDOW SETTINGS

359       git cola remembers modifications to the layout and arrangement of tools
360       within the git cola interface.   Changes  are  saved  and  restored  at
361       application shutdown/startup.
362
363       git  cola can be configured to not save custom layouts by unsetting the
364       Save Window Settings option in the git cola preferences.
365

CONFIGURATION VARIABLES

367       These variables can be set using git config or from the settings.
368
369   cola.blameviewer
370       The command used to blame files.  Defaults to git gui blame.
371
372   cola.browserdockable
373       Whether to create a dock widget with the  Browser  tool.   Defaults  to
374       false to speedup startup time.
375
376   cola.checkconflicts
377       Inspect  unmerged files for conflict markers before staging them.  This
378       feature helps prevent accidental staging of unresolved merge conflicts.
379       Defaults to true.
380
381   cola.defaultrepo
382       git  cola, when run outside of a Git repository, prompts the user for a
383       repository.  Set cola.defaultrepo to the path of a  Git  repository  to
384       make  git  cola  attempt  to use that repository before falling back to
385       prompting the user for a repository.
386
387   cola.dictionary
388       Specifies an additional dictionary for git cola to  use  in  its  spell
389       checker.   This should be configured to the path of a newline-separated
390       list of words.
391
392   cola.expandtab
393       Expand tabs into spaces in the commit  message  editor.   When  set  to
394       true,  git cola will insert a configurable number of spaces when tab is
395       pressed.   The  number  of  spaces  is  determined  by   cola.tabwidth.
396       Defaults to false.
397
398   cola.fileattributes
399       Enables per-file gitattributes encoding support when set to true.  This
400       tells git cola to honor the configured  encoding  when  displaying  and
401       applying diffs.
402
403   cola.fontdiff
404       Specifies the font to use for git cola’s diff display.
405
406   cola.hidpi
407       Specifies  the  High  DPI displays scale factor. Set 0 to automatically
408       scaled.  Setting value between 0  and  1  is  undefined.   This  option
409       requires at least Qt 5.6 to work.  See Qt QT_SCALE_FACTOR documentation
410       for more information.
411
412   cola.icontheme
413       Specifies the icon themes to use throughout git cola. The theme  speci‐
414       fied  must  be the name of the subdirectory containing the icons, which
415       in turn must be placed in the inside the main “icons” directory in  git
416       cola’s installation prefix.
417
418       If  unset,  or  set either “light” or “default”, then the default style
419       will be used.  If set to “dark” then the built-in  “dark”  icon  theme,
420       which is suitable for a dark window manager theme, will be used.
421
422       If  set to an absolute directory path then icons in that directory will
423       be used.  This value can be set to multiple values  using,  git  config
424       --add cola.icontheme $theme.
425
426       This  setting  can be overridden by the GIT_COLA_ICON_THEME environment
427       variable, which can specify multiple  themes  using  a  colon-separated
428       value.
429
430       The icon theme can also be specified by passing --icon-theme=<theme> on
431       the command line, once for each icon theme,  in  the  order  that  they
432       should  be  searched.   This  can  be  used to override a subset of the
433       icons, and fallback to the built-in icons for the remainder.
434
435   cola.inotify
436       Set to false to disable file system  change  monitoring.   Defaults  to
437       true,  but  also  requires either Linux with inotify support or Windows
438       with pywin32 installed for file system change  monitoring  to  actually
439       function.
440
441   cola.refreshonfocus
442       Set  to  true  to  automatically  refresh  when  git  cola gains focus.
443       Defaults to false because this can cause a pause whenever switching  to
444       git cola from another application.
445
446   cola.linebreak
447       Whether  to  automatically  break  long lines while editing commit mes‐
448       sages.  Defaults to true.  This setting is configured using the Prefer‐
449       ences  dialog, but it can be toggled for one-off usage using the commit
450       message editor’s options sub-menu.
451
452   cola.maxrecent
453       git cola caps the number of recent repositories to avoid cluttering the
454       start and recent repositories menu.  The maximum number of repositories
455       to remember is controlled by cola.maxrecent and defaults to 8.
456
457   cola.dragencoding
458       git cola encodes paths dragged from its widgets into utf-16 when adding
459       them  to  the drag-and-drop mime data (specifically, the text/x-moz-url
460       entry).  utf-16 is used to make gnome-terminal see the right paths, but
461       other  terminals  may  expect a different encoding.  If you are using a
462       terminal that expects a modern encoding, e.g. terminator, then set this
463       value to utf-8.
464
465   cola.readsize
466       git cola avoids reading large binary untracked files.  The maximum size
467       to read is controlled by cola.readsize and defaults to 2048.
468
469   cola.safemode
470       The “Stage” button in the git cola Actions panel stages all files  when
471       it  is activated and no files are selected.  This can be problematic if
472       it is accidentally triggered after carefully preparing the  index  with
473       staged  changes.   “Safe  Mode”  is enabled by setting cola.safemode to
474       true.  When enabled, git cola will do nothing when “Stage” is activated
475       without a selection.  Defaults to false.
476
477   cola.savewindowsettings
478       git  cola  will  remember its window settings when set to true.  Window
479       settings and X11 sessions are saved in $HOME/.config/git-cola.
480
481   cola.showpath
482       git cola displays the absolute path of the  repository  in  the  window
483       title.   This  can  be  disabled  by  setting  cola.showpath  to false.
484       Defaults to true.
485
486   cola.signcommits
487       git cola will sign commits by default when set true. Defaults to false.
488       See the section below on setting up GPG for more details.
489
490   cola.statusindent
491       Set to true to indent files in the Status widget.  Files in the Staged,
492       Modified, etc. categories will be grouped  in  a  tree-like  structure.
493       Defaults to false.
494
495   cola.statusshowtotals
496       Set  to  true  to  display files counts in the Status widget’s category
497       titles.  Defaults to false.
498
499   cola.tabwidth
500       The number of columns occupied by a tab character.  Defaults to 8.
501
502   cola.terminal
503       The command to use when launching commands within a graphical terminal.
504
505       cola.terminal defaults to xterm -e when unset.   e.g.  when  opening  a
506       shell, git cola will run xterm -e $SHELL.
507
508       git  cola  has built-in support for xterm, gnome-terminal, konsole.  If
509       either gnome-terminal, xfce4-terminal, or konsole  are  installed  then
510       they will be preferred over xterm when cola.terminal is unset.
511
512       The table below shows the built-in values that are used for the respec‐
513       tive terminal.  You can force the use of a specific terminal by config‐
514       uring cola accordingly.
515
516   cola.terminalshellquote
517       Some  terminal  require that the command string get passed as a string.
518       For example, xfce4-terminal -e "git  difftool"  requires  shellquoting,
519       whereas gnome-terminal -- git difftool does not.
520
521       You  should  not  need  to set this variable for the built-in terminals
522       cola knows about – it will behave correctly without configuration.  For
523       example,  when  unconfigured,  cola  already  knows that xfce4-terminal
524       requires shellquoting.
525
526       This configuration variable is for  custom  terminals  outside  of  the
527       builtin set.  The table below shows the builtin configuration.
528          Terminal             cola.terminal           cola.terminalshellquote
529          ——–                ————-                ———————–      gnome-terminal
530          gnome-terminal   –         false   konsole               konsole  -e
531          false  xfce4-terminal       xfce4-terminal   -e         true   xterm
532          xterm -e                false
533
534   cola.textwidth
535       The number of columns used for line wrapping.  Tabs are counted accord‐
536       ing to cola.tabwidth.
537
538   cola.theme
539       Specifies the GUI theme to use throughout git cola. The theme specified
540       must be one of the following values:
541
542       · default – default Qt theme, may appear different on various systems
543
544       · flat-dark-blue
545
546       · flat-dark-green
547
548       · flat-dark-grey
549
550       · flat-dark-red
551
552       · flat-light-blue
553
554       · flat-light-green
555
556       · flat-light-grey
557
558       · flat-light-red
559
560       If  unset, or set wrong value, then the default style will be used. The
561       default theme is generated by Qt internal engine and should  look  most
562       native but may look noticeable differently on various systems. The flat
563       themes on the other hand should look similar  (but  not  identical)  on
564       various systems.
565
566       The  GUI  theme  can also be specified by passing --theme=<name> on the
567       command line.
568
569       On Linux, you may want Qt to use the theme configured using  the  qt5ct
570       Qt5  configuration  tool.   You  can  do this by exporting QT_QPA_PLAT‐
571       FORMTHEME in your ~/.bash_profile to a value of qt5ct:
572
573          # Use the style configured using the qt5ct tool
574          QT_QPA_PLATFORMTHEME=qt5ct
575          export QT_QPA_PLATFORMTHEME
576
577       This only work with the default theme.  The other  themes  replace  the
578       color palette with a specific configuration.
579
580   cola.turbo
581       Set  to  true to enables “turbo” mode.  “Turbo” mode disables some fea‐
582       tures that can slow things down when operating  on  huge  repositories.
583       “Turbo”  mode  will  skip  loading Git commit messages, author details,
584       status information, and commit date details in the File  Browser  tool.
585       Defaults to false.
586
587   cola.color.text
588       The default diff text color, in hexadecimal #RRGGBB notation.  Defaults
589       to “#030303”:
590
591          git config cola.color.text '#030303'
592
593   cola.color.add
594       The default diff “add” background color, in hexadecimal  #RRGGBB  nota‐
595       tion.  Defaults to “#d2ffe4”:
596
597          git config cola.color.add '#d2ffe4'
598
599   cola.color.remove
600       The  default  diff  “remove”  background  color, in hexadecimal #RRGGBB
601       notation.  Defaults to “#fee0e4”:
602
603          git config cola.color.remove '#fee0e4'
604
605   cola.color.header
606       The default diff header text color, in  hexadecimal  #RRGGBB  notation.
607       Defaults to “#bbbbbb”:
608
609          git config cola.color.header '#bbbbbb'
610
611   gui.diffcontext
612       The number of diff context lines to display.
613
614   gui.displayuntracked
615       git cola avoids showing untracked files when set to false.
616
617   gui.editor
618       The  default  text  editor to use is defined in gui.editor.  The config
619       variable overrides the VISUAL environment variable.  e.g. gvim -f -p.
620
621   gui.historybrowser
622       The history browser to use when visualizing history.  Defaults to gitk.
623
624   diff.tool
625       The default diff tool to use.
626
627   merge.tool
628       The default merge tool to use.
629
630   user.email
631       Your email address to be recorded in any newly created commits.  Can be
632       overridden   by   the  ‘GIT_AUTHOR_EMAIL’,  ‘GIT_COMMITTER_EMAIL’,  and
633       ‘EMAIL’ environment variables.
634
635   user.name
636       Your full name to be recorded in any newly  created  commits.   Can  be
637       overridden  by  the ‘GIT_AUTHOR_NAME’ and ‘GIT_COMMITTER_NAME’ environ‐
638       ment variables.
639

ENVIRONMENT VARIABLES

641   GIT_COLA_ICON_THEME
642       When set in the environment, GIT_COLA_ICON_THEME  overrides  the  theme
643       specified  in  the  cola.icontheme  configuration.  Read the section on
644       cola.icontheme above for more details.
645
646   GIT_COLA_SCALE
647       IMPORTANT:
648          GIT_COLA_SCALE should not be used with newer versions of Qt.
649
650          Set QT_AUTO_SCREEN_SCALE_FACTOR to 1 and Qt will automatically scale
651          the  interface  to  the correct size based on the display DPI.  This
652          option is also available by setting cola.hidpi configuration.
653
654          See the Qt High DPI documentation for more details.
655
656       git cola can be made to scale its interface for HiDPI  displays.   When
657       defined,  git cola will scale icons, radioboxes, and checkboxes accord‐
658       ing to the scale factor.  The default value is 1.  A good  value  is  2
659       for high-resolution displays.
660
661       Fonts are not scaled, as their size can already be set in the settings.
662
663   GIT_COLA_TRACE
664       When  defined, git cola logs git commands to stdout.  When set to full,
665       git cola also logs the exit status and output.  When set to trace,  git
666       cola logs to the Console widget.
667
668   VISUAL
669       Specifies the default editor to use.  This is ignored when the gui.edi‐
670       tor configuration variable is defined.
671

LANGUAGE SETTINGS

673       git cola automatically detects your language and presents some transla‐
674       tions  when  available.   This  may not be desired, or you may want git
675       cola to use a specific language.
676
677       You can make git cola use an alternative language by creating a ~/.con‐
678       fig/git-cola/language  file  containing the standard two-letter gettext
679       language code, e.g. “en”, “de”, “ja”, “zh”, etc.:
680
681          mkdir -p ~/.config/git-cola &&
682          echo en >~/.config/git-cola/language
683
684       Alternatively you may also use LANGUAGE environmental variable to  tem‐
685       porarily  change  git cola’s language just like any other gettext-based
686       program.  For example to temporarily change git cola’s language to Eng‐
687       lish:
688
689          LANGUAGE=en git cola
690
691       To  make git cola use the zh_TW translation with zh_HK, zh, and en as a
692       fallback.:
693
694          LANGUAGE=zh_TW:zh_HK:zh:en git cola
695

CUSTOM GUI ACTIONS

697       git cola allows you to define custom GUI actions by setting git  config
698       variables.  The “name” of the command appears in the “Actions” menu.
699
700   guitool.<name>.cmd
701       Specifies the shell command line to execute when the corresponding item
702       of the Tools menu is invoked. This option is mandatory for every  tool.
703       The  command is executed from the root of the working directory, and in
704       the environment it receives the name of the tool  as  GIT_GUITOOL,  the
705       name  of  the  currently selected file as FILENAME, and the name of the
706       current branch as CUR_BRANCH (if the head is  detached,  CUR_BRANCH  is
707       empty).
708
709   guitool.<name>.background
710       Run  the  command  in  the  background (similar to editing and difftool
711       actions).  This avoids blocking the GUI.  Setting  background  to  true
712       implies noconsole and norescan.
713
714   guitool.<name>.needsfile
715       Run  the tool only if a diff is selected in the GUI. It guarantees that
716       FILENAME is not empty.
717
718   guitool.<name>.noconsole
719       Run the command silently, without creating a window to display its out‐
720       put.
721
722   guitool.<name>.norescan
723       Don’t  rescan the working directory for changes after the tool finishes
724       execution.
725
726   guitool.<name>.confirm
727       Show a confirmation dialog before actually running the tool.
728
729   guitool.<name>.argprompt
730       Request a string argument from the  user,  and  pass  it  to  the  tool
731       through  the  ARGS  environment  variable. Since requesting an argument
732       implies confirmation, the confirm option  has  no  effect  if  this  is
733       enabled.  If  the  option  is set to true, yes, or 1, the dialog uses a
734       built-in generic prompt; otherwise the exact value of the  variable  is
735       used.
736
737   guitool.<name>.revprompt
738       Request  a  single  valid  revision from the user, and set the REVISION
739       environment variable. In other aspects this option is similar  to  arg‐
740       prompt, and can be used together with it.
741
742   guitool.<name>.revunmerged
743       Show  only unmerged branches in the revprompt subdialog. This is useful
744       for tools similar to merge or rebase, but not for things like  checkout
745       or reset.
746
747   guitool.<name>.title
748       Specifies the title to use for the prompt dialog.  Defaults to the tool
749       name.
750
751   guitool.<name>.prompt
752       Specifies the general prompt string to display at the top of  the  dia‐
753       log, before subsections for argprompt and revprompt.  The default value
754       includes the actual command.
755
756   guitool.<name>.shortcut
757       Specifies a keyboard shortcut for the custom tool.
758
759       The value must be a valid string understood by  the  QAction::setShort‐
760       cut()                             API.                              See
761       http://qt-project.org/doc/qt-4.8/qkeysequence.html#QKeySequence-2   for
762       more details about the supported values.
763
764       Avoid  creating shortcuts that conflict with existing built-in git cola
765       shortcuts.  Creating a conflict will  result  in  no  action  when  the
766       shortcut is used.
767

SETTING UP GPG FOR SIGNED COMMITS

769       When  creating  signed  commits  gpg will attempt to read your password
770       from the terminal from which git cola was launched.  The  way  to  make
771       this  work smoothly is to use a GPG agent so that you can avoid needing
772       to re-enter your password every time you commit.
773
774       This also gets you a graphical passphrase  prompt  instead  of  getting
775       prompted for your password in the terminal.
776
777   Install gpg-agent and friends
778       On Mac OS X, you may need to brew install gpg-agent and install the Mac
779       GPG Suite.
780
781       On Linux use your package manager to install  gnupg2,  gnupg-agent  and
782       pinentry-qt, e.g.:
783
784          sudo apt-get install gnupg2 gnupg-agent pinentry-qt
785
786       On  Linux, you should also configure Git so that it uses gpg2 (gnupg2),
787       otherwise you will get errors mentioning, “unable  to  open  /dev/tty”.
788       Set Git’s gpg.program to gpg2:
789
790          git config --global gpg.program gpg2
791
792   Configure gpg-agent and a pin-entry program
793       On Mac OS X, edit ~/.gnupg/gpg.conf to include the line,:
794
795          use-agent
796
797       This  is  typically not needed on Linux, where gpg2 is used, as this is
798       the default value when using gpg2.
799
800       Next, edit ~/.gnupg/gpg-agent.conf to contain a  pinentry-program  line
801       pointing to the pinentry program for your platform.
802
803       The  following  example ~/.gnupg/gpg-agent.conf shows how to use pinen‐
804       try-gtk-2 on Linux:
805
806          pinentry-program /usr/bin/pinentry-gtk-2
807          default-cache-ttl 3600
808
809       This following example .gnupg/gpg-agent.conf shows how to use MacGPG2’s
810       pinentry app on On Mac OS X:
811
812          pinentry-program /usr/local/MacGPG2/libexec/pinentry-mac.app/Contents/MacOS/pinentry-mac
813          default-cache-ttl 3600
814          enable-ssh-support
815          use-standard-socket
816
817       Once  this  has  been setup then you will need to reload your gpg-agent
818       config.:
819
820          echo RELOADAGENT | gpg-connect-agent
821
822       If you see the following output:
823
824          OK
825
826       Then the daemon is already running, and you do not  need  to  start  it
827       yourself.
828
829       If  it  is  not  running, eval the output of gpg-agent --daemon in your
830       shell prior to launching git cola.:
831
832          eval $(gpg-agent --daemon)
833          git cola
834

WINDOWS NOTES

836   Git Installation
837       If Git is installed in a custom location, e.g. not installed in  C:/Git
838       or Program Files, then the path to Git must be configured by creating a
839       file in your home directory ~/.config/git-cola/git-bindir  that  points
840       to your git installation.  e.g.:
841
842          C:/Tools/Git/bin
843
845   Git Cola’s Git Repository
846       https://github.com/git-cola/git-cola/
847
848   Git Cola Homepage
849       https://git-cola.github.io/
850
851   Mailing List
852       https://groups.google.com/group/git-cola
853

AUTHOR

855       David Aguilar and contributors
856
858       2007-2019, David Aguilar and contributors
859
860
861
862
8633.4                              Jul 25, 2019                      GIT-COLA(1)
Impressum