← Back to branch summary

~ubuntu-branches/ubuntu/saucy/terminator/saucy

« back to all changes in this revision

Viewing changes to doc/terminator_config.5

  • Committer: Bazaar Package Importer
  • Author(s): Nicolas Valcárcel Scerpella (Canonical)
  • Date: 2010-04-07 17:10:31 UTC
  • mfrom: (1.1.7 upstream)
  • Revision ID: james.westby@ubuntu.com-20100407171031-35nsuj0tmbub0bj5
Tags: 0.92-0ubuntu1
http://bugs.debian.org/567967
* New upstream release
* Remove python-xdg from Recommends. (Closes: #567967)
* Downgrade python-gnome2 to Recommends.
* Update python-gtk2 dependency to (>= 2.14.0)
* Add python-keybinder to Recommends

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/terminator_config.5
3
3
~/.config/terminator/config \- the config file for Terminator terminal emulator.
4
4
.SH "DESCRIPTION"
5
5
This manual page documents briefly the
6
 
.B Terminator config file.
 
6
.B Terminator
 
7
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.
7
8
.PP
8
 
\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.
9
9
.SH "FILE LOCATION"
10
10
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)
11
11
.SH "FILE FORMAT"
12
12
This is what a Terminator config file should look like:
13
13
 
14
14
  # This is a comment
15
 
  font = Fixed 10
16
 
  background_color = #000000
17
 
  foreground_color = "#FFFFFF" #Another comment. Quotes can be used for any value
18
 
  scrollback_lines = "500" #More comment. Single quotes are valid too
19
 
  cursor_blink = True
20
 
  custom_command = "echo \\"foo#bar\\"" #Final comment - this will work as expected.
21
 
  
 
15
  [global_config]
 
16
    focus = system
 
17
 
22
18
  [keybindings]
23
 
  full_screen = <Ctrl><Shift>F11
24
 
 
25
 
.SH "OPTIONS"
26
 
These are the options Terminator currently supports:
27
 
.TP
28
 
.B allow_bold\fR (boolean)
29
 
If true, allow applications in the terminal to make text boldface.
30
 
Default value: \fBTrue\fR
31
 
.TP
32
 
.B enable_real_transparency\fR (boolean)
33
 
If true, Terminator will try to use real transparency if possible.
34
 
Default value: \fBFalse\fR
35
 
.TP
36
 
\fBNOTE:\fR To enable transparency you should also see the \fBbackground_type\fR and \fBbackground_darkness\fR settings below.
37
 
.TP
38
 
.B audible_bell\fR (boolean)
39
 
If true, make a noise when applications send the escape sequence for the terminal bell.
40
 
Default value: \fBTrue\fR
41
 
.TP
42
 
.B visible_bell\fR (boolean)
43
 
If true, flash the terminal when applications send the escape sequence for the terminal bell.
44
 
Default value: \fBFalse\fR
45
 
.TP
46
 
.B urgent_bell\fR (boolean)
47
 
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.
48
 
Default value: \fBFalse\fR
49
 
.TP
50
 
.B force_no_bell\fR (boolean)
51
 
If true, don't make a noise or flash. All terminal bells will be ignored.
52
 
Default value: \fBFalse\fR
53
 
.TP
54
 
.B use_theme_colors
55
 
If true, ignore the configured colours and use values from the theme instead.
56
 
Default value: \fBFalse\fR
57
 
.TP
58
 
.B background_color
59
 
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.
60
 
Default value: \fB#000000\fR
61
 
.TP
62
 
.B background_darkness
63
 
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.
64
 
Default value: \fB0.5\fR
65
 
.TP
66
 
.B background_type
67
 
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.
68
 
Default value: \fBsolid\fR
69
 
.TP
70
 
.B background_image
71
 
Path to an image file to be used for the background of terminals.
72
 
Default value: Nothing
73
 
.TP
74
 
.B backspace_binding
75
 
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.
76
 
Default value: \fBascii\-del\fR
77
 
.TP
78
 
.B delete_binding
79
 
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.
80
 
Default value: \fBescape\-sequence\fR
81
 
.TP
82
 
.B cursor_blink \fR(boolean)
83
 
Controls if the cursor blinks.
84
 
Default value: \fBTrue\fR
85
 
.TP
86
 
.B cursor_color
87
 
