1TERMINATOR_CONFIG(5) TERMINATOR_CONFIG(5)
2
6 ~/.config/terminator/config - the config file for Terminator terminal
7 emulator.
8
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
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
22 This is what a Terminator config file should look like:
23 # This is a comment
25 [global_config]
26 focus = system
27 [keybindings]
29 full_screen = <Ctrl><Shift>F11
30 [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 Below are the individual sections that can exist in the config file:
44
47 These are the options Terminator currently supports in the global_con‐
48 fig section:
49 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. De‐
56 fault value: True
57 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 fo‐
61 cus will match that used by a GNOME window manager. Default
62 value: click
63 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 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 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 borderless (boolean)
80 Controls whether the Terminator window will be started without
81 window borders Default value: False
82 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 broadcast_default
90 Defines default broadcast behavior. Can be any of: all, group,
91 off. Default value: group
92 close_button_on_tab (boolean)
94 If set to True, tabs will have a close button on them. Default
95 value: True
96 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 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 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 si‐
118 lence them (they are otherwise harmless). Default value: False
119 on Linux, True otherwise.
120 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 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 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 title_transmit_fg_color
137 Sets the colour of the text shown in the titlebar of the active
138 terminal. Default value: '#FFFFFF'
139 title_transmit_bg_color
141 Sets the colour of the background of the titlebar in the active
142 terminal. Default value: '#C80003'
143 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 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 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. De‐
157 fault value: '#000000'
158 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. De‐
162 fault value: '#C0BEBF'
163 title_use_system_font (boolean)
165 Whether or not to use the GNOME default proportional font for
166 titlebars. Default value: True
167 title_font (string)
169 An Pango font name. Examples are "Sans 12" or "Monospace Bold
170 14". Default value: "Sans 9"
171 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 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 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 smart_copy (boolean)
189 If set to True, and there is no selection, the shortcut is al‐
190 lowed to pass through. This is useful for overloading Ctrl-C to
191 copy a selection, or send the SIGINT to the current process if
192 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 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
207 These are the options Terminator currently supports in the keybindings
208 section:
209 zoom_in
211 Make font one unit larger. Default value: <Ctrl>plus
212 zoom_out
214 Make font one unit smaller. Default value: <Ctrl>minus
215 zoom_normal
217 Return font to pre-configured size. Default value: <Ctrl>0
218 new_tab
220 Open a new tab. Default value: <Ctrl><Shift>T
221 cycle_next
223 Cycle forwards through the tabs. Default value: <Ctrl>Tab
224 cycle_prev
226 Cycle backwards through the tabs. Default value:
227 <Ctrl><Shift>Tab go_next Move cursor focus to the next tab. De‐
228 fault value: <Ctrl><Shift>N
229 go_prev
231 Move cursor focus to the previous tab. Default value:
232 <Ctrl><Shift>P
233 go_up Move cursor focus to the terminal above. Default value: <Alt>Up
235 go_down
237 Move cursor focus to the terminal below. Default value:
238 <Alt>Down
239 go_left
241 Move cursor focus to the terminal to the left. Default value:
242 <Alt>Left
243 go_right
245 Move cursor focus to the terminal to the right. Default value:
246 <Alt>Right
247 rotate_cw
249 Rotate terminals clockwise. Default value: <Super>R
250 rotate_ccw
252 Rotate terminals counter-clockwise. Default value: <Su‐
253 per><Shift>R
254 split_horiz
256 Split the current terminal horizontally. Default value:
257 <Ctrl><Shift>O
258 split_vert
260 Split the current terminal vertically. Default value:
261 <Ctrl><Shift>E
262 close_term
264 Close the current terminal. Default value: <Ctrl><Shift>W
265 copy Copy the currently selected text to the clipboard. Default
267 value: <Ctrl><Shift>C
268 paste Paste the current contents of the clipboard. Default value:
270 <Ctrl><Shift>V
271 paste_selection
273 Paste the current contents of the primary selection. Default
274 value: Unbound
275 toggle_scrollbar
277 Show/Hide the scrollbar. Default value: <Ctrl><Shift>S
278 search Search for text in the terminal scrollback history. Default
280 value: <Ctrl><Shift>F
281 close_window
283 Quit Terminator. Default value: <Ctrl><Shift>Q
284 resize_up
286 Move the parent dragbar upwards. Default value: <Ctrl><Shift>Up
287 resize_down
289 Move the parent dragbar downwards. Default value:
290 <Ctrl><Shift>Down
291 resize_left
293 Move the parent dragbar left. Default value: <Ctrl><Shift>Left
294 resize_right
296 Move the parent dragbar right. Default value:
297 <Ctrl><Shift>Right
298 move_tab_right
300 Swap the current tab with the one to its right. Default value:
301 <Ctrl><Shift>Page_Down
302 move_tab_left
304 Swap the current tab with the one to its left. Default value:
305 <Ctrl><Shift>Page_Up
306 toggle_zoom
308 Zoom/Unzoom the current terminal to fill the window. Default
309 value: <Ctrl><Shift>X
310 scaled_zoom
312 Zoom/Unzoom the current terminal to fill the window, and scale
313 its font. Default value: <Ctrl><Shift>Z
314 next_tab
316 Move to the next tab. Default value: <Ctrl>Page_Down
317 prev_tab
319 Move to the previous tab. Default value: <Ctrl>Page_Up
320 switch_to_tab_1 - switch_to_tab_10
322 Keys to switch directly to the numbered tab. Note that
323 <Alt><Shift>1 may need to be provided as <Alt>! or similar, de‐
324 pending on your keyboard layout. Default value: Unbound
325 edit_window_title
327 Edit the current active window's title Default value:
328 <Ctrl><Alt>W
329 edit_tab_title
331 Edit the currently active tab's title Default value:
332 <Ctrl><Alt>A
333 edit_terminal_title
335 Edit the currently active terminal's title Default value:
336 <Ctrl><Alt>X
337 full_screen
339 Toggle the window to a fullscreen window. Default value: F11
340 reset Reset the terminal state. Default value: <Ctrl><Shift>R
342 reset_clear
344 Reset the terminal state and clear the terminal window. Default
345 value: <Ctrl><Shift>G
346 hide_window
348 Toggle visibility of the Terminator window. Default value:
349 <Ctrl><Shift><Alt>a
350 group_all
352 Group all terminals together so input sent to one goes to all of
353 them. Default value: <Super>g
354 ungroup_all
356 Remove grouping from all terminals. Default value: <Su‐
357 per><Shift>G
358 group_tab
360 Group all terminals in the current tab together so input sent to
361 one goes to all of them. Default value: <Super>t
362 ungroup_tab
364 Remove grouping from all terminals in the current tab. Default
365 value: <Super><Shift>T
366 new_window
368 Open a new Terminator window as part of the existing process.
369 Default value: <Ctrl><Shift>I
370 new_terminator
372 Spawn a new instance of Terminator. Default value: <Super>i
373
376 These are the options Terminator currently supports in the profiles
377 section. Each profile should be its own subsection with a header in
378 the format [[name]]
379 allow_bold (boolean) If true, allow applications in the terminal to
381 make text boldface. Default value: True
382 audible_bell (boolean)
384 If true, make a noise when applications send the escape sequence
385 for the terminal bell. Default value: False
386 visible_bell (boolean)
388 If true, flash the terminal when applications send the escape
389 sequence for the terminal bell. Default value: False
390 urgent_bell (boolean)
392 If true, set the window manager "urgent" hint when applications
393 send the escale sequence for the terminal bell. Any keypress
394 will cancel the urgent status. Default value: False
395 icon_bell (boolean)
397 If true, briefly show a small icon on the terminal title bar for
398 the terminal bell. Default value: True
399 force_no_bell (boolean)
401 If true, don't make a noise or flash. All terminal bells will be
402 ignored. Default value: False
403 use_theme_colors
405 If true, ignore the configured colours and use values from the
406 theme instead. Default value: False
407 bold_is_bright
409 If true, show bold text with increased brightness. If false,
410 then text boldness can be controlled by applications indepen‐
411 dently from the text brightness. Default value: False
412 background_color
414 Default colour of terminal background, as a colour specification
415 (can be HTML-style hex digits, or a colour name such as "red").
416 Note: You may need to set use_theme_colors=False to force this
417 setting to take effect. Default value: '#000000'
418 background_darkness
420 A value between 0.0 and 1.0 indicating how much to darken the
421 background image. 0.0 means no darkness, 1.0 means fully dark.
422 If the terminal is set to transparent, this setting controls how
423 transparent it is. 0.0 means fully transparent, 1.0 means fully
424 opaque. Default value: 0.5
425 background_type
427 Type of terminal background. May be "solid" for a solid colour
428 or "transparent" for full transparency in compositing window
429 managers. Default value: solid
430 backspace_binding
432 Sets what code the backspace key generates. Possible values are
433 "ascii-del" for the ASCII DEL character, "control-h" for Con‐
434 trol-H (AKA the ASCII BS character), "escape-sequence" for the
435 escape sequence typically bound to backspace or delete. "ascii-
436 del" is normally considered the correct setting for the
437 Backspace key. Default value: ascii-del
438 delete_binding
440 Sets what code the delete key generates. Possible values are
441 "ascii-del" for the ASCII DEL character, "control-h" for Con‐
442 trol-H (AKA the ASCII BS character), "escape-sequence" for the
443 escape sequence typically bound to backspace or delete. "escape-
444 sequence" is normally considered the correct setting for the
445 Delete key. Default value: escape-sequence
446 color_scheme (boolean)
448 If specified this sets foreground_color and background_color to
449 pre-set values. Possible options are 'grey_on_black',
450 'black_on_yellow', 'black_on_white', 'white_on_black',
451 'green_on_black', 'orange_on_black', 'ambience', 'solar‐
452 ized_dark', 'solarized_light'. Default value: grey_on_black
453 cursor_blink (boolean)
455 Controls if the cursor blinks. Default value: True
456 cursor_color
458 Default colour of cursor, as a colour specification (can be
459 HTML-style hex digits, or a colour name such as "red"). Default
460 value: Current value of foreground_color
461 cursor_shape
463 Default shape of cursor. Possibilities are "block", "ibeam", and
464 "underline". Default value: block
465 term This translates into the value that will be set for TERM in the
467 environment of your terminals. Default value: xterm-256color
468 colorterm
470 This translates into the value that will be set for COLORTERM in
471 the environment of your terminals. Default value: truecolor
472 use_system_font
474 Whether or not to use the GNOME default monospace font for ter‐
475 minals. Default value: True
476 font An Pango font name. Examples are "Sans 12" or "Monospace Bold
478 14". Default value: Mono 10
479 foreground_color
481 Default colour of text in the terminal, as a colour specifica‐
482 tion (can be HTML-style hex digits, or a colour name such as
483 "red"). Note: You may need to set use_theme_colors=False to
484 force this setting to take effect. Default value: '#AAAAAA'
485 scrollbar_position
487 Where to put the terminal scrollbar. Possibilities are "left",
488 "right", and "disabled". Default value: right
489 show_titlebar
491 If true, a titlebar will be drawn for each terminal which shows
492 the current title of that terminal. Default value: True
493 scroll_background (boolean)
495 If true, scroll the background image with the foreground text;
496 if false, keep the image in a fixed position and scroll the text
497 above it. Default value: True
498 scroll_on_keystroke (boolean)
500 If true, pressing a key jumps the scrollbar to the bottom. De‐
501 fault value: True
502 scroll_on_output (boolean)
504 If true, whenever there's new output the terminal will scroll to
505 the bottom. Default value: False
506 scrollback_lines
508 Number of scrollback lines to keep around. You can scroll back
509 in the terminal by this number of lines; lines that don't fit in
510 the scrollback are discarded. Warning: with large values,
511 rewrapping on resize might be slow. Default value: 500
512 scrollback_infinite
514 If this is set to True, scrollback_lines will be ignored and VTE
515 will keep the entire scrollback history. Default value: False
516 focus_on_close
518 Sets which terminal should get the focus when another terminal
519 is closed. Values can be "prev", "next" or "auto". Using
520 "auto", if the closed terminal is within a split window, the fo‐
521 cus will be on the sibling terminal rather than another tab.
522 Default value: auto
523 exit_action
525 Possible values are "close" to close the terminal, and "restart"
526 to restart the command. Default value: close
527 palette
529 Terminals have a 16-colour palette that applications inside the
530 terminal can use. This is that palette, in the form of a colon-
531 separated list of colour names. Colour names should be in hex
532 format e.g. "#FF00FF".
533 word_chars
535 When selecting text by word, sequences of these characters are
536 also considered members of single words. The hyphen and alphanu‐
537 merics do not need to be specified. Ranges can be given as "A-
538 Z". Default value: ',./?%&#:_'
539 mouse_autohide (boolean)
541 Controls whether the mouse cursor should be hidden while typing.
542 Default value: True
543 use_custom_command (boolean)
545 If True, the value of custom_command will be used instead of the
546 default shell. Default value: False
547 custom_command
549 Command to execute instead of the default shell, if use_cus‐
550 tom_command is set to True. Default value: Nothing
551 http_proxy
553 URL of an HTTP proxy to use, e.g. http://proxy.lan:3128/ Default
554 value: Nothing
555 encoding
557 Character set to use for the terminal. Default value: UTF-8
558 copy_on_selection (boolean)
560 If set to True, text selections will be automatically copied to
561 the clipboard, in addition to being made the Primary selection.
562 Default value: False
563 layouts
567 This describes the layouts section of the config file. Like with
569 the profiles, each layout should be defined as a sub-section
570 with a name formatted like: [[name]].
571 Each object in a layout is a named sub-sub-section with various
573 properties:
574 [layouts]
576 [[default]]
577 [[window0]]
578 type = Window
579 [[child1]]
580 type = Terminal
581 parent = window0
582 Window objects may not have a parent attribute. Every other ob‐
584 ject must specify a parent. This is how the structure of the
585 window is determined.
586
589 Terminator plugins can add their own configuration to the config file,
590 and will appear as a sub-section. Please refer to the documentation of
591 individual plugins for more information.
592
595 terminator(1), http://www.voidspace.org.uk/python/configobj.html
596Nicolas Valcarcel <nvalcarcel@ubunFteub.c2o2m,>2008 TERMINATOR_CONFIG(5)