Ubuntu Manpage: ~/.config/terminator/config - the config file for Terminator terminal

NAME

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

DESCRIPTION

       This manual page documents briefly the Terminator config file.

       terminator/config is an  optional  file  to  configure  the  terminator
       terminal  emulator. It is used to control options not in gnome-terminal
       gconf profiles, or override gconf settings.

FILE LOCATION

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

FILE FORMAT

       This is what a Terminator config file should look like:

         # This is a comment
         font = Fixed 10
         background_color = #000000
         foreground_color = "#FFFFFF" #Another comment. Quotes can be used for
       any value
         scrollback_lines = ’500’ #More comment. Single quotes are valid too
         cursor_blink = True
         custom_command  =  "echo \"foo#bar\"" #Final comment - this will work
       as expected.

         [keybindings]
         full_screen = <Ctrl><Shift>F11

OPTIONS

These are the options Terminator currently supports:

allow_bold (boolean)
If true, allow applications in the terminal to make text
boldface. Default value: True

enable_real_transparency (boolean)
If true, Terminator will try to use real transparency if
possible. Default value: False

NOTE: To enable transparency you should also see the background_type
and background_darkness settings below.

audible_bell (boolean)
If true, make a noise when applications send the escape sequence
for the terminal bell. Default value: True

visible_bell (boolean)
If true, flash the terminal when applications send the escape
sequence for the terminal bell. Default value: False

urgent_bell (boolean)
If true, set the window manager "urgent" hint when applications
send the escale sequence for the terminal bell. Any keypress
will cancel the urgent status. Default value: False

force_no_bell (boolean)
If true, don’t make a noise or flash. All terminal bells will be
ignored. Default value: False

use_theme_colors
If true, ignore the configured colours and use values from the
theme instead. Default value: False

background_color
Default colour of terminal background, as a colour specification
(can be HTML-style hex digits, or a colour name such as "red").
Note: You may need to set use_theme_colors=False to force this
setting to take effect. Default value: #000000

background_darkness
A value between 0.0 and 1.0 indicating how much to darken the
background image. 0.0 means no darkness, 1.0 means fully dark.
If the terminal is set to transparent, this setting controls how
transparent it is. 0.0 means fully transparent, 1.0 means fully
opaque. Default value: 0.5

background_type
Type of terminal background. May be "solid" for a solid colour,
"image" for an image, or "transparent" for full transparency in
compositing window managers, otherwise pseudo transparency.
Default value: solid

background_image
Path to an image file to be used for the background of
terminals. Default value: Nothing

backspace_binding
Sets what code the backspace key generates. Possible values are
"ascii-del" for the ASCII DEL character, "control-h" for
Control-H (AKA the ASCII BS character), "escape-sequence" for
the escape sequence typically bound to backspace or delete.
"ascii-del" is normally considered the correct setting for the
Backspace key. Default value: ascii-del

delete_binding
Sets what code the delete key generates. Possible values are
"ascii-del" for the ASCII DEL character, "control-h" for
Control-H (AKA the ASCII BS character), "escape-sequence" for
the escape sequence typically bound to backspace or delete.
"escape-sequence" is normally considered the correct setting for
the Delete key. Default value: escape-sequence

cursor_blink (boolean)
Controls if the cursor blinks. Default value: True

cursor_color
Default colour of cursor, as a colour specification (can be
HTML-style hex digits, or a colour name such as "red"). Default
value: Current value of foreground_color

cursor_shape
Default shape of cursor. Possibilities are "block", "ibeam", and
"underline". Default value: block

emulation
Sets what type of terminal should be emulated. Default value:
xterm

font An Pango font name. Examples are "Sans 12" or "Monospace Bold
14". Default value: Mono 8

foreground_color
Default colour of text in the terminal, as a colour
specification (can be HTML-style hex digits, or a colour name
such as "red"). Note: You may need to set use_theme_colors=False
to force this setting to take effect. Default value: #AAAAAA

scrollbar_position
Where to put the terminal scrollbar. Possibilities are "left",
"right", and "disabled". Default value: right

titlebars
If true, a titlebar will be drawn for each terminal which shows
the current title of that terminal. Default value: True

titlebarzoomed
If true, a titlebar will be drawn on zoomed/maximised terminals
which indicates how many are hidden. Default value: True

titletips
If true, a tooltip will be available for each terminal which
shows the current title of that terminal. Default value: False

scroll_background (boolean)
If true, scroll the background image with the foreground text;
if false, keep the image in a fixed position and scroll the text
above it. Default value: True

scroll_on_keystroke (boolean)
If true, pressing a key jumps the scrollbar to the bottom.
Default value: True

