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.
56 Default value: False
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
61 focus 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-5 (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: True
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 close_button_on_tab (boolean)
90 If set to True, tabs will have a close button on them. Default
91 value: True
92 hide_tabbar (boolean)
94 If set to True, the tab bar will be hidden. This means there
95 will be no visual indication of either how many tabs there are,
96 or which one you are on. Be warned that this can be very confus‐
97 ing and hard to use. NOTE: THIS OPTION IS DEPRECATED, USE
98 tab_position INSTEAD Default value: False
99 scroll_tabbar (boolean)
101 If set to True, the tab bar will not fill the width of the win‐
102 dow. The titlebars of the tabs will only take as much space as
103 is necessary for the text they contain. Except, that is, if the
104 tabs no longer fit the width of the window - in that case scroll
105 buttons will appear to move through the tabs. Default value:
106 False
107 try_posix_regexp (boolean)
109 If set to True, URL matching regexps will try to use POSIX style
110 first, and fall back on GNU style on failure. If you are on
111 Linux but URL matches don't work, try setting this to True. If
112 you are not on Linux, but you get VTE warnings on startup saying
113 "Error compiling regular expression", set this to False to
114 silence them (they are otherwise harmless). Default value:
115 False on Linux, True otherwise.
116 title_transmit_fg_color
118 Sets the colour of the text shown in the titlebar of the active
119 terminal. Default value: '#FFFFFF'
120 title_transmit_bg_color
122 Sets the colour of the background of the titlebar in the active
123 terminal. Default value: '#C80003'
124 title_receive_fg_color
126 Sets the colour of the text shown in the titlebar of any termi‐
127 nal that will receive input from the active terminal. Default
128 value: '#FFFFFF'
129 title_receive_bg_color
131 Sets the colour of the background of the titlebar of any termi‐
132 nal that will receive input from the active terminal. Default
133 value: '#0076C9'
134 title_inactive_fg_color
136 Sets the colour of the text shown in the titlebar of any termi‐
137 nal that will not receive input from the active terminal.
138 Default value: '#000000'
139 title_inactive_bg_color
141 Sets the colour of the background of the titlebar of any termi‐
142 nal that will not receive input from the active terminal.
143 Default value: '#C0BEBF'
144 enabled_plugins
146 A list of plugins which should be loaded by default. All other
147 plugin classes will be ignored. The default value includes two
148 plugins related to Launchpad, which are enabled by default to
149 provide continuity with earlier releases where these were the
150 only substantial plugins available, and all plugins were loaded
151 by default. Default value: "LaunchpadBugURLHandler, Launchpad‐
152 CodeURLHandler"
153
156 These are the options Terminator currently supports in the keybindings
157 section:
158 zoom_in
160 Make font one unit larger. Default value: <Ctrl>plus
161 zoom_out
163 Make font one unit smaller. Default value: <Ctrl>minus
164 zoom_normal
166 Return font to pre-configured size. Default value: <Ctrl>0
167 new_tab
169 Open a new tab. Default value: <Ctrl><Shift>T
170 cycle_next
172 Cycle forwards through the tabs. Default value: <Ctrl>Tab
173 cycle_prev
175 Cycle backwards through the tabs. Default value:
176 <Ctrl><Shift>Tab go_next Move cursor focus to the next tab.
177 Default value: <Ctrl><Shift>N
178 go_prev
180 Move cursor focus to the previous tab. Default value:
181 <Ctrl><Shift>P
182 go_up Move cursor focus to the terminal above. Default value: <Alt>Up
184 go_down
186 Move cursor focus to the terminal below. Default value:
187 <Alt>Down
188 go_left
190 Move cursor focus to the terminal to the left. Default value:
191 <Alt>Left
192 go_right
194 Move cursor focus to the terminal to the right. Default value:
195 <Alt>Right
196 split_horiz
198 Split the current terminal horizontally. Default value:
199 <Ctrl><Shift>O
200 split_vert
202 Split the current terminal vertically. Default value:
203 <Ctrl><Shift>E
204 close_term
206 Close the current terminal. Default value: <Ctrl><Shift>W
207 copy Copy the currently selected text to the clipboard. Default
209 value: <Ctrl><Shift>C
210 paste Paste the current contents of the clipboard. Default value:
212 <Ctrl><Shift>V
213 toggle_scrollbar
215 Show/Hide the scrollbar. Default value: <Ctrl><Shift>S
216 search Search for text in the terminal scrollback history. Default
218 value: <Ctrl><Shift>F
219 close_window
221 Quit Terminator. Default value: <Ctrl><Shift>Q
222 resize_up
224 Move the parent dragbar upwards. Default value: <Ctrl><Shift>Up
225 resize_down
227 Move the parent dragbar downwards. Default value:
228 <Ctrl><Shift>Down
229 resize_left
231 Move the parent dragbar left. Default value: <Ctrl><Shift>Left
232 resize_right
234 Move the parent dragbar right. Default value:
235 <Ctrl><Shift>Right
236 move_tab_right
238 Swap the current tab with the one to its right. Default value:
239 <Ctrl><Shift>Page_Down
240 move_tab_left
242 Swap the current tab with the one to its left. Default value:
243 <Ctrl><Shift>Page_Up
244 toggle_zoom
246 Zoom/Unzoom the current terminal to fill the window. Default
247 value: <Ctrl><Shift>X
248 scaled_zoom
250 Zoom/Unzoom the current terminal to fill the window, and scale
251 its font. Default value: <Ctrl><Shift>Z
252 next_tab
254 Move to the next tab. Default value: <Ctrl>Page_Down
255 prev_tab
257 Move to the previous tab. Default value: <Ctrl>Page_Up
258 switch_to_tab_1 - switch_to_tab_10
260 Keys to switch directly to the numbered tab. Note that
261 <Alt><Shift>1 may need to be provided as <Alt>! or similar,
262 depending on your keyboard layout. Default value: Unbound
263 full_screen
265 Toggle the window to a fullscreen window. Default value: F11
266 reset Reset the terminal state. Default value: <Ctrl><Shift>R
268 reset_clear
270 Reset the terminal state and clear the terminal window. Default
271 value: <Ctrl><Shift>G
272 hide_window
274 Toggle visibility of the Terminator window. Default value:
275 <Ctrl><Shift><Alt>a
276 group_all
278 Group all terminals together so input sent to one goes to all of
279 them. Default value: <Super>g
280 ungroup_all
282 Remove grouping from all terminals. Default value:
283 <Super><Shift>G
284 group_tab
286 Group all terminals in the current tab together so input sent to
287 one goes to all of them. Default value: <Super>t
288 ungroup_tab
290 Remove grouping from all terminals in the current tab. Default
291 value: <Super><Shift>T
292 new_window
294 Open a new Terminator window as part of the existing process.
295 Default value: <Ctrl><Shift>I
296 new_terminator
298 Spawn a new instance of Terminator. Default value: <Super>i
299
302 These are the options Terminator currently supports in the profiles
303 section. Each profile should be its own subsection with a header in
304 the format [[name]]
305 allow_bold (boolean) If true, allow applications in the terminal to
307 make text boldface. Default value: True
308 antialias (boolean)
310 If false, do not apply anti-aliasing to fonts in the terminal.
311 Default value: True
312 audible_bell (boolean)
314 If true, make a noise when applications send the escape sequence
315 for the terminal bell. Default value: False
316 visible_bell (boolean)
318 If true, flash the terminal when applications send the escape
319 sequence for the terminal bell. Default value: False
320 urgent_bell (boolean)
322 If true, set the window manager "urgent" hint when applications
323 send the escale sequence for the terminal bell. Any keypress
324 will cancel the urgent status. Default value: False
325 icon_bell (boolean)
327 If true, briefly show a small icon on the terminal title bar for
328 the terminal bell. Default value: True
329 force_no_bell (boolean)
331 If true, don't make a noise or flash. All terminal bells will be
332 ignored. Default value: False
333 use_theme_colors
335 If true, ignore the configured colours and use values from the
336 theme instead. Default value: False
337 background_color
339 Default colour of terminal background, as a colour specification
340 (can be HTML-style hex digits, or a colour name such as "red").
341 Note: You may need to set use_theme_colors=False to force this
342 setting to take effect. Default value: '#000000'
343 background_darkness
345 A value between 0.0 and 1.0 indicating how much to darken the
346 background image. 0.0 means no darkness, 1.0 means fully dark.
347 If the terminal is set to transparent, this setting controls how
348 transparent it is. 0.0 means fully transparent, 1.0 means fully
349 opaque. Default value: 0.5
350 background_type
352 Type of terminal background. May be "solid" for a solid colour,
353 "image" for an image, or "transparent" for full transparency in
354 compositing window managers, otherwise pseudo transparency.
355 Default value: solid
356 background_image
358 Path to an image file to be used for the background of termi‐
359 nals. Default value: Nothing
360 backspace_binding
362 Sets what code the backspace key generates. Possible values are
363 "ascii-del" for the ASCII DEL character, "control-h" for Con‐
364 trol-H (AKA the ASCII BS character), "escape-sequence" for the
365 escape sequence typically bound to backspace or delete. "ascii-
366 del" is normally considered the correct setting for the
367 Backspace key. Default value: ascii-del
368 delete_binding
370 Sets what code the delete key generates. Possible values are
371 "ascii-del" for the ASCII DEL character, "control-h" for Con‐
372 trol-H (AKA the ASCII BS character), "escape-sequence" for the
373 escape sequence typically bound to backspace or delete. "escape-
374 sequence" is normally considered the correct setting for the
375 Delete key. Default value: escape-sequence
376 color_scheme (boolean)
378 If specified this sets foreground_color and background_color to
379 pre-set values. Possible options are 'grey_on_black',
380 'black_on_yellow', 'black_on_white', 'white_on_black',
381 'green_on_black', 'orange_on_black', 'ambience'. Default value:
382 grey_on_black
383 cursor_blink (boolean)
385 Controls if the cursor blinks. Default value: True
386 cursor_color
388 Default colour of cursor, as a colour specification (can be
389 HTML-style hex digits, or a colour name such as "red"). Default
390 value: Current value of foreground_color
391 cursor_shape
393 Default shape of cursor. Possibilities are "block", "ibeam", and
394 "underline". Default value: block
395 emulation
397 Sets what type of terminal should be emulated. Default value:
398 xterm
399 use_system_font
401 Whether or not to use the GNOME default monospace font for ter‐
402 minals. Default value: True
403 font An Pango font name. Examples are "Sans 12" or "Monospace Bold
405 14". Default value: Mono 8
406 foreground_color
408 Default colour of text in the terminal, as a colour specifica‐
409 tion (can be HTML-style hex digits, or a colour name such as
410 "red"). Note: You may need to set use_theme_colors=False to
411 force this setting to take effect. Default value: '#AAAAAA'
412 scrollbar_position
414 Where to put the terminal scrollbar. Possibilities are "left",
415 "right", and "disabled". Default value: right
416 show_titlebar
418 If true, a titlebar will be drawn for each terminal which shows
419 the current title of that terminal. Default value: True
420 scroll_background (boolean)
422 If true, scroll the background image with the foreground text;
423 if false, keep the image in a fixed position and scroll the text
424 above it. Default value: True
425 scroll_on_keystroke (boolean)
427 If true, pressing a key jumps the scrollbar to the bottom.
428 Default value: True
429 scroll_on_output (boolean)
431 If true, whenever there's new output the terminal will scroll to
432 the bottom. Default value: True
433 alternate_screen_scroll (boolean)
435 Whether or not the mouse wheel scrolls alternate screen buffers
436 (man, vim, mutt, etc). This is the default behavior of VTE, how‐
437 ever Ubuntu and possbly other distributions feature patched ver‐
438 sions of VTE where this functionality is optional. The option
439 only effects the patched versions of VTE, otherwise it is
440 ignored. Default value: True
441 scrollback_lines
443 Number of scrollback lines to keep around. You can scroll back
444 in the terminal by this number of lines; lines that don't fit in
445 the scrollback are discarded. Be careful with this setting; it's
446 the primary factor in determining how much memory the terminal
447 will use. Default value: 500
448 scrollback_infinite
450 If this is set to True, scrollback_lines will be ignored and VTE
451 will continue to allocate RAM for scrollback history. Default
452 value: False
453 focus_on_close
455 Sets which terminal should get the focus when another terminal
456 is closed. Values can be "prev", "next" or "auto". Using
457 "auto", if the closed terminal is within a splitted window, the
458 focus will be on the sibling terminal rather than another tab.
459 Default value: auto
460 exit_action
462 Possible values are "close" to close the terminal, and "restart"
463 to restart the command. Default value: close
464 palette
466 Terminals have a 16-colour palette that applications inside the
467 terminal can use. This is that palette, in the form of a colon-
468 separated list of colour names. Colour names should be in hex
469 format e.g. "#FF00FF".
470 word_chars
472 When selecting text by word, sequences of these characters are
473 considered single words. Ranges can be given as "A-Z". Literal
474 hyphen (not expressing a range) should be the first character
475 given. Default value: '-A-Za-z0-9,./?%&#:_'
476 mouse_autohide (boolean)
478 Controls whether the mouse cursor should be hidden while typing.
479 Default value: True
480 use_custom_command (boolean)
482 If True, the value of custom_command will be used instead of the
483 default shell. Default value: False
484 custom_command
486 Command to execute instead of the default shell, if use_cus‐
487 tom_command is set to True. Default value: Nothing
488 http_proxy
490 URL of an HTTP proxy to use, e.g. http://proxy.lan:3128/ Default
491 value: Nothing
492 encoding
494 Character set to use for the terminal. Default value: UTF-8
495 copy_on_selection (boolean)
497 If set to True, text selections will be automatically copied to
498 the clipboard, in addition to being made the Primary selection.
499 Default value: False
500
503 This describes the layouts section of the config file. Like with the
504 profiles, each layout should be defined as a sub-section with a name
505 formatted like: [[name]].
506 Each object in a layout is a named sub-sub-section with various proper‐
508 ties:
509 [layouts]
511 [[default]]
512 [[window0]]
513 type = Window
514 [[child1]]
515 type = Terminal
516 parent = window0
517 Window objects may not have a parent attribute. Every other object must
519 specify a parent. This is how the structure of the window is deter‐
520 mined.
521
524 Terminator plugins can add their own configuration to the config file,
525 and will appear as a sub-section. Please refer to the documentation of
526 individual plugins for more information.
527
530 gnome-terminal(1),http://www.voidspace.org.uk/python/configobj.html
531Nicolas Valcarcel <nvalcarcel@ubunFteub.c2o2m,>2008 TERMINATOR_CONFIG(5)