Default colour of cursor, as a colour specification (can be HTML-style hex digits, or a colour name such as "red").
88
 
Default value: Current value of \fBforeground_color\fR
89
 
.TP
90
 
.B cursor_shape
91
 
Default shape of cursor. Possibilities are "block", "ibeam", and "underline".
92
 
Default value: \fBblock\fR
93
 
.TP
94
 
.B emulation
95
 
Sets what type of terminal should be emulated.
96
 
Default value: \fBxterm\fR
97
 
.TP
98
 
.B geometry_hinting
99
 
If True the window will resize in step with font sizes, if False it will follow pixels
100
 
Default value: \fBTrue\fR
101
 
.TP
102
 
.B font
103
 
An Pango font name. Examples are "Sans 12" or "Monospace Bold 14".
104
 
Default value: \fBMono 8\fR
105
 
.TP
106
 
.B foreground_color
107
 
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.
108
 
Default value: \fB#AAAAAA\fR
109
 
.TP
110
 
.B scrollbar_position
111
 
Where to put the terminal scrollbar. Possibilities are "left", "right", and "disabled".
112
 
Default value: \fBright\fR
113
 
.TP
114
 
.B titlebars
115
 
If true, a titlebar will be drawn for each terminal which shows the current title of that terminal.
116
 
Default value: \fBTrue\fR
117
 
.TP
118
 
.B titlebarzoomed
119
 
If true, a titlebar will be drawn on zoomed/maximised terminals which indicates how many are hidden.
120
 
Default value: \fBTrue\fR
121
 
.TP
122
 
.B titletips
123
 
If true, a tooltip will be available for each terminal which shows the current title of that terminal.
124
 
Default value: \fBFalse\fR
125
 
.TP
126
 
.B title_tx_txt_color
127
 
Sets the colour of the text shown in the titlebar of the active terminal.
128
 
Default value: \fB#FFFFFF\fR
129
 
.TP
130
 
.B title_tx_bg_color
131
 
Sets the colour of the background of the titlebar in the active terminal.
132
 
Default value: \fB#C80003\fR
133
 
.TP
134
 
.B title_rx_txt_color
135
 
Sets the colour of the text shown in the titlebar of any terminal that \fBwill\fR receive input from the active terminal.
136
 
Default value: \fB#FFFFFF\fR
137
 
.TP
138
 
.B title_rx_bg_color
139
 
Sets the colour of the background of the titlebar of any terminal that \fBwill\fR receive input from the active terminal.
140
 
Default value: \fB#0076C9\fR
141
 
.TP
142
 
.B title_ia_txt_color
143
 
Sets the colour of the text shown in the titlebar of any terminal that will \fBnot\fR receive input from the active terminal.
144
 
Default value: \fB#000000\fR
145
 
.TP
146
 
.B title_ia_bg_color
147
 
Sets the colour of the background of the titlebar of any terminal that will \fBnot\fR receive input from the active terminal.
148
 
Default value: \fB#C0BEBF\fR
149
 
.TP
150
 
.B scroll_background \fR(boolean)
151
 
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.
152
 
Default value: \fBTrue\fR
153
 
.TP
154
 
.B scroll_on_keystroke \fR(boolean)
155
 
If true, pressing a key jumps the scrollbar to the bottom.
156
 
Default value: \fBTrue\fR
157
 
.TP
158
 
.B scroll_on_output \fR(boolean)
159
 
If true, whenever there's new output the terminal will scroll to the bottom.
160
 
Default value: \fBTrue\fR
161
 
.TP
162
 
.B alternate_screen_scroll \fR(boolean)
163
 
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.
164
 
Default value: \fBTrue\fR
165
 
.TP
166
 
.B scrollback_lines
167
 
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.
168
 
Default value: \fB500\fR
 
19
    full_screen = <Ctrl><Shift>F11
 
20
 
 
21
  [profiles]
 
22
    [[default]]
 
23
      font = Fixed 10
 
24
      background_color = "#000000" # A comment
 
25
      foreground_color = "#FFFFFF" # Note that hex colour values must be quoted
 
26
      scrollback_lines = '500' #More comment. Single quotes are valid too
 
27
      cursor_blink = True
 
28
      custom_command = "echo \\"foo#bar\\"" #Final comment - this will work as expected.
 
29
 
 
30
Below are the individual sections that can exist in the config file:
 
31
 
 
32
.SH "global_config"
 
33
These are the options Terminator currently supports in the global_config section:
169
34
.TP
170
35
.B focus
171
 
Sets what type of mouse events should determine terminal focus. Can be "sloppy" or "click". "mouse" is also interpreted as "sloppy".
 
36
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.
172
37
Default value: \fBclick\fR
173
38
.TP
174
 
.B focus_on_close
175
 
Sets which terminal should get the focus when another terminal is closed. Values can be "prev", "next" or "auto".
176
 
Using "auto", if the closed terminal is within a splitted window, the focus will be on the sibling terminal rather than another tab.
177
 
Default value: \fBauto\fR
178
 
.TP
179
 
.B exit_action
180
 
Possible values are "close" to close the terminal, and "restart" to restart the command.
181
 
Default value: \fBclose\fR
182
 
.TP
183
 
.B palette
184
 
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".
185
 
Default value: \fB#000000000000:#CDCD00000000:#0000CDCD0000:#CDCDCDCD0000:#30BF30BFA38E:#A53C212FA53C:#0000CDCDCDCD:#FAFAEBEBD7D7:#404040404040:#FFFF00000000:#0000FFFF0000:#FFFFFFFF0000:#00000000FFFF:#FFFF0000FFFF:#0000FFFFFFFF:#FFFFFFFFFFFF\fR
186
 
.TP
187
 
.B word_chars
188
 
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.
189
 
Default value: \fB\-A\-Za\-z0\-9,./?%&#:_\fR
190
 
.TP
191
 
.B mouse_autohide \fR(boolean)
192
 
Controls whether the mouse cursor should be hidden while typing.
193
 
Default value: \fBTrue\fR
194
 
.TP
195
 
.B use_custom_command \fR(boolean)
196
 
If True, the value of \fBcustom_command\fR will be used instead of the default shell.
197
 
Default value: \fBFalse\fR
198
 
.TP
199
 
.B custom_command
200
 
Command to execute instead of the default shell, if \fBuse_custom_command\fR is set to True.
201
 
Default value: Nothing
202
 
.TP
203
 
.B http_proxy
204
 
URL of an HTTP proxy to use, e.g. http://proxy.lan:3128/
205
 
Default value: Nothing
206
 
.TP
207
 
.B encoding
208
 
Character set to use for the terminal.
209
 
Default value: \fBUTF-8\fR
210
 
.TP
211
 
.B fullscreen \fR(boolean)
212
 
Controls whether the Terminator window will be started in fullscreen mode
213
 
Default value: \fBFalse\fR
214
 
.TP
215
 
.B maximise \fR(boolean)
216
 
Controls whether the Terminator window will be started maximised
217
 
Default value: \fBFalse\fR
218
 
.TP
219
 
.B borderless \fR(boolean)
220
 
Controls whether the Terminator window will be started without window borders
221
 
Default value: \fBFalse\fR
222
 
.TP
223
 
.B hidden \fR(boolean)
224
 
Hides the Terminator window by default. Its visibility can be toggled with the \fBhide_window\fR keybinding (Ctrl-Shift-Alt-a by default)
225
 
Default value: \fBFalse\fR
226
 
.TP
227
39
.B handle_size
228
40
Controls the width of the separator between terminals. Anything outside the range 0-5 (inclusive) will be ignored and use your default theme value.
229
41
Default value: \fB-1\fR
230
42
.TP
231
 
.B f11_modifier \fR(boolean)
232
 
DEPRECATED. This option will disappear by 1.0. See \fB[keybindings]\fR instead.
233
 
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.
 
43
.B geometry_hinting
 
44
If True the window will resize in step with font sizes, if False it will follow pixels
 
45
Default value: \fBTrue\fR
 
46
.TP
 
47
.B window_state
 
48
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.
 
49
Default value: \fBnormal\fR
 
50
.TP
 
51
.B borderless \fR(boolean)
 
52
Controls whether the Terminator window will be started without window borders
234
53
Default value: \fBFalse\fR
235
54
.TP
236
 
.B cycle_term_tab \fR(boolean)
237
 
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.
238
 
Default value: \fBTrue\fR
239
 
.TP
240
 
.B close_button_on_tab \fR(boolean)
241
 
If set to True, tabs will have a close button on them.
242
 
Default value: \fBTrue\fR
243
 