scroll_on_output (boolean)
If true, whenever there’s new output the terminal will scroll to
the bottom. Default value: True

alternate_screen_scroll (boolean)
Whether or not the mouse wheel scrolls alternate screen buffers
(man, vim, mutt, etc). This is the default behavior of VTE,
however Ubuntu and possbly other distributions feature patched
versions of VTE where this functionality is optional. The option
only effects the patched versions of VTE, otherwise it is
ignored. Default value: True

scrollback_lines
Number of scrollback lines to keep around. You can scroll back
in the terminal by this number of lines; lines that don’t fit in
the scrollback are discarded. Be careful with this setting; it’s
the primary factor in determining how much memory the terminal
will use. Default value: 500

focus Sets what type of mouse events should determine terminal focus.
Can be "sloppy" or "click". "mouse" is also interpreted as
"sloppy". Default value: click

focus_on_close
Sets which terminal should get the focus when another terminal
is closed. Values can be "prev", "next" or "auto". Using
"auto", if the closed terminal is within a splitted window, the
focus will be on the sibling terminal rather than another tab.
Default value: auto

exit_action
Possible values are "close" to close the terminal, and "restart"
to restart the command. Default value: close

palette
Terminals have a 16-colour palette that applications inside the
terminal can use. This is that palette, in the form of a colon-
separated list of colour names. Colour names should be in hex
format e.g. "#FF00FF". Default value:
#000000000000:#CDCD00000000:#0000CDCD0000:#CDCDCDCD0000:#30BF30BFA38E:#A53C212FA53C:#0000CDCDCDCD:#FAFAEBEBD7D7:#404040404040:#FFFF00000000:#0000FFFF0000:#FFFFFFFF0000:#00000000FFFF:#FFFF0000FFFF:#0000FFFFFFFF:#FFFFFFFFFFFF

word_chars
When selecting text by word, sequences of these characters are
considered single words. Ranges can be given as "A-Z". Literal
hyphen (not expressing a range) should be the first character
given. Default value: -A-Za-z0-9,./?%&#:_

mouse_autohide (boolean)
Controls whether the mouse cursor should be hidden while typing.
Default value: True

use_custom_command (boolean)
If True, the value of custom_command will be used instead of the
default shell. Default value: False

custom_command
Command to execute instead of the default shell, if
use_custom_command is set to True. Default value: Nothing

http_proxy
URL of an HTTP proxy to use, e.g. http://proxy.lan:3128/ Default
value: Nothing

encoding
Character set to use for the terminal. Default value: UTF-8

fullscreen (boolean)
Controls whether the Terminator window will be started in
fullscreen mode Default value: False

maximise (boolean)
Controls whether the Terminator window will be started maximised
Default value: False

borderless (boolean)
Controls whether the Terminator window will be started without
window borders Default value: False

hidden (boolean)
Hides the Terminator window by default. Its visibility can be
toggled with the hide_window keybinding (Ctrl-Shift-Alt-a by
default) Default value: False

handle_size
Controls the width of the separator between terminals. Anything
outside the range 0-5 (inclusive) will be ignored and use your
default theme value. Default value: -1

