terminator/doc/terminatorrc.5

.TH "TERMINATORRC" "5" "Feb 22, 2008" "Nicolas Valcarcel <nvalcarcel@ubuntu.com>" ""
.SH "NAME"
${XDG_CONFIG_HOME}/terminator/terminatorrc (usually ~/.config/terminator/terminatorrc)
or ~/.terminatorrc \- the config file for terminator terminal emulator.
.SH "DESCRIPTION"
This manual page documents briefly the
.B termiatorrc config file.
.PP 
\fBterminatorrc\fP is an optional file to configure the terminator terminal emulator. It is used if there is no gconf PROFILE on the system for configuring the options of the terminal(s).
.SH "OPTIONS"
The options are defined one per line as \fB'OPTION = VALUE'\fR. The options are described below:

.TP 
.B allow_bold\fR (boolean)
If true, allow applications in the terminal to make text boldface. 
Default value: \fBTrue\fR
.TP 
.B silent_bell\fR (boolean)
If true, don't make a noise when applications send the escape sequence for the terminal bell. Flash the terminal instead. 
Default value: \fBTrue\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 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: \fBdelete\-sequence\fR
.TP 
.B cursor_blink \fR(boolean)
Controls if the cursor blinks. 
Default value: \fBFalse\fR
.TP 
.B emulation
Sets what type of terminal should be emulated. 
Default value: \fBxterm\fR
.TP 
.B font
An Pango font name. Examples are "Sans 12" or "Monospace Bold 14". 
Default value: \fBSerif 10\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 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: \fBFalse\fR
.TP 
.B scroll_on_output \fR(boolean)
If true, whenever there's new output the terminal will scroll to the bottom. 
Default value: \fBFalse\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: \fB100\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: \fBsloppy\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 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 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
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
.SH "SEE ALSO"
.BR gnome\-terminal(1)