.TP
244
55
.B tab_position
245
56
Defines where tabs are placed.  Can be any of: top, left, right, bottom.
246
57
Default value: \fBtop\fR
247
58
.TP
248
 
.B extreme_tabs \fR(boolean)
249
 
If set to True, tabs can be created within other tabs. Be warned that this can be very confusing and hard to use.
250
 
Default value: \fBFalse\fR
 
59
.B close_button_on_tab \fR(boolean)
 
60
If set to True, tabs will have a close button on them.
 
61
Default value: \fBTrue\fR
251
62
.TP
252
63
.B hide_tabbar \fR(boolean)
253
64
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.
257
68
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.
258
69
Default value: \fBFalse\fR
259
70
.TP
260
 
.B copy_on_selection \fR(boolean)
261
 
If set to True, text selections will be automatically copied to the clipboard, in addition to being made the Primary selection.
262
 
Default value: \fBFalse\fR
263
 
.TP
264
71
.B try_posix_regexp \fR(boolean)
265
72
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).
266
73
Default value: \fBFalse\fR on Linux, \fBTrue\fR otherwise.
267
 
.SH "KEYBINDINGS"
268
 
The following actions can have their keyboard shortcut configured in the config file in a section labelled \fB[keybindings]\fR:
 
74
.TP
 
75
.B title_transmit_fg_color
 
76
Sets the colour of the text shown in the titlebar of the active terminal.
 
77
Default value: \fB'#FFFFFF'\fR
 
78
.TP
 
79
.B title_transmit_bg_color
 
80
Sets the colour of the background of the titlebar in the active terminal.
 
81
Default value: \fB'#C80003'\fR
 
82
.TP
 
83
.B title_receive_fg_color
 
84
Sets the colour of the text shown in the titlebar of any terminal that \fBwill\fR receive input from the active terminal.
 
85
Default value: \fB'#FFFFFF'\fR
 
86
.TP
 
87
.B title_receive_bg_color
 
88
Sets the colour of the background of the titlebar of any terminal that \fBwill\fR receive input from the active terminal.
 
89
Default value: \fB'#0076C9'\fR
 
90
.TP
 
91
.B title_inactive_fg_color
 
92
Sets the colour of the text shown in the titlebar of any terminal that will \fBnot\fR receive input from the active terminal.
 
93
Default value: \fB'#000000'\fR
 
94
.TP
 
95
.B title_inactive_bg_color
 
96
Sets the colour of the background of the titlebar of any terminal that will \fBnot\fR receive input from the active terminal.
 
97
Default value: \fB'#C0BEBF'\fR
 
98
.TP
 
99
.B disabled_plugins
 
100
A list of plugins which should not be loaded by default.
 
101
Default value: \fB"TestPlugin, CustomCommandsMenu"\fR
 
102
 
 
103
.SH keybindings
 
104
These are the options Terminator currently supports in the keybindings section:
269
105
.TP
270
106
.B zoom_in
271
107
Make font one unit larger.
283
119
Open a new tab.
284
120
Default value: \fB<Ctrl><Shift>T\fR
285
121
.TP
286
 
.B new_root_tab
287
 
Open a new tab at the root of the window (only useful if you use the \fBextreme_tabs\fR option).
288
 
Default value: \fB<Ctrl><Shift><Alt>T\fR
 
122
.B cycle_next
 
123
Cycle forwards through the tabs.
 
124
Default value: \fB<Ctrl>Tab\fR
289
125
.TP
 
126
.B cycle_prev
 
127
Cycle backwards through the tabs.
 
128
Default value: \fB<Ctrl><Shift>Tab\fR
290
129
.B go_next
291
130
Move cursor focus to the next tab.
292
 
Default values: \fB<Ctrl><Shift>N\fR and \fB<Ctrl>Tab\fR
 
131
Default value: \fB<Ctrl><Shift>N\fR
293
132
.TP
294
133
.B go_prev
295
134
Move cursor focus to the previous tab.
296
 
Default values: \fB<Ctrl><Shift>P\fR and \fB<Ctrl><Shift>Tab\fR
 
135
Default value: \fB<Ctrl><Shift>P\fR
297
136
.TP
298
137
.B go_up
299
138
Move cursor focus to the terminal above.
401
240
Reset the terminal state and clear the terminal window.
402
241
Default value: \fB<Ctrl><Shift>G\fR
403
242
.TP
 