f11_modifier (boolean)
DEPRECATED. This option will disappear by 1.0. See [keybindings]
instead. If this is set to True, the fullscreen keyboard
shortcut changes from F11 (like many GNOME apps) to Ctrl-Shift-
F11 (useful if you use terminal applications which expect to
receive F11. Default value: False

cycle_term_tab (boolean)
If this is set to True, when switching to the next/previous
term, Terminator will cycle within the same tab. Ctrl-
PageUp/PageDown can then be used to move from one tab to the
other one. Default value: True

close_button_on_tab (boolean)
If set to True, tabs will have a close button on them. Default
value: True

tab_position
Defines where tabs are placed. Can be any of: top, left, right,
bottom. Default value: top

extreme_tabs (boolean)
If set to True, tabs can be created within other tabs. Be warned
that this can be very confusing and hard to use. Default value:
False

hide_tabbar (boolean)
If set to True, the tab bar will be hidden. This means there
will be no visual indication of either how many tabs there are,
or which one you are on. Be warned that this can be very
confusing and hard to use. Default value: False

scroll_tabbar (boolean)
If set to True, the tab bar will not fill the width of the
window. The titlebars of the tabs will only take as much space
as is necessary for the text they contain. Except, that is, if
the tabs no longer fit the width of the window - in that case
scroll buttons will appear to move through the tabs. Default
value: False

copy_on_selection (boolean)
If set to True, text selections will be automatically copied to
the clipboard, in addition to being made the Primary selection.
Default value: False

try_posix_regexp (boolean)
If set to True, URL matching regexps will try to use POSIX style
first, and fall back on GNU style on failure. If you are on
Linux but URL matches don’t work, try setting this to True. If
you are not on Linux, but you get VTE warnings on startup saying
"Error compiling regular expression", set this to False to
silence them (they are otherwise harmless). Default value:
False on Linux, True otherwise.

KEYBINDINGS

       The  following  actions  can have their keyboard shortcut configured in
       the config file in a section labelled [keybindings]:

       zoom_in
              Make font one unit larger.  Default value: <Ctrl>plus

       zoom_out
              Make font one unit smaller.  Default value: <Ctrl>minus

       zoom_normal
              Return font to pre-configured size.  Default value: <Ctrl>0

       new_tab
              Open a new tab.  Default value: <Ctrl><Shift>T

       new_root_tab
              Open a new tab at the root of the window (only useful if you use
              the extreme_tabs option).  Default value: <Ctrl><Shift><Alt>T

       go_next
              Move   cursor   focus   to   the   next  tab.   Default  values:
              <Ctrl><Shift>N and <Ctrl>Tab

       go_prev
              Move  cursor  focus  to  the  previous  tab.   Default   values:
              <Ctrl><Shift>P and <Ctrl><Shift>Tab

       go_up  Move cursor focus to the terminal above.  Default value: <Alt>Up

       go_down
              Move  cursor  focus  to  the  terminal  below.   Default  value:
              <Alt>Down

       go_left
              Move  cursor  focus to the terminal to the left.  Default value:
              <Alt>Left

       go_right
              Move cursor focus to the terminal to the right.  Default  value:
              <Alt>Right

       split_horiz
              Split   the   current  terminal  horizontally.   Default  value:
              <Ctrl><Shift>O

       split_vert
              Split  the  current   terminal   vertically.    Default   value:
              <Ctrl><Shift>E

       close_term
              Close the current terminal.  Default value: <Ctrl><Shift>W

       copy   Copy  the  currently  selected  text  to the clipboard.  Default
              value: <Ctrl><Shift>C

       paste  Paste the current contents of  the  clipboard.   Default  value:
              <Ctrl><Shift>V

       toggle_scrollbar
              Show/Hide the scrollbar.  Default value: <Ctrl><Shift>S

       search Search  for  text  in  the terminal scrollback history.  Default
              value: <Ctrl><Shift>F

       close_window
              Quit Terminator.  Default value: <Ctrl><Shift>Q

       resize_up
              Move the parent dragbar upwards.  Default value: <Ctrl><Shift>Up

       resize_down
              Move    the    parent   dragbar   downwards.    Default   value:
              <Ctrl><Shift>Down

       resize_left
              Move the parent dragbar left.  Default value: <Ctrl><Shift>Left

       resize_right
              Move    the    parent    dragbar    right.     Default    value:
              <Ctrl><Shift>Right

       move_tab_right
              Swap  the current tab with the one to its right.  Default value:
              <Ctrl><Shift>Page_Down

       move_tab_left
              Swap the current tab with the one to its left.   Default  value:
              <Ctrl><Shift>Page_Up

       toggle_zoom
              Zoom/Unzoom  the  current  terminal to fill the window.  Default
              value: <Ctrl><Shift>X

       scaled_zoom
              Zoom/Unzoom the current terminal to fill the window,  and  scale
              its font.  Default value: <Ctrl><Shift>Z

       next_tab
              Move to the next tab.  Default value: <Ctrl>Page_Down

       prev_tab
              Move to the previous tab.  Default value: <Ctrl>Page_Up

       switch_to_tab_1 - switch_to_tab_10
              Keys  to  switch  directly  to  the  numbered  tab.   Note  that
              <Alt><Shift>1 may need to be  provided  as  <Alt>!  or  similar,
              depending on your keyboard layout.  Default value: Unbound

       full_screen
              Toggle the window to a fullscreen window.  Default value: F11

       reset  Reset the terminal state.  Default value: <Ctrl><Shift>R

       reset_clear
              Reset the terminal state and clear the terminal window.  Default
              value: <Ctrl><Shift>G

       group_all
              Group all terminals together so input sent to one goes to all of
              them.  Default value: <Super>g

       ungroup_all
              Remove    grouping   from   all   terminals.    Default   value:
              <Super><Shift>G

       group_tab
              Group all terminals in the current tab together so input sent to
              one goes to all of them.  Default value: <Super>t

       ungroup_tab
              Remove  grouping from all terminals in the current tab.  Default
              value: <Super><Shift>T

       new_window
              Spawn a new instance of Terminator and thus get  a  new  window.
              Default value: <Ctrl><Shift>I