… | |
… | |
4 | |
4 | |
5 | SYNOPSIS |
5 | SYNOPSIS |
6 | rxvt [options] [-e command [ args ]] |
6 | rxvt [options] [-e command [ args ]] |
7 | |
7 | |
8 | DESCRIPTION |
8 | DESCRIPTION |
9 | rxvt-unicode, version 6.2, is a colour vt102 terminal emulator intended |
9 | rxvt-unicode, version 8.3, is a colour vt102 terminal emulator intended |
10 | as an *xterm*(1) replacement for users who do not require features such |
10 | as an *xterm*(1) replacement for users who do not require features such |
11 | as Tektronix 4014 emulation and toolkit-style configurability. As a |
11 | as Tektronix 4014 emulation and toolkit-style configurability. As a |
12 | result, rxvt-unicode uses much less swap space -- a significant |
12 | result, rxvt-unicode uses much less swap space -- a significant |
13 | advantage on a machine serving many X sessions. |
13 | advantage on a machine serving many X sessions. |
14 | |
14 | |
15 | FREQUENTLY ASKED QUESTIONS |
15 | FREQUENTLY ASKED QUESTIONS |
16 | See rxvt(7) (try "man 7 rxvt") for a list of frequently asked questions |
16 | See rxvt(7) (try "man 7 rxvt") for a list of frequently asked questions |
17 | and answer to them and some common problems. That document is also |
17 | and answer to them and some common problems. That document is also |
18 | accessible on the World-Wide-Web at |
18 | accessible on the World-Wide-Web at |
19 | <http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>. |
19 | <http://cvs.schmorp.de/browse/rxvt-unicode/doc/rxvt.7.html>. |
20 | |
20 | |
21 | RXVT-UNICODE VS. RXVT |
21 | RXVT-UNICODE VS. RXVT |
22 | Unlike the original rxvt, rxvt-unicode stores all text in Unicode |
22 | Unlike the original rxvt, rxvt-unicode stores all text in Unicode |
23 | internally. That means it can store and display most scripts in the |
23 | internally. That means it can store and display most scripts in the |
24 | world. Being a terminal emulator, however, some things are very |
24 | world. Being a terminal emulator, however, some things are very |
25 | difficult, especially cursive scripts such as arabic, vertically written |
25 | difficult, especially cursive scripts such as arabic, vertically written |
26 | scripts like mongolian or scripts requiring extremely complex combining |
26 | scripts like mongolian or scripts requiring extremely complex combining |
27 | rules, like tibetan or devenagari. Don't expect pretty output when using |
27 | rules, like tibetan or devenagari. Don't expect pretty output when using |
28 | these scripts. Most other scripts, latin, cyrillic, kanji, thai etc. |
28 | these scripts. Most other scripts, latin, cyrillic, kanji, thai etc. |
29 | should work fine, though. A somewhat difficult case are left-to-right |
29 | should work fine, though. A somewhat difficult case are right-to-left |
30 | scripts, such as hebrew: rxvt-unicode adopts the view that bidirectional |
30 | scripts, such as hebrew: rxvt-unicode adopts the view that bidirectional |
31 | algorithms belong into the application, not the terminal emulator (too |
31 | algorithms belong into the application, not the terminal emulator (too |
32 | many things -- such as cursor-movement while editing -- break |
32 | many things -- such as cursor-movement while editing -- break |
33 | otherwise), but that might change. |
33 | otherwise), but that might change. |
34 | |
34 | |
35 | If you are looking for a terminal that supports more exotic scripts, let |
35 | If you are looking for a terminal that supports more exotic scripts, let |
36 | me recommend "mlterm", which is a very userfriendly, lean and clean |
36 | me recommend "mlterm", which is a very user friendly, lean and clean |
37 | terminal emulator. In fact, the reason rxvt-unicode was born was solely |
37 | terminal emulator. In fact, the reason rxvt-unicode was born was solely |
38 | because the author couldn't get "mlterm" to use one font for latin1 and |
38 | because the author couldn't get "mlterm" to use one font for latin1 and |
39 | another for japanese. |
39 | another for japanese. |
40 | |
40 | |
41 | Therefore another design rationale was the use of multiple fonts to |
41 | Therefore another design rationale was the use of multiple fonts to |
42 | display characters: The idea of a single unicode font which many other |
42 | display characters: The idea of a single unicode font which many other |
43 | programs force onto it's users never made sense to me: You should be |
43 | programs force onto its users never made sense to me: You should be able |
44 | able to choose any font for any script freely. |
44 | to choose any font for any script freely. |
45 | |
45 | |
46 | Apart from that, rxvt-unicode is also much better internationalised than |
46 | Apart from that, rxvt-unicode is also much better internationalised than |
47 | it's predecessor, supports things such as XFT and ISO 14755 that are |
47 | its predecessor, supports things such as XFT and ISO 14755 that are |
48 | handy in i18n-environments, is faster, and has a lot less bugs than the |
48 | handy in i18n-environments, is faster, and has a lot bugs less than the |
49 | original rxvt. This all in addition to dozens of other small |
49 | original rxvt. This all in addition to dozens of other small |
50 | improvements. |
50 | improvements. |
51 | |
51 | |
52 | It is still faithfully following the original rxvt idea of being lean |
52 | It is still faithfully following the original rxvt idea of being lean |
53 | and nice on resources: for example, you can still configure rxvt-unicode |
53 | and nice on resources: for example, you can still configure rxvt-unicode |
54 | without most of it's features to get a lean binary. It also comes with a |
54 | without most of its features to get a lean binary. It also comes with a |
55 | client/daemon pair that lets you open any number of terminal windows |
55 | client/daemon pair that lets you open any number of terminal windows |
56 | from within a single process, which makes startup time very fast and |
56 | from within a single process, which makes startup time very fast and |
57 | drastically reduces memory usage. See rxvtd(1) (daemon) and rxvtc(1) |
57 | drastically reduces memory usage. See rxvtd(1) (daemon) and rxvtc(1) |
58 | (client). |
58 | (client). |
59 | |
59 | |
60 | It also makes technical information about escape sequences (which have |
60 | It also makes technical information about escape sequences (which have |
61 | been extended) easier accessible: see rxvt(7) for technical reference |
61 | been extended) more accessible: see rxvt(7) for technical reference |
62 | documentation (escape sequences etc.). |
62 | documentation (escape sequences etc.). |
63 | |
63 | |
64 | OPTIONS |
64 | OPTIONS |
65 | The rxvt options (mostly a subset of *xterm*'s) are listed below. In |
65 | The rxvt options (mostly a subset of *xterm*'s) are listed below. In |
66 | keeping with the smaller-is-better philosophy, options may be eliminated |
66 | keeping with the smaller-is-better philosophy, options may be eliminated |
… | |
… | |
84 | -display *displayname* |
84 | -display *displayname* |
85 | Attempt to open a window on the named X display (-d still |
85 | Attempt to open a window on the named X display (-d still |
86 | respected). In the absence of this option, the display specified by |
86 | respected). In the absence of this option, the display specified by |
87 | the DISPLAY environment variable is used. |
87 | the DISPLAY environment variable is used. |
88 | |
88 | |
|
|
89 | -depth *bitdepth* |
|
|
90 | Compile *xft*: Attempt to find a visual with the given bit depth; |
|
|
91 | resource depth. |
|
|
92 | |
89 | -geometry *geom* |
93 | -geometry *geom* |
90 | Window geometry (-g still respected); resource geometry. |
94 | Window geometry (-g still respected); resource geometry. |
91 | |
95 | |
92 | -rv|+rv |
96 | -rv|+rv |
93 | Turn on/off simulated reverse video; resource reverseVideo. |
97 | Turn on/off simulated reverse video; resource reverseVideo. |
94 | |
98 | |
95 | -j|+j |
99 | -j|+j |
96 | Turn on/off jump scrolling; resource jumpScroll. |
100 | Turn on/off jump scrolling (allow multiple lines per refresh); |
|
|
101 | resource jumpScroll. |
|
|
102 | |
|
|
103 | -ss|+ss |
|
|
104 | Turn on/off skip scrolling (allow multiple screens per refresh); |
|
|
105 | resource skipScroll. |
97 | |
106 | |
98 | -ip|+ip | -tr|+tr |
107 | -ip|+ip | -tr|+tr |
99 | Turn on/off inheriting parent window's pixmap. Alternative form is |
108 | Turn on/off inheriting parent window's pixmap. Alternative form is |
100 | -tr; resource inheritPixmap. |
109 | -tr; resource inheritPixmap. |
|
|
110 | |
|
|
111 | *Please note that transparency of any kind if completely unsupported |
|
|
112 | by the author. Don't bug him with installation questions! Read the |
|
|
113 | FAQ (man 7 rxvt)!* |
101 | |
114 | |
102 | -fade *number* |
115 | -fade *number* |
103 | Fade the text by the given percentage when focus is lost. Small |
116 | Fade the text by the given percentage when focus is lost. Small |
104 | values fade a little only, 100 completely replaces all colours by |
117 | values fade a little only, 100 completely replaces all colours by |
105 | the fade colour; resource fading. |
118 | the fade colour; resource fading. |
106 | |
119 | |
107 | -fadecolor *colour* |
120 | -fadecolor *colour* |
108 | Fade to this colour when fading is used (see -fade). The default |
121 | Fade to this colour when fading is used (see -fade). The default |
109 | colour is black. resource fadeColor. |
122 | colour is opaque black. resource fadeColor. |
110 | |
123 | |
111 | -tint *colour* |
124 | -tint *colour* |
112 | Tint the transparent background pixmap with the given colour when |
125 | Tint the transparent background pixmap with the given colour when |
113 | transparency is enabled with -tr or -ip. This only works for |
126 | transparency is enabled with -tr or -ip. This only works for |
114 | non-tiled backgrounds, currently. See also the -sh option that can |
127 | non-tiled backgrounds, currently. See also the -sh option that can |
115 | be used to brighten or darken the image in addition to tinting it; |
128 | be used to brighten or darken the image in addition to tinting it. |
116 | resource *tintColor*. Example: |
129 | Please note that certain tint colours can be applied on the |
|
|
130 | server-side, thus yielding performance gain of two orders of |
|
|
131 | magnitude. These colours are: blue, red, green, cyan, magenta, |
|
|
132 | yellow, and those close to them; resource *tintColor*. Example: |
117 | |
133 | |
118 | rxvt -tr -tint blue -sh 40 |
134 | rxvt -tr -tint blue -sh 40 |
119 | |
135 | |
|
|
136 | -sh *number* |
120 | -sh *number* Darken (0 .. 100) or lighten (-1 .. -100) the transparent |
137 | Darken (0 .. 100) or lighten (-1 .. -100) the transparent background |
121 | background image in addition to tinting it (i.e. -tint must be |
138 | image in addition to (or instead of) tinting it; resource *shading*. |
122 | specified, too, e.g. "-tint white"). |
139 | |
|
|
140 | -blt *string* |
|
|
141 | Specify background blending type. If background pixmap is specified |
|
|
142 | at the same time as transparency - such pixmap will be blended over |
|
|
143 | transparency image, using method specified. Supported values are : |
|
|
144 | add, alphablend, allanon - color values averaging, colorize, darken, |
|
|
145 | diff, dissipate, hue, lighten, overlay, saturate, screen, sub, tint, |
|
|
146 | value. The default is alpha-blending; resource *blendType*. |
|
|
147 | |
|
|
148 | -blr *HxV* |
|
|
149 | Apply Gaussian Blur with the specified radii to the transparent |
|
|
150 | background image. If single number is specified - both vertical and |
|
|
151 | horizontal radii are considered to be the same. Setting one of the |
|
|
152 | radii to 1 and another to a large number creates interesting effects |
|
|
153 | on some backgrounds. Maximum radius value is 128; resource |
|
|
154 | *blurRadius*. |
123 | |
155 | |
124 | -bg *colour* |
156 | -bg *colour* |
125 | Window background colour; resource background. |
157 | Window background colour; resource background. |
126 | |
158 | |
127 | -fg *colour* |
159 | -fg *colour* |
128 | Window foreground colour; resource foreground. |
160 | Window foreground colour; resource foreground. |
129 | |
161 | |
130 | -pixmap *file[;geom]* |
162 | -pixmap *file[;geom]* |
131 | Compile *XPM*: Specify XPM file for the background and also |
163 | Compile *afterimage*: Specify image file for the background and also |
132 | optionally specify its scaling with a geometry string. Note you may |
164 | optionally specify its scaling with a geometry string. Note you may |
133 | need to add quotes to avoid special shell interpretation of the ";" |
165 | need to add quotes to avoid special shell interpretation of the ";" |
134 | in the command-line; resource backgroundPixmap. |
166 | in the command-line; for more details see resource backgroundPixmap. |
135 | |
167 | |
136 | -cr *colour* |
168 | -cr *colour* |
137 | The cursor colour; resource cursorColor. |
169 | The cursor colour; resource cursorColor. |
138 | |
170 | |
139 | -pr *colour* |
171 | -pr *colour* |
… | |
… | |
146 | The colour of the border around the text area and between the |
178 | The colour of the border around the text area and between the |
147 | scrollbar and the text; resource borderColor. |
179 | scrollbar and the text; resource borderColor. |
148 | |
180 | |
149 | -fn *fontlist* |
181 | -fn *fontlist* |
150 | Select the fonts to be used. This is a comma separated list of font |
182 | Select the fonts to be used. This is a comma separated list of font |
151 | names that are used in turn when trying to display Unicode |
183 | names that are checked in order when trying to find glyphs for |
152 | characters. The first font defines the cell size for characters; |
184 | characters. The first font defines the cell size for characters; |
153 | other fonts might be smaller, but not (in general) larger. A |
185 | other fonts might be smaller, but not (in general) larger. A |
154 | (hopefully) reasonable default font list is always appended to it. |
186 | (hopefully) reasonable default font list is always appended to it. |
155 | See resource font for more details. |
187 | See resource font for more details. |
156 | |
188 | |
157 | In short, to specify an X11 core font, just specify it's name or |
189 | In short, to specify an X11 core font, just specify its name or |
158 | prefix it with "x:". To specify an XFT-font, you need to prefix it |
190 | prefix it with "x:". To specify an XFT-font, you need to prefix it |
159 | with "xft:", e.g.: |
191 | with "xft:", e.g.: |
160 | |
192 | |
161 | rxvt -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" |
193 | rxvt -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" |
162 | rxvt -fn "9x15bold,xft:Bitstream Vera Sans Mono" |
194 | rxvt -fn "9x15bold,xft:Bitstream Vera Sans Mono" |
163 | |
195 | |
164 | See also the question "How does rxvt-unicode choose fonts?" in the |
196 | See also the question "How does rxvt-unicode choose fonts?" in the |
165 | FAQ section of rxvt(7). |
197 | FAQ section of rxvt(7). |
166 | |
198 | |
167 | -fb *fontlist* |
199 | -fb *fontlist* |
168 | Compile font-styles: The bold font list to use when bold characters |
200 | Compile *font-styles*: The bold font list to use when bold |
169 | are to be printed. See resource boldFont for details. |
201 | characters are to be printed. See resource boldFont for details. |
170 | |
202 | |
171 | -fi *fontlist* |
203 | -fi *fontlist* |
172 | Compile font-styles: The italic font list to use when bold |
204 | Compile *font-styles*: The italic font list to use when *italic* |
173 | characters are to be printed. See resource italicFont for details. |
205 | characters are to be printed. See resource italicFont for details. |
174 | |
206 | |
175 | -fbi *fontlist* |
207 | -fbi *fontlist* |
176 | Compile font-styles: The bold italic font list to use when bold |
208 | Compile *font-styles*: The bold italic font list to use when *bold |
177 | characters are to be printed. See resource boldItalicFont for |
209 | italic* characters are to be printed. See resource boldItalicFont |
178 | details. |
210 | for details. |
179 | |
211 | |
180 | -is|+is |
212 | -is|+is |
181 | Compile font-styles: Bold/Italic font styles imply high intensity |
213 | Compile *font-styles*: Bold/Italic font styles imply high intensity |
182 | foreground/background (default). See resource intensityStyles for |
214 | foreground/background (default). See resource intensityStyles for |
183 | details. |
215 | details. |
184 | |
216 | |
185 | -name *name* |
217 | -name *name* |
186 | Specify the application name under which resources are to be |
218 | Specify the application name under which resources are to be |
… | |
… | |
251 | externalBorder. |
283 | externalBorder. |
252 | |
284 | |
253 | -bl Compile *frills*: Set MWM hints to request a borderless window, i.e. |
285 | -bl Compile *frills*: Set MWM hints to request a borderless window, i.e. |
254 | if honoured by the WM, the rxvt-unicode window will not have window |
286 | if honoured by the WM, the rxvt-unicode window will not have window |
255 | decorations; resource borderLess. |
287 | decorations; resource borderLess. |
|
|
288 | |
|
|
289 | -override-redirect |
|
|
290 | Compile *frills*: Sets override-redirect on the window; resource |
|
|
291 | override-redirect. |
|
|
292 | |
|
|
293 | -sbg |
|
|
294 | Compile *frills*: Disable the usage of the built-in block |
|
|
295 | graphics/line drawing characters and just rely on what the specified |
|
|
296 | fonts provide. Use this if you have a good font and want to use its |
|
|
297 | block graphic glyphs; resource skipBuiltinGlyphs. |
256 | |
298 | |
257 | -lsp *number* |
299 | -lsp *number* |
258 | Compile *frills*: Lines (pixel height) to insert between each row of |
300 | Compile *frills*: Lines (pixel height) to insert between each row of |
259 | the display. Useful to work around font rendering problems; resource |
301 | the display. Useful to work around font rendering problems; resource |
260 | linespace. |
302 | linespace. |
… | |
… | |
309 | Set the font set to use for the X Input Method, see resource imFont |
351 | Set the font set to use for the X Input Method, see resource imFont |
310 | for more info. |
352 | for more info. |
311 | |
353 | |
312 | -tcw |
354 | -tcw |
313 | Change the meaning of triple-click selection with the left mouse |
355 | Change the meaning of triple-click selection with the left mouse |
|
|
356 | button. Only effective when the original (non-perl) selection code |
314 | button. Instead of selecting a full line it will extend the |
357 | is in-use. Instead of selecting a full line it will extend the |
315 | selection the end of the logical line only. resource |
358 | selection the end of the logical line only. resource |
316 | tripleclickwords. |
359 | tripleclickwords. |
317 | |
360 | |
318 | -insecure |
361 | -insecure |
319 | Enable "insecure" mode, which currently enables most of the escape |
362 | Enable "insecure" mode, which currently enables most of the escape |
… | |
… | |
340 | |
383 | |
341 | -keysym.*sym* *string* |
384 | -keysym.*sym* *string* |
342 | Remap a key symbol. See resource keysym. |
385 | Remap a key symbol. See resource keysym. |
343 | |
386 | |
344 | -embed *windowid* |
387 | -embed *windowid* |
345 | Tells rxvt to embed it's windows into an already-existing window, |
388 | Tells rxvt to embed its windows into an already-existing window, |
346 | which enables applications to easily embed a terminal. |
389 | which enables applications to easily embed a terminal. |
347 | |
390 | |
348 | Right now, rxvt will first unmap/map the specified window, so it |
391 | Right now, rxvt will first unmap/map the specified window, so it |
349 | shouldn't be a top-level window. rxvt will also reconfigure it quite |
392 | shouldn't be a top-level window. rxvt will also reconfigure it quite |
350 | a bit, so don't expect it to keep some specific state. It's best to |
393 | a bit, so don't expect it to keep some specific state. It's best to |
… | |
… | |
353 | The window will not be destroyed when rxvt exits. |
396 | The window will not be destroyed when rxvt exits. |
354 | |
397 | |
355 | It might be useful to know that rxvt will not close file descriptors |
398 | It might be useful to know that rxvt will not close file descriptors |
356 | passed to it (except for stdin/out/err, of course), so you can use |
399 | passed to it (except for stdin/out/err, of course), so you can use |
357 | file descriptors to communicate with the programs within the |
400 | file descriptors to communicate with the programs within the |
358 | terminal. This works regardless of wether the "-embed" option was |
401 | terminal. This works regardless of whether the "-embed" option was |
359 | used or not. |
402 | used or not. |
360 | |
403 | |
361 | Here is a short Gtk2-perl snippet that illustrates how this option |
404 | Here is a short Gtk2-perl snippet that illustrates how this option |
362 | can be used (a longer example is in doc/embed): |
405 | can be used (a longer example is in doc/embed): |
363 | |
406 | |
… | |
… | |
365 | $rxvt->signal_connect_after (realize => sub { |
408 | $rxvt->signal_connect_after (realize => sub { |
366 | my $xid = $_[0]->window->get_xid; |
409 | my $xid = $_[0]->window->get_xid; |
367 | system "rxvt -embed $xid &"; |
410 | system "rxvt -embed $xid &"; |
368 | }); |
411 | }); |
369 | |
412 | |
370 | -pty-fd *fileno* |
413 | -pty-fd *file descriptor* |
371 | Tells rxvt NOT to execute any commands or create a new pty/tty pair |
414 | Tells rxvt NOT to execute any commands or create a new pty/tty pair |
372 | but instead use the given filehandle as the tty master. This is |
415 | but instead use the given file descriptor as the tty master. This is |
373 | useful if you want to drive rxvt as a generic terminal emulator |
416 | useful if you want to drive rxvt as a generic terminal emulator |
374 | without having to run a program within it. |
417 | without having to run a program within it. |
375 | |
418 | |
376 | If this switch is given, rxvt will not create any utmp/wtmp entries |
419 | If this switch is given, rxvt will not create any utmp/wtmp entries |
377 | and will not tinker with pty/tty permissions - you have to do that |
420 | and will not tinker with pty/tty permissions - you have to do that |
378 | yourself if you want that. |
421 | yourself if you want that. |
|
|
422 | |
|
|
423 | As an extremely special case, specifying -1 will completely suppress |
|
|
424 | pty/tty operations. |
379 | |
425 | |
380 | Here is a example in perl that illustrates how this option can be |
426 | Here is a example in perl that illustrates how this option can be |
381 | used (a longer example is in doc/pty-fd): |
427 | used (a longer example is in doc/pty-fd): |
382 | |
428 | |
383 | use IO::Pty; |
429 | use IO::Pty; |
… | |
… | |
391 | # now communicate with rxvt |
437 | # now communicate with rxvt |
392 | my $slave = $pty->slave; |
438 | my $slave = $pty->slave; |
393 | while (<$slave>) { print $slave "got <$_>\n" } |
439 | while (<$slave>) { print $slave "got <$_>\n" } |
394 | |
440 | |
395 | -pe *string* |
441 | -pe *string* |
396 | Colon-separated list of perl extension scripts to use in this |
442 | Comma-separated list of perl extension scripts to use (or not to |
397 | terminal instance. See resource perl-ext. |
443 | use) in this terminal instance. See resource perl-ext for details. |
398 | |
444 | |
399 | RESOURCES (available also as long-options) |
445 | RESOURCES (available also as long-options) |
400 | Note: `rxvt --help' gives a list of all resources (long options) |
446 | Note: `rxvt --help' gives a list of all resources (long options) |
401 | compiled into your version. |
447 | compiled into your version. |
402 | |
448 | |
403 | There are two different methods that rxvt can use to get the Xresource |
|
|
404 | data: using the X libraries (Xrm*-functions) or internal Xresources |
|
|
405 | reader (~/.Xdefaults). For the first method (ie. rxvt -h lists |
|
|
406 | XGetDefaults), you can set and change the resources using X11 tools like |
449 | You can set and change the resources using X11 tools like xrdb. Many |
407 | xrdb. Many distribution do also load settings from the ~/.Xresources |
450 | distribution do also load settings from the ~/.Xresources file when X |
408 | file when X starts. rxvt will consult the following files/resources in |
451 | starts. rxvt will consult the following files/resources in order, with |
409 | order, with later settings overwriting earlier ones: |
452 | later settings overwriting earlier ones: |
410 | |
453 | |
411 | 1. system-wide app-defaults file, either locale-dependent OR global |
454 | 1. system-wide app-defaults file, either locale-dependent OR global |
412 | 2. app-defaults file in $XAPPLRESDIR |
455 | 2. app-defaults file in $XAPPLRESDIR |
413 | 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults |
456 | 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults |
414 | 4. SCREEN_RESOURCES for the current screen |
457 | 4. SCREEN_RESOURCES for the current screen |
415 | 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> |
458 | 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> |
416 | |
459 | |
417 | If compiled with internal Xresources support (i.e. rxvt -h lists |
460 | Note that when reading X resources, rxvt recognizes two class names: |
418 | .Xdefaults) then rxvt accepts application defaults set in |
461 | Rxvt and URxvt. The class name Rxvt allows resources common to both rxvt |
419 | XAPPLOADDIR/URxvt (compile-time defined: usually |
462 | and the original *rxvt* to be easily configured, while the class name |
420 | /usr/lib/X11/app-defaults/URxvt) and resources set in ~/.Xdefaults, or |
463 | URxvt allows resources unique to rxvt, to be shared between different |
421 | ~/.Xresources if ~/.Xdefaults does not exist. Note that when reading X |
|
|
422 | resources, rxvt recognizes two class names: XTerm and URxvt. The class |
|
|
423 | name Rxvt allows resources common to both rxvt and the original *rxvt* |
|
|
424 | to be easily configured, while the class name URxvt allows resources |
|
|
425 | unique to rxvt, notably colours and key-handling, to be shared between |
|
|
426 | different rxvt configurations. If no resources are specified, suitable |
464 | rxvt configurations. If no resources are specified, suitable defaults |
427 | defaults will be used. Command-line arguments can be used to override |
465 | will be used. Command-line arguments can be used to override resource |
428 | resource settings. The following resources are allowed: |
466 | settings. The following resources are supported (you might want to check |
|
|
467 | the rxvtperl(3) manpage for additional settings by perl extensions not |
|
|
468 | documented here): |
|
|
469 | |
|
|
470 | depth: *bitdepth* |
|
|
471 | Compile *xft*: Attempt to find a visual with the given bit depth; |
|
|
472 | option -depth. |
429 | |
473 | |
430 | geometry: *geom* |
474 | geometry: *geom* |
431 | Create the window with the specified X window geometry [default |
475 | Create the window with the specified X window geometry [default |
432 | 80x24]; option -geometry. |
476 | 80x24]; option -geometry. |
433 | |
477 | |
… | |
… | |
465 | Use the specified colour to display underlined characters when the |
509 | Use the specified colour to display underlined characters when the |
466 | foreground colour is the default. |
510 | foreground colour is the default. |
467 | |
511 | |
468 | colorRV: *colour* |
512 | colorRV: *colour* |
469 | Use the specified colour as the background for reverse video |
513 | Use the specified colour as the background for reverse video |
470 | characters. |
514 | characters when OPTION_HC is disabled (--disable-frills). |
471 | |
515 | |
472 | underlineColor: *colour* |
516 | underlineColor: *colour* |
473 | If set, use the specified colour as the colour for the underline |
517 | If set, use the specified colour as the colour for the underline |
474 | itself. If unset, use the foreground colour. |
518 | itself. If unset, use the foreground colour. |
475 | |
519 | |
… | |
… | |
486 | True: simulate reverse video by foreground and background colours; |
530 | True: simulate reverse video by foreground and background colours; |
487 | option -rv. False: regular screen colours [default]; option +rv. See |
531 | option -rv. False: regular screen colours [default]; option +rv. See |
488 | note in COLORS AND GRAPHICS section. |
532 | note in COLORS AND GRAPHICS section. |
489 | |
533 | |
490 | jumpScroll: *boolean* |
534 | jumpScroll: *boolean* |
491 | True: specify that jump scrolling should be used. When scrolling |
535 | True: specify that jump scrolling should be used. When receiving |
492 | quickly, fewer screen updates are performed [default]; option -j. |
536 | lots of lines, rxvt will only scroll once a whole screen height of |
|
|
537 | lines has been read, resulting in fewer updates while still |
|
|
538 | displaying every received line; option -j. |
|
|
539 | |
493 | False: specify that smooth scrolling should be used; option +j. |
540 | False: specify that smooth scrolling should be used. rxvt will force |
|
|
541 | a screen refresh on each new line it received; option +j. |
|
|
542 | |
|
|
543 | skipScroll: *boolean* |
|
|
544 | True: (the default) specify that skip scrolling should be used. When |
|
|
545 | receiving lots of lines, rxvt will only scroll once in a while |
|
|
546 | (around 60 times per second), resulting in far fewer updates. This |
|
|
547 | can result in rxvt not ever displaying some of the lines it |
|
|
548 | receives; option -ss. |
|
|
549 | |
|
|
550 | False: specify that everything is to be displayed, even if the |
|
|
551 | refresh is too fast for the human eye to read anything (or the |
|
|
552 | monitor to display anything); option +ss. |
494 | |
553 | |
495 | inheritPixmap: *boolean* |
554 | inheritPixmap: *boolean* |
496 | True: make the background inherit the parent windows' pixmap, giving |
555 | True: make the background inherit the parent windows' pixmap, giving |
497 | artificial transparency. False: do not inherit the parent windows' |
556 | artificial transparency. False: do not inherit the parent windows' |
498 | pixmap. |
557 | pixmap. |
499 | |
558 | |
|
|
559 | *Please note that transparency of any kind if completely unsupported |
|
|
560 | by the author. Don't bug him with installation questions!* |
|
|
561 | |
500 | fading: *number* |
562 | fading: *number* |
501 | Fade the text by the given percentage when focus is lost; option |
563 | Fade the text by the given percentage when focus is lost; option |
502 | -fade. |
564 | -fade. |
503 | |
565 | |
504 | fadeColor: *colour* |
566 | fadeColor: *colour* |
… | |
… | |
509 | Tint the transparent background pixmap with the given colour; option |
571 | Tint the transparent background pixmap with the given colour; option |
510 | -tint. |
572 | -tint. |
511 | |
573 | |
512 | shading: *number* |
574 | shading: *number* |
513 | Darken (0 .. 100) or lighten (-1 .. -100) the transparent background |
575 | Darken (0 .. 100) or lighten (-1 .. -100) the transparent background |
514 | image in addition to tinting it. |
576 | image in addition to tinting it; option -sh. |
|
|
577 | |
|
|
578 | blendType: *string* |
|
|
579 | Specify background blending type; option -blt. |
|
|
580 | |
|
|
581 | blurRadius: *number* |
|
|
582 | Apply Gaussian Blurr with the specified radius to the transparent |
|
|
583 | background image; option -blr. |
515 | |
584 | |
516 | scrollColor: *colour* |
585 | scrollColor: *colour* |
517 | Use the specified colour for the scrollbar [default #B2B2B2]. |
586 | Use the specified colour for the scrollbar [default #B2B2B2]. |
518 | |
587 | |
519 | troughColor: *colour* |
588 | troughColor: *colour* |
… | |
… | |
523 | borderColor: *colour* |
592 | borderColor: *colour* |
524 | The colour of the border around the text area and between the |
593 | The colour of the border around the text area and between the |
525 | scrollbar and the text. |
594 | scrollbar and the text. |
526 | |
595 | |
527 | backgroundPixmap: *file[;geom]* |
596 | backgroundPixmap: *file[;geom]* |
528 | Use the specified XPM file (note the `.xpm' extension is optional) |
597 | Use the specified image file for the background and also optionally |
529 | for the background and also optionally specify its scaling with a |
598 | specify its scaling with a geometry string WxH+X+Y, in which "W" / |
530 | geometry string WxH+X+Y, in which "W" / "H" specify the |
|
|
531 | horizontal/vertical scale (percent) and "X" / "Y" locate the image |
599 | "H" specify the horizontal/vertical scale (percent), and "X" / "Y" |
532 | centre (percent). A scale of 0 displays the image with tiling. A |
600 | locate the image centre (percent). A scale of 0 displays the image |
533 | scale of 1 displays the image without any scaling. A scale of 2 to 9 |
601 | with tiling. A scale of 1 displays the image without any scaling. A |
534 | specifies an integer number of images in that direction. No image |
602 | scale of 2 to 9 specifies an integer number of images in that |
535 | will be magnified beyond 10 times its original size. The maximum |
603 | direction. No image will be magnified beyond 10 times its original |
536 | permitted scale is 1000. [default 0x0+50+50] |
604 | size. The maximum permitted scale is 1000. Special string of "auto" |
537 | |
605 | used as a geometry will cause image to be automatically scaled to |
538 | menu: *file[;tag]* |
606 | match window size. If used in conjunction with -tr option - |
539 | Read in the specified menu file (note the `.menu' extension is |
607 | specified pixmap will be blended over transparency image using |
540 | optional) and also optionally specify a starting tag to find. See |
608 | either alpha-blending, or any other blending type, specified with |
541 | the reference documentation for details on the syntax for the |
609 | -blt "type" option. [default 0x0+50+50] |
542 | menuBar. |
|
|
543 | |
610 | |
544 | path: *path* |
611 | path: *path* |
545 | Specify the colon-delimited search path for finding files (XPM and |
612 | Specify the colon-delimited search path for finding XPM files. |
546 | menus), in addition to the paths specified by the RXVTPATH and PATH |
|
|
547 | environment variables. |
|
|
548 | |
613 | |
549 | font: *fontlist* |
614 | font: *fontlist* |
550 | Select the fonts to be used. This is a comma separated list of font |
615 | Select the fonts to be used. This is a comma separated list of font |
551 | names that are used in turn when trying to display Unicode |
616 | names that are checked in order when trying to find glyphs for |
552 | characters. The first font defines the cell size for characters; |
617 | characters. The first font defines the cell size for characters; |
553 | other fonts might be smaller, but not larger. A reasonable default |
618 | other fonts might be smaller, but not (in general) larger. A |
554 | font list is always appended to it; option -fn. |
619 | (hopefully) reasonable default font list is always appended to it; |
|
|
620 | option -fn. |
555 | |
621 | |
556 | Each font can either be a standard X11 core font (XLFD) name, with |
622 | Each font can either be a standard X11 core font (XLFD) name, with |
557 | optional prefix "x:" or a Xft font (Compile *xft*), prefixed with |
623 | optional prefix "x:" or a Xft font (Compile *xft*), prefixed with |
558 | "xft:". |
624 | "xft:". |
559 | |
625 | |
… | |
… | |
562 | available hint currently is "codeset=codeset-name", and this is only |
628 | available hint currently is "codeset=codeset-name", and this is only |
563 | used for Xft fonts. |
629 | used for Xft fonts. |
564 | |
630 | |
565 | For example, this font resource |
631 | For example, this font resource |
566 | |
632 | |
567 | URxvt*font: 9x15bold,\ |
633 | URxvt.font: 9x15bold,\ |
568 | -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\ |
634 | -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\ |
569 | -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \ |
635 | -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \ |
570 | [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ |
636 | [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ |
571 | xft:Code2000:antialias=false |
637 | xft:Code2000:antialias=false |
572 | |
638 | |
… | |
… | |
608 | normal text font will being used for the given style. |
674 | normal text font will being used for the given style. |
609 | |
675 | |
610 | intensityStyles: *boolean* |
676 | intensityStyles: *boolean* |
611 | When font styles are not enabled, or this option is enabled (True, |
677 | When font styles are not enabled, or this option is enabled (True, |
612 | option -is, the default), bold and italic font styles imply high |
678 | option -is, the default), bold and italic font styles imply high |
613 | intensity foreground/backround colours. Disabling this option |
679 | intensity foreground/background colours. Disabling this option |
614 | (False, option +is) disables this behaviour, the high intensity |
680 | (False, option +is) disables this behaviour, the high intensity |
615 | colours are not reachable. |
681 | colours are not reachable. |
616 | |
682 | |
617 | selectstyle: *mode* |
683 | selectstyle: *mode* |
618 | Set mouse selection style to old which is 2.20, oldword which is |
684 | Set mouse selection style to old which is 2.20, oldword which is |
619 | xterm style with 2.20 old word selection, or anything else which |
685 | xterm style with 2.20 old word selection, or anything else which |
620 | gives xterm style selection. |
686 | gives xterm style selection. Only effective when the original |
|
|
687 | (non-perl) selection code is in use. |
621 | |
688 | |
622 | scrollstyle: *mode* |
689 | scrollstyle: *mode* |
623 | Set scrollbar style to rxvt, plain, next or xterm. plain is the |
690 | Set scrollbar style to rxvt, plain, next or xterm. plain is the |
624 | author's favourite. |
691 | author's favourite. |
625 | |
692 | |
… | |
… | |
635 | |
702 | |
636 | mapAlert: *boolean* |
703 | mapAlert: *boolean* |
637 | True: de-iconify (map) on receipt of a bell character. False: no |
704 | True: de-iconify (map) on receipt of a bell character. False: no |
638 | de-iconify (map) on receipt of a bell character [default]. |
705 | de-iconify (map) on receipt of a bell character [default]. |
639 | |
706 | |
|
|
707 | urgentOnBell: *boolean* |
|
|
708 | True: set the urgency hint for the wm on receipt of a bell |
|
|
709 | character. False: do not set the urgency hint [default]. |
|
|
710 | |
640 | visualBell: *boolean* |
711 | visualBell: *boolean* |
641 | True: use visual bell on receipt of a bell character; option -vb. |
712 | True: use visual bell on receipt of a bell character; option -vb. |
642 | False: no visual bell [default]; option +vb. |
713 | False: no visual bell [default]; option +vb. |
643 | |
714 | |
644 | loginShell: *boolean* |
715 | loginShell: *boolean* |
… | |
… | |
658 | |
729 | |
659 | The string will be interpreted as if typed into the shell as-is. |
730 | The string will be interpreted as if typed into the shell as-is. |
660 | |
731 | |
661 | Example: |
732 | Example: |
662 | |
733 | |
663 | URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) |
734 | URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) |
664 | |
735 | |
665 | This creates a new file in your home directory with the screen |
736 | This creates a new file in your home directory with the screen |
666 | contents everytime you hit "Print". |
737 | contents every time you hit "Print". |
667 | |
738 | |
668 | scrollBar: *boolean* |
739 | scrollBar: *boolean* |
669 | True: enable the scrollbar [default]; option -sb. False: disable the |
740 | True: enable the scrollbar [default]; option -sb. False: disable the |
670 | scrollbar; option +sb. |
741 | scrollbar; option +sb. |
671 | |
742 | |
… | |
… | |
686 | do not scroll to bottom when tty receives output; option +si. |
757 | do not scroll to bottom when tty receives output; option +si. |
687 | |
758 | |
688 | scrollWithBuffer: *boolean* |
759 | scrollWithBuffer: *boolean* |
689 | True: scroll with scrollback buffer when tty receives new lines (and |
760 | True: scroll with scrollback buffer when tty receives new lines (and |
690 | scrollTtyOutput is False); option -sw. False: do not scroll with |
761 | scrollTtyOutput is False); option -sw. False: do not scroll with |
691 | scrollback buffer when tty recieves new lines; option +sw. |
762 | scrollback buffer when tty receives new lines; option +sw. |
692 | |
763 | |
693 | scrollTtyKeypress: *boolean* |
764 | scrollTtyKeypress: *boolean* |
694 | True: scroll to bottom when a non-special key is pressed. Special |
765 | True: scroll to bottom when a non-special key is pressed. Special |
695 | keys are those which are intercepted by rxvt-unicode for special |
766 | keys are those which are intercepted by rxvt-unicode for special |
696 | handling and are not passed onto the shell; option -sk. False: do |
767 | handling and are not passed onto the shell; option -sk. False: do |
… | |
… | |
711 | borderLess: *boolean* |
782 | borderLess: *boolean* |
712 | Set MWM hints to request a borderless window, i.e. if honoured by |
783 | Set MWM hints to request a borderless window, i.e. if honoured by |
713 | the WM, the rxvt-unicode window will not have window decorations; |
784 | the WM, the rxvt-unicode window will not have window decorations; |
714 | option -bl. |
785 | option -bl. |
715 | |
786 | |
|
|
787 | skipBuiltinGlyphs: *boolean* |
|
|
788 | Compile *frills*: Disable the usage of the built-in block |
|
|
789 | graphics/line drawing characters and just rely on what the specified |
|
|
790 | fonts provide. Use this if you have a good font and want to use its |
|
|
791 | block graphic glyphs; option -sbg. |
|
|
792 | |
716 | termName: *termname* |
793 | termName: *termname* |
717 | Specifies the terminal type name to be set in the TERM environment |
794 | Specifies the terminal type name to be set in the TERM environment |
718 | variable; option -tn. |
795 | variable; option -tn. |
719 | |
796 | |
720 | linespace: *number* |
797 | linespace: *number* |
… | |
… | |
763 | The string to send when the delete key (not the keypad delete key) |
840 | The string to send when the delete key (not the keypad delete key) |
764 | is pressed. If unset it will send the sequence traditionally |
841 | is pressed. If unset it will send the sequence traditionally |
765 | associated with the Execute key. |
842 | associated with the Execute key. |
766 | |
843 | |
767 | cutchars: *string* |
844 | cutchars: *string* |
768 | The characters used as delimiters for double-click word selection. |
845 | The characters used as delimiters for double-click word selection |
769 | The built-in default: |
846 | (whitespace delimiting is added automatically if resource is given). |
|
|
847 | |
|
|
848 | When the perl selection extension is in use (the default if compiled |
|
|
849 | in, see the rxvtperl(3) manpage), a suitable regex using these |
|
|
850 | characters will be created (if the resource exists, otherwise, no |
|
|
851 | regex will be created). In this mode, characters outside ISO-8859-1 |
|
|
852 | can be used. |
|
|
853 | |
|
|
854 | When the selection extension is not used, only ISO-8859-1 characters |
|
|
855 | can be used. If not specified, the built-in default is used: |
770 | |
856 | |
771 | BACKSLASH `"'&()*,;<=>?@[]{|} |
857 | BACKSLASH `"'&()*,;<=>?@[]{|} |
772 | |
858 | |
773 | preeditType: *style* |
859 | preeditType: *style* |
774 | OverTheSpot, OffTheSpot, Root; option -pt. |
860 | OverTheSpot, OffTheSpot, Root; option -pt. |
… | |
… | |
805 | xterm, have these sequences enabled by default, which doesn't make |
891 | xterm, have these sequences enabled by default, which doesn't make |
806 | it safer, though). |
892 | it safer, though). |
807 | |
893 | |
808 | You can enable them by setting this boolean resource or specifying |
894 | You can enable them by setting this boolean resource or specifying |
809 | -insecure as an option. At the moment, this enables display-answer, |
895 | -insecure as an option. At the moment, this enables display-answer, |
810 | locale, findfont, icon label and window title requests as well as |
896 | locale, findfont, icon label and window title requests. |
811 | dynamic menubar dispatch. |
|
|
812 | |
897 | |
813 | modifier: *modifier* |
898 | modifier: *modifier* |
814 | Set the key to be interpreted as the Meta key to: alt, meta, hyper, |
899 | Set the key to be interpreted as the Meta key to: alt, meta, hyper, |
815 | super, mod1, mod2, mod3, mod4, mod5; option -mod. |
900 | super, mod1, mod2, mod3, mod4, mod5; option -mod. |
816 | |
901 | |
817 | answerbackString: *string* |
902 | answerbackString: *string* |
818 | Specify the reply rxvt-unicode sends to the shell when an ENQ |
903 | Specify the reply rxvt-unicode sends to the shell when an ENQ |
819 | (control-E) character is passed through. It may contain escape |
904 | (control-E) character is passed through. It may contain escape |
820 | values as described in the entry on keysym following. |
905 | values as described in the entry on keysym following. |
821 | |
906 | |
822 | secondaryScreen: *bool* |
907 | secondaryScreen: *boolean* |
823 | Turn on/off secondary screen (default enabled). |
908 | Turn on/off secondary screen (default enabled). |
824 | |
909 | |
825 | secondaryScroll: *bool* |
910 | secondaryScroll: *boolean* |
826 | Turn on/off secondary screen scroll (default enabled). If the this |
911 | Turn on/off secondary screen scroll (default enabled). If this |
827 | option is enabled, scrolls on the secondary screen will change the |
912 | option is enabled, scrolls on the secondary screen will change the |
828 | scrollback buffer and switching to/from the secondary screen will |
913 | scrollback buffer and switching to/from the secondary screen will |
829 | instead scroll the screen up. |
914 | instead scroll the screen up. |
830 | |
915 | |
831 | hold: *bool* |
916 | hold: *boolean* |
832 | Turn on/off hold window after exit support. If enabled, rxvt will |
917 | Turn on/off hold window after exit support. If enabled, rxvt will |
833 | not immediately destroy its window when the program executed within |
918 | not immediately destroy its window when the program executed within |
834 | it exits. Instead, it will wait till it is being killed or closed by |
919 | it exits. Instead, it will wait till it is being killed or closed by |
835 | the user. |
920 | the user. |
836 | |
921 | |
… | |
… | |
857 | |
942 | |
858 | *string* may contain escape values ("\a": bell, "\b": backspace, |
943 | *string* may contain escape values ("\a": bell, "\b": backspace, |
859 | "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab, |
944 | "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab, |
860 | "\000": octal number) or verbatim control characters ("^?": delete, |
945 | "\000": octal number) or verbatim control characters ("^?": delete, |
861 | "^@": null, "^A" ...) and may be enclosed with double quotes so that |
946 | "^@": null, "^A" ...) and may be enclosed with double quotes so that |
862 | it can start or end with whitespace. |
947 | it can start or end with whitespace. This feature is deprecated and |
|
|
948 | will be removed. |
863 | |
949 | |
864 | Please note that you need to double the "\" when using |
950 | Please note that you need to double the "\" in resource files, as |
865 | "--enable-xgetdefault", as X itself does it's own de-escaping (you |
951 | Xlib itself does its own de-escaping (you can use "\033" instead of |
866 | can use "\033" instead of "\e" (and so on), which will work with |
952 | "\e" (and so on), which will work with both Xt and rxvt's own |
867 | both Xt and rxvt's own processing). |
953 | processing). |
868 | |
954 | |
869 | You can define a range of keysyms in one shot by providing a |
955 | You can define a range of keysyms in one shot by providing a |
870 | *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter |
956 | *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimiter |
871 | `/' should be a character not used by the strings. |
957 | `/' should be a character not used by the strings. |
872 | |
958 | |
873 | Its usage can be demonstrated by an example: |
959 | Its usage can be demonstrated by an example: |
874 | |
960 | |
875 | URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> |
961 | URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> |
… | |
… | |
884 | is interpreted and executed as rxvt's control sequence. For example |
970 | is interpreted and executed as rxvt's control sequence. For example |
885 | the following means "change the current locale to "zh_CN.GBK" when |
971 | the following means "change the current locale to "zh_CN.GBK" when |
886 | Control-Meta-c is being pressed": |
972 | Control-Meta-c is being pressed": |
887 | |
973 | |
888 | URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 |
974 | URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 |
|
|
975 | |
|
|
976 | If *string* takes the form "perl:STRING", then the specified STRING |
|
|
977 | is passed to the "on_keyboard_command" perl handler. See the |
|
|
978 | rxvtperl(3) manpage. For example, the selection extension (activated |
|
|
979 | via "rxvt -pe selection") listens for "selection:rot13" events: |
|
|
980 | |
|
|
981 | URxvt.keysym.M-C-c: perl:selection:rot13 |
889 | |
982 | |
890 | Due the the large number of modifier combinations, a defined key |
983 | Due the the large number of modifier combinations, a defined key |
891 | mapping will match if at *at least* the specified identifiers are |
984 | mapping will match if at *at least* the specified identifiers are |
892 | being set, and no other key mappings with those and more bits are |
985 | being set, and no other key mappings with those and more bits are |
893 | being defined. That means that defining a key map for "a" will |
986 | being defined. That means that defining a key map for "a" will |
… | |
… | |
917 | info): |
1010 | info): |
918 | |
1011 | |
919 | URxvt.keysym.M-C-3: command:\033[8;25;80t |
1012 | URxvt.keysym.M-C-3: command:\033[8;25;80t |
920 | URxvt.keysym.M-C-4: command:\033[8;48;110t |
1013 | URxvt.keysym.M-C-4: command:\033[8;48;110t |
921 | |
1014 | |
|
|
1015 | perl-ext-common: *string* |
922 | perl-ext: *string* |
1016 | perl-ext: *string* |
923 | Colon-separated list of perl extension scripts to use in this |
1017 | Comma-separated list(s) of perl extension scripts (default: |
924 | terminal instance. Each extension is looked up in the library |
1018 | "default") to use in this terminal instance; option -pe. |
|
|
1019 | |
|
|
1020 | Extension names can be prefixed with a "-" sign to prohibit using |
|
|
1021 | them. This can be useful to selectively disable some extensions |
|
|
1022 | loaded by default, or specified via the "perl-ext-common" resource. |
|
|
1023 | For example, "default,-selection" will use all the default extension |
|
|
1024 | except "selection". |
|
|
1025 | |
|
|
1026 | Extension names can also be followed by an argument in angle |
|
|
1027 | brackets (e.g. "searchable-scrollback<M-s>", which binds the hotkey |
|
|
1028 | for searchable scrollback to Alt/Meta-s). Mentioning the same |
|
|
1029 | extension multiple times with different arguments will pass multiple |
|
|
1030 | arguments to the extension. |
|
|
1031 | |
|
|
1032 | Each extension is looked up in the library directories, loaded if |
925 | directories, loaded if necessary, and bound to the current terminal |
1033 | necessary, and bound to the current terminal instance. |
926 | instance; option -pe. |
1034 | |
|
|
1035 | If both of these resources are the empty string, then the perl |
|
|
1036 | interpreter will not be initialized. The idea behind two options is |
|
|
1037 | that perl-ext-common will be used for extensions that should be |
|
|
1038 | available to all instances, while perl-ext is used for specific |
|
|
1039 | instances. |
927 | |
1040 | |
928 | perl-eval: *string* |
1041 | perl-eval: *string* |
929 | Perl code to be evaluated when all extensions have been registered. |
1042 | Perl code to be evaluated when all extensions have been registered. |
930 | See the rxvtperl(3) manpage. |
1043 | See the rxvtperl(3) manpage. Due to security reasons, this resource |
|
|
1044 | will be ignored when running setuid/setgid. |
931 | |
1045 | |
932 | perl-lib: *path* |
1046 | perl-lib: *path* |
933 | Colon-separated list of additional directories that hold extension |
1047 | Colon-separated list of additional directories that hold extension |
934 | scripts. When looking for extensions specified by the "perl" |
1048 | scripts. When looking for extensions specified by the "perl" |
935 | resource, rxvt will first look in these directories and then in |
1049 | resource, rxvt will first look in these directories and then in |
936 | /opt/rxvt/lib/urxvt/perl-ext/. |
1050 | /opt/rxvt/lib/urxvt/perl/. Due to security reasons, this resource |
|
|
1051 | will be ignored when running setuid/setgid. |
937 | |
1052 | |
938 | See the rxvtperl(3) manpage. |
1053 | See the rxvtperl(3) manpage. |
|
|
1054 | |
|
|
1055 | selection.pattern-*idx*: *perl-regex* |
|
|
1056 | Additional selection patterns, see the rxvtperl(3) manpage for |
|
|
1057 | details. |
|
|
1058 | |
|
|
1059 | selection-autotransform.*idx*: *perl-transform* |
|
|
1060 | Selection auto-transform patterns, see the rxvtperl(3) manpage for |
|
|
1061 | details. |
|
|
1062 | |
|
|
1063 | searchable-scrollback: *keysym* |
|
|
1064 | Sets the hotkey that starts the incremental scrollback buffer search |
|
|
1065 | (default: "M-s"). |
|
|
1066 | |
|
|
1067 | urlLauncher: *string* |
|
|
1068 | Specifies the program to be started with a URL argument. Used by the |
|
|
1069 | "selection-popup" and "matcher" perl extensions. |
|
|
1070 | |
|
|
1071 | transient-for: *windowid* |
|
|
1072 | Compile *frills*: Sets the WM_TRANSIENT_FOR property to the given |
|
|
1073 | window id. |
|
|
1074 | |
|
|
1075 | override-redirect: *boolean* |
|
|
1076 | Compile *frills*: Sets override-redirect for the terminal window, |
|
|
1077 | making it almost invisible to window managers; option |
|
|
1078 | -override-redirect. |
|
|
1079 | |
|
|
1080 | iso14755_52: *boolean* |
|
|
1081 | Turn on/off ISO 14755 5.2 mode (default enabled). |
939 | |
1082 | |
940 | THE SCROLLBAR |
1083 | THE SCROLLBAR |
941 | Lines of text that scroll off the top of the rxvt window (resource: |
1084 | Lines of text that scroll off the top of the rxvt window (resource: |
942 | saveLines) and can be scrolled back using the scrollbar or by |
1085 | saveLines) and can be scrolled back using the scrollbar or by |
943 | keystrokes. The normal rxvt scrollbar has arrows and its behaviour is |
1086 | keystrokes. The normal rxvt scrollbar has arrows and its behaviour is |
… | |
… | |
957 | disabled -- on the assumption that we are using a fullscreen |
1100 | disabled -- on the assumption that we are using a fullscreen |
958 | application. Instead, pressing Button1 and Button3 sends ESC [ 6 ~ |
1101 | application. Instead, pressing Button1 and Button3 sends ESC [ 6 ~ |
959 | (Next) and ESC [ 5 ~ (Prior), respectively. Similarly, clicking on the |
1102 | (Next) and ESC [ 5 ~ (Prior), respectively. Similarly, clicking on the |
960 | up and down arrows sends ESC [ A (Up) and ESC [ B (Down), respectively. |
1103 | up and down arrows sends ESC [ A (Up) and ESC [ B (Down), respectively. |
961 | |
1104 | |
962 | TEXT SELECTION AND INSERTION |
1105 | THE SELECTION: SELECTING AND PASTING TEXT |
963 | The behaviour of text selection and insertion mechanism is similar to |
1106 | The behaviour of text selection and insertion/pasting mechanism is |
964 | *xterm*(1). |
1107 | similar to *xterm*(1). |
965 | |
1108 | |
966 | Selection: |
1109 | Selecting: |
967 | Left click at the beginning of the region, drag to the end of the |
1110 | Left click at the beginning of the region, drag to the end of the |
968 | region and release; Right click to extend the marked region; Left |
1111 | region and release; Right click to extend the marked region; Left |
969 | double-click to select a word; Left triple-click to select the |
1112 | double-click to select a word; Left triple-click to select the |
970 | entire logical line (which can span multiple screen lines), unless |
1113 | entire logical line (which can span multiple screen lines), unless |
971 | modified by resource tripleclickwords. |
1114 | modified by resource tripleclickwords. |
… | |
… | |
974 | (Compile: *frills*) will create a rectangular selection instead of a |
1117 | (Compile: *frills*) will create a rectangular selection instead of a |
975 | normal one. In this mode, every selected row becomes its own line in |
1118 | normal one. In this mode, every selected row becomes its own line in |
976 | the selection, and trailing whitespace is visually underlined and |
1119 | the selection, and trailing whitespace is visually underlined and |
977 | removed from the selection. |
1120 | removed from the selection. |
978 | |
1121 | |
979 | Insertion: |
1122 | Pasting: |
980 | Pressing and releasing the Middle mouse button (or Shift-Insert) in |
1123 | Pressing and releasing the Middle mouse button in an rxvt window |
981 | an rxvt window causes the current text selection to be inserted as |
1124 | causes the value of the PRIMARY selection (or CLIPBOARD with the |
982 | if it had been typed on the keyboard. |
1125 | Meta modifier) to be inserted as if it had been typed on the |
|
|
1126 | keyboard. |
|
|
1127 | |
|
|
1128 | Pressing Shift-Insert causes the value of the PRIMARY selection to |
|
|
1129 | be inserted too. |
983 | |
1130 | |
984 | CHANGING FONTS |
1131 | CHANGING FONTS |
985 | Changing fonts (or font sizes, respectively) via the keypad is not yet |
1132 | Changing fonts (or font sizes, respectively) via the keypad is not yet |
986 | supported in rxvt-unicode. Bug me if you need this. |
1133 | supported in rxvt-unicode. Bug me if you need this. |
987 | |
1134 | |
988 | You can, however, switch fonts at runtime using escape sequences (and |
1135 | You can, however, switch fonts at runtime using escape sequences, e.g.: |
989 | therefore using the menubar), e.g.: |
|
|
990 | |
1136 | |
991 | printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic" |
1137 | printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic" |
|
|
1138 | |
|
|
1139 | You can use keyboard shortcuts, too: |
|
|
1140 | |
|
|
1141 | URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007 |
|
|
1142 | URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007 |
992 | |
1143 | |
993 | rxvt-unicode will automatically re-apply these fonts to the output so |
1144 | rxvt-unicode will automatically re-apply these fonts to the output so |
994 | far. |
1145 | far. |
995 | |
1146 | |
996 | ISO 14755 SUPPORT |
1147 | ISO 14755 SUPPORT |
997 | ISO 14755 is a standard for entering and viewing unicode characters and |
1148 | ISO 14755 is a standard for entering and viewing unicode characters and |
998 | character codes using the keyboard. It consists of 4 parts. The first |
1149 | character codes using the keyboard. It consists of 4 parts. The first |
999 | part is available rxvt-unicode has been compiled with "--enable-frills", |
1150 | part is available if rxvt-unicode has been compiled with |
1000 | the rest is available when rxvt-unicode was compiled with |
1151 | "--enable-frills", the rest is available when rxvt-unicode was compiled |
1001 | "--enable-iso14755". |
1152 | with "--enable-iso14755". |
1002 | |
1153 | |
1003 | * 5.1: Basic method |
1154 | * 5.1: Basic method |
1004 | This allows you to enter unicode characters using their hexcode. |
1155 | This allows you to enter unicode characters using their hexcode. |
1005 | |
1156 | |
1006 | Start by pressing and holding both "Control" and "Shift", then enter |
1157 | Start by pressing and holding both "Control" and "Shift", then enter |
… | |
… | |
1020 | This mode lets you input characters representing the keycap symbols |
1171 | This mode lets you input characters representing the keycap symbols |
1021 | of your keyboard, if representable in the current locale encoding. |
1172 | of your keyboard, if representable in the current locale encoding. |
1022 | |
1173 | |
1023 | Start by pressing "Control" and "Shift" together, then releasing |
1174 | Start by pressing "Control" and "Shift" together, then releasing |
1024 | them. The next special key (cursor keys, home etc.) you enter will |
1175 | them. The next special key (cursor keys, home etc.) you enter will |
1025 | not invoke it's usual function but instead will insert the |
1176 | not invoke its usual function but instead will insert the |
1026 | corresponding keycap symbol. The symbol will only be entered when |
1177 | corresponding keycap symbol. The symbol will only be entered when |
1027 | the key has been released, otherwise pressing e.g. "Shift" would |
1178 | the key has been released, otherwise pressing e.g. "Shift" would |
1028 | enter the symbol for "ISO Level 2 Switch", although your intention |
1179 | enter the symbol for "ISO Level 2 Switch", although your intention |
1029 | might have been to enter a reverse tab (Shift-Tab). |
1180 | might have been to enter a reverse tab (Shift-Tab). |
1030 | |
1181 | |
… | |
… | |
1059 | setgid to root or to some other group on others. |
1210 | setgid to root or to some other group on others. |
1060 | |
1211 | |
1061 | COLORS AND GRAPHICS |
1212 | COLORS AND GRAPHICS |
1062 | In addition to the default foreground and background colours, rxvt can |
1213 | In addition to the default foreground and background colours, rxvt can |
1063 | display up to 16 colours (8 ANSI colours plus high-intensity bold/blink |
1214 | display up to 16 colours (8 ANSI colours plus high-intensity bold/blink |
1064 | versions of the same). Here is a list of the colours with their rgb.txt |
1215 | versions of the same). Here is a list of the colours with their names. |
1065 | names. |
|
|
1066 | |
1216 | |
1067 | color0 (black) = Black |
1217 | color0 (black) = Black |
1068 | color1 (red) = Red3 |
1218 | color1 (red) = Red3 |
1069 | color2 (green) = Green3 |
1219 | color2 (green) = Green3 |
1070 | color3 (yellow) = Yellow3 |
1220 | color3 (yellow) = Yellow3 |
… | |
… | |
1086 | It is also possible to specify the colour values of foreground, |
1236 | It is also possible to specify the colour values of foreground, |
1087 | background, cursorColor, cursorColor2, colorBD, colorUL as a number |
1237 | background, cursorColor, cursorColor2, colorBD, colorUL as a number |
1088 | 0-15, as a convenient shorthand to reference the colour name of |
1238 | 0-15, as a convenient shorthand to reference the colour name of |
1089 | color0-color15. |
1239 | color0-color15. |
1090 | |
1240 | |
|
|
1241 | In addition to the colours defined above, rxvt offers an additional 72 |
|
|
1242 | colours. The first 64 of those (with indices 16 to 79) consist of a |
|
|
1243 | 4*4*4 RGB colour cube (i.e. *index = r * 16 + g * 4 + b + 16*), followed |
|
|
1244 | by 8 additional shades of gray (with indices 80 to 87). |
|
|
1245 | |
|
|
1246 | Together, all those colours implement the 88 colour xterm colours. Only |
|
|
1247 | the first 16 can be changed using resources currently, the rest can only |
|
|
1248 | be changed via command sequences ("escape codes"). |
|
|
1249 | |
1091 | Note that -rv ("reverseVideo: True") simulates reverse video by always |
1250 | Note that -rv ("reverseVideo: True") simulates reverse video by always |
1092 | swapping the foreground/background colours. This is in contrast to |
1251 | swapping the foreground/background colours. This is in contrast to |
1093 | *xterm*(1) where the colours are only swapped if they have not otherwise |
1252 | *xterm*(1) where the colours are only swapped if they have not otherwise |
1094 | been specified. For example, |
1253 | been specified. For example, |
1095 | |
1254 | |
1096 | rxvt -fg Black -bg White -rv |
1255 | rxvt -fg Black -bg White -rv |
1097 | would yield White on Black, while on *xterm*(1) it would yield Black |
1256 | would yield White on Black, while on *xterm*(1) it would yield Black |
1098 | on White. |
1257 | on White. |
1099 | |
1258 | |
|
|
1259 | ALPHA CHANNEL SUPPORT |
|
|
1260 | If Xft support has been compiled in and as long as Xft/Xrender/X don't |
|
|
1261 | get their act together, rxvt-unicode will support |
|
|
1262 | "rgba:rrrr/gggg/bbbb/aaaa" (recommended, but MUST have 4 |
|
|
1263 | digits/component) colour specifications, in addition to the ones |
|
|
1264 | provided by X, where the additional A component specifies opacity |
|
|
1265 | (alpha) values. The minimum value of 0 is completely transparent). You |
|
|
1266 | can also prefix any color with "[percent]", where "percent" is a decimal |
|
|
1267 | percentage (0-100) that specifies the opacity of the color, where 0 is |
|
|
1268 | completely transparent and 100 is completelxy opaque. |
|
|
1269 | |
|
|
1270 | You probably need to specify "-depth 32", too, and have the luck that |
|
|
1271 | your X-server uses ARGB pixel layout, as X is far from just supporting |
|
|
1272 | ARGB visuals out of the box, and rxvt-unicode just fudges around. |
|
|
1273 | |
|
|
1274 | For example, the following selects an almost completely transparent red |
|
|
1275 | background, and an almost opaque pink foreground: |
|
|
1276 | |
|
|
1277 | rxvt -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink" |
|
|
1278 | |
|
|
1279 | *Please note that transparency of any kind if completely unsupported by |
|
|
1280 | the author. Don't bug him with installation questions!* |
|
|
1281 | |
1100 | ENVIRONMENT |
1282 | ENVIRONMENT |
1101 | rxvt sets and/or uses the following environment variables: |
1283 | rxvt sets and/or uses the following environment variables: |
1102 | |
1284 | |
1103 | TERM |
1285 | TERM |
1104 | Normally set to "rxvt-unicode", unless overwritten at configure |
1286 | Normally set to "rxvt-unicode", unless overwritten at configure |
1105 | time, via resources or on the commandline. |
1287 | time, via resources or on the command line. |
1106 | |
1288 | |
1107 | COLORTERM |
1289 | COLORTERM |
1108 | Either "rxvt", "rxvt-xpm", depending on wether rxvt was compiled |
1290 | Either "rxvt", "rxvt-xpm", depending on whether rxvt was compiled |
1109 | with XPM support, and optionally with the added extension "-mono" to |
1291 | with XPM support, and optionally with the added extension "-mono" to |
1110 | indicate that rxvt-unicode runs on a monochrome screen. |
1292 | indicate that rxvt-unicode runs on a monochrome screen. |
1111 | |
1293 | |
1112 | COLORFGBG |
1294 | COLORFGBG |
1113 | Set to a string of the form "fg;bg" or "fg;xpm;bg", where "fg" is |
1295 | Set to a string of the form "fg;bg" or "fg;xpm;bg", where "fg" is |
… | |
… | |
1127 | Set to the terminfo directory iff rxvt was configured with |
1309 | Set to the terminfo directory iff rxvt was configured with |
1128 | "--with-terminfo=PATH". |
1310 | "--with-terminfo=PATH". |
1129 | |
1311 | |
1130 | DISPLAY |
1312 | DISPLAY |
1131 | Used by rxvt to connect to the display and set to the correct |
1313 | Used by rxvt to connect to the display and set to the correct |
1132 | display in it's child processes. |
1314 | display in its child processes. |
1133 | |
1315 | |
1134 | SHELL |
1316 | SHELL |
1135 | The shell to be used for command execution, defaults to "/bin/sh". |
1317 | The shell to be used for command execution, defaults to "/bin/sh". |
1136 | |
|
|
1137 | RXVTPATH |
|
|
1138 | The path where rxvt looks for support files such as menu and xpm |
|
|
1139 | files. |
|
|
1140 | |
|
|
1141 | PATH |
|
|
1142 | Used in the same way as "RXVTPATH". |
|
|
1143 | |
1318 | |
1144 | RXVT_SOCKET |
1319 | RXVT_SOCKET |
1145 | The unix domain socket path used by rxvtc(1) and rxvtd(1). |
1320 | The unix domain socket path used by rxvtc(1) and rxvtd(1). |
1146 | |
1321 | |
1147 | Default $HOME/.rxvt-unicode-*<nodename*. |
1322 | Default $HOME/.rxvt-unicode-*<nodename*. |
… | |
… | |
1168 | |
1343 | |
1169 | CURRENT PROJECT COORDINATOR |
1344 | CURRENT PROJECT COORDINATOR |
1170 | Project Coordinator |
1345 | Project Coordinator |
1171 | Marc A. Lehmann <rxvt-unicode@schmorp.de> |
1346 | Marc A. Lehmann <rxvt-unicode@schmorp.de> |
1172 | |
1347 | |
1173 | <http://software.schmorp.de/#rxvt-unicode> |
1348 | <http://software.schmorp.de/pkg/rxvt-unicode.html> |
1174 | |
1349 | |
1175 | AUTHORS |
1350 | AUTHORS |
1176 | John Bovey |
1351 | John Bovey |
1177 | University of Kent, 1992, wrote the original Xvt. |
1352 | University of Kent, 1992, wrote the original Xvt. |
1178 | |
1353 | |
… | |
… | |
1189 | |
1364 | |
1190 | Oezguer Kesim <kesim@math.fu-berlin.de> |
1365 | Oezguer Kesim <kesim@math.fu-berlin.de> |
1191 | Project Coordinator (changes.txt 2.21a to 2.4.5) |
1366 | Project Coordinator (changes.txt 2.21a to 2.4.5) |
1192 | |
1367 | |
1193 | Geoff Wing <gcw@pobox.com> |
1368 | Geoff Wing <gcw@pobox.com> |
1194 | Rewrote screen display and text selection routines. Project |
1369 | Rewrote screen display and text selection routines. |
|
|
1370 | |
1195 | Coordinator (changes.txt 2.4.6 - rxvt-unicode) |
1371 | Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) |
1196 | |
1372 | |
1197 | Marc Alexander Lehmann <rxvt-unicode@schmorp.de> |
1373 | Marc Alexander Lehmann <rxvt-unicode@schmorp.de> |
1198 | Forked rxvt-unicode, rewrote most of the display code and internal |
1374 | Forked rxvt-unicode, unicode support, rewrote almost all the code, |
1199 | character handling to store text in unicode, improve xterm |
1375 | perl extension, random hacks, numerous bugfixes and extensions. |
1200 | compatibility and apply numerous other bugfixes and extensions. |
|
|
1201 | |
1376 | |
1202 | Project Coordinator (Changes 1.0 -) |
1377 | Project Coordinator (Changes 1.0 -) |
1203 | |
1378 | |
|
|
1379 | Emanuele Giaquinta <e.giaquinta@glauco.it> |
|
|
1380 | Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing. |
|
|
1381 | |