From f68f288c331af0996a98066cb874c9f84a352d5d Mon Sep 17 00:00:00 2001 From: Vulcalien Date: Sat, 22 Apr 2023 14:50:45 +0200 Subject: [PATCH] Update terminator_config.5 This file is now compiled from 'terminator_config.adoc' --- doc/terminator_config.5 | 1858 ++++++++++++++++++++++++++++----------- 1 file changed, 1345 insertions(+), 513 deletions(-) diff --git a/doc/terminator_config.5 b/doc/terminator_config.5 index 8a9b2b4e..04b1e084 100644 --- a/doc/terminator_config.5 +++ b/doc/terminator_config.5 @@ -1,528 +1,1360 @@ -.TH "TERMINATOR_CONFIG" "5" "Feb 22, 2008" "Nicolas Valcarcel " "" +'\" t +.\" Title: terminator_config +.\" Author: [see the "AUTHOR(S)" section] +.\" Generator: Asciidoctor 2.0.18 +.\" Date: 2023-04-22 +.\" Manual: Manual for Terminator +.\" Source: Terminator +.\" Language: English +.\" +.TH "TERMINATOR_CONFIG" "5" "2023-04-22" "Terminator" "Manual for Terminator" +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.ss \n[.ss] 0 +.nh +.ad l +.de URL +\fI\\$2\fP <\\$1>\\$3 +.. +.als MTO URL +.if \n[.g] \{\ +. mso www.tmac +. am URL +. ad l +. . +. am MTO +. ad l +. . +. LINKSTYLE blue R < > +.\} .SH "NAME" -~/.config/terminator/config \- the config file for Terminator terminal emulator. +terminator_config \- the config file for Terminator terminal emulator .SH "DESCRIPTION" -This manual page documents briefly the -.B Terminator -config file. Terminator manages its configuration file via the ConfigObj library to combine flexibility with clear, human editable files. As of version 0.90, Terminator offers a full GUI preferences editor which automatically saves its config file so you don't need to write a config file by hand. -.PP +.sp +This file contains the configuration for \fBterminator\fP(1). +Terminator manages its configuration file via the ConfigObj library to +combine flexibility with clear, human editable files. +.br +Terminator offers a full GUI preferences editor which automatically +saves its config file so you don\(cqt need to write a config file by hand. .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) +.sp +Normally the config file will be \fB~/.config/terminator/config\fP, but it +may be overridden with \fB$XDG_CONFIG_HOME\fP (in which case it will be +\fB$XDG_CONFIG_HOME/terminator/config\fP). .SH "FILE FORMAT" +.sp This is what a Terminator config file should look like: +.sp +.if n .RS 4 +.nf +.fam C +# This is a comment +[global_config] + focus = system - # This is a comment - [global_config] - focus = system +[keybindings] + full_screen = F11 - [keybindings] - full_screen = F11 - - [profiles] - [[default]] - font = Fixed 10 - background_color = "#000000" # A comment - foreground_color = "#FFFFFF" # Note that hex colour values must be quoted - 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. - -Below are the individual sections that can exist in the config file: - -.SH "global_config" -These are the options Terminator currently supports in the global_config section: -.TP -.B dbus -Control whether or not Terminator will load its DBus server. When this server is loaded, running Terminator multiple times will cause the first Terminator process to open additional windows. If this configuration item is set to False, or the python dbus module is unavailable, running Terminator multiple times will run a separate Terminator process for each invocation. -Default value: \fBTrue\fR -.TP -.B focus -Control how focus is given to terminals. 'click' means the focus only moves to a terminal after you click in it. 'sloppy' means the focus will follow the mouse pointer. 'system' means the focus will match that used by a GNOME window manager. -Default value: \fBclick\fR -.TP -.B handle_size -Controls the width of the separator between terminals. Anything outside the range 0-20 (inclusive) will be ignored and use your default theme value. -Default value: \fB-1\fR -.TP -.B geometry_hinting -If True the window will resize in step with font sizes, if False it will follow pixels -Default value: \fBFalse\fR -.TP -.B window_state -When set to 'normal' the Terminator window opens normally. 'maximise' opens the window in a maximised state, 'fullscreen' in a fullscreen state and 'hidden' will make it not shown by default. -Default value: \fBnormal\fR -.TP -.B borderless \fR(boolean) -Controls whether the Terminator window will be started without window borders -Default value: \fBFalse\fR -.TP -.B tab_position -Defines where tabs are placed. Can be any of: top, left, right, bottom. -If this is set to "hidden", the tab bar will not be shown. Note that hiding the tab bar is very confusing and not recommended. -Default value: \fBtop\fR -.TP -.B broadcast_default -Defines default broadcast behavior. Can be any of: all, group, off. -Default value: \fBgroup\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 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. -.B NOTE: THIS OPTION IS DEPRECATED, USE tab_position INSTEAD -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 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. -.TP -.B use_custom_url_handler \fR(boolean) -If set to True, URL handling will be given over entirely to the program specified by 'custom_url_handler'. -Default value: \fBFalse\fR -.TP -.B custom_url_handler \fR(string) -Path to a program which accepts a URI as an argument and does something relevant with it. This option is ignored unless 'use_custom_url_handler' is set to True. -Default value: unset -.TP -.B disable_real_transparency \fR(string) -If this is set to True, Terminator will never try to use 'real' transparency if your windowing environment supports it. Instead it will use 'fake' transparency where a background image is shown, but other windows are not. -Default value: False -.TP -.B title_transmit_fg_color -Sets the colour of the text shown in the titlebar of the active terminal. -Default value: \fB'#FFFFFF'\fR -.TP -.B title_transmit_bg_color -Sets the colour of the background of the titlebar in the active terminal. -Default value: \fB'#C80003'\fR -.TP -.B title_receive_fg_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_receive_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_inactive_fg_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_inactive_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 title_use_system_font \fR(boolean) -Whether or not to use the GNOME default proportional font for titlebars. -Default value: \fBTrue\fR -.TP -.B title_font \fR(string) -An Pango font name. Examples are "Sans 12" or "Monospace Bold 14". -Default value: \fB"Sans 9"\fR -.TP -.B inactive_color_offset -Controls how much to reduce the colour values of fonts in terminals that do not have focus. It is a simple multiplication -factor. A font colour that was RGB(200,200,200) with an inactive_color_offset of 0.5 would set inactive terminals to -RGB(100,100,100). -.TP -.B always_split_with_profile -Controls whether splits/tabs will continue to use the profile of their peer terminal. If set to False, they will always use -the default profile. -Default value: \fBFalse\fR -.TP -.B putty_paste_style \fR(boolean) -If set to True, right-click will paste the Primary selection, middle-click will popup the context menu. -Default value: \fBFalse\fR -.TP -.B smart_copy \fR(boolean) -If set to True, and there is no selection, the shortcut is allowed to pass through. This is useful for overloading Ctrl-C to copy a selection, or send the SIGINT to the current process if there is no selection. If False the shortcut does not pass through at all, and the SIGINT does not get sent. -Default value: \fBTrue\fR -.TP -.B enabled_plugins -A list of plugins which should be loaded by default. All other plugin classes will be ignored. The default value includes two -plugins related to Launchpad, which are enabled by default to provide continuity with earlier releases where these were the -only substantial plugins available, and all plugins were loaded by default. -Default value: \fB"LaunchpadBugURLHandler, LaunchpadCodeURLHandler"\fR - -.SH keybindings -These are the options Terminator currently supports in the keybindings section: -.TP -.B zoom_in -Make font one unit larger. -Default value: \fBplus\fR -.TP -.B zoom_out -Make font one unit smaller. -Default value: \fBminus\fR -.TP -.B zoom_normal -Return font to pre-configured size. -Default value: \fB0\fR -.TP -.B new_tab -Open a new tab. -Default value: \fBT\fR -.TP -.B cycle_next -Cycle forwards through the tabs. -Default value: \fBTab\fR -.TP -.B cycle_prev -Cycle backwards through the tabs. -Default value: \fBTab\fR -.B go_next -Move cursor focus to the next tab. -Default value: \fBN\fR -.TP -.B go_prev -Move cursor focus to the previous tab. -Default value: \fBP\fR -.TP -.B go_up -Move cursor focus to the terminal above. -Default value: \fBUp\fR -.TP -.B go_down -Move cursor focus to the terminal below. -Default value: \fBDown\fR -.TP -.B go_left -Move cursor focus to the terminal to the left. -Default value: \fBLeft\fR -.TP -.B go_right -Move cursor focus to the terminal to the right. -Default value: \fBRight\fR -.TP -.B rotate_cw -Rotate terminals clockwise. -Default value: \fBR\fR -.TP -.B rotate_ccw -Rotate terminals counter-clockwise. -Default value: \fBR\fR -.TP -.B split_horiz -Split the current terminal horizontally. -Default value: \fBO\fR -.TP -.B split_vert -Split the current terminal vertically. -Default value: \fBE\fR -.TP -.B close_term -Close the current terminal. -Default value: \fBW\fR -.TP -.B copy -Copy the currently selected text to the clipboard. -Default value: \fBC\fR -.TP -.B paste -Paste the current contents of the clipboard. -Default value: \fBV\fR -.TP -.B paste_selection -Paste the current contents of the primary selection. -Default value: \fBUnbound\fR -.TP -.B toggle_scrollbar -Show/Hide the scrollbar. -Default value: \fBS\fR -.TP -.B search -Search for text in the terminal scrollback history. -Default value: \fBF\fR -.TP -.B close_window -Quit Terminator. -Default value: \fBQ\fR -.TP -.B resize_up -Move the parent dragbar upwards. -Default value: \fBUp\fR -.TP -.B resize_down -Move the parent dragbar downwards. -Default value: \fBDown\fR -.TP -.B resize_left -Move the parent dragbar left. -Default value: \fBLeft\fR -.TP -.B resize_right -Move the parent dragbar right. -Default value: \fBRight\fR -.TP -.B move_tab_right -Swap the current tab with the one to its right. -Default value: \fBPage_Down\fR -.TP -.B move_tab_left -Swap the current tab with the one to its left. -Default value: \fBPage_Up\fR -.TP -.B toggle_zoom -Zoom/Unzoom the current terminal to fill the window. -Default value: \fBX\fR -.TP -.B scaled_zoom -Zoom/Unzoom the current terminal to fill the window, and scale its font. -Default value: \fBZ\fR -.TP -.B next_tab -Move to the next tab. -Default value: \fBPage_Down\fR -.TP -.B prev_tab -Move to the previous tab. -Default value: \fBPage_Up\fR -.TP -.B switch_to_tab_1 - switch_to_tab_10 -Keys to switch directly to the numbered tab. -Note that 1 may need to be provided as ! or similar, -depending on your keyboard layout. -Default value: \fBUnbound\fR -.TP -.B edit_window_title -Edit the current active window's title -Default value: \fBW\fR -.TP -.B edit_tab_title -Edit the currently active tab's title -Default value: \fBA\fR -.TP -.B edit_terminal_title -Edit the currently active terminal's title -Default value: \fBX\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: \fBR\fR -.TP -.B reset_clear -Reset the terminal state and clear the terminal window. -Default value: \fBG\fR -.TP -.B hide_window -Toggle visibility of the Terminator window. -Default value: \fBa\fR -.TP -.B group_all -Group all terminals together so input sent to one goes to all of them. -Default value: \fBg\fR -.TP -.B ungroup_all -Remove grouping from all terminals. -Default value: \fBG\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: \fBt\fR -.TP -.B ungroup_tab -Remove grouping from all terminals in the current tab. -Default value: \fBT\fR -.TP -.B new_window -Open a new Terminator window as part of the existing process. -Default value: \fBI\fR -.TP -.B new_terminator -Spawn a new instance of Terminator. -Default value: \fBi\fR - -.SH profiles -These are the options Terminator currently supports in the profiles section. -Each profile should be its own subsection with a header in the format \fB[[name]]\fR - -.B allow_bold\fR (boolean) -If true, allow applications in the terminal to make text boldface. -Default value: \fBTrue\fR -.TP -.B audible_bell\fR (boolean) -If true, make a noise when applications send the escape sequence for the terminal bell. -Default value: \fBFalse\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 icon_bell\fR (boolean) -If true, briefly show a small icon on the terminal title bar for the terminal bell. -Default value: \fBTrue\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 bold_is_bright -If true, show bold text with increased brightness. If false, then text boldness can be controlled by applications independently from the text brightness. -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 or "transparent" for full transparency in compositing window managers. -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: \fBescape\-sequence\fR -.TP -.B color_scheme \fR(boolean) -If specified this sets foreground_color and background_color to pre-set values. Possible options are 'grey_on_black', 'black_on_yellow', 'black_on_white', 'white_on_black', 'green_on_black', 'orange_on_black', 'ambience', 'solarized_dark', 'solarized_light'. -Default value: \fRgrey_on_black\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 term -This translates into the value that will be set for TERM in the environment of your terminals. -Default value: \fBxterm-256color\fR -.TP -.B colorterm -This translates into the value that will be set for COLORTERM in the environment of your terminals. -Default value: \fBtruecolor\fR -.TP -.B use_system_font -Whether or not to use the GNOME default monospace font for terminals. -Default value: \fBTrue\fR -.TP -.B font -An Pango font name. Examples are "Sans 12" or "Monospace Bold 14". -Default value: \fBMono 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 show_titlebar -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: \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: \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. Warning: with large values, rewrapping on resize might be slow. -Default value: \fB500\fR -.TP -.B scrollback_infinite -If this is set to True, scrollback_lines will be ignored and VTE will keep the entire scrollback history. -Default value: \fBFalse\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 split 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". -.TP -.B word_chars -When selecting text by word, sequences of these characters are also considered members of single words. The hyphen and alphanumerics do not need to be specified. Ranges can be given as "A-Z". -Default value: \fB',./?%&#:_'\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 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 - -.SH layouts - -This describes the layouts section of the config file. Like with the profiles, each layout should be defined as a sub-section with a name formatted like: \fB[[name]]\fR. - -Each object in a layout is a named sub-sub-section with various properties: +[profiles] + [[default]] + font = Fixed 10 + background_color = "#000000" # A comment + foreground_color = "#FFFFFF" # Note that hex colour values must be quoted + scrollback_lines = \*(Aq500\*(Aq #More comment. Single quotes are valid too + cursor_blink = True + custom_command = "echo \(rs"foo#bar\(rs"" #Final comment \- this will work as expected. [layouts] [[default]] - [[window0]] + [[[window0]]] type = Window - [[child1]] + parent = "" + [[[child1]]] type = Terminal parent = window0 -Window objects may not have a parent attribute. \fBEvery\fR other object must specify a parent. This is how the structure of the window is determined. - -.SH plugins - -Terminator plugins can add their own configuration to the config file, and will appear as a sub-section. Please refer to the documentation of individual plugins for more information. - +[plugins] +.fam +.fi +.if n .RE +.SH "GLOBAL_CONFIG" +.sp +These are the options Terminator currently supports in the +\fBglobal_config\fP section. +.SS "Window Behavior & Appearance" +.sp +\fBwindow_state\fP = \fIstring\fP +.RS 4 +Control how the Terminator window opens. +\*(Aqnormal\*(Aq to open normally. +\*(Aqmaximise\*(Aq to open in a maximised state. +\*(Aqfullscreen\*(Aq to open in a fullscreen state. +\*(Aqhidden\*(Aq to stay hidden. +.br +Default value: \fBnormal\fP +.RE +.sp +\fBalways_on_top\fP = \fIboolean\fP +.RS 4 +If set to True, the window will always stay on top of other windows. +.br +Default value: \fBFalse\fP +.RE +.sp +\fBsticky\fP = \fIboolean\fP +.RS 4 +If set to True, the window will be visible on all workspaces. +.br +Default value: \fBFalse\fP +.RE +.sp +\fBhide_on_lose_focus\fP = \fIboolean\fP +.RS 4 +If set to True, the window will be hidden when focus is lost. +.br +Default value: \fBFalse\fP +.RE +.sp +\fBhide_from_taskbar\fP = \fIboolean\fP +.RS 4 +If set to True, the window will be hidden from the taskbar. +.br +Default value: \fBFalse\fP +.RE +.sp +\fBgeometry_hinting\fP = \fIboolean\fP +.RS 4 +If set to True, the window will resize in step with font sizes. +.br +Default value: \fBFalse\fP +.RE +.sp +\fBsuppress_multiple_term_dialog\fP = \fIboolean\fP +.RS 4 +If set to True, Terminator will ask for confirmation when closing +multiple terminals. +.br +Default value: \fBFalse\fP +.RE +.sp +\fBborderless\fP = \fIboolean\fP +.RS 4 +If set to True, the window will be started without window borders. +.br +Default value: \fBFalse\fP +.RE +.SS "Tab Behavior & Appearance" +.sp +\fBtab_position\fP = \fIstring\fP +.RS 4 +Specify where tabs are placed. +Can be any of: \*(Aqtop\*(Aq, \*(Aqleft\*(Aq, \*(Aqright\*(Aq, \*(Aqbottom\*(Aq, \*(Aqhidden\*(Aq. +If set to \*(Aqhidden\*(Aq, the tab bar will not be shown. Hiding the tab is not +recommended, as it can be very confusing. +.br +Default value: \fBtop\fP +.RE +.sp +\fBclose_button_on_tab\fP = \fIboolean\fP +.RS 4 +If set to True, tabs will have a close button on them. +.br +Default value: \fBTrue\fP +.RE +.sp +\fBscroll_tabbar\fP = \fIboolean\fP +.RS 4 +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. +.br +Default value: \fBFalse\fP +.RE +.SS "Terminal Behavior & Appearance" +.sp +\fBfocus\fP = \fIstring\fP +.RS 4 +Specify how focus is given to terminals. +\*(Aqclick\*(Aq means the focus only moves to a terminal after you click in it. +\*(Aqsloppy\*(Aq means the focus will follow the mouse pointer. +\*(Aqsystem\*(Aq means the focus will match that used by a GNOME window manager. +.br +Default value: \fBclick\fP +.RE +.sp +\fBalways_split_with_profile\fP = \fIboolean\fP +.RS 4 +Specify whether splits/tabs will continue to use the profile of their +peer terminal. If set to False, they will always use the default profile. +.br +Default value: \fBFalse\fP +.RE +.sp +\fBlink_single_click\fP = \fIboolean\fP +.RS 4 +If set to True, clicking a link will open it even if \fBCtrl\fP is not +pressed. +.br +Default value: \fBFalse\fP +.RE +.sp +\fBputty_paste_style\fP = \fIboolean\fP +.RS 4 +If set to True, right\-click will paste text, while middle\-click will +popup the context menu. The source for the pasted text depends on the +value of \fBputty_paste_style_source_clipboard\fP. +.br +Default value: \fBFalse\fP +.RE +.sp +\fBputty_paste_style_source_clipboard\fP = \fIboolean\fP +.RS 4 +If set to True, the Clipboard will be used as source for pasting in +PuTTY style. Otherwise, the Primary Selection will be used. +.br +This option is ignored unless \fBputty_paste_style\fP is set to True. +.br +Default value: \fBFalse\fP +.RE +.sp +\fBdisable_mouse_paste\fP = \fIboolean\fP +.RS 4 +If set to True, mouse pasting will be disabled. +.br +Default value: \fBFalse\fP +.RE +.sp +\fBsmart_copy\fP = \fIboolean\fP +.RS 4 +If set to True, and there is no selection, the shortcut is allowed to +pass through. This is useful for overloading Ctrl\-C to copy a selection, +or send the SIGINT to the current process if there is no selection. +If False, the shortcut does not pass through at all, and the SIGINT does +not get sent. +.br +Default value: \fBTrue\fP +.RE +.sp +\fBclear_select_on_copy\fP = \fIboolean\fP +.RS 4 +If set to True, text selection will be cleared after copying using the +\fBcopy\fP keybinding. +.br +Default value: \fBFalse\fP +.RE +.sp +\fBhandle_size\fP = \fIinteger\fP +.RS 4 +Specify the width of the separator between terminals. +Anything outside the range 0\-20 (inclusive) will be ignored and the +default theme value will be used instead. +.br +Default value: \fB1\fP +.RE +.sp +\fBinactive_color_offset\fP = \fIfloat\fP +.RS 4 +Specify how much to reduce the color values of fonts in terminals that +do not have focus. +.br +Default value: \fB0.8\fP +.RE +.sp +\fBinactive_bg_color_offset\fP = \fIfloat\fP +.RS 4 +Specify how much to reduce the color values of the background in +terminals that do not have focus. +.br +Default value: \fB1.0\fP +.RE +.sp +\fBcell_width\fP = \fIfloat\fP +.RS 4 +Specify the horizontal scale of character cells in the terminal. +.br +Default value: \fB1.0\fP +.RE +.sp +\fBcell_height\fP = \fIfloat\fP +.RS 4 +Specify the vertical scale of character cells in the terminal. +.br +Default value: \fB1.0\fP +.RE +.sp +\fBtitle_at_bottom\fP = \fIboolean\fP +.RS 4 +If set to True, the terminal\(cqs titlebar will be drawn at the bottom +instead of the top. +.br +Default value: \fBFalse\fP +.RE +.SS "Miscellaneous" +.sp +\fBdbus\fP = \fIboolean\fP +.RS 4 +Specify whether Terminator will load its DBus server. +When this server is loaded, running Terminator multiple times will cause +the first Terminator process to open additional windows. +If this configuration item is set to False, or the python dbus module is +unavailable, running Terminator multiple times will run a separate +Terminator process for each invocation. +.br +Default value: \fBTrue\fP +.RE +.sp +\fBextra_styling\fP = \fIboolean\fP +.RS 4 +If set to True, Terminator may load an additional CSS styling file, +depending on the theme. +.br +Default value: \fBTrue\fP +.RE +.sp +\fBbroadcast_default\fP = \fIstring\fP +.RS 4 +Specify the default broadcast behavior. +Can be any of: \*(Aqall\*(Aq, \*(Aqgroup\*(Aq, \*(Aqoff\*(Aq. +.br +Default value: \fBgroup\fP +.RE +.sp +\fBuse_custom_url_handler\fP = \fIboolean\fP +.RS 4 +If set to True, URL handling will be given over entirely to the program +specified by \*(Aqcustom_url_handler\*(Aq. +.br +Default value: \fBFalse\fP +.RE +.sp +\fBcustom_url_handler\fP = \fIstring\fP +.RS 4 +Specify the path to a program which accepts a URI as an argument and +does something relevant with it. +This option is ignored unless \fBuse_custom_url_handler\fP is set to True. +.RE +.sp +\fBcase_sensitive\fP = \fIboolean\fP +.RS 4 +If set to True, uppercase and lowercase characters will be considered +different when searching text in the terminal. +.br +Default value: \fBTrue\fP +.RE +.sp +\fBinvert_search\fP = \fIboolean\fP +.RS 4 +If set to True, the search direction will be inverted (bottom to top) +when searching text in the terminal. +.br +Default value: \fBFalse\fP +.RE +.sp +\fBenabled_plugins\fP = \fIlist of strings\fP +.RS 4 +Specify which plugins will be loaded by default. All other plugin +classes will be ignored. +.br +Default value: \fB[\*(AqLaunchpadBugURLHandler\*(Aq, \*(AqLaunchpadCodeURLHandler\*(Aq, \*(AqAPTURLHandler\*(Aq]\fP +.RE +.SH "KEYBINDINGS" +.sp +These are the options Terminator currently supports in the \fBkeybindings\fP +section. +.SS "Creation & Destruction" +.sp +\fBsplit_horiz\fP +.RS 4 +Split the current terminal horizontally. +.br +Default value: \fBO\fP +.RE +.sp +\fBsplit_vert\fP +.RS 4 +Split the current terminal vertically. +.br +Default value: \fBE\fP +.RE +.sp +\fBsplit_auto\fP +.RS 4 +Split the current terminal automatically, along the longer side. +.br +Default value: \fBA\fP +.RE +.sp +\fBnew_tab\fP +.RS 4 +Open a new tab. +.br +Default value: \fBT\fP +.RE +.sp +\fBnew_window\fP +.RS 4 +Open a new window as part of the existing process. +.br +Default value: \fBI\fP +.RE +.sp +\fBnew_terminator\fP +.RS 4 +Spawn a new Terminator process. +.br +Default value: \fBI\fP +.RE +.sp +\fBlayout_launcher\fP +.RS 4 +Open the layout launcher. +.br +Default value: \fBL\fP +.RE +.sp +\fBclose_term\fP +.RS 4 +Close the current terminal. +.br +Default value: \fBW\fP +.RE +.sp +\fBclose_window\fP +.RS 4 +Close the current window. +.br +Default value: \fBQ\fP +.RE +.SS "Navigation" +.sp +\fBcycle_next\fP +.RS 4 +Focus the next terminal. This is an alias for \fBgo_next\fP. +.br +Default value: \fBTab\fP +.RE +.sp +\fBcycle_prev\fP +.RS 4 +Focus the previous terminal. This is an alias for \fBgo_prev\fP. +.br +Default value: \fBTab\fP +.RE +.sp +\fBgo_next\fP +.RS 4 +Focus the next terminal. +.br +Default value: \fBN\fP +.RE +.sp +\fBgo_prev\fP +.RS 4 +Focus the previous terminal. +.br +Default value: \fBP\fP +.RE +.sp +\fBgo_up\fP +.RS 4 +Focus the terminal above the current one. +.br +Default value: \fBUp\fP +.RE +.sp +\fBgo_down\fP +.RS 4 +Focus the terminal below the current one. +.br +Default value: \fBDown\fP +.RE +.sp +\fBgo_left\fP +.RS 4 +Focus the terminal to the left of the current one. +.br +Default value: \fBLeft\fP +.RE +.sp +\fBgo_right\fP +.RS 4 +Focus the terminal to the right of the current one. +.br +Default value: \fBRight\fP +.RE +.sp +\fBpage_up\fP +.RS 4 +Scroll the terminal up one page. +.RE +.sp +\fBpage_down\fP +.RS 4 +Scroll the terminal down one page. +.RE +.sp +\fBpage_up_half\fP +.RS 4 +Scroll the terminal up half a page. +.RE +.sp +\fBpage_down_half\fP +.RS 4 +Scroll the terminal down half a page. +.RE +.sp +\fBline_up\fP +.RS 4 +Scroll the terminal up one line. +.RE +.sp +\fBline_down\fP +.RS 4 +Scroll the terminal down one line. +.RE +.sp +\fBnext_tab\fP +.RS 4 +Move to the next tab. +.br +Default value: \fBPage_Down\fP +.RE +.sp +\fBprev_tab\fP +.RS 4 +Move to the previous tab. +.br +Default value: \fBPage_Up\fP +.RE +.sp +\fBswitch_to_tab_1\fP, \fBswitch_to_tab_2\fP, ... \fBswitch_to_tab_10\fP +.RS 4 +Move to the \fBN\fPth tab. +Note that \fB1\fP may be provided as \fB!\fP or similar, +depending on the keyboard layout. +.RE +.SS "Organisation" +.sp +\fBresize_up\fP +.RS 4 +Move the parent dragbar up. +.br +Default value: \fBUp\fP +.RE +.sp +\fBresize_down\fP +.RS 4 +Move the parent dragbar down. +.br +Default value: \fBDown\fP +.RE +.sp +\fBresize_left\fP +.RS 4 +Move the parent dragbar left. +.br +Default value: \fBLeft\fP +.RE +.sp +\fBresize_right\fP +.RS 4 +Move the parent dragbar right. +.br +Default value: \fBRight\fP +.RE +.sp +\fBrotate_cw\fP +.RS 4 +Rotate terminals clockwise. +.br +Default value: \fBR\fP +.RE +.sp +\fBrotate_ccw\fP +.RS 4 +Rotate terminals counter+clockwise. +.br +Default value: \fBR\fP +.RE +.sp +\fBmove_tab_right\fP +.RS 4 +Move the current tab to the right by swapping position with the next +tab. +.br +Default value: \fBPage_Down\fP +.RE +.sp +\fBmove_tab_left\fP +.RS 4 +Move the current tab to the left by swapping position with the previous +tab. +.br +Default value: \fBPage_Up\fP +.RE +.SS "Focus" +.sp +\fBfull_screen\fP +.RS 4 +Toggle window to fullscreen. +.br +Default value: \fBF11\fP +.RE +.sp +\fBtoggle_zoom\fP +.RS 4 +Toggle maximisation of the current terminal. +.br +Default value: \fBX\fP +.RE +.sp +\fBscaled_zoom\fP +.RS 4 +Toggle maximisation of the current terminal and scale the font when +maximised. +.br +Default value: \fBZ\fP +.RE +.sp +\fBhide_window\fP +.RS 4 +Hide/Show all Terminator windows. +.br +Default value: \fBA\fP +.RE +.SS "Grouping & Broadcasting" +.sp +\fBcreate_group\fP +.RS 4 +Create a new group. +.RE +.sp +\fBgroup_all\fP +.RS 4 +Group all terminals together. +.br +Default value: \fBG\fP +.RE +.sp +\fBungroup_all\fP +.RS 4 +Ungroup all terminals. +.RE +.sp +\fBgroup_all_toggle\fP +.RS 4 +Toggle grouping of all terminals. +.RE +.sp +\fBgroup_win\fP +.RS 4 +Group all terminals in the current window together. +.RE +.sp +\fBungroup_win\fP +.RS 4 +Ungroup all terminals in the current window. +.br +Default value: \fBW\fP +.RE +.sp +\fBgroup_win_toggle\fP +.RS 4 +Toggle grouping of all terminals in the current window. +.RE +.sp +\fBgroup_tab\fP +.RS 4 +Group all terminals in the current tab together. +.br +Default value: \fBT\fP +.RE +.sp +\fBungroup_tab\fP +.RS 4 +Ungroup all terminals in the current tab. +.br +Default value: \fBT\fP +.RE +.sp +\fBgroup_tab_toggle\fP +.RS 4 +Toggle grouping of all terminals in the current tab. +.RE +.sp +\fBbroadcast_off\fP +.RS 4 +Turn broadcasting off. +.RE +.sp +\fBbroadcast_group\fP +.RS 4 +Broadcast to all terminals in the same group as the current terminal. +.RE +.sp +\fBbroadcast_all\fP +.RS 4 +Broadcast to all terminals. +.RE +.SS "Miscellaneous" +.sp +\fBhelp\fP +.RS 4 +Open the full HTML manual in the browser. +.br +Default value: \fBF1\fP +.RE +.sp +\fBpreferences\fP +.RS 4 +Open the Preferences window. +.RE +.sp +\fBpreferences_keybindings\fP +.RS 4 +Open the Preferences window and show the Keybindings tab. +.br +Default value: \fBK\fP +.RE +.sp +\fBcopy\fP +.RS 4 +Copy the selected text to the Clipboard. +.br +Default value: \fBC\fP +.RE +.sp +\fBpaste\fP +.RS 4 +Paste the current contents of the Clipboard. +.br +Default value: \fBV\fP +.RE +.sp +\fBpaste_selection\fP +.RS 4 +Paste the current contents of the Primary Selection. +.RE +.sp +\fBtoggle_scrollbar\fP +.RS 4 +Toggle the scrollbar. +.br +Default value: \fBS\fP +.RE +.sp +\fBsearch\fP +.RS 4 +Search for text in the terminal scrollback history. +.br +Default value: \fBF\fP +.RE +.sp +\fBreset\fP +.RS 4 +Reset the terminal state. +.br +Default value: \fBR\fP +.RE +.sp +\fBreset_clear\fP +.RS 4 +Reset the terminal state and clear the terminal window. +.br +Default value: \fBG\fP +.RE +.sp +\fBzoom_in\fP +.RS 4 +Increase the font size by one unit. +.br +Default value: \fBplus\fP +.RE +.sp +\fBzoom_out\fP +.RS 4 +Decrease the font size by one unit. +.br +Default value: \fBminus\fP +.RE +.sp +\fBzoom_normal\fP +.RS 4 +Restore the original font size. +.br +Default value: \fB0\fP +.RE +.sp +\fBzoom_in_all\fP +.RS 4 +Increase the font size by one unit for all terminals. +.RE +.sp +\fBzoom_out_all\fP +.RS 4 +Decrease the font size by one unit for all terminals. +.RE +.sp +\fBzoom_normal_all\fP +.RS 4 +Restore the original font size for all terminals. +.RE +.sp +\fBedit_window_title\fP +.RS 4 +Rename the current window. +.br +Default value: \fBW\fP +.RE +.sp +\fBedit_tab_title\fP +.RS 4 +Rename the current tab. +.br +Default value: \fBA\fP +.RE +.sp +\fBedit_terminal_title\fP +.RS 4 +Rename the current terminal. +.br +Default value: \fBX\fP +.RE +.sp +\fBinsert_number\fP +.RS 4 +Insert the current terminal\(cqs number, i.e. 1 to 12. +.br +Default value: \fB1\fP +.RE +.sp +\fBinsert_padded\fP +.RS 4 +Insert the current terminal\(cqs number, but zero padded, i.e. 01 to 12. +.br +Default value: \fB0\fP +.RE +.sp +\fBnext_profile\fP +.RS 4 +Switch to the next profile. +.RE +.sp +\fBprevious_profile\fP +.RS 4 +Switch to the previous profile. +.RE +.SH "PROFILES" +.sp +These are the options Terminator currently supports in the \fBprofiles\fP +section. Each profile should be its own subsection with a header in the +format \fB[[name]]\fP. +.SS "General" +.sp +\fBallow_bold\fP = \fIboolean\fP +.RS 4 +If set to True, text in the terminal can displayed in bold. +.br +Default value: \fBTrue\fP +.RE +.sp +\fBcopy_on_selection\fP = \fIboolean\fP +.RS 4 +If set to True, text selections will be automatically copied to the +Clipboard, in addition to being copied to the Primary Selection. +.br +Default value: \fBFalse\fP +.RE +.sp +\fBdisable_mousewheel_zoom\fP = \fIboolean\fP +.RS 4 +If set to True, Ctrl+mouse_wheel will not zoom or unzoom the terminal. +.br +Default value: \fBFalse\fP +.RE +.sp +\fBword_chars\fP = \fIstring\fP +.RS 4 +Specify the characters that will be considered part of a single word +when selecting text by word. +Hyphen and alphanumerics do not need to be specified. +Ranges can be given, e.g. "A\-Z". +.br +For example, if \fBword_chars\fP = "," then "foo,bar" is considered a single +word. +.br +Default value: \fB\-,./?%&#:_\fP +.RE +.sp +\fBmouse_autohide\fP = \fIboolean\fP +.RS 4 +If set to True, the mouse pointer will be hidden when typing. +.br +Default value: \fBTrue\fP +.RE +.sp +\fBterm\fP = \fIstring\fP +.RS 4 +Specify the value Terminator will assign to the \*(AqTERM\*(Aq environment +variable. +.br +Default value: \fBxterm\-256color\fP +.RE +.sp +\fBcolorterm\fP = \fIstring\fP +.RS 4 +Specify the value Terminator will assign to the \*(AqCOLORTERM\*(Aq environment +variable. +.br +Default value: \fBtruecolor\fP +.RE +.sp +\fBsplit_to_group\fP = \fIboolean\fP +.RS 4 +If set to True, the terminal created by splitting will be inserted in +the current terminal\(cqs group. +.br +Default value: \fBFalse\fP +.RE +.sp +\fBautoclean_groups\fP = \fIboolean\fP +.RS 4 +If set to True, empty groups will be removed. +.br +Default value: \fBTrue\fP +.RE +.sp +\fBuse_system_font\fP = \fIboolean\fP +.RS 4 +If set to True, the system default font will be used for text in the +terminal. Otherwise, the value of \fBfont\fP will be used. +.br +Default value: \fBTrue\fP +.RE +.sp +\fBfont\fP = \fIstring\fP +.RS 4 +Specify which font to use for text in the terminal. +This option is ignored unless \fBuse_system_font\fP is set to False. +.br +Default value: \fBMono 10\fP +.RE +.sp +\fBcursor_blink\fP = \fIboolean\fP +.RS 4 +If set to True, the cursor will blink when not typing. +.br +Default value: \fBTrue\fP +.RE +.sp +\fBcursor_shape\fP = \fIstring\fP +.RS 4 +Specify the shape of the cursor. +Can be any of: \*(Aqblock\*(Aq, \*(Aqunderline\*(Aq, \*(Aqibeam\*(Aq. +.br +Default value: \fBblock\fP +.RE +.sp +\fBcursor_color_default\fP = \fIboolean\fP +.RS 4 +If set to True, the background and foreground colors of the terminal +will be used as foreground and background colors for the cursor, +respectively. +.br +Default value: \fBTrue\fP +.RE +.sp +\fBcursor_fg_color\fP = \fIcolor string\fP +.RS 4 +Specify the foreground color to use for the cursor. +This option is ignored unless \fBcursor_color_default\fP is set to False. +.RE +.sp +\fBcursor_bg_color\fP = \fIcolor string\fP +.RS 4 +Specify the background color to use for the cursor. +This option is ignored unless \fBcursor_color_default\fP is set to False. +.RE +.sp +\fBaudible_bell\fP = \fIboolean\fP +.RS 4 +If set to True, a sound will be played when an application writes the +escape sequence for the terminal bell. +.br +Default value: \fBFalse\fP +.RE +.sp +\fBvisible_bell\fP = \fIboolean\fP +.RS 4 +If set to True, the terminal will flash when an application writes the +escape sequence for the terminal bell. +.br +Default value: \fBFalse\fP +.RE +.sp +\fBurgent_bell\fP = \fIboolean\fP +.RS 4 +If set to True, the window\(cqs urgency hint will be set when an +application writes the escape sequence for the terminal bell. +.br +Default value: \fBFalse\fP +.RE +.sp +\fBicon_bell\fP = \fIboolean\fP +.RS 4 +If set to True, a small icon will be shown on the terminal titlebar when +an application writes the escape sequence for the terminal bell. +.br +Default value: \fBTrue\fP +.RE +.sp +\fBforce_no_bell\fP = \fIboolean\fP +.RS 4 +If set to True, the terminal bell will be completely disabled. +.br +Default value: \fBFalse\fP +.RE +.SS "Command" +.sp +\fBlogin_shell\fP = \fIboolean\fP +.RS 4 +If set to True, the terminal will run the default shell (or the command +specified by \fBcustom_command\fP) as a login shell. +This means the first argument passed to the shell/command will be \*(Aq\-l\*(Aq. +.br +Default value: \fBFalse\fP +.RE +.sp +\fBuse_custom_command\fP = \fIboolean\fP +.RS 4 +If set to True, the value of \fBcustom_command\fP will be used instead of +the default shell. +.br +Default value: \fBFalse\fP +.RE +.sp +\fBcustom_command\fP = \fIstring\fP +.RS 4 +Specify the command to execute instead of the default shell. +This option is ignored unless \fBuse_custom_command\fP is set to True. +.RE +.sp +\fBexit_action\fP = \fIstring\fP +.RS 4 +Specify the action to perform when the terminal is closed. +\*(Aqclose\*(Aq to remove the terminal. +\*(Aqrestart\*(Aq to restart the shell (or the command specified by +\fBcustom_command\fP). +\*(Aqhold\*(Aq to keep the terminal open, even if the process in it has +terminated. +.br +Default value: \fBclose\fP +.RE +.SS "Colors" +.sp +\fBuse_theme_colors\fP = \fIboolean\fP +.RS 4 +If set to True, the theme\(cqs foreground and background colors will be +used for the terminal. Otherwise, the values of \fBforeground_color\fP and +\fBbackground_color\fP will be used. +.br +Default value: \fBFalse\fP +.RE +.sp +\fBforeground_color\fP = \fIcolor string\fP +.RS 4 +Specify the foreground color to use for the terminal. +This option is ignored unless \fBuse_theme_colors\fP is set to False. +.br +Default value: \fB#AAAAAA\fP +.RE +.sp +\fBbackground_color\fP = \fIcolor string\fP +.RS 4 +Specify the background color to use for the terminal. +This option is ignored unless \fBuse_theme_colors\fP is set to False. +.br +Default value: \fB#000000\fP +.RE +.sp +\fBpalette\fP = \fIstring list of colors\fP +.RS 4 +Specify the 16\-color palette to use for the terminal. +The value must be a string containing a colon\-separated list of colors +in hex format. +.br +For example, "#000000:#cd0000:#00cd00: ... ". +.RE +.sp +\fBbold_is_bright\fP = \fIboolean\fP +.RS 4 +If set to True, bold text will have brighter colors. +.br +Default value: \fBFalse\fP +.RE +.SS "Background" +.sp +\fBbackground_darkness\fP = \fIfloat\fP +.RS 4 +Specify the transparency of the background color. +The value must be between 0.0 and 1.0. +This option is ignored unless \fBbackground_type\fP is set to \*(Aqtransparent\*(Aq +or \*(Aqimage\*(Aq. +.br +Default value: \fB0.5\fP +.RE +.sp +\fBbackground_type\fP = \fIstring\fP +.RS 4 +Specify what type of background the terminal will have. +\*(Aqsolid\*(Aq for a solid (opaque) background. +\*(Aqtransparent\*(Aq for a transparent background. +\*(Aqimage\*(Aq for a background image. +.br +If this is set to \*(Aqtransparent\*(Aq, the transparency of the background will +be the value of \fBbackground_darkness\fP. +If this is set to \*(Aqimage\*(Aq, the image specified by \fBbackground_image\fP +will be the background; the background color will then be drawn on top +of it, with a transparency specified by \fBbackground_darkness\fP. +.br +Default value: \fBsolid\fP +.RE +.sp +\fBbackground_image\fP = \fIpath string\fP +.RS 4 +Specify the path to an image that will be used as background. +This option is ignored unless \fBbackground_type\fP is set to \*(Aqimage\*(Aq. +.RE +.sp +\fBbackground_image_mode\fP = \fIstring\fP +.RS 4 +Specify how the background image will be drawn. +\*(Aqstretch_and_fill\*(Aq to fill the terminal entirely, without necessarily +maintaining aspect ratio. +\*(Aqscale_and_fit\*(Aq to fit the image inside the terminal, eventually leaving +blank bars, while maintaining aspect ratio. +\*(Aqscale_and_crop\*(Aq to fill the terminal entirely, eventually cropping the +image, while maintaining aspect ratio. +\*(Aqtiling\*(Aq to repeat the image as to fill the terminal. +This option is ignored unless \fBbackground_type\fP is set to \*(Aqimage\*(Aq. +.br +Default value: \fBstretch_and_fill\fP +.RE +.sp +\fBbackground_image_align_horiz\fP = \fIstring\fP +.RS 4 +Specify the horizontal alignment of the background image. +Can be any of: \*(Aqleft\*(Aq, \*(Aqcenter\*(Aq, \*(Aqright\*(Aq. +This option is ignored unless \fBbackground_type\fP is set to \*(Aqimage\*(Aq. +.br +Default value: \fBcenter\fP +.RE +.sp +\fBbackground_image_align_vert\fP = \fIstring\fP +.RS 4 +Specify the vertical alignment of the background image. +Can be any of: \*(Aqtop\*(Aq, \*(Aqmiddle\*(Aq, \*(Aqbottom\*(Aq. +This option is ignored unless \fBbackground_type\fP is set to \*(Aqimage\*(Aq. +.br +Default value: \fBmiddle\fP +.RE +.SS "Scrolling" +.sp +\fBscrollbar_position\fP = \fIstring\fP +.RS 4 +Specify where the terminal scrollbar is put. +Can be any of: \*(Aqleft\*(Aq, \*(Aqright\*(Aq, \*(Aqhidden\*(Aq. +.br +Default value: \fBright\fP +.RE +.sp +\fBscroll_on_output\fP = \fIboolean\fP +.RS 4 +If set to True, the terminall will scroll to the bottom when an +application writes text to it. +.br +Default value: \fBFalse\fP +.RE +.sp +\fBscroll_on_keystroke\fP = \fIboolean\fP +.RS 4 +If set to True, the terminal will scroll to the bottom when typing. +.br +Default value: \fBTrue\fP +.RE +.sp +\fBscrollback_infinite\fP = \fIboolean\fP +.RS 4 +If set to True, the terminal will keep the entire scrollback history. +.br +Default value: \fBFalse\fP +.RE +.sp +\fBscrollback_lines\fP = \fIinteger\fP +.RS 4 +Specify how many lines of scrollback history will be kept by the +terminal. Lines that don\(cqt fit in the scrollback history will be +discarted. Note that setting large values can slow down rewrapping and +resizing. +This option is ignored unless \fBscrollback_infinite\fP is set to False. +.br +Default value: \fB500\fP +.RE +.SS "Compatibility" +.sp +\fBbackspace_binding\fP = \fIstring\fP +.RS 4 +Specify what code will be generated by the backspace key. +The value can be: +\*(Aqascii\-del\*(Aq for the ASCII DEL character; +\*(Aqcontrol\-h\*(Aq for the ASCII BS character (Ctrl+H); +\*(Aqescape\-sequence\*(Aq for the escape sequence typically bound to backspace +or delete; +\*(Aqautomatic\*(Aq for letting the terminal automatically decide the character +sequence to use. +.br +Default value: \fBascii\-del\fP +.RE +.sp +\fBdelete_binding\fP = \fIstring\fP +.RS 4 +Specify what code will be generated by the delete key. +The value can be: +\*(Aqascii\-del\*(Aq for the ASCII DEL character; +\*(Aqcontrol\-h\*(Aq for the ASCII BS character (Ctrl+H); +\*(Aqescape\-sequence\*(Aq for the escape sequence typically bound to backspace +or delete; +\*(Aqautomatic\*(Aq for letting the terminal automatically decide the character +sequence to use. +.br +Default value: \fBescape\-sequence\fP +.RE +.SS "Titlebar" +.sp +\fBshow_titlebar\fP = \fIboolean\fP +.RS 4 +If set to True, the terminal will have a titlebar showing the current +title of that terminal. +.br +Default value: \fBTrue\fP +.RE +.sp +\fBtitle_hide_sizetext\fP = \fIboolean\fP +.RS 4 +If set to True, the size of the terminal will not be written on its +titlebar. +.br +Default value: \fBFalse\fP +.RE +.sp +\fBtitle_use_system_font\fP = \fIboolean\fP +.RS 4 +If set to True, the system default font will be used for text in the +terminal\(cqs titlebar. Otherwise, the value of \fBtitle_font\fP will be used. +.br +Default value: \fBTrue\fP +.RE +.sp +\fBtitle_font\fP = \fIstring\fP +.RS 4 +Specify which font to use for text in the terminal\(cqs titlebar. +This option is ignored unless \fBtitle_use_system_font\fP is set to False. +.br +Default value: \fBSans 9\fP +.RE +.sp +\fBtitle_transmit_fg_color\fP = \fIcolor string\fP +.RS 4 +Specify the foreground color to use for the terminal\(cqs titlebar in case +the terminal is focused. +.br +Default value: \fB#ffffff\fP +.RE +.sp +\fBtitle_transmit_bg_color\fP = \fIcolor string\fP +.RS 4 +Specify the background color to use for the terminal\(cqs titlebar in case +the terminal is focused. +.br +Default value: \fB#c80003\fP +.RE +.sp +\fBtitle_inactive_fg_color\fP = \fIcolor string\fP +.RS 4 +Specify the foreground color to use for the terminal\(cqs titlebar in case +the terminal is unfocused. +.br +Default value: \fB#000000\fP +.RE +.sp +\fBtitle_inactive_bg_color\fP = \fIcolor string\fP +.RS 4 +Specify the background color to use for the terminal\(cqs titlebar in case +the terminal is unfocused. +.br +Default value: \fB#c0bebf\fP +.RE +.sp +\fBtitle_receive_fg_color\fP = \fIcolor string\fP +.RS 4 +Specify the foreground color to use for the terminal\(cqs titlebar in case +the terminal is in a group and is receiving input while unfocused. +.br +Default value: \fB#ffffff\fP +.RE +.sp +\fBtitle_receive_bg_color\fP = \fIcolor string\fP +.RS 4 +Specify the background color to use for the terminal\(cqs titlebar in case +the terminal is in a group and is receiving input while unfocused. +.br +Default value: \fB#0076c9\fP +.RE +.SH "LAYOUTS" +.sp +The \fBlayouts\fP section contains all the saved layouts. Each layout should +be its own subsection with a header in the format \fB[[name]]\fP. +.sp +Each object in a layout is a named sub\-sub\-section with various +properties. +.sp +\fBtype\fP = \fIstring\fP +.RS 4 +Can be any of: \*(AqWindow\*(Aq, \*(AqNotebook\*(Aq, \*(AqHPaned\*(Aq, \*(AqVPaned\*(Aq, \*(AqTerminal\*(Aq. +.RE +.sp +\fBparent\fP = \fIstring\fP +.RS 4 +Specify which object is the parent of the component being defined. +All objects, except those of type Window, must specify a parent. +.RE +.sp +This is an example of a \fBlayouts\fP section containing only the layout +named "default". +.sp +.if n .RS 4 +.nf +.fam C +[layouts] + [[default]] + [[[window0]]] + type = Window + parent = "" + [[[child1]]] + type = Terminal + parent = window0 +.fam +.fi +.if n .RE +.SH "PLUGINS" +.sp +Terminator plugins can add their own configuration to the config file, +and it will appear as a subsection. Please refer to the documentation of +individual plugins for more information. .SH "SEE ALSO" -.TP -\fBterminator\fP(1), http://www.voidspace.org.uk/python/configobj.html +.sp +\fBterminator\fP(1), \c +.URL "https://configobj.readthedocs.io/" "" "" \ No newline at end of file