1TERMINATOR_CONFIG(5)                                      TERMINATOR_CONFIG(5)
2
3
4

NAME

6       ~/.config/terminator/config  -  the config file for Terminator terminal
7       emulator.
8

DESCRIPTION

10       This manual page documents briefly the Terminator config file. Termina‐
11       tor manages its configuration file via the ConfigObj library to combine
12       flexibility with clear, human editable files. As of version 0.90,  Ter‐
13       minator  offers a full GUI preferences editor which automatically saves
14       its config file so you don't need to write a config file by hand.
15

FILE LOCATION

17       Normally the config file will be  ~/.config/terminator/config,  but  it
18       may  be  overridden  with  $XDG_CONFIG_HOME  (in  which case it will be
19       $XDG_CONFIG_HOME/terminator/config)
20

FILE FORMAT

22       This is what a Terminator config file should look like:
23
24         # This is a comment
25         [global_config]
26           focus = system
27
28         [keybindings]
29           full_screen = <Ctrl><Shift>F11
30
31         [profiles]
32           [[default]]
33             font = Fixed 10
34             background_color = "#000000" # A comment
35             foreground_color = "#FFFFFF" # Note that hex colour  values  must
36       be quoted
37             scrollback_lines  =  '500' #More comment. Single quotes are valid
38       too
39             cursor_blink = True
40             custom_command = "echo \"foo#bar\"" #Final comment  -  this  will
41       work as expected.
42
43       Below are the individual sections that can exist in the config file:
44
45

global_config