243
.B hide_window
 
244
Toggle visibility of the Terminator window.
 
245
Default value: \fB<Ctrl><Shift><Alt>a\fR
 
246
.TP
404
247
.B group_all
405
248
Group all terminals together so input sent to one goes to all of them.
406
249
Default value: \fB<Super>g\fR
418
261
Default value: \fB<Super><Shift>T\fR
419
262
.TP
420
263
.B new_window
421
 
Spawn a new instance of Terminator and thus get a new window.
 
264
Open a new Terminator window as part of the existing process.
422
265
Default value: \fB<Ctrl><Shift>I\fR
 
266
.TP
 
267
.B new_terminator
 
268
Spawn a new instance of Terminator.
 
269
Default value: \fB<Super>i\fR
 
270
 
 
271
.SH profiles
 
272
These are the options Terminator currently supports in the profiles section.
 
273
Each profile should be its own subsection with a header in the format \fB[[name]]\fR
 
274
 
 
275
.B allow_bold\fR (boolean)
 
276
If true, allow applications in the terminal to make text boldface.
 
277
Default value: \fBTrue\fR
 
278
.TP
 
279
.B audible_bell\fR (boolean)
 
280
If true, make a noise when applications send the escape sequence for the terminal bell.
 
281
Default value: \fBFalse\fR
 
282
.TP
 
283
.B visible_bell\fR (boolean)
 
284
If true, flash the terminal when applications send the escape sequence for the terminal bell.
 
285
Default value: \fBFalse\fR
 
286
.TP
 
287
.B urgent_bell\fR (boolean)
 
288
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.
 
289
Default value: \fBFalse\fR
 
290
.TP
 
291
.B icon_bell\fR (boolean)
 
292
If true, briefly show a small icon on the terminal title bar for the terminal bell.
 
293
Default value: \fBTrue\fR
 
294
.TP
 
295
.B force_no_bell\fR (boolean)
 
296
If true, don't make a noise or flash. All terminal bells will be ignored.
 
297
Default value: \fBFalse\fR
 
298
.TP
 
299
.B use_theme_colors
 
300
If true, ignore the configured colours and use values from the theme instead.
 
301
Default value: \fBFalse\fR
 
302
.TP
 
303
.B background_color
 
304
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.
 
305
Default value: \fB'#000000'\fR
 
306
.TP
 
307
.B background_darkness
 
308
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.
 
309
Default value: \fB0.5\fR
 
310
.TP
 
311
.B background_type
 
312
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.
 
313
Default value: \fBsolid\fR
 
314
.TP
 
315
.B background_image
 
316
Path to an image file to be used for the background of terminals.
 
317
Default value: Nothing
 
318
.TP
 
319
.B backspace_binding
 
320
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.
 
321
Default value: \fBascii\-del\fR
 
322
.TP
 
323
.B delete_binding
 
324
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.
 
325
Default value: \fBescape\-sequence\fR
 
326
.TP
 
327
.B color_scheme \fR(boolean)
 
328
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'.
 
329
Default value: \fRgrey_on_black\fR
 
330
.TP
 
331
.B cursor_blink \fR(boolean)
 
332
Controls if the cursor blinks.
 
333
Default value: \fBTrue\fR
 
334
.TP
 
335
.B cursor_color
 
336
Default colour of cursor, as a colour specification (can be HTML-style hex digits, or a colour name such as "red").
 
337
Default value: Current value of \fBforeground_color\fR
 
338
.TP
 
339
.B cursor_shape
 
340
Default shape of cursor. Possibilities are "block", "ibeam", and "underline".
 
341
Default value: \fBblock\fR
 
342
.TP
 
343
.B emulation
 
344
Sets what type of terminal should be emulated.
 
345
Default value: \fBxterm\fR
 
346
.TP
 
347
.B use_system_font
 
348
Whether or not to use the GNOME default monospace font for terminals.
 
349
Default value: \fBTrue\fR
 
350
.TP
 
351
.B font
 
352
An Pango font name. Examples are "Sans 12" or "Monospace Bold 14".
 
353
Default value: \fBMono 8\fR
 
354
.TP
 
355
.B foreground_color
 
356
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.
 
357
Default value: \fB'#AAAAAA'\fR
 
358
.TP
 
