From db66ec7743c58e48931f7a908cdd66cbbfaeca26 Mon Sep 17 00:00:00 2001 From: Chris Jones Date: Mon, 25 Feb 2008 23:26:51 +0000 Subject: [PATCH] Add schema descriptions from gconf to document the rc settings --- doc/terminatorrc.5 | 85 +++++++++++++++++++++++++++------------------- 1 file changed, 50 insertions(+), 35 deletions(-) diff --git a/doc/terminatorrc.5 b/doc/terminatorrc.5 index 22d0428c..b10407f7 100644 --- a/doc/terminatorrc.5 +++ b/doc/terminatorrc.5 @@ -10,73 +10,88 @@ This manual page documents briefly the The options are defined one per line as \fB'OPTION = VALUE'\fR. The options are described below: .TP -.B gt_dir -Default value: \fB/apps/gnome\-terminal\fR +.B allow_bold\fR (boolean) +If true, allow applications in the terminal to make text boldface. +Default value: \fBTrue\fR .TP -.B _profile_dir -Default value: \fB%s/profiles\fR -.TP -.B allow_bold -Boolean value. Default value: \fBTrue\fR -.TP -.B silent_bell -Boolean value. Default value: \fBTrue\fR +.B silent_bell\fR (boolean) +If true, don't make a noise when applications send the escape sequence for the terminal bell. Flash the terminal instead. +Default value: \fBTrue\fR .TP .B background_color -Heximal RGB value for the background color. Default value: \fB#000000\fR +Default colour of terminal background, as a colour specification (can be HTML-style hex digits, or a colour name such as "red"). +Default value: \fB#000000\fR .TP .B background_darkness -Number for the background darkness. Default value: \fB0.5\fR +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. In the current implementation, there are only two levels of darkness possible, so the setting behaves as a boolean, where 0.0 disables the darkening effect. +Default value: \fB0.5\fR .TP .B background_type +Type of terminal background. May be "solid" for a solid colour, "image" for an image, or "transparent" for full transparency in compositing window managers, otherwise pseudo transparency. Default value: \fBsolid\fR .TP .B backspace_binding +Sets what code the backspace key generates. Possible values are "ascii-del" for the ASCII DEL character, "control-h" for Control-H (AKA the ASCII BS character), "escape-sequence" for the escape sequence typically bound to backspace or delete. "ascii-del" is normally considered the correct setting for the Backspace key. Default value: \fBascii\-del\fR .TP .B delete_binding +Sets what code the delete key generates. Possible values are "ascii-del" for the ASCII DEL character, "control-h" for Control-H (AKA the ASCII BS character), "escape-sequence" for the escape sequence typically bound to backspace or delete. "escape-sequence" is normally considered the correct setting for the Delete key. Default value: \fBdelete\-sequence\fR .TP -.B cursor_blink -Boolean value. Default value: \fBFalse\fR +.B cursor_blink \fR(boolean) +Controls if the cursor blinks. +Default value: \fBFalse\fR .TP .B emulation +Sets what type of terminal should be emulated. Default value: \fBxterm\fR .TP .B font -Value for the font time and size in the format \fBFONTNAME SIZENUMBER\fR. Default value: \fBSerif 10\fR +An Pango font name. Examples are "Sans 12" or "Monospace Bold 14". +Default value: \fBSerif 10\fR .TP .B foreground_color -Hexadecimal RGB value for the font color. Default value: \fB#AAAAAA\fR +Default colour of text in the terminal, as a colour specification (can be HTML-style hex digits, or a colour name such as "red"). +Default value: \fB#AAAAAA\fR .TP .B scrollbar_position -Scrollbar position. Options available: right, left and hidden. Default value: \fBright\fR +Where to put the terminal scrollbar. Possibilities are "left", "right", and "disabled". +Default value: \fBright\fR .TP -.B scroll_background -Boolean value. Default value: \fBTrue\fR +.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 -Boolean value. Default value: \fBFalse\fR -.TP -.B scroll_on_output -Boolean value. Default value: \fBFalse\fR -.TP -.B scrollback_lines -Number of lines stored for the scrollbar. Default value: \fB100\fR -.TP -.B focus -Default value: \fBsloppy\fR -.TP -.B child_restart +.B scroll_on_keystroke \fR(boolean) +If true, pressing a key jumps the scrollbar to the bottom. Default value: \fBFalse\fR .TP +.B scroll_on_output \fR(boolean) +If true, whenever there's new output the terminal will scroll to the bottom. +Default value: \fBFalse\fR +.TP +.B scrollback_lines +Number of scrollback lines to keep around. You can scroll back in the terminal by this number of lines; lines that don't fit in the scrollback are discarded. Be careful with this setting; it's the primary factor in determining how much memory the terminal will use. +Default value: \fB100\fR +.TP +.B focus +Sets what type of mouse events should determine terminal focus. Can be "sloppy" or "click". "mouse" is also interpreted as "sloppy". +Default value: \fBsloppy\fR +.TP +.B exit_action +Possible values are "close" to close the terminal, and "restart" to restart the command. +Default value: \fBclose\fR +.TP .B palette +Terminals have a 16-colour palette that applications inside the terminal can use. This is that palette, in the form of a colon-separated list of colour names. Colour names should be in hex format e.g. "#FF00FF". Default value: \fB#000000000000:#CDCD00000000:#0000CDCD0000:#CDCDCDCD0000:#30BF30BFA38E:#A53C212FA53C:#0000CDCDCDCD:#FAFAEBEBD7D7:#404040404040:#FFFF00000000:#0000FFFF0000:#FFFFFFFF0000:#00000000FFFF:#FFFF0000FFFF:#0000FFFFFFFF:#FFFFFFFFFFFF\fR .TP .B word_chars +When selecting text by word, sequences of these characters are considered single words. Ranges can be given as "A-Z". Literal hyphen (not expressing a range) should be the first character given. Default value: \fB\-A\-Za\-z0\-9,./?%&#:_\fR .TP -.B mouse_autohide -Boolean value. Default value: \fBTrue\fR +.B mouse_autohide \fR(boolean) +Controls whether the mouse cursor should be hidden while typing. +Default value: \fBTrue\fR .SH "SEE ALSO" -.BR gnome\-terminal(1), +.BR gnome\-terminal(1)