47       These  are the options Terminator currently supports in the global_con‐
48       fig section:
49
50       dbus   Control whether or not Terminator will  load  its  DBus  server.
51              When  this  server  is loaded, running Terminator multiple times
52              will cause the first Terminator process to open additional  win‐
53              dows.  If this configuration item is set to False, or the python
54              dbus module is unavailable, running  Terminator  multiple  times
55              will  run  a  separate  Terminator  process for each invocation.
56              Default value: True
57
58       focus  Control how focus is given to terminals. 'click' means the focus
59              only  moves  to a terminal after you click in it. 'sloppy' means
60              the focus will follow the  mouse  pointer.  'system'  means  the
61              focus  will  match that used by a GNOME window manager.  Default
62              value: click
63
64       handle_size
65              Controls the width of the separator between terminals.  Anything
66              outside  the range 0-20 (inclusive) will be ignored and use your
67              default theme value.  Default value: -1
68
69       geometry_hinting
70              If True the window will resize in step with font sizes, if False
71              it will follow pixels Default value: False
72
73       window_state
74              When set to 'normal' the Terminator window opens normally. 'max‐
75              imise' opens the window in a maximised state, 'fullscreen' in  a
76              fullscreen state and 'hidden' will make it not shown by default.
77              Default value: normal
78
79       borderless (boolean)
80              Controls whether the Terminator window will be  started  without
81              window borders Default value: False
82
83       tab_position
84              Defines where tabs are placed.  Can be any of: top, left, right,
85              bottom.  If this is set to "hidden", the tab  bar  will  not  be
86              shown.  Note  that  hiding the tab bar is very confusing and not
87              recommended.  Default value: top
88
89       broadcast_default
90              Defines default broadcast behavior.  Can be any of: all,  group,
91              off.  Default value: group
92
93       close_button_on_tab (boolean)
94              If  set to True, tabs will have a close button on them.  Default
95              value: True
96
97       hide_tabbar (boolean)
98              If set to True, the tab bar will be  hidden.  This  means  there
99              will  be no visual indication of either how many tabs there are,
100              or which one you are on. Be warned that this can be very confus‐
101              ing  and  hard  to  use.   NOTE:  THIS OPTION IS DEPRECATED, USE
102              tab_position INSTEAD Default value: False
103
104       scroll_tabbar (boolean)
105              If set to True, the tab bar will not fill the width of the  win‐
106              dow.  The  titlebars of the tabs will only take as much space as
107              is necessary for the text they contain. Except, that is, if  the
108              tabs no longer fit the width of the window - in that case scroll
109              buttons will appear to move through the  tabs.   Default  value:
110              False
111
112       try_posix_regexp (boolean)
113              If set to True, URL matching regexps will try to use POSIX style
114              first, and fall back on GNU style on failure.   If  you  are  on
115              Linux  but URL matches don't work, try setting this to True.  If
116              you are not on Linux, but you get VTE warnings on startup saying
117              "Error  compiling  regular  expression",  set  this  to False to
118              silence them (they  are  otherwise  harmless).   Default  value:
119              False on Linux, True otherwise.
120
121       use_custom_url_handler (boolean)
122              If  set to True, URL handling will be given over entirely to the
123              program specified by 'custom_url_handler'.  Default value: False
124
125       custom_url_handler (string)
126              Path to a program which accepts a URI as an  argument  and  does
127              something  relevant  with  it.  This  option  is  ignored unless
128              'use_custom_url_handler' is set to True.  Default value: unset
129
130       disable_real_transparency (string)
131              If this is set to True, Terminator will never try to use  'real'
132              transparency  if your windowing environment supports it. Instead
133              it will use 'fake' transparency  where  a  background  image  is
134              shown, but other windows are not.  Default value: False
135
136       title_transmit_fg_color
137              Sets  the colour of the text shown in the titlebar of the active
138              terminal.  Default value: '#FFFFFF'
139
140       title_transmit_bg_color
141              Sets the colour of the background of the titlebar in the  active
142              terminal.  Default value: '#C80003'
143
144       title_receive_fg_color
145              Sets  the colour of the text shown in the titlebar of any termi‐
146              nal that will receive input from the active  terminal.   Default
147              value: '#FFFFFF'
148
149       title_receive_bg_color
150              Sets  the colour of the background of the titlebar of any termi‐
151              nal that will receive input from the active  terminal.   Default
152              value: '#0076C9'
153
154       title_inactive_fg_color
155              Sets  the colour of the text shown in the titlebar of any termi‐
156              nal that will  not  receive  input  from  the  active  terminal.
157              Default value: '#000000'
158
159       title_inactive_bg_color
160              Sets  the colour of the background of the titlebar of any termi‐
161              nal that will  not  receive  input  from  the  active  terminal.
162              Default value: '#C0BEBF'
163
164       title_use_system_font (boolean)
165              Whether  or  not  to use the GNOME default proportional font for
166              titlebars.  Default value: True
167
168       title_font (string)
169              An Pango font name. Examples are "Sans 12"  or  "Monospace  Bold
170              14".  Default value: "Sans 9"
171
172       inactive_color_offset
173              Controls how much to reduce the colour values of fonts in termi‐
174              nals that do not have focus. It is a simple multiplication  fac‐
175              tor.  A  font  colour  that  was  RGB(200,200,200) with an inac‐
176              tive_color_offset  of  0.5  would  set  inactive  terminals   to
177              RGB(100,100,100).
178
179       always_split_with_profile
180              Controls whether splits/tabs will continue to use the profile of
181              their peer terminal. If set to False, they will always  use  the
182              default profile.  Default value: False
183
184       putty_paste_style (boolean)
185              If  set  to  True, right-click will paste the Primary selection,
186              middle-click will popup the context menu.  Default value: False
187
188       smart_copy (boolean)
189              If set to True, and there  is  no  selection,  the  shortcut  is
190              allowed  to  pass through. This is useful for overloading Ctrl-C
191              to copy a selection, or send the SIGINT to the  current  process
192              if  there  is  no selection. If False the shortcut does not pass
193              through at all, and the  SIGINT  does  not  get  sent.   Default
194              value: True
195
196       enabled_plugins
197              A  list  of plugins which should be loaded by default. All other
198              plugin classes will be ignored. The default value  includes  two
199              plugins  related  to  Launchpad, which are enabled by default to
200              provide continuity with earlier releases where  these  were  the
201              only  substantial plugins available, and all plugins were loaded
202              by default.  Default value: "LaunchpadBugURLHandler,  Launchpad‐
203              CodeURLHandler"
204
205

keybindings