359
.B scrollbar_position
 
360
Where to put the terminal scrollbar. Possibilities are "left", "right", and "disabled".
 
361
Default value: \fBright\fR
 
362
.TP
 
363
.B show_titlebar
 
364
If true, a titlebar will be drawn for each terminal which shows the current title of that terminal.
 
365
Default value: \fBTrue\fR
 
366
.TP
 
367
.B scroll_background \fR(boolean)
 
368
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.
 
369
Default value: \fBTrue\fR
 
370
.TP
 
371
.B scroll_on_keystroke \fR(boolean)
 
372
If true, pressing a key jumps the scrollbar to the bottom.
 
373
Default value: \fBTrue\fR
 
374
.TP
 
375
.B scroll_on_output \fR(boolean)
 
376
If true, whenever there's new output the terminal will scroll to the bottom.
 
377
Default value: \fBTrue\fR
 
378
.TP
 
379
.B alternate_screen_scroll \fR(boolean)
 
380
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.
 
381
Default value: \fBTrue\fR
 
382
.TP
 
383
.B scrollback_lines
 
384
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.
 
385
Default value: \fB500\fR
 
386
.TP
 
387
.B scrollback_infinite
 
388
If this is set to True, scrollback_lines will be ignored and VTE will continue to allocate RAM for scrollback history.
 
389
Default value: \fBFalse\fR
 
390
.TP
 
391
.B focus_on_close
 
392
Sets which terminal should get the focus when another terminal is closed. Values can be "prev", "next" or "auto".
 
393
Using "auto", if the closed terminal is within a splitted window, the focus will be on the sibling terminal rather than another tab.
 
394
Default value: \fBauto\fR
 
395
.TP
 
396
.B exit_action
 
397
Possible values are "close" to close the terminal, and "restart" to restart the command.
 
398
Default value: \fBclose\fR
 
399
.TP
 
400
.B palette
 
401
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".
 
402
Default value: \fB'#000000000000:#CDCD00000000:#0000CDCD0000:#CDCDCDCD0000:#30BF30BFA38E:#A53C212FA53C:#0000CDCDCDCD:#FAFAEBEBD7D7:#404040404040:#FFFF00000000:#0000FFFF0000:#FFFFFFFF0000:#00000000FFFF:#FFFF0000FFFF:#0000FFFFFFFF:#FFFFFFFFFFFF'\fR
 
403
.TP
 
404
.B word_chars
 
405
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.
 
406
Default value: \fB'\-A\-Za\-z0\-9,./?%&#:_'\fR
 
407
.TP
 
408
.B mouse_autohide \fR(boolean)
 
409
Controls whether the mouse cursor should be hidden while typing.
 
410
Default value: \fBTrue\fR
 
411
.TP
 
412
.B use_custom_command \fR(boolean)
 
413
If True, the value of \fBcustom_command\fR will be used instead of the default shell.
 
414
Default value: \fBFalse\fR
 
415
.TP
 
416
.B custom_command
 
417
Command to execute instead of the default shell, if \fBuse_custom_command\fR is set to True.
 
418
Default value: Nothing
 
419
.TP
 
420
.B http_proxy
 
421
URL of an HTTP proxy to use, e.g. http://proxy.lan:3128/
 
422
Default value: Nothing
 
423
.TP
 
424
.B encoding
 
425
Character set to use for the terminal.
 
426
Default value: \fBUTF-8\fR
 
427
.TP
 
428
.B copy_on_selection \fR(boolean)
 
429
If set to True, text selections will be automatically copied to the clipboard, in addition to being made the Primary selection.
 
430
Default value: \fBFalse\fR
 
431
.TP
 
432
 
 
433
.SH layouts
 
434
 
 
435
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.
 
436
 
 
437
Each object in a layout is a named sub-sub-section with various properties:
 
438
 
 
439
[layouts]
 
440
  [[default]]
 
441
    [[window0]]
 
442
      type = Window
 
443
    [[child1]]
 
444
      type = Terminal
 
445
      parent = window0
 
446
 
 
447
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.
 
448
 
 
449
.SH plugins
 
450
 
 
451
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.
 
452
 
423
453
.SH "SEE ALSO"
424
 
.BR gnome\-terminal(1)
 
454
.BR gnome\-terminal(1), http://www.voidspace.org.uk/python/configobj.html