| 1 |
COMMENT(-- $Id: rxvt-resources.yo,v 1.18 2004/07/31 15:32:50 root Exp $ --) |
| 2 |
COMMENT(----------------------------------------------------------------------) |
| 3 |
manpagesection(RESOURCES (available also as long-options)) |
| 4 |
|
| 5 |
Note: `RXVTNAME() --help' gives a list of all resources (long options) compiled |
| 6 |
into your version. |
| 7 |
|
| 8 |
There are two different methods that RXVTNAME() can use to get the |
| 9 |
Xresource data: using the X libraries (Xrm*-functions) or internal Xresources |
| 10 |
reader (bf(~/.Xdefaults)). For the first method (ie. bf(RXVTNAME() -h) lists |
| 11 |
bf(XGetDefaults)), you can set and change the resources using X11 |
| 12 |
tools like bf(xset). Many distribution do also load settings from the |
| 13 |
bf(~/.Xresources) file when X starts. |
| 14 |
|
| 15 |
If compiled with internal Xresources support (i.e. bf(RXVTNAME() |
| 16 |
-h) lists bf(.Xdefaults)) then bf(RXVTNAME()) accepts application |
| 17 |
defaults set in XAPPLOADDIR/URxvt (compile-time defined: usually |
| 18 |
bf(/usr/lib/X11/app-defaults/URxvt)) and resources set in |
| 19 |
bf(~/.Xdefaults), or bf(~/.Xresources) if bf(~/.Xdefaults) does not exist. |
| 20 |
Note that when reading X resources, bf(RXVTNAME()) recognizes two class |
| 21 |
names: bf(XTerm) and bf(URxvt). The class name bf(Rxvt) allows resources |
| 22 |
common to both bf(RXVTNAME()) and the original em(rxvt) to be easily configured, |
| 23 |
while the class name bf(URxvt) allows resources unique to bf(RXVTNAME()), |
| 24 |
notably colours and key-handling, to be shared between different |
| 25 |
bf(RXVTNAME()) configurations. If no resources are specified, suitable |
| 26 |
defaults will be used. Command-line arguments can be used to override |
| 27 |
resource settings. The following resources are allowed: |
| 28 |
|
| 29 |
startdit() |
| 30 |
dit(bf(geometry:) em(geom)) |
| 31 |
Create the window with the specified X window geometry [default |
| 32 |
80x24]; |
| 33 |
option bf(-geometry). |
| 34 |
dit(bf(background:) em(colour)) |
| 35 |
Use the specified colour as the window's background colour [default |
| 36 |
White]; |
| 37 |
option bf(-bg). |
| 38 |
dit(bf(foreground:) em(colour)) |
| 39 |
Use the specified colour as the window's foreground colour [default |
| 40 |
Black]; |
| 41 |
option bf(-fg). |
| 42 |
dit(bf(color)em(n)bf(:) em(colour)) |
| 43 |
Use the specified colour for the colour value em(n), where 0-7 |
| 44 |
corresponds to low-intensity (normal) colours and 8-15 corresponds to |
| 45 |
high-intensity (bold = bright foreground, blink = bright |
| 46 |
background) colours. The canonical names are as follows: |
| 47 |
0=black, 1=red, 2=green, 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, |
| 48 |
but the actual colour names used are listed in the |
| 49 |
bf(COLORS AND GRAPHICS) section. |
| 50 |
dit(bf(colorBD:) em(colour)) |
| 51 |
Use the specified colour to display bold characters when the |
| 52 |
foreground colour is the default. |
| 53 |
This option will be ignored if bf(realBold) is enabled. |
| 54 |
dit(bf(colorUL:) em(colour)) |
| 55 |
Use the specified colour to display underlined characters when the |
| 56 |
foreground colour is the default. |
| 57 |
dit(bf(colorRV:) em(colour)) |
| 58 |
Use the specified colour as the background for reverse video |
| 59 |
characters. |
| 60 |
dit(bf(cursorColor:) em(colour)) |
| 61 |
Use the specified colour for the cursor. The default is to use the |
| 62 |
foreground colour; |
| 63 |
option bf(-cr). |
| 64 |
dit(bf(cursorColor2:) em(colour)) |
| 65 |
Use the specified colour for the colour of the cursor text. For this |
| 66 |
to take effect, bf(cursorColor) must also be specified. The default |
| 67 |
is to use the background colour. |
| 68 |
dit(bf(reverseVideo:) em(boolean)) |
| 69 |
bf(True): simulate reverse video by foreground and background colours; |
| 70 |
option bf(-rv). |
| 71 |
bf(False): regular screen colours [default]; |
| 72 |
option bf(+rv). |
| 73 |
See note in bf(COLORS AND GRAPHICS) section. |
| 74 |
dit(bf(jumpScroll:) em(boolean)) |
| 75 |
bf(True): specify that jump scrolling should be used. When scrolling |
| 76 |
quickly, fewer screen updates are performed [default]; |
| 77 |
option bf(-j). |
| 78 |
bf(False): specify that smooth scrolling should be used; |
| 79 |
option bf(+j). |
| 80 |
dit(bf(inheritPixmap:) em(boolean)) |
| 81 |
bf(True): make the background inherit the parent windows' pixmap, |
| 82 |
giving artificial transparency. |
| 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(shading:) em(number)) |
| 89 |
Darken (0 .. 100) or lighten (-1 .. -100) the transparent background |
| 90 |
image in addition to tinting it. |
| 91 |
dit(bf(fading:) em(number)) |
| 92 |
Scale the tint colour by the given percentage. |
| 93 |
dit(bf(scrollColor:) em(colour)) |
| 94 |
Use the specified colour for the scrollbar [default #B2B2B2]. |
| 95 |
dit(bf(troughColor:) em(colour)) |
| 96 |
Use the specified colour for the scrollbar's trough area [default |
| 97 |
#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. |
| 98 |
dit(bf(backgroundPixmap:) em(file[;geom])) |
| 99 |
Use the specified XPM file (note the `.xpm' extension is optional) |
| 100 |
for the background and also optionally specify its scaling with a |
| 101 |
geometry string bf(WxH+X+Y), in which bf("W" / "H") specify the |
| 102 |
horizontal/vertical scale (percent) and bf("X" / "Y") locate the |
| 103 |
image centre (percent). A scale of 0 displays the image with tiling. |
| 104 |
A scale of 1 displays the image without any scaling. A scale of 2 to |
| 105 |
9 specifies an integer number of images in that direction. No image |
| 106 |
will be magnified beyond 10 times its original size. The maximum |
| 107 |
permitted scale is 1000. [default 0x0+50+50] |
| 108 |
dit(bf(menu:) em(file[;tag])) |
| 109 |
Read in the specified menu file (note the `.menu' extension is |
| 110 |
optional) and also optionally specify a starting tag to find. See |
| 111 |
the reference documentation for details on the syntax for the menuBar. |
| 112 |
dit(bf(path:) em(path)) |
| 113 |
Specify the colon-delimited search path for finding files (XPM and |
| 114 |
menus), in addition to the paths specified by the bf(RXVTPATH) and |
| 115 |
bf(PATH) environment variables. |
| 116 |
dit(bf(font:) em(fontname)) |
| 117 |
Select the fonts to be used. |
| 118 |
This is a comma seperated list of font names that are used in turn when |
| 119 |
trying to display Unicode characters. |
| 120 |
The first font defines the cell size for characters; other fonts might |
| 121 |
be smaller, but not larger. |
| 122 |
A reasonable default font list is always appended to it. |
| 123 |
option bf(-fn). |
| 124 |
dit(bf(realBold:) em(boolean)) |
| 125 |
bf(True): Enable "real bold" support. |
| 126 |
When this option is on, bold text will be displayed using the first |
| 127 |
available bold font in the font list. |
| 128 |
Bold fonts should thus be specified in the font list after their |
| 129 |
corresponding regular fonts. |
| 130 |
If no bold font can be found, a regular font will be used. |
| 131 |
option bf(-rb). |
| 132 |
bf(False): Display bold text in a regular font, using the color |
| 133 |
specified with bf(colorBD); |
| 134 |
option bf(+rb). |
| 135 |
dit(bf(selectstyle:) em(mode)) |
| 136 |
Set mouse selection style to bf(old) which is 2.20, bf(oldword) which |
| 137 |
is xterm style with 2.20 old word selection, or anything else which |
| 138 |
gives xterm style selection. |
| 139 |
dit(bf(scrollstyle:) em(mode)) |
| 140 |
Set scrollbar style to bf(RXVTNAME()), bf(rxvt), bf(plain), bf(next) or bf(xterm) |
| 141 |
dit(bf(title:) em(string)) |
| 142 |
Set window title string, the default title is the command-line |
| 143 |
specified after the bf(-e) option, if any, otherwise the application |
| 144 |
name; |
| 145 |
option bf(-title). |
| 146 |
dit(bf(iconName:) em(string)) |
| 147 |
Set the name used to label the window's icon or displayed in an icon |
| 148 |
manager window, it also sets the window's title unless it is |
| 149 |
explicitly set; |
| 150 |
option bf(-n). |
| 151 |
dit(bf(mapAlert:) em(boolean)) |
| 152 |
bf(True): de-iconify (map) on receipt of a bell character. |
| 153 |
bf(False): no de-iconify (map) on receipt of a bell character |
| 154 |
[default]. |
| 155 |
dit(bf(visualBell:) em(boolean)) |
| 156 |
bf(True): use visual bell on receipt of a bell character; |
| 157 |
option bf(-vb). |
| 158 |
bf(False): no visual bell [default]; |
| 159 |
option bf(+vb). |
| 160 |
dit(bf(loginShell:) em(boolean)) |
| 161 |
bf(True): start as a login shell by prepending a `-' to bf(argv[0]) |
| 162 |
of the shell; |
| 163 |
option bf(-ls). |
| 164 |
bf(False): start as a normal sub-shell [default]; |
| 165 |
option bf(+ls). |
| 166 |
dit(bf(utmpInhibit:) em(boolean)) |
| 167 |
bf(True): inhibit writing record into the system log file bf(utmp); |
| 168 |
option bf(-ut). |
| 169 |
bf(False): write record into the system log file bf(utmp) [default]; |
| 170 |
option bf(+ut). |
| 171 |
dit(bf(print-pipe:) em(string)) |
| 172 |
Specify a command pipe for vt100 printer [default em(lpr(1))]. Use |
| 173 |
bf(Print) to initiate a screen dump to the printer and bf(Ctrl-Print) |
| 174 |
or bf(Shift-Print) to include the scrollback as well. |
| 175 |
dit(bf(scrollBar:) em(boolean)) |
| 176 |
bf(True): enable the scrollbar [default]; |
| 177 |
option bf(-sb). |
| 178 |
bf(False): disable the scrollbar; |
| 179 |
option bf(+sb). |
| 180 |
dit(bf(scrollBar_right:) em(boolean)) |
| 181 |
bf(True): place the scrollbar on the right of the window; |
| 182 |
option bf(-sr). |
| 183 |
bf(False): place the scrollbar on the left of the window; |
| 184 |
option bf(+sr). |
| 185 |
dit(bf(scrollBar_floating:) em(boolean)) |
| 186 |
bf(True): display an rxvt scrollbar without a trough; |
| 187 |
option bf(-st). |
| 188 |
bf(False): display an rxvt scrollbar with a trough; |
| 189 |
option bf(+st). |
| 190 |
dit(bf(scrollBar_align:) em(mode)) |
| 191 |
Align the bf(top), bf(bottom) or bf(centre) [default] of |
| 192 |
the scrollbar thumb with the pointer on middle button |
| 193 |
press/drag. |
| 194 |
dit(bf(scrollTtyOutput:) em(boolean)) |
| 195 |
bf(True): scroll to bottom when tty receives output; |
| 196 |
option(+si). |
| 197 |
bf(False): do not scroll to bottom when tty receives output; |
| 198 |
option(-si). |
| 199 |
dit(bf(scrollWithBuffer:) em(boolean)) |
| 200 |
bf(True): scroll with scrollback buffer when tty recieves |
| 201 |
new lines (and bf(scrollTtyOutput) is False); |
| 202 |
option(+sw). |
| 203 |
bf(False): do not scroll with scrollback buffer when tty |
| 204 |
recieves new lines; |
| 205 |
option(-sw). |
| 206 |
dit(bf(scrollTtyKeypress:) em(boolean)) |
| 207 |
bf(True): scroll to bottom when a non-special key is pressed. |
| 208 |
Special keys are those which are intercepted by rxvt for special |
| 209 |
handling and are not passed onto the shell; |
| 210 |
option(-sk). |
| 211 |
bf(False): do not scroll to bottom when a non-special key is pressed; |
| 212 |
option(+sk). |
| 213 |
dit(bf(smallfont_key:) em(keysym)) |
| 214 |
If enabled, use bf(HOTKEY()-)em(keysym) to toggle to a smaller font |
| 215 |
[default bf(HOTKEY()-SMALLFONT())] |
| 216 |
dit(bf(bigfont_key:) em(keysym)) |
| 217 |
If enabled, use bf(HOTKEY()-)em(keysym) to toggle to a bigger font |
| 218 |
[default bf(HOTKEY()-BIGFONT())] |
| 219 |
dit(bf(saveLines:) em(number)) |
| 220 |
Save em(number) lines in the scrollback buffer [default 64]. This |
| 221 |
resource is limited on most machines to 65535; |
| 222 |
option bf(-sl). |
| 223 |
dit(bf(internalBorder:) em(number)) |
| 224 |
Internal border of em(number) pixels. This resource is limited to 100; |
| 225 |
option bf(-b). |
| 226 |
dit(bf(externalBorder:) em(number)) |
| 227 |
External border of em(number) pixels. This resource is limited to 100; |
| 228 |
option bf(-w), bf(-bw), bf(-borderwidth). |
| 229 |
dit(bf(borderLess:) em(boolean)) |
| 230 |
Set MWM hints to request a borderless window, |
| 231 |
i.e. if honoured by the WM, the rxvt window will not have window |
| 232 |
decorations; option bf(-bl). |
| 233 |
dit(bf(termName:) em(termname)) |
| 234 |
Specifies the terminal type name to be set in the bf(TERM) |
| 235 |
environment variable; |
| 236 |
option bf(-tn). |
| 237 |
dit(bf(linespace:) em(number)) |
| 238 |
Specifies number of lines (pixel height) to insert between each row |
| 239 |
of the display [default 0]; |
| 240 |
option bf(-lsp). |
| 241 |
dit(bf(meta8:) em(boolean)) |
| 242 |
bf(True): handle Meta (Alt) + keypress to set the 8th bit. |
| 243 |
bf(False): handle Meta (Alt) + keypress as an escape prefix [default]. |
| 244 |
dit(bf(mouseWheelScrollPage:) em(boolean)) |
| 245 |
bf(True): the mouse wheel scrolls a page full. |
| 246 |
bf(False): the mouse wheel scrolls five lines [default]. |
| 247 |
dit(bf(cursorBlink:) em(boolean)) |
| 248 |
bf(True): blink the cursor. |
| 249 |
bf(False): do not blink the cursor [default]; |
| 250 |
option bf(-bc). |
| 251 |
dit(bf(pointerBlank:) em(boolean)) |
| 252 |
bf(True): blank the pointer when a key is pressed or after a set number |
| 253 |
of seconds of inactivity. |
| 254 |
bf(False): the pointer is always visible [default]. |
| 255 |
dit(bf(pointerColor:) em(colour)) |
| 256 |
Mouse pointer foreground colour. |
| 257 |
dit(bf(pointerColor2:) em(colour)) |
| 258 |
Mouse pointer background colour. |
| 259 |
dit(bf(pointerBlankDelay:) em(number)) |
| 260 |
Specifies number of seconds before blanking the pointer [default 2]. |
| 261 |
dit(bf(backspacekey:) em(string)) |
| 262 |
The string to send when the backspace key is pressed. If set to |
| 263 |
bf(DEC) or unset it will send bf(Delete) (code 127) or, if shifted, |
| 264 |
bf(Backspace) (code 8) - which can be reversed with the appropriate |
| 265 |
DEC private mode escape sequence. |
| 266 |
dit(bf(deletekey:) em(string)) |
| 267 |
The string to send when the delete key (not the keypad delete key) is |
| 268 |
pressed. If unset it will send the sequence traditionally associated |
| 269 |
with the bf(Execute) key. |
| 270 |
dit(bf(cutchars:) em(string)) |
| 271 |
The characters used as delimiters for double-click word selection. |
| 272 |
The built-in default: nl()\ |
| 273 |
bf(BACKSLASH `"'&()*,;<=>?@[]{|}) |
| 274 |
dit(bf(preeditType:) em(style)) |
| 275 |
bf(OverTheSpot), bf(OffTheSpot), bf(Root); |
| 276 |
option bf(-pt). |
| 277 |
dit(bf(inputMethod:) em(name)) |
| 278 |
em(name) of inputMethod to use; |
| 279 |
option bf(-im). |
| 280 |
dit(bf(imLocale:) em(name)) |
| 281 |
The locale to use for opening the IM. You can use an LC_CTYPE |
| 282 |
of e.g. de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP |
| 283 |
for the input extension to be able to input japanese characters |
| 284 |
while staying in another locale. |
| 285 |
option bf(-imlocale). |
| 286 |
dit(bf(insecure)) |
| 287 |
Enables "insecure" mode. Rxvt-unicode offers some escape sequences |
| 288 |
that echo arbitrary strings like the icon name or the locale. This |
| 289 |
could be abused if somebody gets 8-bit-clean access to your |
| 290 |
display, wether throuh a mail client displaying mail bodies |
| 291 |
unfiltered or though write(1). Therefore, these sequences are |
| 292 |
disabled by default. (Note that other terminals, including xterm, |
| 293 |
have these sequences enabled by default). You can enable them |
| 294 |
by setting this boolean resource or specifying bf(-insecure) as |
| 295 |
an option. At the moment, this enabled display-answer, locale, |
| 296 |
findfont, icon label and window title requests as well as dynamic |
| 297 |
menubar dispatch. |
| 298 |
dit(bf(modifier:) em(modifier)) |
| 299 |
Set the key to be interpreted as the Meta key to: |
| 300 |
bf(alt), bf(meta), bf(hyper), bf(super), bf(mod1), bf(mod2), bf(mod3), |
| 301 |
bf(mod4), bf(mod5); |
| 302 |
option bf(-mod). |
| 303 |
dit(bf(answerbackString:) em(string)) |
| 304 |
Specify the reply rxvt sends to the shell when an ENQ (control-E) |
| 305 |
character is passed through. It may contain escape values as |
| 306 |
described in the entry on bf(keysym) following. |
| 307 |
dit(bf(secondaryScreen:) em(bool)) |
| 308 |
Turn on/off secondary screen (default enabled). |
| 309 |
dit(bf(secondaryScroll:) em(bool)) |
| 310 |
Turn on/off secondary screen scroll (default enabled). If |
| 311 |
the this option is enabled, scrolls on the secondary screen will |
| 312 |
change the scrollback buffer and switching to/from the secondary screen |
| 313 |
will instead scroll the screen up. |
| 314 |
dit(bf(keysym.)em(sym): em(string)) |
| 315 |
Associate em(string) with keysym em(sym) (bf(0xFF00 - 0xFFFF)). It |
| 316 |
may contain escape values (\a: bell, \b: backspace, \e, \E: escape, |
| 317 |
\n: newline, \r: return, \t: tab, \000: octal number) or control |
| 318 |
characters (^?: delete, ^@: null, ^A ...) and may enclosed with |
| 319 |
double quotes so that it can start or end with whitespace. The |
| 320 |
intervening resource name bf(keysym.) cannot be omitted. This |
| 321 |
resource is only available when compiled with KEYSYM_RESOURCE. |
| 322 |
enddit() |