207       These  are the options Terminator currently supports in the keybindings
208       section:
209
210       zoom_in
211              Make font one unit larger.  Default value: <Ctrl>plus
212
213       zoom_out
214              Make font one unit smaller.  Default value: <Ctrl>minus
215
216       zoom_normal
217              Return font to pre-configured size.  Default value: <Ctrl>0
218
219       new_tab
220              Open a new tab.  Default value: <Ctrl><Shift>T
221
222       cycle_next
223              Cycle forwards through the tabs.  Default value: <Ctrl>Tab
224
225       cycle_prev
226              Cycle   backwards   through   the    tabs.     Default    value:
227              <Ctrl><Shift>Tab  go_next  Move  cursor  focus  to the next tab.
228              Default value: <Ctrl><Shift>N
229
230       go_prev
231              Move  cursor  focus  to  the  previous  tab.    Default   value:
232              <Ctrl><Shift>P
233
234       go_up  Move cursor focus to the terminal above.  Default value: <Alt>Up
235
236       go_down
237              Move  cursor  focus  to  the  terminal  below.   Default  value:
238              <Alt>Down
239
240       go_left
241              Move cursor focus to the terminal to the left.   Default  value:
242              <Alt>Left
243
244       go_right
245              Move  cursor focus to the terminal to the right.  Default value:
246              <Alt>Right
247
248       rotate_cw
249              Rotate terminals clockwise.  Default value: <Super>R
250
251       rotate_ccw
252              Rotate    terminals    counter-clockwise.     Default     value:
253              <Super><Shift>R
254
255       split_horiz
256              Split   the   current  terminal  horizontally.   Default  value:
257              <Ctrl><Shift>O
258
259       split_vert
260              Split  the  current   terminal   vertically.    Default   value:
261              <Ctrl><Shift>E
262
263       close_term
264              Close the current terminal.  Default value: <Ctrl><Shift>W
265
266       copy   Copy  the  currently  selected  text  to the clipboard.  Default
267              value: <Ctrl><Shift>C
268
269       paste  Paste the current contents of  the  clipboard.   Default  value:
270              <Ctrl><Shift>V
271
272       toggle_scrollbar
273              Show/Hide the scrollbar.  Default value: <Ctrl><Shift>S
274
275       search Search  for  text  in  the terminal scrollback history.  Default
276              value: <Ctrl><Shift>F
277
278       close_window
279              Quit Terminator.  Default value: <Ctrl><Shift>Q
280
281       resize_up
282              Move the parent dragbar upwards.  Default value: <Ctrl><Shift>Up
283
284       resize_down
285              Move   the   parent   dragbar   downwards.     Default    value:
286              <Ctrl><Shift>Down
287
288       resize_left
289              Move the parent dragbar left.  Default value: <Ctrl><Shift>Left
290
291       resize_right
292              Move    the    parent    dragbar    right.     Default    value:
293              <Ctrl><Shift>Right
294
295       move_tab_right
296              Swap the current tab with the one to its right.  Default  value:
297              <Ctrl><Shift>Page_Down
298
299       move_tab_left
300              Swap  the  current tab with the one to its left.  Default value:
301              <Ctrl><Shift>Page_Up
302
303       toggle_zoom
304              Zoom/Unzoom the current terminal to fill  the  window.   Default
305              value: <Ctrl><Shift>X
306
307       scaled_zoom
308              Zoom/Unzoom  the  current terminal to fill the window, and scale
309              its font.  Default value: <Ctrl><Shift>Z
310
311       next_tab
312              Move to the next tab.  Default value: <Ctrl>Page_Down
313
314       prev_tab
315              Move to the previous tab.  Default value: <Ctrl>Page_Up
316
317       switch_to_tab_1 - switch_to_tab_10
318              Keys  to  switch  directly  to  the  numbered  tab.   Note  that
319              <Alt><Shift>1  may  need  to  be  provided as <Alt>! or similar,
320              depending on your keyboard layout.  Default value: Unbound
321
322       edit_window_title
323              Edit  the  current  active   window's   title   Default   value:
324              <Ctrl><Alt>W
325
326       edit_tab_title
327              Edit   the   currently   active   tab's   title  Default  value:
328              <Ctrl><Alt>A
329
330       edit_terminal_title
331              Edit  the  currently  active  terminal's  title  Default  value:
332              <Ctrl><Alt>X
333
334       full_screen
335              Toggle the window to a fullscreen window.  Default value: F11
336
337       reset  Reset the terminal state.  Default value: <Ctrl><Shift>R
338
339       reset_clear
340              Reset the terminal state and clear the terminal window.  Default
341              value: <Ctrl><Shift>G
342
343       hide_window
344              Toggle visibility of  the  Terminator  window.   Default  value:
345              <Ctrl><Shift><Alt>a
346
347       group_all
348              Group all terminals together so input sent to one goes to all of
349              them.  Default value: <Super>g
350
351       ungroup_all
352              Remove   grouping   from   all   terminals.    Default    value:
353              <Super><Shift>G
354
355       group_tab
356              Group all terminals in the current tab together so input sent to
357              one goes to all of them.  Default value: <Super>t
358
359       ungroup_tab
360              Remove grouping from all terminals in the current tab.   Default
361              value: <Super><Shift>T
362
363       new_window
364              Open  a  new  Terminator window as part of the existing process.
365              Default value: <Ctrl><Shift>I
366
367       new_terminator
368              Spawn a new instance of Terminator.  Default value: <Super>i
369
370

profiles

372       These are the options Terminator currently  supports  in  the  profiles
373       section.   Each  profile  should be its own subsection with a header in
374       the format [[name]]
375
376       allow_bold (boolean) If true, allow applications  in  the  terminal  to
377       make text boldface.  Default value: True
378
379       audible_bell (boolean)
380              If true, make a noise when applications send the escape sequence
381              for the terminal bell.  Default value: False
382
383       visible_bell (boolean)
384              If true, flash the terminal when applications  send  the  escape
385              sequence for the terminal bell.  Default value: False
386
387       urgent_bell (boolean)
388              If  true, set the window manager "urgent" hint when applications
389              send the escale sequence for the  terminal  bell.  Any  keypress
390              will cancel the urgent status.  Default value: False
391
392       icon_bell (boolean)
393              If true, briefly show a small icon on the terminal title bar for
394              the terminal bell.  Default value: True
395
396       force_no_bell (boolean)
397              If true, don't make a noise or flash. All terminal bells will be
398              ignored.  Default value: False
399
400       use_theme_colors
401              If  true,  ignore the configured colours and use values from the
402              theme instead.  Default value: False
403
404       background_color
405              Default colour of terminal background, as a colour specification
406              (can  be HTML-style hex digits, or a colour name such as "red").
407              Note: You may need to set use_theme_colors=False to  force  this
408              setting to take effect.  Default value: '#000000'
409
410       background_darkness
411              A  value  between  0.0 and 1.0 indicating how much to darken the
412              background image. 0.0 means no darkness, 1.0 means  fully  dark.
413              If the terminal is set to transparent, this setting controls how
414              transparent it is. 0.0 means fully transparent, 1.0 means  fully
415              opaque.  Default value: 0.5
416
417       background_type
418              Type  of  terminal background. May be "solid" for a solid colour
419              or "transparent" for full  transparency  in  compositing  window
420              managers.  Default value: solid
421
422       backspace_binding
423              Sets  what code the backspace key generates. Possible values are
424              "ascii-del" for the ASCII DEL character,  "control-h"  for  Con‐
425              trol-H  (AKA  the ASCII BS character), "escape-sequence" for the
426              escape sequence typically bound to backspace or delete.  "ascii-
427              del"   is  normally  considered  the  correct  setting  for  the
428              Backspace key.  Default value: ascii-del
429
430       delete_binding
431              Sets what code the delete key  generates.  Possible  values  are
432              "ascii-del"  for  the  ASCII DEL character, "control-h" for Con‐
433              trol-H (AKA the ASCII BS character), "escape-sequence"  for  the
434              escape sequence typically bound to backspace or delete. "escape-
435              sequence" is normally considered the  correct  setting  for  the
436              Delete key.  Default value: escape-sequence
437
438       color_scheme (boolean)
439              If  specified this sets foreground_color and background_color to
440              pre-set   values.   Possible   options   are    'grey_on_black',
441              'black_on_yellow',      'black_on_white',      'white_on_black',
442              'green_on_black',   'orange_on_black',    'ambience',    'solar‐
443              ized_dark', 'solarized_light'.  Default value: grey_on_black
444
445       cursor_blink (boolean)
446              Controls if the cursor blinks.  Default value: True
447
448       cursor_color
449              Default  colour  of  cursor,  as  a colour specification (can be
450              HTML-style hex digits, or a colour name such as "red").  Default
451              value: Current value of foreground_color
452
453       cursor_shape
454              Default shape of cursor. Possibilities are "block", "ibeam", and
455              "underline".  Default value: block
456
457       term   This translates into the value that will be set for TERM in  the
458              environment of your terminals.  Default value: xterm-256color
459
460       colorterm
461              This translates into the value that will be set for COLORTERM in
462              the environment of your terminals.  Default value: truecolor
463
464       use_system_font
465              Whether or not to use the GNOME default monospace font for  ter‐
466              minals.  Default value: True
467
468       font   An  Pango  font  name. Examples are "Sans 12" or "Monospace Bold
469              14".  Default value: Mono 10
470
471       foreground_color
472              Default colour of text in the terminal, as a  colour  specifica‐
473              tion  (can  be  HTML-style  hex digits, or a colour name such as
474              "red"). Note: You may  need  to  set  use_theme_colors=False  to
475              force this setting to take effect.  Default value: '#AAAAAA'
476
477       scrollbar_position
478              Where  to  put the terminal scrollbar. Possibilities are "left",
479              "right", and "disabled".  Default value: right
480
481       show_titlebar
482              If true, a titlebar will be drawn for each terminal which  shows
483              the current title of that terminal.  Default value: True
484
485       scroll_background (boolean)
486              If  true,  scroll the background image with the foreground text;
487              if false, keep the image in a fixed position and scroll the text
488              above it.  Default value: True
489
490       scroll_on_keystroke (boolean)
491              If  true,  pressing  a  key  jumps  the scrollbar to the bottom.
492              Default value: True
493
494       scroll_on_output (boolean)
495              If true, whenever there's new output the terminal will scroll to
496              the bottom.  Default value: False
497
498       scrollback_lines
499              Number  of  scrollback lines to keep around. You can scroll back
500              in the terminal by this number of lines; lines that don't fit in
501              the  scrollback  are  discarded.  Warning:  with  large  values,
502              rewrapping on resize might be slow.  Default value: 500
503
504       scrollback_infinite
505              If this is set to True, scrollback_lines will be ignored and VTE
506              will keep the entire scrollback history.  Default value: False
507
508       focus_on_close
509              Sets  which  terminal should get the focus when another terminal
510              is closed. Values  can  be  "prev",  "next"  or  "auto".   Using
511              "auto",  if  the  closed  terminal is within a split window, the
512              focus will be on the sibling terminal rather than  another  tab.
513              Default value: auto
514
515       exit_action
516              Possible values are "close" to close the terminal, and "restart"
517              to restart the command.  Default value: close
518
519       palette
520              Terminals have a 16-colour palette that applications inside  the
521              terminal  can use. This is that palette, in the form of a colon-
522              separated list of colour names. Colour names should  be  in  hex
523              format e.g. "#FF00FF".
524
525       word_chars
526              When  selecting  text by word, sequences of these characters are
527              also considered members of single words. The hyphen and alphanu‐
528              merics  do  not need to be specified. Ranges can be given as "A-
529              Z".  Default value: ',./?%&#:_'
530
531       mouse_autohide (boolean)
532              Controls whether the mouse cursor should be hidden while typing.
533              Default value: True
534
535       use_custom_command (boolean)
536              If True, the value of custom_command will be used instead of the
537              default shell.  Default value: False
538
539       custom_command
540              Command to execute instead of the  default  shell,  if  use_cus‐
541              tom_command is set to True.  Default value: Nothing
542
543       http_proxy
544              URL of an HTTP proxy to use, e.g. http://proxy.lan:3128/ Default
545              value: Nothing
546
547       encoding
548              Character set to use for the terminal.  Default value: UTF-8
549
550       copy_on_selection (boolean)
551              If set to True, text selections will be automatically copied  to
552              the  clipboard, in addition to being made the Primary selection.
553              Default value: False
554
555       rewrap_on_resize (boolean)
556              If True, the terminal contents are rewrapped when the terminal's
557              width  changes.  Warning:  This might be slow if you have a huge
558              scrollback buffer.  Default value: True
559
560

layouts

562       This describes the layouts section of the config file.  Like  with  the
563       profiles,  each  layout  should be defined as a sub-section with a name
564       formatted like: [[name]].
565
566       Each object in a layout is a named sub-sub-section with various proper‐
567       ties:
568
569       [layouts]
570         [[default]]
571           [[window0]]
572             type = Window
573           [[child1]]
574             type = Terminal
575             parent = window0
576
577       Window objects may not have a parent attribute. Every other object must
578       specify a parent. This is how the structure of  the  window  is  deter‐
579       mined.
580
581

plugins

583       Terminator  plugins can add their own configuration to the config file,
584       and will appear as a sub-section. Please refer to the documentation  of
585       individual plugins for more information.
586
587

SEE ALSO

589       terminator(1), http://www.voidspace.org.uk/python/configobj.html
590
591
592
593Nicolas Valcarcel <nvalcarcel@ubunFteub.c2o2m,>2008             TERMINATOR_CONFIG(5)
Impressum