itdominator
/
terminator
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update the configuration manpage to mention the full GUI, and also clarify the need for quoting of hex colour values

This commit is contained in:
Chris Jones 2010-04-02 12:47:17 +01:00
parent 4fd06ba8b3
commit bc3fb61649
1 changed files with 15 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
doc/terminator_config.5
View File

@ -4,7 +4,7 @@
.SH "DESCRIPTION" .SH "DESCRIPTION"
This manual page documents briefly the This manual page documents briefly the
.B Terminator .B Terminator
config file. 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 .PP
.SH "FILE LOCATION" .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) 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)
@ -21,9 +21,9 @@ This is what a Terminator config file should look like:
[profiles] [profiles]
[[default]] [[default]]
font = Fixed 10 font = Fixed 10
background_color = #000000 background_color = "#000000" # A comment
foreground_color = "#FFFFFF" #Another comment. Quotes can be used for any value foreground_color = "#FFFFFF" # Note that hex colour values must be quoted
scrollback_lines = "500" #More comment. Single quotes are valid too scrollback_lines = '500' #More comment. Single quotes are valid too
cursor_blink = True cursor_blink = True
custom_command = "echo \\"foo#bar\\"" #Final comment - this will work as expected. custom_command = "echo \\"foo#bar\\"" #Final comment - this will work as expected.
@ -78,27 +78,27 @@ Default value: \fBFalse\fR on Linux, \fBTrue\fR otherwise.
.TP .TP
.B title_transmit_fg_color .B title_transmit_fg_color
Sets the colour of the text shown in the titlebar of the active terminal. Sets the colour of the text shown in the titlebar of the active terminal.
Default value: \fB#FFFFFF\fR Default value: \fB'#FFFFFF'\fR
.TP .TP
.B title_transmit_bg_color .B title_transmit_bg_color
Sets the colour of the background of the titlebar in the active terminal. Sets the colour of the background of the titlebar in the active terminal.
Default value: \fB#C80003\fR Default value: \fB'#C80003'\fR
.TP .TP
.B title_receive_fg_color .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. 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 Default value: \fB'#FFFFFF'\fR
.TP .TP
.B title_receive_bg_color .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. 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 Default value: \fB'#0076C9'\fR
.TP .TP
.B title_inactive_fg_color .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. 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 Default value: \fB'#000000'\fR
.TP .TP
.B title_inactive_bg_color .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. 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 Default value: \fB'#C0BEBF'\fR
.TP .TP
.B disabled_plugins .B disabled_plugins
A list of plugins which should not be loaded by default. A list of plugins which should not be loaded by default.
@ -306,7 +306,7 @@ Default value: \fBFalse\fR
.TP .TP
.B background_color .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 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 Default value: \fB'#000000'\fR
.TP .TP
.B background_darkness .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. 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.
@ -358,7 +358,7 @@ Default value: \fBMono 8\fR
.TP .TP
.B foreground_color .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 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 Default value: \fB'#AAAAAA'\fR
.TP .TP
.B scrollbar_position .B scrollbar_position
Where to put the terminal scrollbar. Possibilities are "left", "right", and "disabled". Where to put the terminal scrollbar. Possibilities are "left", "right", and "disabled".
@ -403,11 +403,11 @@ Default value: \fBclose\fR
.TP .TP
.B palette .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". 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 Default value: \fB'#000000000000:#CDCD00000000:#0000CDCD0000:#CDCDCDCD0000:#30BF30BFA38E:#A53C212FA53C:#0000CDCDCDCD:#FAFAEBEBD7D7:#404040404040:#FFFF00000000:#0000FFFF0000:#FFFFFFFF0000:#00000000FFFF:#FFFF0000FFFF:#0000FFFFFFFF:#FFFFFFFFFFFF'\fR
.TP .TP
.B word_chars .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. 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 Default value: \fB'\-A\-Za\-z0\-9,./?%&#:_'\fR
.TP .TP
.B mouse_autohide \fR(boolean) .B mouse_autohide \fR(boolean)
Controls whether the mouse cursor should be hidden while typing. Controls whether the mouse cursor should be hidden while typing.
@ -455,4 +455,4 @@ Window objects may not have a parent attribute. \fBEvery\fR other object must sp
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. 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.
.SH "SEE ALSO" .SH "SEE ALSO"
.BR gnome\-terminal(1) .BR gnome\-terminal(1), http://www.voidspace.org.uk/python/configobj.html