ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/yodl/rxvt-resources.yo
(Generate patch)

Comparing rxvt-unicode/doc/yodl/rxvt-resources.yo (file contents):
Revision 1.6 by pcg, Sun Mar 14 21:59:58 2004 UTC vs.
Revision 1.17 by root, Fri Jul 30 22:36:42 2004 UTC

1COMMENT(-- $Id: rxvt-resources.yo,v 1.6 2004/03/14 21:59:58 pcg Exp $ --) 1COMMENT(-- $Id: rxvt-resources.yo,v 1.17 2004/07/30 22:36:42 root Exp $ --)
2COMMENT(----------------------------------------------------------------------) 2COMMENT(----------------------------------------------------------------------)
3manpagesection(RESOURCES (available also as long-options)) 3manpagesection(RESOURCES (available also as long-options))
4 4
5Note: `rxvt --help' gives a list of all resources (long options) compiled 5Note: `RXVTNAME() --help' gives a list of all resources (long options) compiled
6into your version. 6into your version.
7
8There are two different methods that RXVTNAME() can use to get the
9Xresource data: using the X libraries (Xrm*-functions) or internal Xresources
10reader (bf(~/.Xdefaults)). For the first method (ie. bf(RXVTNAME() -h) lists
11bf(XGetDefaults)), you can set and change the resources using X11
12tools like bf(xset). Many distribution do also load settings from the
13bf(~/.Xresources) file when X starts.
14
7If compiled with internal Xresources support (i.e. bf(rxvt -h) lists 15If compiled with internal Xresources support (i.e. bf(RXVTNAME()
8bf(.Xdefaults)) then bf(RXVTNAME()) accepts application defaults set in 16-h) lists bf(.Xdefaults)) then bf(RXVTNAME()) accepts application
9XAPPLOADDIR/Rxvt (compile-time defined: usually 17defaults set in XAPPLOADDIR/URxvt (compile-time defined: usually
10bf(/usr/lib/X11/app-defaults/Rxvt)) and resources set in bf(~/.Xdefaults), 18bf(/usr/lib/X11/app-defaults/URxvt)) and resources set in
11or bf(~/.Xresources) if bf(~/.Xdefaults) does not exist. Note that when 19bf(~/.Xdefaults), or bf(~/.Xresources) if bf(~/.Xdefaults) does not exist.
12reading X resources, bf(RXVTNAME()) recognizes two class names: bf(XTerm) and 20Note that when reading X resources, bf(RXVTNAME()) recognizes two class
13bf(Rxvt). The class name bf(XTerm) allows resources common to both 21names: bf(XTerm) and bf(URxvt). The class name bf(Rxvt) allows resources
14bf(RXVTNAME()) and em(xterm) to be easily configured, while the class name 22common to both bf(RXVTNAME()) and the original em(rxvt) to be easily configured,
15bf(Rxvt) allows resources unique to bf(RXVTNAME()), notably colours and 23while the class name bf(URxvt) allows resources unique to bf(RXVTNAME()),
16key-handling, to be shared between different bf(RXVTNAME()) configurations. 24notably colours and key-handling, to be shared between different
17If no resources are specified, suitable defaults will be used. 25bf(RXVTNAME()) configurations. If no resources are specified, suitable
18Command-line arguments can be used to override resource settings. The 26defaults will be used. Command-line arguments can be used to override
19following resources are allowed: 27resource settings. The following resources are allowed:
20 28
21startdit() 29startdit()
22 dit(bf(geometry:) em(geom)) 30 dit(bf(geometry:) em(geom))
23 Create the window with the specified X window geometry [default 31 Create the window with the specified X window geometry [default
24 80x24]; 32 80x24];
… …
40 but the actual colour names used are listed in the 48 but the actual colour names used are listed in the
41 bf(COLORS AND GRAPHICS) section. 49 bf(COLORS AND GRAPHICS) section.
42 dit(bf(colorBD:) em(colour)) 50 dit(bf(colorBD:) em(colour))
43 Use the specified colour to display bold characters when the 51 Use the specified colour to display bold characters when the
44 foreground colour is the default. 52 foreground colour is the default.
53 This option will be ignored if bf(realBold) is enabled.
45 dit(bf(colorUL:) em(colour)) 54 dit(bf(colorUL:) em(colour))
46 Use the specified colour to display underlined characters when the 55 Use the specified colour to display underlined characters when the
47 foreground colour is the default. 56 foreground colour is the default.
48 dit(bf(colorRV:) em(colour)) 57 dit(bf(colorRV:) em(colour))
49 Use the specified colour as the background for reverse video 58 Use the specified colour as the background for reverse video
… …
70 option bf(+j). 79 option bf(+j).
71 dit(bf(inheritPixmap:) em(boolean)) 80 dit(bf(inheritPixmap:) em(boolean))
72 bf(True): make the background inherit the parent windows' pixmap, 81 bf(True): make the background inherit the parent windows' pixmap,
73 giving artificial transparency. 82 giving artificial transparency.
74 bf(False): do not inherit the parent windows' pixmap. 83 bf(False): do not inherit the parent windows' pixmap.
84 dit(bf(fading:) em(number))
85 Fade the text by the given percentage when focus is lost.
86 dit(bf(tintColor:) em(colour))
87 Tint the transparent background pixmap with the given colour.
88 dit(bf(fading:) em(number))
89 Scale the tint colour by the given percentage.
75 dit(bf(scrollColor:) em(colour)) 90 dit(bf(scrollColor:) em(colour))
76 Use the specified colour for the scrollbar [default #B2B2B2]. 91 Use the specified colour for the scrollbar [default #B2B2B2].
77 dit(bf(troughColor:) em(colour)) 92 dit(bf(troughColor:) em(colour))
78 Use the specified colour for the scrollbar's trough area [default 93 Use the specified colour for the scrollbar's trough area [default
79 #969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 94 #969696]. Only relevant for normal (non XTerm/NeXT) scrollbar.
… …
94 dit(bf(path:) em(path)) 109 dit(bf(path:) em(path))
95 Specify the colon-delimited search path for finding files (XPM and 110 Specify the colon-delimited search path for finding files (XPM and
96 menus), in addition to the paths specified by the bf(RXVTPATH) and 111 menus), in addition to the paths specified by the bf(RXVTPATH) and
97 bf(PATH) environment variables. 112 bf(PATH) environment variables.
98 dit(bf(font:) em(fontname)) 113 dit(bf(font:) em(fontname))
99 Select the fonts to be used used. This is a comma seperated 114 Select the fonts to be used.
100 list of font names that are used in turn when trying to display 115 This is a comma seperated list of font names that are used in turn when
101 unicode characters. The first font defines the cell size for characters, 116 trying to display Unicode characters.
102 pther fonts might be smaller, but not larger. A reasonable default list 117 The first font defines the cell size for characters; other fonts might
103 is appended. 118 be smaller, but not larger.
119 A reasonable default font list is always appended to it.
104 option bf(-fn). 120 option bf(-fn).
121 dit(bf(realBold:) em(boolean))
122 bf(True): Enable "real bold" support.
123 When this option is on, bold text will be displayed using the first
124 available bold font in the font list.
125 Bold fonts should thus be specified in the font list after their
126 corresponding regular fonts.
127 If no bold font can be found, a regular font will be used.
128 option bf(-rb).
129 bf(False): Display bold text in a regular font, using the color
130 specified with bf(colorBD);
131 option bf(+rb).
105 dit(bf(selectstyle:) em(mode)) 132 dit(bf(selectstyle:) em(mode))
106 Set mouse selection style to bf(old) which is 2.20, bf(oldword) which 133 Set mouse selection style to bf(old) which is 2.20, bf(oldword) which
107 is xterm style with 2.20 old word selection, or anything else which 134 is xterm style with 2.20 old word selection, or anything else which
108 gives xterm style selection. 135 gives xterm style selection.
109 dit(bf(scrollstyle:) em(mode)) 136 dit(bf(scrollstyle:) em(mode))
110 Set scrollbar style to bf(RXVTNAME()), bf(next) or bf(xterm) 137 Set scrollbar style to bf(RXVTNAME()), bf(rxvt), bf(plain), bf(next) or bf(xterm)
111 dit(bf(title:) em(string)) 138 dit(bf(title:) em(string))
112 Set window title string, the default title is the command-line 139 Set window title string, the default title is the command-line
113 specified after the bf(-e) option, if any, otherwise the application 140 specified after the bf(-e) option, if any, otherwise the application
114 name; 141 name;
115 option bf(-title). 142 option bf(-title).
… …
216 option bf(-bc). 243 option bf(-bc).
217 dit(bf(pointerBlank:) em(boolean)) 244 dit(bf(pointerBlank:) em(boolean))
218 bf(True): blank the pointer when a key is pressed or after a set number 245 bf(True): blank the pointer when a key is pressed or after a set number
219 of seconds of inactivity. 246 of seconds of inactivity.
220 bf(False): the pointer is always visible [default]. 247 bf(False): the pointer is always visible [default].
248 dit(bf(pointerColor:) em(colour))
249 Mouse pointer foreground colour.
250 dit(bf(pointerColor2:) em(colour))
251 Mouse pointer background colour.
221 dit(bf(pointerBlankDelay:) em(number)) 252 dit(bf(pointerBlankDelay:) em(number))
222 Specifies number of seconds before blanking the pointer [default 2]. 253 Specifies number of seconds before blanking the pointer [default 2].
223 dit(bf(backspacekey:) em(string)) 254 dit(bf(backspacekey:) em(string))
224 The string to send when the backspace key is pressed. If set to 255 The string to send when the backspace key is pressed. If set to
225 bf(DEC) or unset it will send bf(Delete) (code 127) or, if shifted, 256 bf(DEC) or unset it will send bf(Delete) (code 127) or, if shifted,
… …
243 The locale to use for opening the IM. You can use an LC_CTYPE 274 The locale to use for opening the IM. You can use an LC_CTYPE
244 of e.g. de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP 275 of e.g. de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP
245 for the input extension to be able to input japanese characters 276 for the input extension to be able to input japanese characters
246 while staying in another locale. 277 while staying in another locale.
247 option bf(-imlocale). 278 option bf(-imlocale).
279 dit(bf(insecure))
280 Enables "insecure" mode. Rxvt-unicode offers some escape sequences
281 that echo arbitrary strings like the icon name or the locale. This
282 could be abused if somebody gets 8-bit-clean access to your
283 display, wether throuh a mail client displaying mail bodies
284 unfiltered or though write(1). Therefore, these sequences are
285 disabled by default. (Note that other terminals, including xterm,
286 have these sequences enabled by default). You can enable them
287 by setting this boolean resource or specifying bf(-insecure) as
288 an option. At the moment, this enabled display-answer, locale,
289 findfont, icon label and window title requests as well as dynamic
290 menubar dispatch.
248 dit(bf(modifier:) em(modifier)) 291 dit(bf(modifier:) em(modifier))
249 Set the key to be interpreted as the Meta key to: 292 Set the key to be interpreted as the Meta key to:
250 bf(alt), bf(meta), bf(hyper), bf(super), bf(mod1), bf(mod2), bf(mod3), 293 bf(alt), bf(meta), bf(hyper), bf(super), bf(mod1), bf(mod2), bf(mod3),
251 bf(mod4), bf(mod5); 294 bf(mod4), bf(mod5);
252 option bf(-mod). 295 option bf(-mod).
253 dit(bf(answerbackString:) em(string)) 296 dit(bf(answerbackString:) em(string))
254 Specify the reply rxvt sends to the shell when an ENQ (control-E) 297 Specify the reply rxvt sends to the shell when an ENQ (control-E)
255 character is passed through. It may contain escape values as 298 character is passed through. It may contain escape values as
256 described in the entry on bf(keysym) following. 299 described in the entry on bf(keysym) following.
300 dit(bf(secondaryScreen:) em(bool))
301 Turn on/off secondary screen (default enabled).
302 dit(bf(secondaryScroll:) em(bool))
303 Turn on/off secondary screen scroll (default enabled). If
304 the this option is enabled, scrolls on the secondary screen will
305 change the scrollback buffer and switching to/from the secondary screen
306 will instead scroll the screen up.
257 dit(bf(keysym.)em(sym): em(string)) 307 dit(bf(keysym.)em(sym): em(string))
258 Associate em(string) with keysym em(sym) (bf(0xFF00 - 0xFFFF)). It 308 Associate em(string) with keysym em(sym) (bf(0xFF00 - 0xFFFF)). It
259 may contain escape values (\a: bell, \b: backspace, \e, \E: escape, 309 may contain escape values (\a: bell, \b: backspace, \e, \E: escape,
260 \n: newline, \r: return, \t: tab, \000: octal number) or control 310 \n: newline, \r: return, \t: tab, \000: octal number) or control
261 characters (^?: delete, ^@: null, ^A ...) and may enclosed with 311 characters (^?: delete, ^@: null, ^A ...) and may enclosed with

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines