terminator/doc/terminator_config.5

.TH "TERMINATOR_CONFIG" "5" "Feb 22, 2008" "Nicolas Valcarcel <nvalcarcel@ubuntu.com>" ""
.SH "NAME"
~/.config/terminator/config \- the config file for Terminator terminal emulator.
.SH "DESCRIPTION"
This manual page documents briefly the
.B Terminator config file.
.PP
\fBterminator/config\fP 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.
.SH "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)
.SH "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

.SH "OPTIONS"
These are the options Terminator currently supports:
.TP
.B allow_bold\fR (boolean)
If true, allow applications in the terminal to make text boldface.
Default value: \fBTrue\fR
.TP
.B enable_real_transparency\fR (boolean)
If true, Terminator will try to use real transparency if possible.
Default value: \fBFalse\fR
.TP
\fBNOTE:\fR To enable transparency you should also see the \fBbackground_type\fR and \fBbackground_darkness\fR settings below.
.TP
.B audible_bell\fR (boolean)
If true, make a noise when applications send the escape sequence for the terminal bell.
Default value: \fBTrue\fR
.TP
.B visible_bell\fR (boolean)
If true, flash the terminal when applications send the escape sequence for the terminal bell.
Default value: \fBFalse\fR
.TP
.B urgent_bell\fR (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: \fBFalse\fR
.TP
.B force_no_bell\fR (boolean)
If true, don't make a noise or flash. All terminal bells will be ignored.
Default value: \fBFalse\fR
.TP
.B use_theme_colors
If true, ignore the configured colours and use values from the theme instead.
Default value: \fBFalse\fR
.TP
.B background_color
Default colour of terminal background, as a colour specification (can be HTML-style hex digits, or a colour name such as "red"). \fBNote:\fR You may need to set \fBuse_theme_colors=False\fR to force this setting to take effect.
Default value: \fB#000000\fR
.TP
.B 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: \fB0.5\fR
.TP
.B 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: \fBsolid\fR
.TP
.B background_image
Path to an image file to be used for the background of terminals.
Default value: Nothing
.TP
.B 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: \fBascii\-del\fR
.TP
.B 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: \fBescape\-sequence\fR
.TP
.B cursor_blink \fR(boolean)
Controls if the cursor blinks.
Default value: \fBTrue\fR
.TP
.B 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 \fBforeground_color\fR
.TP
.B cursor_shape
Default shape of cursor. Possibilities are "block", "ibeam", and "underline".
Default value: \fBblock\fR
.TP
.B emulation
Sets what type of terminal should be emulated.
Default value: \fBxterm\fR
.TP
.B geometry_hinting
If True the window will resize in step with font sizes, if False it will follow pixels
Default value: \fBTrue\fR
.TP
.B font
An Pango font name. Examples are "Sans 12" or "Monospace Bold 14".
Default value: \fBMono 8\fR
.TP
.B 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"). \fBNote:\fR You may need to set \fBuse_theme_colors=False\fR to force this setting to take effect.
Default value: \fB#AAAAAA\fR
.TP
.B scrollbar_position
Where to put the terminal scrollbar. Possibilities are "left", "right", and "disabled".
Default value: \fBright\fR
.TP
.B titlebars
If true, a titlebar will be drawn for each terminal which shows the current title of that terminal.
Default value: \fBTrue\fR
.TP
.B titlebarzoomed
If true, a titlebar will be drawn on zoomed/maximised terminals which indicates how many are hidden.
Default value: \fBTrue\fR
.TP
.B title_tx_txt_color
Sets the colour of the text shown in the titlebar of the active terminal.
Default value: \fB#FFFFFF\fR
.TP
.B title_tx_bg_color
Sets the colour of the background of the titlebar in the active terminal.
Default value: \fB#C80003\fR
.TP
.B title_rx_txt_color
Sets the colour of the text shown in the titlebar of any terminal that \fBwill\fR receive input from the active terminal.
Default value: \fB#FFFFFF\fR
.TP
.B title_rx_bg_color
Sets the colour of the background of the titlebar of any terminal that \fBwill\fR receive input from the active terminal.
Default value: \fB#0076C9\fR
.TP
.B title_ia_txt_color
Sets the colour of the text shown in the titlebar of any terminal that will \fBnot\fR receive input from the active terminal.
Default value: \fB#000000\fR
.TP
.B title_ia_bg_color
Sets the colour of the background of the titlebar of any terminal that will \fBnot\fR receive input from the active terminal.
Default value: \fB#C0BEBF\fR
.TP
.B scroll_background \fR(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: \fBTrue\fR
.TP
.B scroll_on_keystroke \fR(boolean)
If true, pressing a key jumps the scrollbar to the bottom.
Default value: \fBTrue\fR
.TP
.B scroll_on_output \fR(boolean)
If true, whenever there's new output the terminal will scroll to the bottom.
Default value: \fBTrue\fR
.TP
.B alternate_screen_scroll \fR(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: \fBTrue\fR
.TP
.B 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: \fB500\fR
.TP
.B focus
Sets what type of mouse events should determine terminal focus. Can be "sloppy" or "click". "mouse" is also interpreted as "sloppy".
Default value: \fBclick\fR
.TP
.B 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: \fBauto\fR
.TP
.B exit_action
Possible values are "close" to close the terminal, and "restart" to restart the command.
Default value: \fBclose\fR
.TP
.B 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: \fB#000000000000:#CDCD00000000:#0000CDCD0000:#CDCDCDCD0000:#30BF30BFA38E:#A53C212FA53C:#0000CDCDCDCD:#FAFAEBEBD7D7:#404040404040:#FFFF00000000:#0000FFFF0000:#FFFFFFFF0000:#00000000FFFF:#FFFF0000FFFF:#0000FFFFFFFF:#FFFFFFFFFFFF\fR
.TP
.B 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: \fB\-A\-Za\-z0\-9,./?%&#:_\fR
.TP
.B mouse_autohide \fR(boolean)
Controls whether the mouse cursor should be hidden while typing.
Default value: \fBTrue\fR
.TP
.B use_custom_command \fR(boolean)
If True, the value of \fBcustom_command\fR will be used instead of the default shell.
Default value: \fBFalse\fR
.TP
.B custom_command
Command to execute instead of the default shell, if \fBuse_custom_command\fR is set to True.
Default value: Nothing
.TP
.B http_proxy
URL of an HTTP proxy to use, e.g. http://proxy.lan:3128/
Default value: Nothing
.TP
.B encoding
Character set to use for the terminal.
Default value: \fBUTF-8\fR
.TP
.B fullscreen \fR(boolean)
Controls whether the Terminator window will be started in fullscreen mode
Default value: \fBFalse\fR
.TP
.B maximise \fR(boolean)
Controls whether the Terminator window will be started maximised
Default value: \fBFalse\fR
.TP
.B borderless \fR(boolean)
Controls whether the Terminator window will be started without window borders
Default value: \fBFalse\fR
.TP
.B hidden \fR(boolean)
Hides the Terminator window by default. Its visibility can be toggled with the \fBhide_window\fR keybinding (Ctrl-Shift-Alt-a by default)
Default value: \fBFalse\fR
.TP
.B 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: \fB-1\fR
.TP
.B f11_modifier \fR(boolean)
DEPRECATED. This option will disappear by 1.0. See \fB[keybindings]\fR 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: \fBFalse\fR
.TP
.B cycle_term_tab \fR(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: \fBTrue\fR
.TP
.B close_button_on_tab \fR(boolean)
If set to True, tabs will have a close button on them.
Default value: \fBTrue\fR
.TP
.B tab_position
Defines where tabs are placed.  Can be any of: top, left, right, bottom.
Default value: \fBtop\fR
.TP
.B extreme_tabs \fR(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: \fBFalse\fR
.TP
.B hide_tabbar \fR(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: \fBFalse\fR
.TP
.B scroll_tabbar \fR(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: \fBFalse\fR
.TP
.B copy_on_selection \fR(boolean)
If set to True, text selections will be automatically copied to the clipboard, in addition to being made the Primary selection.
Default value: \fBFalse\fR
.TP
.B try_posix_regexp \fR(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: \fBFalse\fR on Linux, \fBTrue\fR otherwise.
.SH "KEYBINDINGS"
The following actions can have their keyboard shortcut configured in the config file in a section labelled \fB[keybindings]\fR:
.TP
.B zoom_in
Make font one unit larger.
Default value: \fB<Ctrl>plus\fR
.TP
.B zoom_out
Make font one unit smaller.
Default value: \fB<Ctrl>minus\fR
.TP
.B zoom_normal
Return font to pre-configured size.
Default value: \fB<Ctrl>0\fR
.TP
.B new_tab
Open a new tab.
Default value: \fB<Ctrl><Shift>T\fR
.TP
.B new_root_tab
Open a new tab at the root of the window (only useful if you use the \fBextreme_tabs\fR option).
Default value: \fB<Ctrl><Shift><Alt>T\fR
.TP
.B go_next
Move cursor focus to the next tab.
Default values: \fB<Ctrl><Shift>N\fR and \fB<Ctrl>Tab\fR
.TP
.B go_prev
Move cursor focus to the previous tab.
Default values: \fB<Ctrl><Shift>P\fR and \fB<Ctrl><Shift>Tab\fR
.TP
.B go_up
Move cursor focus to the terminal above.
Default value: \fB<Alt>Up\fR
.TP
.B go_down
Move cursor focus to the terminal below.
Default value: \fB<Alt>Down\fR
.TP
.B go_left
Move cursor focus to the terminal to the left.
Default value: \fB<Alt>Left\fR
.TP
.B go_right
Move cursor focus to the terminal to the right.
Default value: \fB<Alt>Right\fR
.TP
.B split_horiz
Split the current terminal horizontally.
Default value: \fB<Ctrl><Shift>O\fR
.TP
.B split_vert
Split the current terminal vertically.
Default value: \fB<Ctrl><Shift>E\fR
.TP
.B close_term
Close the current terminal.
Default value: \fB<Ctrl><Shift>W\fR
.TP
.B copy
Copy the currently selected text to the clipboard.
Default value: \fB<Ctrl><Shift>C\fR
.TP
.B paste
Paste the current contents of the clipboard.
Default value: \fB<Ctrl><Shift>V\fR
.TP
.B toggle_scrollbar
Show/Hide the scrollbar.
Default value: \fB<Ctrl><Shift>S\fR
.TP
.B search
Search for text in the terminal scrollback history.
Default value: \fB<Ctrl><Shift>F\fR
.TP
.B close_window
Quit Terminator.
Default value: \fB<Ctrl><Shift>Q\fR
.TP
.B resize_up
Move the parent dragbar upwards.
Default value: \fB<Ctrl><Shift>Up\fR
.TP
.B resize_down
Move the parent dragbar downwards.
Default value: \fB<Ctrl><Shift>Down\fR
.TP
.B resize_left
Move the parent dragbar left.
Default value: \fB<Ctrl><Shift>Left\fR
.TP
.B resize_right
Move the parent dragbar right.
Default value: \fB<Ctrl><Shift>Right\fR
.TP
.B move_tab_right
Swap the current tab with the one to its right.
Default value: \fB<Ctrl><Shift>Page_Down\fR
.TP
.B move_tab_left
Swap the current tab with the one to its left.
Default value: \fB<Ctrl><Shift>Page_Up\fR
.TP
.B toggle_zoom
Zoom/Unzoom the current terminal to fill the window.
Default value: \fB<Ctrl><Shift>X\fR
.TP
.B scaled_zoom
Zoom/Unzoom the current terminal to fill the window, and scale its font.
Default value: \fB<Ctrl><Shift>Z\fR
.TP
.B next_tab
Move to the next tab.
Default value: \fB<Ctrl>Page_Down\fR
.TP
.B prev_tab
Move to the previous tab.
Default value: \fB<Ctrl>Page_Up\fR
.TP
.B 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: \fBUnbound\fR
.TP
.B full_screen
Toggle the window to a fullscreen window.
Default value: \fBF11\fR
.TP
.B reset
Reset the terminal state.
Default value: \fB<Ctrl><Shift>R\fR
.TP
.B reset_clear
Reset the terminal state and clear the terminal window.
Default value: \fB<Ctrl><Shift>G\fR
.TP
.B group_all
Group all terminals together so input sent to one goes to all of them.
Default value: \fB<Super>g\fR
.TP
.B ungroup_all
Remove grouping from all terminals.
Default value: \fB<Super><Shift>G\fR
.TP
.B group_tab
Group all terminals in the current tab together so input sent to one goes to all of them.
Default value: \fB<Super>t\fR
.TP
.B ungroup_tab
Remove grouping from all terminals in the current tab.
Default value: \fB<Super><Shift>T\fR
.TP
.B new_window
Spawn a new instance of Terminator and thus get a new window.
Default value: \fB<Ctrl><Shift>I\fR
.SH "SEE ALSO"
.BR gnome\-terminal(1)