~ubuntu-branches/ubuntu/precise/terminator/precise

« back to all changes in this revision

Viewing changes to doc/terminator_config.5

  • Committer: Bazaar Package Importer
  • Author(s): Nicolas Valcárcel
  • Date: 2008-07-08 07:24:49 UTC
  • mfrom: (1.1.2 upstream)
  • Revision ID: james.westby@ubuntu.com-20080708072449-n7ey6xc46bo9lo2x
Tags: 0.9-1
New upstream release. (Closes: #489858)

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.TH "TERMINATOR_CONFIG" "5" "Feb 22, 2008" "Nicolas Valcarcel <nvalcarcel@ubuntu.com>" ""
 
2
.SH "NAME"
 
3
${XDG_CONFIG_HOME}/terminator/config (usually ~/.config/terminator/config)
 
4
\- the config file for Terminator terminal emulator.
 
5
.SH "DESCRIPTION"
 
6
This manual page documents briefly the
 
7
.B Terminator config file.
 
8
.PP
 
9
\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.
 
10
 
 
11
The options can be defined one per line in the form: \fBOPTION = VALUE\fR.
 
12
.SH "OPTIONS"
 
13
.TP
 
14
.B allow_bold\fR (boolean)
 
15
If true, allow applications in the terminal to make text boldface.
 
16
Default value: \fBTrue\fR
 
17
.TP
 
18
.B enable_real_transparency\fR (boolean)
 
19
If true, Terminator will try to use real transparency if possible.
 
20
Default value: \fBFalse\fR
 
21
.TP
 
22
.B silent_bell\fR (boolean)
 
23
If true, don't make a noise when applications send the escape sequence for the terminal bell. Flash the terminal instead.
 
24
Default value: \fBTrue\fR
 
25
.TP
 
26
.B force_no_bell\fR (boolean)
 
27
If true, don't make a noise or flash. All terminal bells will be ignored.
 
28
Default value: \fBFalse\fR
 
29
.TP
 
30
.B use_theme_colors
 
31
If true, ignore the configured colours and use values from the theme instead.
 
32
Default value: \fBFalse\fR
 
33
.TP
 
34
.B background_color
 
35
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.
 
36
Default value: \fB#000000\fR
 
37
.TP
 
38
.B background_darkness
 
39
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.
 
40
Default value: \fB0.5\fR
 
41
.TP
 
42
.B background_type
 
43
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.
 
44
Default value: \fBsolid\fR
 
45
.TP
 
46
.B background_image
 
47
Path to an image file to be used for the background of terminals.
 
48
Default value: Nothing
 
49
.TP
 
50
.B backspace_binding
 
51
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.
 
52
Default value: \fBascii\-del\fR
 
53
.TP
 
54
.B delete_binding
 
55
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.
 
56
Default value: \fBdelete\-sequence\fR
 
57
.TP
 
58
.B cursor_blink \fR(boolean)
 
59
Controls if the cursor blinks.
 
60
Default value: \fBTrue\fR
 
61
.TP
 
62
.B emulation
 
63
Sets what type of terminal should be emulated.
 
64
Default value: \fBxterm\fR
 
65
.TP
 
66
.B font
 
67
An Pango font name. Examples are "Sans 12" or "Monospace Bold 14".
 
68
Default value: \fBMono 8\fR
 
69
.TP
 
70
.B foreground_color
 
71
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.
 
72
Default value: \fB#AAAAAA\fR
 
73
.TP
 
74
.B scrollbar_position
 
75
Where to put the terminal scrollbar. Possibilities are "left", "right", and "disabled".
 
76
Default value: \fBright\fR
 
77
.TP
 
78
.B titlebars
 
79
If true, a titlebar will be drawn for each terminal which shows the current title of that terminal.
 
80
Default value: \fBTrue\fR
 
81
.TP
 
82
.B titletips
 
83
If true, a tooltip will be available for each terminal which shows the current title of that terminal.
 
84
Default value: \fBFalse\fR
 
85
.TP
 
86
.B scroll_background \fR(boolean)
 
87
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.
 
88
Default value: \fBTrue\fR
 
89
.TP
 
90
.B scroll_on_keystroke \fR(boolean)
 
91
If true, pressing a key jumps the scrollbar to the bottom.
 
92
Default value: \fBTrue\fR
 
93
.TP
 
94
.B scroll_on_output \fR(boolean)
 
95
If true, whenever there's new output the terminal will scroll to the bottom.
 
96
Default value: \fBTrue\fR
 
97
.TP
 
98
.B scrollback_lines
 
99
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.
 
100
Default value: \fB500\fR
 
101
.TP
 
102
.B focus
 
103
Sets what type of mouse events should determine terminal focus. Can be "sloppy" or "click". "mouse" is also interpreted as "sloppy".
 
104
Default value: \fBclick\fR
 
105
.TP
 
106
.B focus_on_close
 
107
Sets which terminal should get the focus when another terminal is closed. Values can be "prev", "next" or "auto".
 
108
Using "auto", if the closed terminal is within a splitted window, the focus will be on the sibling terminal rather than another tab.
 
109
Default value: \fBauto\fR
 
110
.TP
 
111
.B exit_action
 
112
Possible values are "close" to close the terminal, and "restart" to restart the command.
 
113
Default value: \fBclose\fR
 
114
.TP
 
115
.B palette
 
116
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".
 
117
Default value: \fB#000000000000:#CDCD00000000:#0000CDCD0000:#CDCDCDCD0000:#30BF30BFA38E:#A53C212FA53C:#0000CDCDCDCD:#FAFAEBEBD7D7:#404040404040:#FFFF00000000:#0000FFFF0000:#FFFFFFFF0000:#00000000FFFF:#FFFF0000FFFF:#0000FFFFFFFF:#FFFFFFFFFFFF\fR
 
118
.TP
 
119
.B word_chars
 
120
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.
 
121
Default value: \fB\-A\-Za\-z0\-9,./?%&#:_\fR
 
122
.TP
 
123
.B mouse_autohide \fR(boolean)
 
124
Controls whether the mouse cursor should be hidden while typing.
 
125
Default value: \fBTrue\fR
 
126
.TP
 
127
.B use_custom_command \fR(boolean)
 
128
If True, the value of \fBcustom_command\fR will be used instead of the default shell.
 
129
Default value: \fBFalse\fR
 
130
.TP
 
131
.B custom_command
 
132
Command to execute instead of the default shell, if \fBuse_custom_command\fR is set to True.
 
133
Default value: Nothing
 
134
.TP
 
135
.B http_proxy
 
136
URL of an HTTP proxy to use, e.g. http://proxy.lan:3128/
 
137
Default value: Nothing
 
138
.TP
 
139
.B encoding
 
140
Character set to use for the terminal.
 
141
Default value: \fBUTF-8\fR
 
142
.TP
 
143
.B fullscreen \fR(boolean)
 
144
Controls whether the Terminator window will be started in fullscreen mode
 
145
Default value: \fBFalse\fR
 
146
.TP
 
147
.B maximise \fR(boolean)
 
148
Controls whether the Terminator window will be started maximised
 
149
Default value: \fBFalse\fR
 
150
.TP
 
151
.B borderless \fR(boolean)
 
152
Controls whether the Terminator window will be started without window borders
 
153
Default value: \fBFalse\fR
 
154
.TP
 
155
.B handle_size
 
156
Controls the width of the separator between terminals. Anything outside the range 0-5 (inclusive) will be ignored and use your default theme value.
 
157
Default value: \fB-1\fR
 
158
.TP
 
159
.B f11_modifier \fR(boolean)
 
160
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.
 
161
Default value: \fBFalse\fR
 
162
.TP
 
163
.B cycle_term_tab \fR(boolean)
 
164
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.
 
165
Default value: \fBTrue\fR
 
166
.TP
 
167
.B close_button_on_tab \fR(boolean)
 
168
If set to True, tabs will have a close button on them.
 
169
Default value: \fBTrue\fR
 
170
.TP
 
171
.B copy_on_selection \fR(boolean)
 
172
If set to True, text selections will be automatically copied to the clipboard, in addition to being made the Primary selection.
 
173
Default value: \fBFalse\fR
 
174
.TP
 
175
.B extreme_tabs \fB(boolean)\fR
 
176
If set to True, tabs can be created within other tabs. Be warned that this can be very confusing and hard to use.
 
177
Default value: \fBFalse\fR
 
178
.SH "SEE ALSO"
 
179
.BR gnome\-terminal(1)