… | |
… | |
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.2, 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 | resource *tintColor*. Example: |
117 | |
130 | |
118 | rxvt -tr -tint blue -sh 40 |
131 | rxvt -tr -tint blue -sh 40 |
119 | |
132 | |
|
|
133 | -sh *number* |
120 | -sh *number* Darken (0 .. 100) or lighten (-1 .. -100) the transparent |
134 | Darken (0 .. 100) or lighten (-1 .. -100) the transparent background |
121 | background image in addition to tinting it (i.e. -tint must be |
135 | image in addition to (or instead of) tinting it; resource *shading*. |
122 | specified, too, e.g. "-tint white"). |
136 | |
|
|
137 | -blt *string* |
|
|
138 | Specify background blending type. If background pixmap is specified |
|
|
139 | at the same time as transparency - such pixmap will be blended over |
|
|
140 | transparency image, using method specified. Supported values are : |
|
|
141 | add, alphablend, allanon - color values averaging, colorize, darken, |
|
|
142 | diff, dissipate, hue, lighten, overlay, saturate, screen, sub, tint, |
|
|
143 | value. The default is alpha-blending; resource *blendType*. |
|
|
144 | |
|
|
145 | -blr *number* |
|
|
146 | Apply Gaussian Blur with the specified radius to the transparent |
|
|
147 | background image; resource *blurRadius*. |
123 | |
148 | |
124 | -bg *colour* |
149 | -bg *colour* |
125 | Window background colour; resource background. |
150 | Window background colour; resource background. |
126 | |
151 | |
127 | -fg *colour* |
152 | -fg *colour* |
128 | Window foreground colour; resource foreground. |
153 | Window foreground colour; resource foreground. |
129 | |
154 | |
130 | -pixmap *file[;geom]* |
155 | -pixmap *file[;geom]* |
131 | Compile *XPM*: Specify XPM file for the background and also |
156 | Compile *afterimage*: Specify image file for the background and also |
132 | optionally specify its scaling with a geometry string. Note you may |
157 | optionally specify its scaling with a geometry string. Note you may |
133 | need to add quotes to avoid special shell interpretation of the ";" |
158 | need to add quotes to avoid special shell interpretation of the ";" |
134 | in the command-line; resource backgroundPixmap. |
159 | in the command-line; for more details see resource backgroundPixmap. |
135 | |
160 | |
136 | -cr *colour* |
161 | -cr *colour* |
137 | The cursor colour; resource cursorColor. |
162 | The cursor colour; resource cursorColor. |
138 | |
163 | |
139 | -pr *colour* |
164 | -pr *colour* |
… | |
… | |
146 | The colour of the border around the text area and between the |
171 | The colour of the border around the text area and between the |
147 | scrollbar and the text; resource borderColor. |
172 | scrollbar and the text; resource borderColor. |
148 | |
173 | |
149 | -fn *fontlist* |
174 | -fn *fontlist* |
150 | Select the fonts to be used. This is a comma separated list of font |
175 | 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 |
176 | names that are checked in order when trying to find glyphs for |
152 | characters. The first font defines the cell size for characters; |
177 | characters. The first font defines the cell size for characters; |
153 | other fonts might be smaller, but not (in general) larger. A |
178 | other fonts might be smaller, but not (in general) larger. A |
154 | (hopefully) reasonable default font list is always appended to it. |
179 | (hopefully) reasonable default font list is always appended to it. |
155 | See resource font for more details. |
180 | See resource font for more details. |
156 | |
181 | |
157 | In short, to specify an X11 core font, just specify it's name or |
182 | 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 |
183 | prefix it with "x:". To specify an XFT-font, you need to prefix it |
159 | with "xft:", e.g.: |
184 | with "xft:", e.g.: |
160 | |
185 | |
161 | rxvt -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" |
186 | rxvt -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" |
162 | rxvt -fn "9x15bold,xft:Bitstream Vera Sans Mono" |
187 | rxvt -fn "9x15bold,xft:Bitstream Vera Sans Mono" |
163 | |
188 | |
164 | See also the question "How does rxvt-unicode choose fonts?" in the |
189 | See also the question "How does rxvt-unicode choose fonts?" in the |
165 | FAQ section of rxvt(7). |
190 | FAQ section of rxvt(7). |
166 | |
191 | |
167 | -fb *fontlist* |
192 | -fb *fontlist* |
168 | Compile font-styles: The bold font list to use when bold characters |
193 | Compile *font-styles*: The bold font list to use when bold |
169 | are to be printed. See resource boldFont for details. |
194 | characters are to be printed. See resource boldFont for details. |
170 | |
195 | |
171 | -fi *fontlist* |
196 | -fi *fontlist* |
172 | Compile font-styles: The italic font list to use when bold |
197 | Compile *font-styles*: The italic font list to use when *italic* |
173 | characters are to be printed. See resource italicFont for details. |
198 | characters are to be printed. See resource italicFont for details. |
174 | |
199 | |
175 | -fbi *fontlist* |
200 | -fbi *fontlist* |
176 | Compile font-styles: The bold italic font list to use when bold |
201 | Compile *font-styles*: The bold italic font list to use when *bold |
177 | characters are to be printed. See resource boldItalicFont for |
202 | italic* characters are to be printed. See resource boldItalicFont |
178 | details. |
203 | for details. |
179 | |
204 | |
180 | -is|+is |
205 | -is|+is |
181 | Compile font-styles: Bold/Italic font styles imply high intensity |
206 | Compile *font-styles*: Bold/Italic font styles imply high intensity |
182 | foreground/background (default). See resource intensityStyles for |
207 | foreground/background (default). See resource intensityStyles for |
183 | details. |
208 | details. |
184 | |
209 | |
185 | -name *name* |
210 | -name *name* |
186 | Specify the application name under which resources are to be |
211 | Specify the application name under which resources are to be |
… | |
… | |
251 | externalBorder. |
276 | externalBorder. |
252 | |
277 | |
253 | -bl Compile *frills*: Set MWM hints to request a borderless window, i.e. |
278 | -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 |
279 | if honoured by the WM, the rxvt-unicode window will not have window |
255 | decorations; resource borderLess. |
280 | decorations; resource borderLess. |
|
|
281 | |
|
|
282 | -override-redirect |
|
|
283 | Compile *frills*: Sets override-redirect on the window; resource |
|
|
284 | override-redirect. |
|
|
285 | |
|
|
286 | -sbg |
|
|
287 | Compile *frills*: Disable the usage of the built-in block |
|
|
288 | graphics/line drawing characters and just rely on what the specified |
|
|
289 | fonts provide. Use this if you have a good font and want to use its |
|
|
290 | block graphic glyphs; resource skipBuiltinGlyphs. |
256 | |
291 | |
257 | -lsp *number* |
292 | -lsp *number* |
258 | Compile *frills*: Lines (pixel height) to insert between each row of |
293 | Compile *frills*: Lines (pixel height) to insert between each row of |
259 | the display. Useful to work around font rendering problems; resource |
294 | the display. Useful to work around font rendering problems; resource |
260 | linespace. |
295 | linespace. |
… | |
… | |
309 | Set the font set to use for the X Input Method, see resource imFont |
344 | Set the font set to use for the X Input Method, see resource imFont |
310 | for more info. |
345 | for more info. |
311 | |
346 | |
312 | -tcw |
347 | -tcw |
313 | Change the meaning of triple-click selection with the left mouse |
348 | Change the meaning of triple-click selection with the left mouse |
|
|
349 | button. Only effective when the original (non-perl) selection code |
314 | button. Instead of selecting a full line it will extend the |
350 | is in-use. Instead of selecting a full line it will extend the |
315 | selection the end of the logical line only. resource |
351 | selection the end of the logical line only. resource |
316 | tripleclickwords. |
352 | tripleclickwords. |
317 | |
353 | |
318 | -insecure |
354 | -insecure |
319 | Enable "insecure" mode, which currently enables most of the escape |
355 | Enable "insecure" mode, which currently enables most of the escape |
… | |
… | |
340 | |
376 | |
341 | -keysym.*sym* *string* |
377 | -keysym.*sym* *string* |
342 | Remap a key symbol. See resource keysym. |
378 | Remap a key symbol. See resource keysym. |
343 | |
379 | |
344 | -embed *windowid* |
380 | -embed *windowid* |
345 | Tells rxvt to embed it's windows into an already-existing window, |
381 | Tells rxvt to embed its windows into an already-existing window, |
346 | which enables applications to easily embed a terminal. |
382 | which enables applications to easily embed a terminal. |
347 | |
383 | |
348 | Right now, rxvt will first unmap/map the specified window, so it |
384 | 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 |
385 | 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 |
386 | 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. |
389 | The window will not be destroyed when rxvt exits. |
354 | |
390 | |
355 | It might be useful to know that rxvt will not close file descriptors |
391 | 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 |
392 | passed to it (except for stdin/out/err, of course), so you can use |
357 | file descriptors to communicate with the programs within the |
393 | file descriptors to communicate with the programs within the |
358 | terminal. This works regardless of wether the "-embed" option was |
394 | terminal. This works regardless of whether the "-embed" option was |
359 | used or not. |
395 | used or not. |
360 | |
396 | |
361 | Here is a short Gtk2-perl snippet that illustrates how this option |
397 | Here is a short Gtk2-perl snippet that illustrates how this option |
362 | can be used (a longer example is in doc/embed): |
398 | can be used (a longer example is in doc/embed): |
363 | |
399 | |
… | |
… | |
365 | $rxvt->signal_connect_after (realize => sub { |
401 | $rxvt->signal_connect_after (realize => sub { |
366 | my $xid = $_[0]->window->get_xid; |
402 | my $xid = $_[0]->window->get_xid; |
367 | system "rxvt -embed $xid &"; |
403 | system "rxvt -embed $xid &"; |
368 | }); |
404 | }); |
369 | |
405 | |
370 | -pty-fd *fileno* |
406 | -pty-fd *file descriptor* |
371 | Tells rxvt NOT to execute any commands or create a new pty/tty pair |
407 | 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 |
408 | 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 |
409 | useful if you want to drive rxvt as a generic terminal emulator |
374 | without having to run a program within it. |
410 | without having to run a program within it. |
375 | |
411 | |
376 | If this switch is given, rxvt will not create any utmp/wtmp entries |
412 | 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 |
413 | and will not tinker with pty/tty permissions - you have to do that |
378 | yourself if you want that. |
414 | yourself if you want that. |
|
|
415 | |
|
|
416 | As an extremely special case, specifying -1 will completely suppress |
|
|
417 | pty/tty operations. |
379 | |
418 | |
380 | Here is a example in perl that illustrates how this option can be |
419 | Here is a example in perl that illustrates how this option can be |
381 | used (a longer example is in doc/pty-fd): |
420 | used (a longer example is in doc/pty-fd): |
382 | |
421 | |
383 | use IO::Pty; |
422 | use IO::Pty; |
… | |
… | |
390 | |
429 | |
391 | # now communicate with rxvt |
430 | # now communicate with rxvt |
392 | my $slave = $pty->slave; |
431 | my $slave = $pty->slave; |
393 | while (<$slave>) { print $slave "got <$_>\n" } |
432 | while (<$slave>) { print $slave "got <$_>\n" } |
394 | |
433 | |
|
|
434 | -pe *string* |
|
|
435 | Comma-separated list of perl extension scripts to use (or not to |
|
|
436 | use) in this terminal instance. See resource perl-ext for details. |
|
|
437 | |
395 | RESOURCES (available also as long-options) |
438 | RESOURCES (available also as long-options) |
396 | Note: `rxvt --help' gives a list of all resources (long options) |
439 | Note: `rxvt --help' gives a list of all resources (long options) |
397 | compiled into your version. |
440 | compiled into your version. |
398 | |
441 | |
399 | There are two different methods that rxvt can use to get the Xresource |
|
|
400 | data: using the X libraries (Xrm*-functions) or internal Xresources |
|
|
401 | reader (~/.Xdefaults). For the first method (ie. rxvt -h lists |
|
|
402 | XGetDefaults), you can set and change the resources using X11 tools like |
442 | You can set and change the resources using X11 tools like xrdb. Many |
403 | xrdb. Many distribution do also load settings from the ~/.Xresources |
443 | distribution do also load settings from the ~/.Xresources file when X |
404 | file when X starts. rxvt will consult the following files/resources in |
444 | starts. rxvt will consult the following files/resources in order, with |
405 | order, with later settings overwriting earlier ones: |
445 | later settings overwriting earlier ones: |
406 | |
446 | |
407 | 1. system-wide app-defaults file, either locale-dependent OR global |
447 | 1. system-wide app-defaults file, either locale-dependent OR global |
408 | 2. app-defaults file in $XAPPLRESDIR |
448 | 2. app-defaults file in $XAPPLRESDIR |
409 | 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults |
449 | 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults |
410 | 4. SCREEN_RESOURCES for the current screen |
450 | 4. SCREEN_RESOURCES for the current screen |
411 | 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> |
451 | 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> |
412 | |
452 | |
413 | If compiled with internal Xresources support (i.e. rxvt -h lists |
453 | Note that when reading X resources, rxvt recognizes two class names: |
414 | .Xdefaults) then rxvt accepts application defaults set in |
454 | Rxvt and URxvt. The class name Rxvt allows resources common to both rxvt |
415 | XAPPLOADDIR/URxvt (compile-time defined: usually |
455 | and the original *rxvt* to be easily configured, while the class name |
416 | /usr/lib/X11/app-defaults/URxvt) and resources set in ~/.Xdefaults, or |
456 | URxvt allows resources unique to rxvt, to be shared between different |
417 | ~/.Xresources if ~/.Xdefaults does not exist. Note that when reading X |
|
|
418 | resources, rxvt recognizes two class names: XTerm and URxvt. The class |
|
|
419 | name Rxvt allows resources common to both rxvt and the original *rxvt* |
|
|
420 | to be easily configured, while the class name URxvt allows resources |
|
|
421 | unique to rxvt, notably colours and key-handling, to be shared between |
|
|
422 | different rxvt configurations. If no resources are specified, suitable |
457 | rxvt configurations. If no resources are specified, suitable defaults |
423 | defaults will be used. Command-line arguments can be used to override |
458 | will be used. Command-line arguments can be used to override resource |
424 | resource settings. The following resources are allowed: |
459 | settings. The following resources are supported (you might want to check |
|
|
460 | the rxvtperl(3) manpage for additional settings by perl extensions not |
|
|
461 | documented here): |
|
|
462 | |
|
|
463 | depth: *bitdepth* |
|
|
464 | Compile *xft*: Attempt to find a visual with the given bit depth; |
|
|
465 | option -depth. |
425 | |
466 | |
426 | geometry: *geom* |
467 | geometry: *geom* |
427 | Create the window with the specified X window geometry [default |
468 | Create the window with the specified X window geometry [default |
428 | 80x24]; option -geometry. |
469 | 80x24]; option -geometry. |
429 | |
470 | |
… | |
… | |
461 | Use the specified colour to display underlined characters when the |
502 | Use the specified colour to display underlined characters when the |
462 | foreground colour is the default. |
503 | foreground colour is the default. |
463 | |
504 | |
464 | colorRV: *colour* |
505 | colorRV: *colour* |
465 | Use the specified colour as the background for reverse video |
506 | Use the specified colour as the background for reverse video |
466 | characters. |
507 | characters when OPTION_HC is disabled (--disable-frills). |
467 | |
508 | |
468 | underlineColor: *colour* |
509 | underlineColor: *colour* |
469 | If set, use the specified colour as the colour for the underline |
510 | If set, use the specified colour as the colour for the underline |
470 | itself. If unset, use the foreground colour. |
511 | itself. If unset, use the foreground colour. |
471 | |
512 | |
… | |
… | |
482 | True: simulate reverse video by foreground and background colours; |
523 | True: simulate reverse video by foreground and background colours; |
483 | option -rv. False: regular screen colours [default]; option +rv. See |
524 | option -rv. False: regular screen colours [default]; option +rv. See |
484 | note in COLORS AND GRAPHICS section. |
525 | note in COLORS AND GRAPHICS section. |
485 | |
526 | |
486 | jumpScroll: *boolean* |
527 | jumpScroll: *boolean* |
487 | True: specify that jump scrolling should be used. When scrolling |
528 | True: specify that jump scrolling should be used. When receiving |
488 | quickly, fewer screen updates are performed [default]; option -j. |
529 | lots of lines, rxvt will only scroll once a whole screen height of |
|
|
530 | lines has been read, resulting in fewer updates while still |
|
|
531 | displaying every received line; option -j. |
|
|
532 | |
489 | False: specify that smooth scrolling should be used; option +j. |
533 | False: specify that smooth scrolling should be used. rxvt will force |
|
|
534 | a screen refresh on each new line it received; option +j. |
|
|
535 | |
|
|
536 | skipScroll: *boolean* |
|
|
537 | True: (the default) specify that skip scrolling should be used. When |
|
|
538 | receiving lots of lines, rxvt will only scroll once in a while |
|
|
539 | (around 60 times per second), resulting in far fewer updates. This |
|
|
540 | can result in rxvt not ever displaying some of the lines it |
|
|
541 | receives; option -ss. |
|
|
542 | |
|
|
543 | False: specify that everything is to be displayed, even if the |
|
|
544 | refresh is too fast for the human eye to read anything (or the |
|
|
545 | monitor to display anything); option +ss. |
490 | |
546 | |
491 | inheritPixmap: *boolean* |
547 | inheritPixmap: *boolean* |
492 | True: make the background inherit the parent windows' pixmap, giving |
548 | True: make the background inherit the parent windows' pixmap, giving |
493 | artificial transparency. False: do not inherit the parent windows' |
549 | artificial transparency. False: do not inherit the parent windows' |
494 | pixmap. |
550 | pixmap. |
495 | |
551 | |
|
|
552 | *Please note that transparency of any kind if completely unsupported |
|
|
553 | by the author. Don't bug him with installation questions!* |
|
|
554 | |
496 | fading: *number* |
555 | fading: *number* |
497 | Fade the text by the given percentage when focus is lost; option |
556 | Fade the text by the given percentage when focus is lost; option |
498 | -fade. |
557 | -fade. |
499 | |
558 | |
500 | fadeColor: *colour* |
559 | fadeColor: *colour* |
… | |
… | |
505 | Tint the transparent background pixmap with the given colour; option |
564 | Tint the transparent background pixmap with the given colour; option |
506 | -tint. |
565 | -tint. |
507 | |
566 | |
508 | shading: *number* |
567 | shading: *number* |
509 | Darken (0 .. 100) or lighten (-1 .. -100) the transparent background |
568 | Darken (0 .. 100) or lighten (-1 .. -100) the transparent background |
510 | image in addition to tinting it. |
569 | image in addition to tinting it; option -sh. |
|
|
570 | |
|
|
571 | blendType: *string* |
|
|
572 | Specify background blending type; option -blt. |
|
|
573 | |
|
|
574 | blurRadius: *number* |
|
|
575 | Apply Gaussian Blurr with the specified radius to the transparent |
|
|
576 | background image; option -blr. |
511 | |
577 | |
512 | scrollColor: *colour* |
578 | scrollColor: *colour* |
513 | Use the specified colour for the scrollbar [default #B2B2B2]. |
579 | Use the specified colour for the scrollbar [default #B2B2B2]. |
514 | |
580 | |
515 | troughColor: *colour* |
581 | troughColor: *colour* |
… | |
… | |
519 | borderColor: *colour* |
585 | borderColor: *colour* |
520 | The colour of the border around the text area and between the |
586 | The colour of the border around the text area and between the |
521 | scrollbar and the text. |
587 | scrollbar and the text. |
522 | |
588 | |
523 | backgroundPixmap: *file[;geom]* |
589 | backgroundPixmap: *file[;geom]* |
524 | Use the specified XPM file (note the `.xpm' extension is optional) |
590 | Use the specified image file for the background and also optionally |
525 | for the background and also optionally specify its scaling with a |
591 | specify its scaling with a geometry string WxH+X+Y, in which "W" / |
526 | geometry string WxH+X+Y, in which "W" / "H" specify the |
|
|
527 | horizontal/vertical scale (percent) and "X" / "Y" locate the image |
592 | "H" specify the horizontal/vertical scale (percent), and "X" / "Y" |
528 | centre (percent). A scale of 0 displays the image with tiling. A |
593 | locate the image centre (percent). A scale of 0 displays the image |
529 | scale of 1 displays the image without any scaling. A scale of 2 to 9 |
594 | with tiling. A scale of 1 displays the image without any scaling. A |
530 | specifies an integer number of images in that direction. No image |
595 | scale of 2 to 9 specifies an integer number of images in that |
531 | will be magnified beyond 10 times its original size. The maximum |
596 | direction. No image will be magnified beyond 10 times its original |
532 | permitted scale is 1000. [default 0x0+50+50] |
597 | size. The maximum permitted scale is 1000. Special string of "auto" |
533 | |
598 | used as a geometry will cause image to be automatically scaled to |
534 | menu: *file[;tag]* |
599 | match window size. If used in conjunction with -tr option - |
535 | Read in the specified menu file (note the `.menu' extension is |
600 | specified pixmap will be blended over transparency image using |
536 | optional) and also optionally specify a starting tag to find. See |
601 | either alpha-blending, or any other blending type, specified with |
537 | the reference documentation for details on the syntax for the |
602 | -blt "type" option. [default 0x0+50+50] |
538 | menuBar. |
|
|
539 | |
603 | |
540 | path: *path* |
604 | path: *path* |
541 | Specify the colon-delimited search path for finding files (XPM and |
605 | Specify the colon-delimited search path for finding XPM files. |
542 | menus), in addition to the paths specified by the RXVTPATH and PATH |
|
|
543 | environment variables. |
|
|
544 | |
606 | |
545 | font: *fontlist* |
607 | font: *fontlist* |
546 | Select the fonts to be used. This is a comma separated list of font |
608 | Select the fonts to be used. This is a comma separated list of font |
547 | names that are used in turn when trying to display Unicode |
609 | names that are checked in order when trying to find glyphs for |
548 | characters. The first font defines the cell size for characters; |
610 | characters. The first font defines the cell size for characters; |
549 | other fonts might be smaller, but not larger. A reasonable default |
611 | other fonts might be smaller, but not (in general) larger. A |
550 | font list is always appended to it. option -fn. |
612 | (hopefully) reasonable default font list is always appended to it; |
|
|
613 | option -fn. |
551 | |
614 | |
552 | Each font can either be a standard X11 core font (XLFD) name, with |
615 | Each font can either be a standard X11 core font (XLFD) name, with |
553 | optional prefix "x:" or a Xft font (Compile *xft*), prefixed with |
616 | optional prefix "x:" or a Xft font (Compile *xft*), prefixed with |
554 | "xft:". |
617 | "xft:". |
555 | |
618 | |
… | |
… | |
558 | available hint currently is "codeset=codeset-name", and this is only |
621 | available hint currently is "codeset=codeset-name", and this is only |
559 | used for Xft fonts. |
622 | used for Xft fonts. |
560 | |
623 | |
561 | For example, this font resource |
624 | For example, this font resource |
562 | |
625 | |
563 | URxvt*font: 9x15bold,\ |
626 | URxvt.font: 9x15bold,\ |
564 | -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\ |
627 | -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\ |
565 | -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \ |
628 | -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \ |
566 | [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ |
629 | [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ |
567 | xft:Code2000:antialias=false |
630 | xft:Code2000:antialias=false |
568 | |
631 | |
… | |
… | |
604 | normal text font will being used for the given style. |
667 | normal text font will being used for the given style. |
605 | |
668 | |
606 | intensityStyles: *boolean* |
669 | intensityStyles: *boolean* |
607 | When font styles are not enabled, or this option is enabled (True, |
670 | When font styles are not enabled, or this option is enabled (True, |
608 | option -is, the default), bold and italic font styles imply high |
671 | option -is, the default), bold and italic font styles imply high |
609 | intensity foreground/backround colours. Disabling this option |
672 | intensity foreground/background colours. Disabling this option |
610 | (False, option +is) disables this behaviour, the high intensity |
673 | (False, option +is) disables this behaviour, the high intensity |
611 | colours are not reachable. |
674 | colours are not reachable. |
612 | |
675 | |
613 | selectstyle: *mode* |
676 | selectstyle: *mode* |
614 | Set mouse selection style to old which is 2.20, oldword which is |
677 | Set mouse selection style to old which is 2.20, oldword which is |
615 | xterm style with 2.20 old word selection, or anything else which |
678 | xterm style with 2.20 old word selection, or anything else which |
616 | gives xterm style selection. |
679 | gives xterm style selection. Only effective when the original |
|
|
680 | (non-perl) selection code is in use. |
617 | |
681 | |
618 | scrollstyle: *mode* |
682 | scrollstyle: *mode* |
619 | Set scrollbar style to rxvt, plain, next or xterm. plain is the |
683 | Set scrollbar style to rxvt, plain, next or xterm. plain is the |
620 | author's favourite. |
684 | author's favourite. |
621 | |
685 | |
… | |
… | |
631 | |
695 | |
632 | mapAlert: *boolean* |
696 | mapAlert: *boolean* |
633 | True: de-iconify (map) on receipt of a bell character. False: no |
697 | True: de-iconify (map) on receipt of a bell character. False: no |
634 | de-iconify (map) on receipt of a bell character [default]. |
698 | de-iconify (map) on receipt of a bell character [default]. |
635 | |
699 | |
|
|
700 | urgentOnBell: *boolean* |
|
|
701 | True: set the urgency hint for the wm on receipt of a bell |
|
|
702 | character. False: do not set the urgency hint [default]. |
|
|
703 | |
636 | visualBell: *boolean* |
704 | visualBell: *boolean* |
637 | True: use visual bell on receipt of a bell character; option -vb. |
705 | True: use visual bell on receipt of a bell character; option -vb. |
638 | False: no visual bell [default]; option +vb. |
706 | False: no visual bell [default]; option +vb. |
639 | |
707 | |
640 | loginShell: *boolean* |
708 | loginShell: *boolean* |
… | |
… | |
654 | |
722 | |
655 | The string will be interpreted as if typed into the shell as-is. |
723 | The string will be interpreted as if typed into the shell as-is. |
656 | |
724 | |
657 | Example: |
725 | Example: |
658 | |
726 | |
659 | URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) |
727 | URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) |
660 | |
728 | |
661 | This creates a new file in your home directory with the screen |
729 | This creates a new file in your home directory with the screen |
662 | contents everytime you hit "Print". |
730 | contents every time you hit "Print". |
663 | |
731 | |
664 | scrollBar: *boolean* |
732 | scrollBar: *boolean* |
665 | True: enable the scrollbar [default]; option -sb. False: disable the |
733 | True: enable the scrollbar [default]; option -sb. False: disable the |
666 | scrollbar; option +sb. |
734 | scrollbar; option +sb. |
667 | |
735 | |
… | |
… | |
682 | do not scroll to bottom when tty receives output; option +si. |
750 | do not scroll to bottom when tty receives output; option +si. |
683 | |
751 | |
684 | scrollWithBuffer: *boolean* |
752 | scrollWithBuffer: *boolean* |
685 | True: scroll with scrollback buffer when tty receives new lines (and |
753 | True: scroll with scrollback buffer when tty receives new lines (and |
686 | scrollTtyOutput is False); option -sw. False: do not scroll with |
754 | scrollTtyOutput is False); option -sw. False: do not scroll with |
687 | scrollback buffer when tty recieves new lines; option +sw. |
755 | scrollback buffer when tty receives new lines; option +sw. |
688 | |
756 | |
689 | scrollTtyKeypress: *boolean* |
757 | scrollTtyKeypress: *boolean* |
690 | True: scroll to bottom when a non-special key is pressed. Special |
758 | True: scroll to bottom when a non-special key is pressed. Special |
691 | keys are those which are intercepted by rxvt-unicode for special |
759 | keys are those which are intercepted by rxvt-unicode for special |
692 | handling and are not passed onto the shell; option -sk. False: do |
760 | handling and are not passed onto the shell; option -sk. False: do |
… | |
… | |
707 | borderLess: *boolean* |
775 | borderLess: *boolean* |
708 | Set MWM hints to request a borderless window, i.e. if honoured by |
776 | Set MWM hints to request a borderless window, i.e. if honoured by |
709 | the WM, the rxvt-unicode window will not have window decorations; |
777 | the WM, the rxvt-unicode window will not have window decorations; |
710 | option -bl. |
778 | option -bl. |
711 | |
779 | |
|
|
780 | skipBuiltinGlyphs: *boolean* |
|
|
781 | Compile *frills*: Disable the usage of the built-in block |
|
|
782 | graphics/line drawing characters and just rely on what the specified |
|
|
783 | fonts provide. Use this if you have a good font and want to use its |
|
|
784 | block graphic glyphs; option -sbg. |
|
|
785 | |
712 | termName: *termname* |
786 | termName: *termname* |
713 | Specifies the terminal type name to be set in the TERM environment |
787 | Specifies the terminal type name to be set in the TERM environment |
714 | variable; option -tn. |
788 | variable; option -tn. |
715 | |
789 | |
716 | linespace: *number* |
790 | linespace: *number* |
… | |
… | |
759 | The string to send when the delete key (not the keypad delete key) |
833 | The string to send when the delete key (not the keypad delete key) |
760 | is pressed. If unset it will send the sequence traditionally |
834 | is pressed. If unset it will send the sequence traditionally |
761 | associated with the Execute key. |
835 | associated with the Execute key. |
762 | |
836 | |
763 | cutchars: *string* |
837 | cutchars: *string* |
764 | The characters used as delimiters for double-click word selection. |
838 | The characters used as delimiters for double-click word selection |
765 | The built-in default: |
839 | (whitespace delimiting is added automatically if resource is given). |
|
|
840 | |
|
|
841 | When the perl selection extension is in use (the default if compiled |
|
|
842 | in, see the rxvtperl(3) manpage), a suitable regex using these |
|
|
843 | characters will be created (if the resource exists, otherwise, no |
|
|
844 | regex will be created). In this mode, characters outside ISO-8859-1 |
|
|
845 | can be used. |
|
|
846 | |
|
|
847 | When the selection extension is not used, only ISO-8859-1 characters |
|
|
848 | can be used. If not specified, the built-in default is used: |
766 | |
849 | |
767 | BACKSLASH `"'&()*,;<=>?@[]{|} |
850 | BACKSLASH `"'&()*,;<=>?@[]{|} |
768 | |
851 | |
769 | preeditType: *style* |
852 | preeditType: *style* |
770 | OverTheSpot, OffTheSpot, Root; option -pt. |
853 | OverTheSpot, OffTheSpot, Root; option -pt. |
… | |
… | |
774 | |
857 | |
775 | imLocale: *name* |
858 | imLocale: *name* |
776 | The locale to use for opening the IM. You can use an "LC_CTYPE" of |
859 | The locale to use for opening the IM. You can use an "LC_CTYPE" of |
777 | e.g. "de_DE.UTF-8" for normal text processing but "ja_JP.EUC-JP" for |
860 | e.g. "de_DE.UTF-8" for normal text processing but "ja_JP.EUC-JP" for |
778 | the input extension to be able to input japanese characters while |
861 | the input extension to be able to input japanese characters while |
779 | staying in another locale. option -imlocale. |
862 | staying in another locale; option -imlocale. |
780 | |
863 | |
781 | imFont: *fontset* |
864 | imFont: *fontset* |
782 | Specify the font-set used for XIM styles "OverTheSpot" or |
865 | Specify the font-set used for XIM styles "OverTheSpot" or |
783 | "OffTheSpot". It must be a standard X font set (XLFD patterns |
866 | "OffTheSpot". It must be a standard X font set (XLFD patterns |
784 | separated by commas), i.e. it's not in the same format as the other |
867 | separated by commas), i.e. it's not in the same format as the other |
… | |
… | |
787 | to the base font. option -imfont. |
870 | to the base font. option -imfont. |
788 | |
871 | |
789 | tripleclickwords: *boolean* |
872 | tripleclickwords: *boolean* |
790 | Change the meaning of triple-click selection with the left mouse |
873 | Change the meaning of triple-click selection with the left mouse |
791 | button. Instead of selecting a full line it will extend the |
874 | button. Instead of selecting a full line it will extend the |
792 | selection to the end of the logical line only. option -tcw. |
875 | selection to the end of the logical line only; option -tcw. |
793 | |
876 | |
794 | insecure: *boolean* |
877 | insecure: *boolean* |
795 | Enables "insecure" mode. Rxvt-unicode offers some escape sequences |
878 | Enables "insecure" mode. Rxvt-unicode offers some escape sequences |
796 | that echo arbitrary strings like the icon name or the locale. This |
879 | that echo arbitrary strings like the icon name or the locale. This |
797 | could be abused if somebody gets 8-bit-clean access to your display, |
880 | could be abused if somebody gets 8-bit-clean access to your display, |
… | |
… | |
801 | xterm, have these sequences enabled by default, which doesn't make |
884 | xterm, have these sequences enabled by default, which doesn't make |
802 | it safer, though). |
885 | it safer, though). |
803 | |
886 | |
804 | You can enable them by setting this boolean resource or specifying |
887 | You can enable them by setting this boolean resource or specifying |
805 | -insecure as an option. At the moment, this enables display-answer, |
888 | -insecure as an option. At the moment, this enables display-answer, |
806 | locale, findfont, icon label and window title requests as well as |
889 | locale, findfont, icon label and window title requests. |
807 | dynamic menubar dispatch. |
|
|
808 | |
890 | |
809 | modifier: *modifier* |
891 | modifier: *modifier* |
810 | Set the key to be interpreted as the Meta key to: alt, meta, hyper, |
892 | Set the key to be interpreted as the Meta key to: alt, meta, hyper, |
811 | super, mod1, mod2, mod3, mod4, mod5; option -mod. |
893 | super, mod1, mod2, mod3, mod4, mod5; option -mod. |
812 | |
894 | |
813 | answerbackString: *string* |
895 | answerbackString: *string* |
814 | Specify the reply rxvt-unicode sends to the shell when an ENQ |
896 | Specify the reply rxvt-unicode sends to the shell when an ENQ |
815 | (control-E) character is passed through. It may contain escape |
897 | (control-E) character is passed through. It may contain escape |
816 | values as described in the entry on keysym following. |
898 | values as described in the entry on keysym following. |
817 | |
899 | |
818 | secondaryScreen: *bool* |
900 | secondaryScreen: *boolean* |
819 | Turn on/off secondary screen (default enabled). |
901 | Turn on/off secondary screen (default enabled). |
820 | |
902 | |
821 | secondaryScroll: *bool* |
903 | secondaryScroll: *boolean* |
822 | Turn on/off secondary screen scroll (default enabled). If the this |
904 | Turn on/off secondary screen scroll (default enabled). If this |
823 | option is enabled, scrolls on the secondary screen will change the |
905 | option is enabled, scrolls on the secondary screen will change the |
824 | scrollback buffer and switching to/from the secondary screen will |
906 | scrollback buffer and switching to/from the secondary screen will |
825 | instead scroll the screen up. |
907 | instead scroll the screen up. |
826 | |
908 | |
827 | hold: *bool* |
909 | hold: *boolean* |
828 | Turn on/off hold window after exit support. If enabled, rxvt will |
910 | Turn on/off hold window after exit support. If enabled, rxvt will |
829 | not immediately destroy its window when the program executed within |
911 | not immediately destroy its window when the program executed within |
830 | it exits. Instead, it will wait till it is being killed or closed by |
912 | it exits. Instead, it will wait till it is being killed or closed by |
831 | the user. |
913 | the user. |
832 | |
914 | |
… | |
… | |
853 | |
935 | |
854 | *string* may contain escape values ("\a": bell, "\b": backspace, |
936 | *string* may contain escape values ("\a": bell, "\b": backspace, |
855 | "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab, |
937 | "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab, |
856 | "\000": octal number) or verbatim control characters ("^?": delete, |
938 | "\000": octal number) or verbatim control characters ("^?": delete, |
857 | "^@": null, "^A" ...) and may be enclosed with double quotes so that |
939 | "^@": null, "^A" ...) and may be enclosed with double quotes so that |
858 | it can start or end with whitespace. |
940 | it can start or end with whitespace. This feature is deprecated and |
|
|
941 | will be removed. |
859 | |
942 | |
860 | Please note that you need to double the "\" when using |
943 | Please note that you need to double the "\" in resource files, as |
861 | "--enable-xgetdefault", as X itself does it's own de-escaping (you |
944 | Xlib itself does its own de-escaping (you can use "\033" instead of |
862 | can use "\033" instead of "\e" (and so on), which will work with |
945 | "\e" (and so on), which will work with both Xt and rxvt's own |
863 | both Xt and rxvt's own processing). |
946 | processing). |
864 | |
947 | |
865 | You can define a range of keysyms in one shot by providing a |
948 | You can define a range of keysyms in one shot by providing a |
866 | *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter |
949 | *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimiter |
867 | `/' should be a character not used by the strings. |
950 | `/' should be a character not used by the strings. |
868 | |
951 | |
869 | Its usage can be demonstrated by an example: |
952 | Its usage can be demonstrated by an example: |
870 | |
953 | |
871 | URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> |
954 | URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> |
… | |
… | |
880 | is interpreted and executed as rxvt's control sequence. For example |
963 | is interpreted and executed as rxvt's control sequence. For example |
881 | the following means "change the current locale to "zh_CN.GBK" when |
964 | the following means "change the current locale to "zh_CN.GBK" when |
882 | Control-Meta-c is being pressed": |
965 | Control-Meta-c is being pressed": |
883 | |
966 | |
884 | URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 |
967 | URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 |
|
|
968 | |
|
|
969 | If *string* takes the form "perl:STRING", then the specified STRING |
|
|
970 | is passed to the "on_keyboard_command" perl handler. See the |
|
|
971 | rxvtperl(3) manpage. For example, the selection extension (activated |
|
|
972 | via "rxvt -pe selection") listens for "selection:rot13" events: |
|
|
973 | |
|
|
974 | URxvt.keysym.M-C-c: perl:selection:rot13 |
885 | |
975 | |
886 | Due the the large number of modifier combinations, a defined key |
976 | Due the the large number of modifier combinations, a defined key |
887 | mapping will match if at *at least* the specified identifiers are |
977 | mapping will match if at *at least* the specified identifiers are |
888 | being set, and no other key mappings with those and more bits are |
978 | being set, and no other key mappings with those and more bits are |
889 | being defined. That means that defining a key map for "a" will |
979 | being defined. That means that defining a key map for "a" will |
… | |
… | |
913 | info): |
1003 | info): |
914 | |
1004 | |
915 | URxvt.keysym.M-C-3: command:\033[8;25;80t |
1005 | URxvt.keysym.M-C-3: command:\033[8;25;80t |
916 | URxvt.keysym.M-C-4: command:\033[8;48;110t |
1006 | URxvt.keysym.M-C-4: command:\033[8;48;110t |
917 | |
1007 | |
|
|
1008 | perl-ext-common: *string* |
|
|
1009 | perl-ext: *string* |
|
|
1010 | Comma-separated list(s) of perl extension scripts (default: |
|
|
1011 | "default") to use in this terminal instance; option -pe. |
|
|
1012 | |
|
|
1013 | Extension names can be prefixed with a "-" sign to prohibit using |
|
|
1014 | them. This can be useful to selectively disable some extensions |
|
|
1015 | loaded by default, or specified via the "perl-ext-common" resource. |
|
|
1016 | For example, "default,-selection" will use all the default extension |
|
|
1017 | except "selection". |
|
|
1018 | |
|
|
1019 | Extension names can also be followed by an argument in angle |
|
|
1020 | brackets (e.g. "searchable-scrollback<M-s>", which binds the hotkey |
|
|
1021 | for searchable scrollback to Alt/Meta-s). Mentioning the same |
|
|
1022 | extension multiple times with different arguments will pass multiple |
|
|
1023 | arguments to the extension. |
|
|
1024 | |
|
|
1025 | Each extension is looked up in the library directories, loaded if |
|
|
1026 | necessary, and bound to the current terminal instance. |
|
|
1027 | |
|
|
1028 | If both of these resources are the empty string, then the perl |
|
|
1029 | interpreter will not be initialized. The idea behind two options is |
|
|
1030 | that perl-ext-common will be used for extensions that should be |
|
|
1031 | available to all instances, while perl-ext is used for specific |
|
|
1032 | instances. |
|
|
1033 | |
|
|
1034 | perl-eval: *string* |
|
|
1035 | Perl code to be evaluated when all extensions have been registered. |
|
|
1036 | See the rxvtperl(3) manpage. Due to security reasons, this resource |
|
|
1037 | will be ignored when running setuid/setgid. |
|
|
1038 | |
|
|
1039 | perl-lib: *path* |
|
|
1040 | Colon-separated list of additional directories that hold extension |
|
|
1041 | scripts. When looking for extensions specified by the "perl" |
|
|
1042 | resource, rxvt will first look in these directories and then in |
|
|
1043 | /opt/rxvt/lib/urxvt/perl/. Due to security reasons, this resource |
|
|
1044 | will be ignored when running setuid/setgid. |
|
|
1045 | |
|
|
1046 | See the rxvtperl(3) manpage. |
|
|
1047 | |
|
|
1048 | selection.pattern-*idx*: *perl-regex* |
|
|
1049 | Additional selection patterns, see the rxvtperl(3) manpage for |
|
|
1050 | details. |
|
|
1051 | |
|
|
1052 | selection-autotransform.*idx*: *perl-transform* |
|
|
1053 | Selection auto-transform patterns, see the rxvtperl(3) manpage for |
|
|
1054 | details. |
|
|
1055 | |
|
|
1056 | searchable-scrollback: *keysym* |
|
|
1057 | Sets the hotkey that starts the incremental scrollback buffer search |
|
|
1058 | (default: "M-s"). |
|
|
1059 | |
|
|
1060 | urlLauncher: *string* |
|
|
1061 | Specifies the program to be started with a URL argument. Used by the |
|
|
1062 | "selection-popup" and "matcher" perl extensions. |
|
|
1063 | |
|
|
1064 | transient-for: *windowid* |
|
|
1065 | Compile *frills*: Sets the WM_TRANSIENT_FOR property to the given |
|
|
1066 | window id. |
|
|
1067 | |
|
|
1068 | override-redirect: *boolean* |
|
|
1069 | Compile *frills*: Sets override-redirect for the terminal window, |
|
|
1070 | making it almost invisible to window managers; option |
|
|
1071 | -override-redirect. |
|
|
1072 | |
|
|
1073 | iso14755_52: *boolean* |
|
|
1074 | Turn on/off ISO 14755 5.2 mode (default enabled). |
|
|
1075 | |
918 | THE SCROLLBAR |
1076 | THE SCROLLBAR |
919 | Lines of text that scroll off the top of the rxvt window (resource: |
1077 | Lines of text that scroll off the top of the rxvt window (resource: |
920 | saveLines) and can be scrolled back using the scrollbar or by |
1078 | saveLines) and can be scrolled back using the scrollbar or by |
921 | keystrokes. The normal rxvt scrollbar has arrows and its behaviour is |
1079 | keystrokes. The normal rxvt scrollbar has arrows and its behaviour is |
922 | fairly intuitive. The xterm-scrollbar is without arrows and its |
1080 | fairly intuitive. The xterm-scrollbar is without arrows and its |
… | |
… | |
935 | disabled -- on the assumption that we are using a fullscreen |
1093 | disabled -- on the assumption that we are using a fullscreen |
936 | application. Instead, pressing Button1 and Button3 sends ESC [ 6 ~ |
1094 | application. Instead, pressing Button1 and Button3 sends ESC [ 6 ~ |
937 | (Next) and ESC [ 5 ~ (Prior), respectively. Similarly, clicking on the |
1095 | (Next) and ESC [ 5 ~ (Prior), respectively. Similarly, clicking on the |
938 | up and down arrows sends ESC [ A (Up) and ESC [ B (Down), respectively. |
1096 | up and down arrows sends ESC [ A (Up) and ESC [ B (Down), respectively. |
939 | |
1097 | |
940 | TEXT SELECTION AND INSERTION |
1098 | THE SELECTION: SELECTING AND PASTING TEXT |
941 | The behaviour of text selection and insertion mechanism is similar to |
1099 | The behaviour of text selection and insertion/pasting mechanism is |
942 | *xterm*(1). |
1100 | similar to *xterm*(1). |
943 | |
1101 | |
944 | Selection: |
1102 | Selecting: |
945 | Left click at the beginning of the region, drag to the end of the |
1103 | Left click at the beginning of the region, drag to the end of the |
946 | region and release; Right click to extend the marked region; Left |
1104 | region and release; Right click to extend the marked region; Left |
947 | double-click to select a word; Left triple-click to select the |
1105 | double-click to select a word; Left triple-click to select the |
948 | entire logical line (which can span multiple screen lines), unless |
1106 | entire logical line (which can span multiple screen lines), unless |
949 | modified by resource tripleclickwords. |
1107 | modified by resource tripleclickwords. |
… | |
… | |
952 | (Compile: *frills*) will create a rectangular selection instead of a |
1110 | (Compile: *frills*) will create a rectangular selection instead of a |
953 | normal one. In this mode, every selected row becomes its own line in |
1111 | normal one. In this mode, every selected row becomes its own line in |
954 | the selection, and trailing whitespace is visually underlined and |
1112 | the selection, and trailing whitespace is visually underlined and |
955 | removed from the selection. |
1113 | removed from the selection. |
956 | |
1114 | |
957 | Insertion: |
1115 | Pasting: |
958 | Pressing and releasing the Middle mouse button (or Shift-Insert) in |
1116 | Pressing and releasing the Middle mouse button in an rxvt window |
959 | an rxvt window causes the current text selection to be inserted as |
1117 | causes the value of the PRIMARY selection (or CLIPBOARD with the |
960 | if it had been typed on the keyboard. |
1118 | Meta modifier) to be inserted as if it had been typed on the |
|
|
1119 | keyboard. |
|
|
1120 | |
|
|
1121 | Pressing Shift-Insert causes the value of the PRIMARY selection to |
|
|
1122 | be inserted too. |
961 | |
1123 | |
962 | CHANGING FONTS |
1124 | CHANGING FONTS |
963 | Changing fonts (or font sizes, respectively) via the keypad is not yet |
1125 | Changing fonts (or font sizes, respectively) via the keypad is not yet |
964 | supported in rxvt-unicode. Bug me if you need this. |
1126 | supported in rxvt-unicode. Bug me if you need this. |
965 | |
1127 | |
966 | You can, however, switch fonts at runtime using escape sequences (and |
1128 | You can, however, switch fonts at runtime using escape sequences, e.g.: |
967 | therefore using the menubar), e.g.: |
|
|
968 | |
1129 | |
969 | printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic" |
1130 | printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic" |
|
|
1131 | |
|
|
1132 | You can use keyboard shortcuts, too: |
|
|
1133 | |
|
|
1134 | URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007 |
|
|
1135 | URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007 |
970 | |
1136 | |
971 | rxvt-unicode will automatically re-apply these fonts to the output so |
1137 | rxvt-unicode will automatically re-apply these fonts to the output so |
972 | far. |
1138 | far. |
973 | |
1139 | |
974 | ISO 14755 SUPPORT |
1140 | ISO 14755 SUPPORT |
… | |
… | |
998 | This mode lets you input characters representing the keycap symbols |
1164 | This mode lets you input characters representing the keycap symbols |
999 | of your keyboard, if representable in the current locale encoding. |
1165 | of your keyboard, if representable in the current locale encoding. |
1000 | |
1166 | |
1001 | Start by pressing "Control" and "Shift" together, then releasing |
1167 | Start by pressing "Control" and "Shift" together, then releasing |
1002 | them. The next special key (cursor keys, home etc.) you enter will |
1168 | them. The next special key (cursor keys, home etc.) you enter will |
1003 | not invoke it's usual function but instead will insert the |
1169 | not invoke its usual function but instead will insert the |
1004 | corresponding keycap symbol. The symbol will only be entered when |
1170 | corresponding keycap symbol. The symbol will only be entered when |
1005 | the key has been released, otherwise pressing e.g. "Shift" would |
1171 | the key has been released, otherwise pressing e.g. "Shift" would |
1006 | enter the symbol for "ISO Level 2 Switch", although your intention |
1172 | enter the symbol for "ISO Level 2 Switch", although your intention |
1007 | might have been to enter a reverse tab (Shift-Tab). |
1173 | might have been to enter a reverse tab (Shift-Tab). |
1008 | |
1174 | |
… | |
… | |
1037 | setgid to root or to some other group on others. |
1203 | setgid to root or to some other group on others. |
1038 | |
1204 | |
1039 | COLORS AND GRAPHICS |
1205 | COLORS AND GRAPHICS |
1040 | In addition to the default foreground and background colours, rxvt can |
1206 | In addition to the default foreground and background colours, rxvt can |
1041 | display up to 16 colours (8 ANSI colours plus high-intensity bold/blink |
1207 | display up to 16 colours (8 ANSI colours plus high-intensity bold/blink |
1042 | versions of the same). Here is a list of the colours with their rgb.txt |
1208 | versions of the same). Here is a list of the colours with their names. |
1043 | names. |
|
|
1044 | |
1209 | |
1045 | color0 (black) = Black |
1210 | color0 (black) = Black |
1046 | color1 (red) = Red3 |
1211 | color1 (red) = Red3 |
1047 | color2 (green) = Green3 |
1212 | color2 (green) = Green3 |
1048 | color3 (yellow) = Yellow3 |
1213 | color3 (yellow) = Yellow3 |
… | |
… | |
1064 | It is also possible to specify the colour values of foreground, |
1229 | It is also possible to specify the colour values of foreground, |
1065 | background, cursorColor, cursorColor2, colorBD, colorUL as a number |
1230 | background, cursorColor, cursorColor2, colorBD, colorUL as a number |
1066 | 0-15, as a convenient shorthand to reference the colour name of |
1231 | 0-15, as a convenient shorthand to reference the colour name of |
1067 | color0-color15. |
1232 | color0-color15. |
1068 | |
1233 | |
|
|
1234 | In addition to the colours defined above, rxvt offers an additional 72 |
|
|
1235 | colours. The first 64 of those (with indices 16 to 79) consist of a |
|
|
1236 | 4*4*4 RGB colour cube (i.e. *index = r * 16 + g * 4 + b + 16*), followed |
|
|
1237 | by 8 additional shades of gray (with indices 80 to 87). |
|
|
1238 | |
|
|
1239 | Together, all those colours implement the 88 colour xterm colours. Only |
|
|
1240 | the first 16 can be changed using resources currently, the rest can only |
|
|
1241 | be changed via command sequences ("escape codes"). |
|
|
1242 | |
1069 | Note that -rv ("reverseVideo: True") simulates reverse video by always |
1243 | Note that -rv ("reverseVideo: True") simulates reverse video by always |
1070 | swapping the foreground/background colours. This is in contrast to |
1244 | swapping the foreground/background colours. This is in contrast to |
1071 | *xterm*(1) where the colours are only swapped if they have not otherwise |
1245 | *xterm*(1) where the colours are only swapped if they have not otherwise |
1072 | been specified. For example, |
1246 | been specified. For example, |
1073 | |
1247 | |
1074 | rxvt -fg Black -bg White -rv |
1248 | rxvt -fg Black -bg White -rv |
1075 | would yield White on Black, while on *xterm*(1) it would yield Black |
1249 | would yield White on Black, while on *xterm*(1) it would yield Black |
1076 | on White. |
1250 | on White. |
1077 | |
1251 | |
|
|
1252 | ALPHA CHANNEL SUPPORT |
|
|
1253 | If Xft support has been compiled in and as long as Xft/Xrender/X don't |
|
|
1254 | get their act together, rxvt-unicode will support |
|
|
1255 | "rgba:rrrr/gggg/bbbb/aaaa" (recommended, but MUST have 4 |
|
|
1256 | digits/component) colour specifications, in addition to the ones |
|
|
1257 | provided by X, where the additional A component specifies opacity |
|
|
1258 | (alpha) values. The minimum value of 0 is completely transparent). You |
|
|
1259 | can also prefix any color with "[percent]", where "percent" is a decimal |
|
|
1260 | percentage (0-100) that specifies the opacity of the color, where 0 is |
|
|
1261 | completely transparent and 100 is completelxy opaque. |
|
|
1262 | |
|
|
1263 | You probably need to specify "-depth 32", too, and have the luck that |
|
|
1264 | your X-server uses ARGB pixel layout, as X is far from just supporting |
|
|
1265 | ARGB visuals out of the box, and rxvt-unicode just fudges around. |
|
|
1266 | |
|
|
1267 | For example, the following selects an almost completely transparent red |
|
|
1268 | background, and an almost opaque pink foreground: |
|
|
1269 | |
|
|
1270 | rxvt -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink" |
|
|
1271 | |
|
|
1272 | *Please note that transparency of any kind if completely unsupported by |
|
|
1273 | the author. Don't bug him with installation questions!* |
|
|
1274 | |
1078 | ENVIRONMENT |
1275 | ENVIRONMENT |
1079 | rxvt sets and/or uses the following environment variables: |
1276 | rxvt sets and/or uses the following environment variables: |
1080 | |
1277 | |
1081 | TERM |
1278 | TERM |
1082 | Normally set to "rxvt-unicode", unless overwritten at configure |
1279 | Normally set to "rxvt-unicode", unless overwritten at configure |
1083 | time, via resources or on the commandline. |
1280 | time, via resources or on the command line. |
1084 | |
1281 | |
1085 | COLORTERM |
1282 | COLORTERM |
1086 | Either "rxvt", "rxvt-xpm", depending on wether rxvt was compiled |
1283 | Either "rxvt", "rxvt-xpm", depending on whether rxvt was compiled |
1087 | with XPM support, and optionally with the added extension "-mono" to |
1284 | with XPM support, and optionally with the added extension "-mono" to |
1088 | indicate that rxvt-unicode runs on a monochrome screen. |
1285 | indicate that rxvt-unicode runs on a monochrome screen. |
1089 | |
1286 | |
1090 | COLORFGBG |
1287 | COLORFGBG |
1091 | Set to a string of the form "fg;bg" or "fg;xpm;bg", where "fg" is |
1288 | Set to a string of the form "fg;bg" or "fg;xpm;bg", where "fg" is |
… | |
… | |
1105 | Set to the terminfo directory iff rxvt was configured with |
1302 | Set to the terminfo directory iff rxvt was configured with |
1106 | "--with-terminfo=PATH". |
1303 | "--with-terminfo=PATH". |
1107 | |
1304 | |
1108 | DISPLAY |
1305 | DISPLAY |
1109 | Used by rxvt to connect to the display and set to the correct |
1306 | Used by rxvt to connect to the display and set to the correct |
1110 | display in it's child processes. |
1307 | display in its child processes. |
1111 | |
1308 | |
1112 | SHELL |
1309 | SHELL |
1113 | The shell to be used for command execution, defaults to "/bin/sh". |
1310 | The shell to be used for command execution, defaults to "/bin/sh". |
1114 | |
|
|
1115 | RXVTPATH |
|
|
1116 | The path where rxvt looks for support files such as menu and xpm |
|
|
1117 | files. |
|
|
1118 | |
|
|
1119 | PATH |
|
|
1120 | Used in the same way as "RXVTPATH". |
|
|
1121 | |
1311 | |
1122 | RXVT_SOCKET |
1312 | RXVT_SOCKET |
1123 | The unix domain socket path used by rxvtc(1) and rxvtd(1). |
1313 | The unix domain socket path used by rxvtc(1) and rxvtd(1). |
1124 | |
1314 | |
1125 | Default $HOME/.rxvt-unicode-*<nodename*. |
1315 | Default $HOME/.rxvt-unicode-*<nodename*. |
… | |
… | |
1146 | |
1336 | |
1147 | CURRENT PROJECT COORDINATOR |
1337 | CURRENT PROJECT COORDINATOR |
1148 | Project Coordinator |
1338 | Project Coordinator |
1149 | Marc A. Lehmann <rxvt-unicode@schmorp.de> |
1339 | Marc A. Lehmann <rxvt-unicode@schmorp.de> |
1150 | |
1340 | |
1151 | <http://software.schmorp.de/#rxvt-unicode> |
1341 | <http://software.schmorp.de/pkg/rxvt-unicode.html> |
1152 | |
1342 | |
1153 | AUTHORS |
1343 | AUTHORS |
1154 | John Bovey |
1344 | John Bovey |
1155 | University of Kent, 1992, wrote the original Xvt. |
1345 | University of Kent, 1992, wrote the original Xvt. |
1156 | |
1346 | |
… | |
… | |
1167 | |
1357 | |
1168 | Oezguer Kesim <kesim@math.fu-berlin.de> |
1358 | Oezguer Kesim <kesim@math.fu-berlin.de> |
1169 | Project Coordinator (changes.txt 2.21a to 2.4.5) |
1359 | Project Coordinator (changes.txt 2.21a to 2.4.5) |
1170 | |
1360 | |
1171 | Geoff Wing <gcw@pobox.com> |
1361 | Geoff Wing <gcw@pobox.com> |
1172 | Rewrote screen display and text selection routines. Project |
1362 | Rewrote screen display and text selection routines. |
|
|
1363 | |
1173 | Coordinator (changes.txt 2.4.6 - rxvt-unicode) |
1364 | Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) |
1174 | |
1365 | |
1175 | Marc Alexander Lehmann <rxvt-unicode@schmorp.de> |
1366 | Marc Alexander Lehmann <rxvt-unicode@schmorp.de> |
1176 | Forked rxvt-unicode, rewrote most of the display code and internal |
1367 | Forked rxvt-unicode, unicode support, rewrote almost all the code, |
1177 | character handling to store text in unicode, improve xterm |
1368 | perl extension, random hacks, numerous bugfixes and extensions. |
1178 | compatibility and apply numerous other bugfixes and extensions. |
|
|
1179 | |
1369 | |
1180 | Project Coordinator (Changes 1.0 -) |
1370 | Project Coordinator (Changes 1.0 -) |
1181 | |
1371 | |
|
|
1372 | Emanuele Giaquinta <e.giaquinta@glauco.it> |
|
|
1373 | Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing. |
|
|
1374 | |