1 | NAME |
1 | NAME |
2 | rxvt-unicode (ouR XVT, unicode) - (a VT102 emulator for the X window |
2 | rxvt-unicode (ouR XVT, unicode) - (a VT102 emulator for the X window |
3 | system) |
3 | system) |
4 | |
4 | |
5 | SYNOPSIS |
5 | SYNOPSIS |
6 | rxvt [options] [-e command [ args ]] |
6 | urxvt [options] [-e command [ args ]] |
7 | |
7 | |
8 | DESCRIPTION |
8 | DESCRIPTION |
9 | rxvt-unicode, version 5.1, is a colour vt102 terminal emulator intended |
9 | rxvt-unicode, version 8.4, 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 urxvt(7) (try "man 7 urxvt") for a list of frequently asked |
17 | and answer to them and some common problems. That document is also |
17 | questions and answer to them and some common problems. That document is |
18 | accessible on the World-Wide-Web at |
18 | also 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 devanagari. 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 urxvtd(1) (daemon) and urxvtc(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 urxvt(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 urxvt 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 |
67 | or default values chosen at compile-time, so options and defaults listed |
67 | or default values chosen at compile-time, so options and defaults listed |
68 | may not accurately reflect the version installed on your system. `rxvt |
68 | may not accurately reflect the version installed on your system. `urxvt |
69 | -h' gives a list of major compile-time options on the *Options* line. |
69 | -h' gives a list of major compile-time options on the *Options* line. |
70 | Option descriptions may be prefixed with which compile option each is |
70 | Option descriptions may be prefixed with which compile option each is |
71 | dependent upon. e.g. `Compile *XIM*:' requires *XIM* on the *Options* |
71 | dependent upon. e.g. `Compile *XIM*:' requires *XIM* on the *Options* |
72 | line. Note: `rxvt -help' gives a list of all command-line options |
72 | line. Note: `urxvt -help' gives a list of all command-line options |
73 | compiled into your version. |
73 | compiled into your version. |
74 | |
74 | |
75 | Note that rxvt permits the resource name to be used as a long-option |
75 | Note that urxvt permits the resource name to be used as a long-option |
76 | (--/++ option) so the potential command-line options are far greater |
76 | (--/++ option) so the potential command-line options are far greater |
77 | than those listed. For example: `rxvt --loginShell --color1 Orange'. |
77 | than those listed. For example: `urxvt --loginShell --color1 Orange'. |
78 | |
78 | |
79 | The following options are available: |
79 | The following options are available: |
80 | |
80 | |
81 | -help, --help |
81 | -help, --help |
82 | Print out a message describing available options. |
82 | Print out a message describing available options. |
… | |
… | |
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. |
97 | |
102 | |
98 | -ip|+ip |
103 | -ss|+ss |
99 | Turn on/off inheriting parent window's pixmap. Alternative form is |
104 | Turn on/off skip scrolling (allow multiple screens per refresh); |
100 | -tr; resource inheritPixmap. |
105 | resource skipScroll. |
|
|
106 | |
|
|
107 | -tr|+tr |
|
|
108 | Turn on/off illusion of a transparent window background. Obsolete |
|
|
109 | form of it is -ip and it should not be used anymore; resource |
|
|
110 | transparent. |
|
|
111 | |
|
|
112 | *Please note that old resource name of inheritPixmap is obsolete and |
|
|
113 | should be changed to transparent. Backwards compatibility support |
|
|
114 | for inheritPixmap will be phased out in future versions of rxvt!* |
|
|
115 | |
|
|
116 | *Please address all transparency related issues to Sasha Vasko at |
|
|
117 | sasha@aftercode.net. Read the FAQ (man 7 urxvt)!* |
101 | |
118 | |
102 | -fade *number* |
119 | -fade *number* |
103 | Fade the text by the given percentage when focus is lost. resource |
120 | Fade the text by the given percentage when focus is lost. Small |
104 | fading. |
121 | values fade a little only, 100 completely replaces all colours by |
|
|
122 | the fade colour; resource fading. |
|
|
123 | |
|
|
124 | -fadecolor *colour* |
|
|
125 | Fade to this colour when fading is used (see -fade). The default |
|
|
126 | colour is opaque black. resource fadeColor. |
105 | |
127 | |
106 | -tint *colour* |
128 | -tint *colour* |
107 | Tint the transparent background pixmap with the given colour when |
129 | Tint the transparent background pixmap with the given colour when |
108 | transparency is enabled with -tr or -ip. See also the -sh option |
130 | transparency is enabled with -tr. This only works for non-tiled |
109 | that can be used to brighten or darken the image in addition to |
131 | backgrounds, currently. See also the -sh option that can be used to |
110 | tinting it. |
132 | brighten or darken the image in addition to tinting it. Please note |
|
|
133 | that certain tint colours can be applied on the server-side, thus |
|
|
134 | yielding performance gain of two orders of magnitude. These colours |
|
|
135 | are: blue, red, green, cyan, magenta, yellow, and those close to |
|
|
136 | them; resource *tintColor*. Example: |
111 | |
137 | |
|
|
138 | urxvt -tr -tint blue -sh 40 |
|
|
139 | |
|
|
140 | -sh *number* |
112 | -sh *number* Darken (0 .. 100) or lighten (-1 .. -100) the transparent |
141 | Darken (0 .. 100) or lighten (-1 .. -100) the transparent background |
113 | background image in addition to tinting it (i.e. -tint must be |
142 | image in addition to (or instead of) tinting it; resource *shading*. |
114 | specified, too, e.g. "-tint white"). |
143 | |
|
|
144 | -blt *string* |
|
|
145 | Specify background blending type. If background pixmap is specified |
|
|
146 | at the same time as transparency - such pixmap will be blended over |
|
|
147 | transparency image, using method specified. Supported values are : |
|
|
148 | add, alphablend, allanon - color values averaging, colorize, darken, |
|
|
149 | diff, dissipate, hue, lighten, overlay, saturate, screen, sub, tint, |
|
|
150 | value. The default is alpha-blending. Compile *afterimage*; resource |
|
|
151 | *blendType*. |
|
|
152 | |
|
|
153 | -blr *HxV* |
|
|
154 | Apply Gaussian Blur with the specified radii to the transparent |
|
|
155 | background image. If single number is specified - both vertical and |
|
|
156 | horizontal radii are considered to be the same. Setting one of the |
|
|
157 | radii to 1 and another to a large number creates interesting effects |
|
|
158 | on some backgrounds. Maximum radius value is 128. Compile |
|
|
159 | *afterimage*; resource *blurRadius*. |
115 | |
160 | |
116 | -bg *colour* |
161 | -bg *colour* |
117 | Window background colour; resource background. |
162 | Window background colour; resource background. |
118 | |
163 | |
119 | -fg *colour* |
164 | -fg *colour* |
120 | Window foreground colour; resource foreground. |
165 | Window foreground colour; resource foreground. |
121 | |
166 | |
122 | -pixmap *file[;geom]* |
167 | -pixmap *file[;geom]* |
123 | Compile *XPM*: Specify XPM file for the background and also |
168 | Compile *afterimage*: Specify image file for the background and also |
124 | optionally specify its scaling with a geometry string. Note you may |
169 | optionally specify its scaling with a geometry string. Note you may |
125 | need to add quotes to avoid special shell interpretation of the ";" |
170 | need to add quotes to avoid special shell interpretation of the ";" |
126 | in the command-line; resource backgroundPixmap. |
171 | in the command-line; for more details see resource backgroundPixmap. |
127 | |
172 | |
128 | -cr *colour* |
173 | -cr *colour* |
129 | The cursor colour; resource cursorColor. |
174 | The cursor colour; resource cursorColor. |
130 | |
175 | |
131 | -pr *colour* |
176 | -pr *colour* |
… | |
… | |
138 | The colour of the border around the text area and between the |
183 | The colour of the border around the text area and between the |
139 | scrollbar and the text; resource borderColor. |
184 | scrollbar and the text; resource borderColor. |
140 | |
185 | |
141 | -fn *fontlist* |
186 | -fn *fontlist* |
142 | Select the fonts to be used. This is a comma separated list of font |
187 | Select the fonts to be used. This is a comma separated list of font |
143 | names that are used in turn when trying to display Unicode |
188 | names that are checked in order when trying to find glyphs for |
144 | characters. The first font defines the cell size for characters; |
189 | characters. The first font defines the cell size for characters; |
145 | other fonts might be smaller, but not (in general) larger. A |
190 | other fonts might be smaller, but not (in general) larger. A |
146 | (hopefully) reasonable default font list is always appended to it. |
191 | (hopefully) reasonable default font list is always appended to it. |
147 | See resource font for more details. |
192 | See resource font for more details. |
148 | |
193 | |
149 | In short, to specify an X11 core font, just specify it's name or |
194 | In short, to specify an X11 core font, just specify its name or |
150 | prefix it with "x:". To specify an XFT-font, you need to prefix it |
195 | prefix it with "x:". To specify an XFT-font, you need to prefix it |
151 | with "xft:", e.g.: |
196 | with "xft:", e.g.: |
152 | |
197 | |
153 | rxvt -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" |
198 | urxvt -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" |
154 | rxvt -fn "9x15bold,xft:Bitstream Vera Sans Mono" |
199 | urxvt -fn "9x15bold,xft:Bitstream Vera Sans Mono" |
155 | |
200 | |
156 | See also the question "How does rxvt-unicode choose fonts?" in the |
201 | See also the question "How does rxvt-unicode choose fonts?" in the |
157 | FAQ section of rxvt(7). |
202 | FAQ section of urxvt(7). |
158 | |
203 | |
159 | -fb *fontlist* |
204 | -fb *fontlist* |
160 | Compile font-styles: The bold font list to use when bold characters |
205 | Compile *font-styles*: The bold font list to use when bold |
161 | are to be printed. See resource boldFont for details. |
206 | characters are to be printed. See resource boldFont for details. |
162 | |
207 | |
163 | -fi *fontlist* |
208 | -fi *fontlist* |
164 | Compile font-styles: The italic font list to use when bold |
209 | Compile *font-styles*: The italic font list to use when *italic* |
165 | characters are to be printed. See resource italicFont for details. |
210 | characters are to be printed. See resource italicFont for details. |
166 | |
211 | |
167 | -fbi *fontlist* |
212 | -fbi *fontlist* |
168 | Compile font-styles: The bold italic font list to use when bold |
213 | Compile *font-styles*: The bold italic font list to use when *bold |
169 | characters are to be printed. See resource boldItalicFont for |
214 | italic* characters are to be printed. See resource boldItalicFont |
|
|
215 | for details. |
|
|
216 | |
|
|
217 | -is|+is |
|
|
218 | Compile *font-styles*: Bold/Italic font styles imply high intensity |
|
|
219 | foreground/background (default). See resource intensityStyles for |
170 | details. |
220 | details. |
171 | |
221 | |
172 | -name *name* |
222 | -name *name* |
173 | Specify the application name under which resources are to be |
223 | Specify the application name under which resources are to be |
174 | obtained, rather than the default executable file name. Name should |
224 | obtained, rather than the default executable file name. Name should |
… | |
… | |
204 | |
254 | |
205 | -sr|+sr |
255 | -sr|+sr |
206 | Put scrollbar on right/left; resource scrollBar_right. |
256 | Put scrollbar on right/left; resource scrollBar_right. |
207 | |
257 | |
208 | -st|+st |
258 | -st|+st |
209 | Display normal (non XTerm/NeXT) scrollbar without/with a trough; |
259 | Display rxvt (non XTerm/NeXT) scrollbar without/with a trough; |
210 | resource scrollBar_floating. |
260 | resource scrollBar_floating. |
211 | |
261 | |
212 | -ptab|+ptab |
262 | -ptab|+ptab |
213 | If enabled (default), "Horizontal Tab" characters are being stored |
263 | If enabled (default), "Horizontal Tab" characters are being stored |
214 | as actual wide characters in the screen buffer, which makes it |
264 | as actual wide characters in the screen buffer, which makes it |
… | |
… | |
239 | |
289 | |
240 | -bl Compile *frills*: Set MWM hints to request a borderless window, i.e. |
290 | -bl Compile *frills*: Set MWM hints to request a borderless window, i.e. |
241 | if honoured by the WM, the rxvt-unicode window will not have window |
291 | if honoured by the WM, the rxvt-unicode window will not have window |
242 | decorations; resource borderLess. |
292 | decorations; resource borderLess. |
243 | |
293 | |
|
|
294 | -override-redirect |
|
|
295 | Compile *frills*: Sets override-redirect on the window; resource |
|
|
296 | override-redirect. |
|
|
297 | |
|
|
298 | -sbg |
|
|
299 | Compile *frills*: Disable the usage of the built-in block |
|
|
300 | graphics/line drawing characters and just rely on what the specified |
|
|
301 | fonts provide. Use this if you have a good font and want to use its |
|
|
302 | block graphic glyphs; resource skipBuiltinGlyphs. |
|
|
303 | |
244 | -lsp *number* |
304 | -lsp *number* |
245 | Compile *frills*: Lines (pixel height) to insert between each row of |
305 | Compile *frills*: Lines (pixel height) to insert between each row of |
246 | the display. Useful to work around font rendering problems; resource |
306 | the display. Useful to work around font rendering problems; resource |
247 | linespace. |
307 | lineSpace. |
248 | |
308 | |
249 | -tn *termname* |
309 | -tn *termname* |
250 | This option specifies the name of the terminal type to be set in the |
310 | This option specifies the name of the terminal type to be set in the |
251 | TERM environment variable. This terminal type must exist in the |
311 | TERM environment variable. This terminal type must exist in the |
252 | *termcap(5)* database and should have *li#* and *co#* entries; |
312 | *termcap(5)* database and should have *li#* and *co#* entries; |
253 | resource termName. |
313 | resource termName. |
254 | |
314 | |
255 | -e *command [arguments]* |
315 | -e *command [arguments]* |
256 | Run the command with its command-line arguments in the rxvt window; |
316 | Run the command with its command-line arguments in the urxvt window; |
257 | also sets the window title and icon name to be the basename of the |
317 | also sets the window title and icon name to be the basename of the |
258 | program being executed if neither *-title* (*-T*) nor *-n* are given |
318 | program being executed if neither *-title* (*-T*) nor *-n* are given |
259 | on the command line. If this option is used, it must be the last on |
319 | on the command line. If this option is used, it must be the last on |
260 | the command-line. If there is no -e option then the default is to |
320 | the command-line. If there is no -e option then the default is to |
261 | run the program specified by the SHELL environment variable or, |
321 | run the program specified by the SHELL environment variable or, |
262 | failing that, *sh(1)*. |
322 | failing that, *sh(1)*. |
263 | |
323 | |
|
|
324 | Please note that you must specify a program with arguments. If you |
|
|
325 | want to run shell commands, you have to specify the shell, like |
|
|
326 | this: |
|
|
327 | |
|
|
328 | urxvt -e sh -c "shell commands" |
|
|
329 | |
264 | -title *text* |
330 | -title *text* |
265 | Window title (-T still respected); the default title is the basename |
331 | Window title (-T still respected); the default title is the basename |
266 | of the program specified after the -e option, if any, otherwise the |
332 | of the program specified after the -e option, if any, otherwise the |
267 | application name; resource title. |
333 | application name; resource title. |
268 | |
334 | |
… | |
… | |
290 | Set the font set to use for the X Input Method, see resource imFont |
356 | Set the font set to use for the X Input Method, see resource imFont |
291 | for more info. |
357 | for more info. |
292 | |
358 | |
293 | -tcw |
359 | -tcw |
294 | Change the meaning of triple-click selection with the left mouse |
360 | Change the meaning of triple-click selection with the left mouse |
|
|
361 | button. Only effective when the original (non-perl) selection code |
295 | button. Instead of selecting a full line it will extend the |
362 | is in-use. Instead of selecting a full line it will extend the |
296 | selection the end of the logical line only. resource |
363 | selection the end of the logical line only. resource |
297 | tripleclickwords. |
364 | tripleclickwords. |
298 | |
365 | |
299 | -insecure |
366 | -insecure |
300 | Enable "insecure" mode, which currently enables most of the escape |
367 | Enable "insecure" mode, which currently enables most of the escape |
… | |
… | |
311 | |
378 | |
312 | -ssr|+ssr |
379 | -ssr|+ssr |
313 | Turn on/off secondary screen scroll (default enabled); resource |
380 | Turn on/off secondary screen scroll (default enabled); resource |
314 | secondaryScroll. |
381 | secondaryScroll. |
315 | |
382 | |
|
|
383 | -hold|+hold |
|
|
384 | Turn on/off hold window after exit support. If enabled, urxvt will |
|
|
385 | not immediately destroy its window when the program executed within |
|
|
386 | it exits. Instead, it will wait till it is being killed or closed by |
|
|
387 | the user; resource hold. |
|
|
388 | |
316 | -keysym.*sym*: *string* |
389 | -keysym.*sym* *string* |
317 | Remap a key symbol. See resource keysym. |
390 | Remap a key symbol. See resource keysym. |
318 | |
391 | |
319 | -embed: *windowid* |
392 | -embed *windowid* |
320 | Tells rxvt to embed it's windows into an already-existing window, |
393 | Tells urxvt to embed its windows into an already-existing window, |
321 | which enables applications to easily embed a terminal. |
394 | which enables applications to easily embed a terminal. |
322 | |
395 | |
323 | Right now, rxvt will first unmap/map the specified window, so it |
396 | Right now, urxvt will first unmap/map the specified window, so it |
324 | shouldn't be a top-level window. rxvt will also reconfigure it quite |
397 | shouldn't be a top-level window. urxvt will also reconfigure it |
325 | a bit, so don't expect it to keep some specific state. It's best to |
398 | quite a bit, so don't expect it to keep some specific state. It's |
326 | create an extra subwindow for rxvt and leave it alone. |
399 | best to create an extra subwindow for urxvt and leave it alone. |
327 | |
400 | |
328 | The window will not be destroyed when rxvt exits. |
401 | The window will not be destroyed when urxvt exits. |
329 | |
402 | |
330 | It might be useful to know that rxvt will not close file descriptors |
403 | It might be useful to know that urxvt will not close file |
331 | passed to it (except for stdin/out/err, of course), so you can use |
404 | descriptors passed to it (except for stdin/out/err, of course), so |
332 | file descriptors to communicate with the programs within the |
405 | you can use file descriptors to communicate with the programs within |
333 | terminal. This works regardless of wether the "-embed" option was |
406 | the terminal. This works regardless of whether the "-embed" option |
334 | used or not. |
407 | was used or not. |
|
|
408 | |
|
|
409 | Here is a short Gtk2-perl snippet that illustrates how this option |
|
|
410 | can be used (a longer example is in doc/embed): |
|
|
411 | |
|
|
412 | my $rxvt = new Gtk2::Socket; |
|
|
413 | $rxvt->signal_connect_after (realize => sub { |
|
|
414 | my $xid = $_[0]->window->get_xid; |
|
|
415 | system "urxvt -embed $xid &"; |
|
|
416 | }); |
|
|
417 | |
|
|
418 | -pty-fd *file descriptor* |
|
|
419 | Tells urxvt NOT to execute any commands or create a new pty/tty pair |
|
|
420 | but instead use the given file descriptor as the tty master. This is |
|
|
421 | useful if you want to drive urxvt as a generic terminal emulator |
|
|
422 | without having to run a program within it. |
|
|
423 | |
|
|
424 | If this switch is given, urxvt will not create any utmp/wtmp entries |
|
|
425 | and will not tinker with pty/tty permissions - you have to do that |
|
|
426 | yourself if you want that. |
|
|
427 | |
|
|
428 | As an extremely special case, specifying -1 will completely suppress |
|
|
429 | pty/tty operations. |
|
|
430 | |
|
|
431 | Here is a example in perl that illustrates how this option can be |
|
|
432 | used (a longer example is in doc/pty-fd): |
|
|
433 | |
|
|
434 | use IO::Pty; |
|
|
435 | use Fcntl; |
|
|
436 | |
|
|
437 | my $pty = new IO::Pty; |
|
|
438 | fcntl $pty, F_SETFD, 0; # clear close-on-exec |
|
|
439 | system "urxvt -pty-fd " . (fileno $pty) . "&"; |
|
|
440 | close $pty; |
|
|
441 | |
|
|
442 | # now communicate with rxvt |
|
|
443 | my $slave = $pty->slave; |
|
|
444 | while (<$slave>) { print $slave "got <$_>\n" } |
|
|
445 | |
|
|
446 | -pe *string* |
|
|
447 | Comma-separated list of perl extension scripts to use (or not to |
|
|
448 | use) in this terminal instance. See resource perl-ext for details. |
335 | |
449 | |
336 | RESOURCES (available also as long-options) |
450 | RESOURCES (available also as long-options) |
337 | Note: `rxvt --help' gives a list of all resources (long options) |
451 | Note: `urxvt --help' gives a list of all resources (long options) |
338 | compiled into your version. |
452 | compiled into your version. |
339 | |
453 | |
340 | There are two different methods that rxvt can use to get the Xresource |
|
|
341 | data: using the X libraries (Xrm*-functions) or internal Xresources |
|
|
342 | reader (~/.Xdefaults). For the first method (ie. rxvt -h lists |
|
|
343 | XGetDefaults), you can set and change the resources using X11 tools like |
454 | You can set and change the resources using X11 tools like xrdb. Many |
344 | xrdb. Many distribution do also load settings from the ~/.Xresources |
455 | distribution do also load settings from the ~/.Xresources file when X |
345 | file when X starts. rxvt will consult the following files/resources in |
456 | starts. urxvt will consult the following files/resources in order, with |
346 | order, with later settings overwriting earlier ones: |
457 | later settings overwriting earlier ones: |
347 | |
458 | |
348 | 1. system-wide app-defaults file, either locale-dependent OR global |
459 | 1. system-wide app-defaults file, either locale-dependent OR global |
349 | 2. app-defaults file in $XAPPLRESDIR |
460 | 2. app-defaults file in $XAPPLRESDIR |
350 | 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults |
461 | 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults |
351 | 4. SCREEN_RESOURCES for the current screen |
462 | 4. SCREEN_RESOURCES for the current screen |
352 | 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> |
463 | 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> |
353 | |
464 | |
354 | If compiled with internal Xresources support (i.e. rxvt -h lists |
465 | Note that when reading X resources, urxvt recognizes two class names: |
355 | .Xdefaults) then rxvt accepts application defaults set in |
466 | Rxvt and URxvt. The class name Rxvt allows resources common to both |
356 | XAPPLOADDIR/URxvt (compile-time defined: usually |
467 | urxvt and the original *rxvt* to be easily configured, while the class |
357 | /usr/lib/X11/app-defaults/URxvt) and resources set in ~/.Xdefaults, or |
468 | name URxvt allows resources unique to urxvt, to be shared between |
358 | ~/.Xresources if ~/.Xdefaults does not exist. Note that when reading X |
|
|
359 | resources, rxvt recognizes two class names: XTerm and URxvt. The class |
|
|
360 | name Rxvt allows resources common to both rxvt and the original *rxvt* |
|
|
361 | to be easily configured, while the class name URxvt allows resources |
|
|
362 | unique to rxvt, notably colours and key-handling, to be shared between |
|
|
363 | different rxvt configurations. If no resources are specified, suitable |
469 | different urxvt configurations. If no resources are specified, suitable |
364 | defaults will be used. Command-line arguments can be used to override |
470 | defaults will be used. Command-line arguments can be used to override |
365 | resource settings. The following resources are allowed: |
471 | resource settings. The following resources are supported (you might want |
|
|
472 | to check the urxvtperl(3) manpage for additional settings by perl |
|
|
473 | extensions not documented here): |
|
|
474 | |
|
|
475 | depth: *bitdepth* |
|
|
476 | Compile *xft*: Attempt to find a visual with the given bit depth; |
|
|
477 | option -depth. |
366 | |
478 | |
367 | geometry: *geom* |
479 | geometry: *geom* |
368 | Create the window with the specified X window geometry [default |
480 | Create the window with the specified X window geometry [default |
369 | 80x24]; option -geometry. |
481 | 80x24]; option -geometry. |
370 | |
482 | |
… | |
… | |
384 | 1=red, 2=green, 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but |
496 | 1=red, 2=green, 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but |
385 | the actual colour names used are listed in the COLORS AND GRAPHICS |
497 | the actual colour names used are listed in the COLORS AND GRAPHICS |
386 | section. |
498 | section. |
387 | |
499 | |
388 | Colours higher than 15 cannot be set using resources (yet), but can |
500 | Colours higher than 15 cannot be set using resources (yet), but can |
389 | be changed using an escape command (see rxvt(7)). |
501 | be changed using an escape command (see urxvt(7)). |
390 | |
502 | |
391 | Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm |
503 | Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm |
392 | with 88 colour support). Colours 80-87 are evenly spaces grey steps. |
504 | with 88 colour support). Colours 80-87 are evenly spaces grey steps. |
393 | |
505 | |
394 | colorBD: *colour* |
506 | colorBD: *colour* |
… | |
… | |
402 | Use the specified colour to display underlined characters when the |
514 | Use the specified colour to display underlined characters when the |
403 | foreground colour is the default. |
515 | foreground colour is the default. |
404 | |
516 | |
405 | colorRV: *colour* |
517 | colorRV: *colour* |
406 | Use the specified colour as the background for reverse video |
518 | Use the specified colour as the background for reverse video |
407 | characters. |
519 | characters when OPTION_HC is disabled (--disable-frills). |
408 | |
520 | |
409 | underlineColor: *colour* |
521 | underlineColor: *colour* |
410 | If set, use the specified colour as the colour for the underline |
522 | If set, use the specified colour as the colour for the underline |
411 | itself. If unset, use the foreground colour. |
523 | itself. If unset, use the foreground colour. |
412 | |
524 | |
… | |
… | |
423 | True: simulate reverse video by foreground and background colours; |
535 | True: simulate reverse video by foreground and background colours; |
424 | option -rv. False: regular screen colours [default]; option +rv. See |
536 | option -rv. False: regular screen colours [default]; option +rv. See |
425 | note in COLORS AND GRAPHICS section. |
537 | note in COLORS AND GRAPHICS section. |
426 | |
538 | |
427 | jumpScroll: *boolean* |
539 | jumpScroll: *boolean* |
428 | True: specify that jump scrolling should be used. When scrolling |
540 | True: specify that jump scrolling should be used. When receiving |
429 | quickly, fewer screen updates are performed [default]; option -j. |
541 | lots of lines, urxvt will only scroll once a whole screen height of |
|
|
542 | lines has been read, resulting in fewer updates while still |
|
|
543 | displaying every received line; option -j. |
|
|
544 | |
430 | False: specify that smooth scrolling should be used; option +j. |
545 | False: specify that smooth scrolling should be used. urxvt will |
|
|
546 | force a screen refresh on each new line it received; option +j. |
|
|
547 | |
|
|
548 | skipScroll: *boolean* |
|
|
549 | True: (the default) specify that skip scrolling should be used. When |
|
|
550 | receiving lots of lines, urxvt will only scroll once in a while |
|
|
551 | (around 60 times per second), resulting in far fewer updates. This |
|
|
552 | can result in urxvt not ever displaying some of the lines it |
|
|
553 | receives; option -ss. |
|
|
554 | |
|
|
555 | False: specify that everything is to be displayed, even if the |
|
|
556 | refresh is too fast for the human eye to read anything (or the |
|
|
557 | monitor to display anything); option +ss. |
431 | |
558 | |
432 | inheritPixmap: *boolean* |
559 | inheritPixmap: *boolean* |
433 | True: make the background inherit the parent windows' pixmap, giving |
560 | True: make the background inherit the parent windows' pixmap, giving |
434 | artificial transparency. False: do not inherit the parent windows' |
561 | artificial transparency. False: do not inherit the parent windows' |
435 | pixmap. |
562 | pixmap. |
436 | |
563 | |
|
|
564 | *Please note that transparency of any kind if completely unsupported |
|
|
565 | by the author. Don't bug him with installation questions!* |
|
|
566 | |
437 | fading: *number* |
567 | fading: *number* |
438 | Fade the text by the given percentage when focus is lost. |
568 | Fade the text by the given percentage when focus is lost; option |
|
|
569 | -fade. |
|
|
570 | |
|
|
571 | fadeColor: *colour* |
|
|
572 | Fade to this colour, when fading is used (see fading:). The default |
|
|
573 | colour is black; option -fadecolor. |
439 | |
574 | |
440 | tintColor: *colour* |
575 | tintColor: *colour* |
441 | Tint the transparent background pixmap with the given colour. |
576 | Tint the transparent background pixmap with the given colour; option |
|
|
577 | -tint. |
442 | |
578 | |
443 | shading: *number* |
579 | shading: *number* |
444 | Darken (0 .. 100) or lighten (-1 .. -100) the transparent background |
580 | Darken (0 .. 100) or lighten (-1 .. -100) the transparent background |
445 | image in addition to tinting it. |
581 | image in addition to tinting it; option -sh. |
|
|
582 | |
|
|
583 | blendType: *string* |
|
|
584 | Specify background blending type; option -blt. |
|
|
585 | |
|
|
586 | blurRadius: *number* |
|
|
587 | Apply Gaussian Blurr with the specified radius to the transparent |
|
|
588 | background image; option -blr. |
446 | |
589 | |
447 | scrollColor: *colour* |
590 | scrollColor: *colour* |
448 | Use the specified colour for the scrollbar [default #B2B2B2]. |
591 | Use the specified colour for the scrollbar [default #B2B2B2]. |
449 | |
592 | |
450 | troughColor: *colour* |
593 | troughColor: *colour* |
451 | Use the specified colour for the scrollbar's trough area [default |
594 | Use the specified colour for the scrollbar's trough area [default |
452 | #969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. |
595 | #969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar. |
453 | |
596 | |
454 | borderColor: *colour* |
597 | borderColor: *colour* |
455 | The colour of the border around the text area and between the |
598 | The colour of the border around the text area and between the |
456 | scrollbar and the text. |
599 | scrollbar and the text. |
457 | |
600 | |
458 | backgroundPixmap: *file[;geom]* |
601 | backgroundPixmap: *file[;geom]* |
459 | Use the specified XPM file (note the `.xpm' extension is optional) |
602 | Use the specified image file for the background and also optionally |
460 | for the background and also optionally specify its scaling with a |
603 | specify its scaling with a geometry string WxH+X+Y, in which "W" / |
461 | geometry string WxH+X+Y, in which "W" / "H" specify the |
|
|
462 | horizontal/vertical scale (percent) and "X" / "Y" locate the image |
604 | "H" specify the horizontal/vertical scale (percent), and "X" / "Y" |
463 | centre (percent). A scale of 0 displays the image with tiling. A |
605 | locate the image centre (percent). A scale of 0 displays the image |
464 | scale of 1 displays the image without any scaling. A scale of 2 to 9 |
606 | with tiling. A scale of 1 displays the image without any scaling. A |
465 | specifies an integer number of images in that direction. No image |
607 | scale of 2 to 9 specifies an integer number of images in that |
466 | will be magnified beyond 10 times its original size. The maximum |
608 | direction. No image will be magnified beyond 10 times its original |
467 | permitted scale is 1000. [default 0x0+50+50] |
609 | size. The maximum permitted scale is 1000. Special string of "auto" |
468 | |
610 | used as a geometry will cause image to be automatically scaled to |
469 | menu: *file[;tag]* |
611 | match window size. If used in conjunction with -tr option - |
470 | Read in the specified menu file (note the `.menu' extension is |
612 | specified pixmap will be blended over transparency image using |
471 | optional) and also optionally specify a starting tag to find. See |
613 | either alpha-blending, or any other blending type, specified with |
472 | the reference documentation for details on the syntax for the |
614 | -blt "type" option. [default 0x0+50+50] |
473 | menuBar. |
|
|
474 | |
615 | |
475 | path: *path* |
616 | path: *path* |
476 | Specify the colon-delimited search path for finding files (XPM and |
617 | Specify the colon-delimited search path for finding background image |
477 | menus), in addition to the paths specified by the RXVTPATH and PATH |
618 | files. |
478 | environment variables. |
|
|
479 | |
619 | |
480 | font: *fontlist* |
620 | font: *fontlist* |
481 | Select the fonts to be used. This is a comma separated list of font |
621 | Select the fonts to be used. This is a comma separated list of font |
482 | names that are used in turn when trying to display Unicode |
622 | names that are checked in order when trying to find glyphs for |
483 | characters. The first font defines the cell size for characters; |
623 | characters. The first font defines the cell size for characters; |
484 | other fonts might be smaller, but not larger. A reasonable default |
624 | other fonts might be smaller, but not (in general) larger. A |
485 | font list is always appended to it. option -fn. |
625 | (hopefully) reasonable default font list is always appended to it; |
|
|
626 | option -fn. |
486 | |
627 | |
487 | Each font can either be a standard X11 core font (XLFD) name, with |
628 | Each font can either be a standard X11 core font (XLFD) name, with |
488 | optional prefix "x:" or a Xft font (Compile *xft*), prefixed with |
629 | optional prefix "x:" or a Xft font (Compile *xft*), prefixed with |
489 | "xft:". |
630 | "xft:". |
490 | |
631 | |
… | |
… | |
493 | available hint currently is "codeset=codeset-name", and this is only |
634 | available hint currently is "codeset=codeset-name", and this is only |
494 | used for Xft fonts. |
635 | used for Xft fonts. |
495 | |
636 | |
496 | For example, this font resource |
637 | For example, this font resource |
497 | |
638 | |
498 | URxvt*font: 9x15bold,\ |
639 | URxvt.font: 9x15bold,\ |
499 | -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\ |
640 | -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\ |
500 | -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \ |
641 | -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \ |
501 | [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ |
642 | [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ |
502 | xft:Code2000:antialias=false |
643 | xft:Code2000:antialias=false |
503 | |
644 | |
… | |
… | |
536 | tried. |
677 | tried. |
537 | |
678 | |
538 | If set, but empty, then this specific style is disabled and the |
679 | If set, but empty, then this specific style is disabled and the |
539 | normal text font will being used for the given style. |
680 | normal text font will being used for the given style. |
540 | |
681 | |
|
|
682 | intensityStyles: *boolean* |
|
|
683 | When font styles are not enabled, or this option is enabled (True, |
|
|
684 | option -is, the default), bold and italic font styles imply high |
|
|
685 | intensity foreground/background colours. Disabling this option |
|
|
686 | (False, option +is) disables this behaviour, the high intensity |
|
|
687 | colours are not reachable. |
|
|
688 | |
541 | selectstyle: *mode* |
689 | selectstyle: *mode* |
542 | Set mouse selection style to old which is 2.20, oldword which is |
690 | Set mouse selection style to old which is 2.20, oldword which is |
543 | xterm style with 2.20 old word selection, or anything else which |
691 | xterm style with 2.20 old word selection, or anything else which |
544 | gives xterm style selection. |
692 | gives xterm style selection. Only effective when the original |
|
|
693 | (non-perl) selection code is in use. |
545 | |
694 | |
546 | scrollstyle: *mode* |
695 | scrollstyle: *mode* |
547 | Set scrollbar style to rxvt, plain, next or xterm. plain is the |
696 | Set scrollbar style to rxvt, plain, next or xterm. plain is the |
548 | author's favourite.. |
697 | author's favourite. |
549 | |
698 | |
550 | title: *string* |
699 | title: *string* |
551 | Set window title string, the default title is the command-line |
700 | Set window title string, the default title is the command-line |
552 | specified after the -e option, if any, otherwise the application |
701 | specified after the -e option, if any, otherwise the application |
553 | name; option -title. |
702 | name; option -title. |
… | |
… | |
559 | |
708 | |
560 | mapAlert: *boolean* |
709 | mapAlert: *boolean* |
561 | True: de-iconify (map) on receipt of a bell character. False: no |
710 | True: de-iconify (map) on receipt of a bell character. False: no |
562 | de-iconify (map) on receipt of a bell character [default]. |
711 | de-iconify (map) on receipt of a bell character [default]. |
563 | |
712 | |
|
|
713 | urgentOnBell: *boolean* |
|
|
714 | True: set the urgency hint for the wm on receipt of a bell |
|
|
715 | character. False: do not set the urgency hint [default]. |
|
|
716 | |
564 | visualBell: *boolean* |
717 | visualBell: *boolean* |
565 | True: use visual bell on receipt of a bell character; option -vb. |
718 | True: use visual bell on receipt of a bell character; option -vb. |
566 | False: no visual bell [default]; option +vb. |
719 | False: no visual bell [default]; option +vb. |
567 | |
720 | |
568 | loginShell: *boolean* |
721 | loginShell: *boolean* |
… | |
… | |
578 | print-pipe: *string* |
731 | print-pipe: *string* |
579 | Specify a command pipe for vt100 printer [default *lpr(1)*]. Use |
732 | Specify a command pipe for vt100 printer [default *lpr(1)*]. Use |
580 | Print to initiate a screen dump to the printer and Ctrl-Print or |
733 | Print to initiate a screen dump to the printer and Ctrl-Print or |
581 | Shift-Print to include the scrollback as well. |
734 | Shift-Print to include the scrollback as well. |
582 | |
735 | |
|
|
736 | The string will be interpreted as if typed into the shell as-is. |
|
|
737 | |
|
|
738 | Example: |
|
|
739 | |
|
|
740 | URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) |
|
|
741 | |
|
|
742 | This creates a new file in your home directory with the screen |
|
|
743 | contents every time you hit "Print". |
|
|
744 | |
583 | scrollBar: *boolean* |
745 | scrollBar: *boolean* |
584 | True: enable the scrollbar [default]; option -sb. False: disable the |
746 | True: enable the scrollbar [default]; option -sb. False: disable the |
585 | scrollbar; option +sb. |
747 | scrollbar; option +sb. |
586 | |
748 | |
587 | scrollBar_right: *boolean* |
749 | scrollBar_right: *boolean* |
… | |
… | |
600 | True: scroll to bottom when tty receives output; option -si. False: |
762 | True: scroll to bottom when tty receives output; option -si. False: |
601 | do not scroll to bottom when tty receives output; option +si. |
763 | do not scroll to bottom when tty receives output; option +si. |
602 | |
764 | |
603 | scrollWithBuffer: *boolean* |
765 | scrollWithBuffer: *boolean* |
604 | True: scroll with scrollback buffer when tty receives new lines (and |
766 | True: scroll with scrollback buffer when tty receives new lines (and |
605 | scrollTtyOutput is False); option +sw. False: do not scroll with |
767 | scrollTtyOutput is False); option -sw. False: do not scroll with |
606 | scrollback buffer when tty recieves new lines; option -sw. |
768 | scrollback buffer when tty receives new lines; option +sw. |
607 | |
769 | |
608 | scrollTtyKeypress: *boolean* |
770 | scrollTtyKeypress: *boolean* |
609 | True: scroll to bottom when a non-special key is pressed. Special |
771 | True: scroll to bottom when a non-special key is pressed. Special |
610 | keys are those which are intercepted by rxvt-unicode for special |
772 | keys are those which are intercepted by rxvt-unicode for special |
611 | handling and are not passed onto the shell; option -sk. False: do |
773 | handling and are not passed onto the shell; option -sk. False: do |
… | |
… | |
626 | borderLess: *boolean* |
788 | borderLess: *boolean* |
627 | Set MWM hints to request a borderless window, i.e. if honoured by |
789 | Set MWM hints to request a borderless window, i.e. if honoured by |
628 | the WM, the rxvt-unicode window will not have window decorations; |
790 | the WM, the rxvt-unicode window will not have window decorations; |
629 | option -bl. |
791 | option -bl. |
630 | |
792 | |
|
|
793 | skipBuiltinGlyphs: *boolean* |
|
|
794 | Compile *frills*: Disable the usage of the built-in block |
|
|
795 | graphics/line drawing characters and just rely on what the specified |
|
|
796 | fonts provide. Use this if you have a good font and want to use its |
|
|
797 | block graphic glyphs; option -sbg. |
|
|
798 | |
631 | termName: *termname* |
799 | termName: *termname* |
632 | Specifies the terminal type name to be set in the TERM environment |
800 | Specifies the terminal type name to be set in the TERM environment |
633 | variable; option -tn. |
801 | variable; option -tn. |
634 | |
802 | |
635 | linespace: *number* |
803 | lineSpace: *number* |
636 | Specifies number of lines (pixel height) to insert between each row |
804 | Specifies number of lines (pixel height) to insert between each row |
637 | of the display [default 0]; option -lsp. |
805 | of the display [default 0]; option -lsp. |
638 | |
806 | |
639 | meta8: *boolean* |
807 | meta8: *boolean* |
640 | True: handle Meta (Alt) + keypress to set the 8th bit. False: handle |
808 | True: handle Meta (Alt) + keypress to set the 8th bit. False: handle |
… | |
… | |
663 | pointerColor2: *colour* |
831 | pointerColor2: *colour* |
664 | Mouse pointer background colour. |
832 | Mouse pointer background colour. |
665 | |
833 | |
666 | pointerBlankDelay: *number* |
834 | pointerBlankDelay: *number* |
667 | Specifies number of seconds before blanking the pointer [default 2]. |
835 | Specifies number of seconds before blanking the pointer [default 2]. |
|
|
836 | Use a large number (e.g. 987654321) to effectively disable the |
|
|
837 | timeout. |
668 | |
838 | |
669 | backspacekey: *string* |
839 | backspacekey: *string* |
670 | The string to send when the backspace key is pressed. If set to DEC |
840 | The string to send when the backspace key is pressed. If set to DEC |
671 | or unset it will send Delete (code 127) or, if shifted, Backspace |
841 | or unset it will send Delete (code 127) or, if shifted, Backspace |
672 | (code 8) - which can be reversed with the appropriate DEC private |
842 | (code 8) - which can be reversed with the appropriate DEC private |
… | |
… | |
676 | The string to send when the delete key (not the keypad delete key) |
846 | The string to send when the delete key (not the keypad delete key) |
677 | is pressed. If unset it will send the sequence traditionally |
847 | is pressed. If unset it will send the sequence traditionally |
678 | associated with the Execute key. |
848 | associated with the Execute key. |
679 | |
849 | |
680 | cutchars: *string* |
850 | cutchars: *string* |
681 | The characters used as delimiters for double-click word selection. |
851 | The characters used as delimiters for double-click word selection |
682 | The built-in default: |
852 | (whitespace delimiting is added automatically if resource is given). |
|
|
853 | |
|
|
854 | When the perl selection extension is in use (the default if compiled |
|
|
855 | in, see the urxvtperl(3) manpage), a suitable regex using these |
|
|
856 | characters will be created (if the resource exists, otherwise, no |
|
|
857 | regex will be created). In this mode, characters outside ISO-8859-1 |
|
|
858 | can be used. |
|
|
859 | |
|
|
860 | When the selection extension is not used, only ISO-8859-1 characters |
|
|
861 | can be used. If not specified, the built-in default is used: |
683 | |
862 | |
684 | BACKSLASH `"'&()*,;<=>?@[]{|} |
863 | BACKSLASH `"'&()*,;<=>?@[]{|} |
685 | |
864 | |
686 | preeditType: *style* |
865 | preeditType: *style* |
687 | OverTheSpot, OffTheSpot, Root; option -pt. |
866 | OverTheSpot, OffTheSpot, Root; option -pt. |
… | |
… | |
691 | |
870 | |
692 | imLocale: *name* |
871 | imLocale: *name* |
693 | The locale to use for opening the IM. You can use an "LC_CTYPE" of |
872 | The locale to use for opening the IM. You can use an "LC_CTYPE" of |
694 | e.g. "de_DE.UTF-8" for normal text processing but "ja_JP.EUC-JP" for |
873 | e.g. "de_DE.UTF-8" for normal text processing but "ja_JP.EUC-JP" for |
695 | the input extension to be able to input japanese characters while |
874 | the input extension to be able to input japanese characters while |
696 | staying in another locale. option -imlocale. |
875 | staying in another locale; option -imlocale. |
697 | |
876 | |
698 | imFont: *fontset* |
877 | imFont: *fontset* |
699 | Specify the font-set used for XIM styles "OverTheSpot" or |
878 | Specify the font-set used for XIM styles "OverTheSpot" or |
700 | "OffTheSpot". It must be a standard X font set (XLFD patterns |
879 | "OffTheSpot". It must be a standard X font set (XLFD patterns |
701 | separated by commas), i.e. it's not in the same format as the other |
880 | separated by commas), i.e. it's not in the same format as the other |
702 | font lists used in rxvt. The default will be set-up to chose *any* |
881 | font lists used in urxvt. The default will be set-up to chose *any* |
703 | suitable found found, preferably one or two pixels differing in size |
882 | suitable found found, preferably one or two pixels differing in size |
704 | to the base font. option -imfont. |
883 | to the base font. option -imfont. |
705 | |
884 | |
706 | tripleclickwords: *boolean* |
885 | tripleclickwords: *boolean* |
707 | Change the meaning of triple-click selection with the left mouse |
886 | Change the meaning of triple-click selection with the left mouse |
708 | button. Instead of selecting a full line it will extend the |
887 | button. Instead of selecting a full line it will extend the |
709 | selection to the end of the logical line only. option -tcw. |
888 | selection to the end of the logical line only; option -tcw. |
710 | |
889 | |
711 | insecure: *boolean* |
890 | insecure: *boolean* |
712 | Enables "insecure" mode. Rxvt-unicode offers some escape sequences |
891 | Enables "insecure" mode. Rxvt-unicode offers some escape sequences |
713 | that echo arbitrary strings like the icon name or the locale. This |
892 | that echo arbitrary strings like the icon name or the locale. This |
714 | could be abused if somebody gets 8-bit-clean access to your display, |
893 | could be abused if somebody gets 8-bit-clean access to your display, |
715 | whether throuh a mail client displaying mail bodies unfiltered or |
894 | whether through a mail client displaying mail bodies unfiltered or |
716 | though write(1). Therefore, these sequences are disabled by default. |
895 | through write(1) or any other means. Therefore, these sequences are |
717 | (Note that other terminals, including xterm, have these sequences |
896 | disabled by default. (Note that many other terminals, including |
718 | enabled by default). You can enable them by setting this boolean |
897 | xterm, have these sequences enabled by default, which doesn't make |
719 | resource or specifying -insecure as an option. At the moment, this |
898 | it safer, though). |
720 | enabled display-answer, locale, findfont, icon label and window |
899 | |
721 | title requests as well as dynamic menubar dispatch. |
900 | You can enable them by setting this boolean resource or specifying |
|
|
901 | -insecure as an option. At the moment, this enables display-answer, |
|
|
902 | locale, findfont, icon label and window title requests. |
722 | |
903 | |
723 | modifier: *modifier* |
904 | modifier: *modifier* |
724 | Set the key to be interpreted as the Meta key to: alt, meta, hyper, |
905 | Set the key to be interpreted as the Meta key to: alt, meta, hyper, |
725 | super, mod1, mod2, mod3, mod4, mod5; option -mod. |
906 | super, mod1, mod2, mod3, mod4, mod5; option -mod. |
726 | |
907 | |
727 | answerbackString: *string* |
908 | answerbackString: *string* |
728 | Specify the reply rxvt-unicode sends to the shell when an ENQ |
909 | Specify the reply rxvt-unicode sends to the shell when an ENQ |
729 | (control-E) character is passed through. It may contain escape |
910 | (control-E) character is passed through. It may contain escape |
730 | values as described in the entry on keysym following. |
911 | values as described in the entry on keysym following. |
731 | |
912 | |
732 | secondaryScreen: *bool* |
913 | secondaryScreen: *boolean* |
733 | Turn on/off secondary screen (default enabled). |
914 | Turn on/off secondary screen (default enabled). |
734 | |
915 | |
735 | secondaryScroll: *bool* |
916 | secondaryScroll: *boolean* |
736 | Turn on/off secondary screen scroll (default enabled). If the this |
917 | Turn on/off secondary screen scroll (default enabled). If this |
737 | option is enabled, scrolls on the secondary screen will change the |
918 | option is enabled, scrolls on the secondary screen will change the |
738 | scrollback buffer and switching to/from the secondary screen will |
919 | scrollback buffer and switching to/from the secondary screen will |
739 | instead scroll the screen up. |
920 | instead scroll the screen up. |
|
|
921 | |
|
|
922 | hold: *boolean* |
|
|
923 | Turn on/off hold window after exit support. If enabled, urxvt will |
|
|
924 | not immediately destroy its window when the program executed within |
|
|
925 | it exits. Instead, it will wait till it is being killed or closed by |
|
|
926 | the user. |
740 | |
927 | |
741 | keysym.*sym*: *string* |
928 | keysym.*sym*: *string* |
742 | Compile *frills*: Associate *string* with keysym *sym*. The |
929 | Compile *frills*: Associate *string* with keysym *sym*. The |
743 | intervening resource name keysym. cannot be omitted. |
930 | intervening resource name keysym. cannot be omitted. |
744 | |
931 | |
… | |
… | |
757 | omitting the prefix XK_. Alternatively you can specify *key* by its |
944 | omitting the prefix XK_. Alternatively you can specify *key* by its |
758 | hex keysym value (0x0000 - 0xFFFF). Note that the lookup of *sym*s |
945 | hex keysym value (0x0000 - 0xFFFF). Note that the lookup of *sym*s |
759 | is not performed in an exact manner; however, the closest match is |
946 | is not performed in an exact manner; however, the closest match is |
760 | assured. |
947 | assured. |
761 | |
948 | |
762 | *string* may contain escape values ("\a": bell, "\b": backspace, |
949 | *string* may contain escape values ("\n": newline, "\000": octal |
763 | "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab, |
950 | number), see RESOURCES in "man 7 X" for futher details. |
764 | "\000": octal number) or verbatim control characters ("^?": delete, |
|
|
765 | "^@": null, "^A" ...) and may be enclosed with double quotes so that |
|
|
766 | it can start or end with whitespace. |
|
|
767 | |
|
|
768 | Please note that you need to double the "\" when using |
|
|
769 | "--enable-xgetdefault", as X itself does it's own de-escaping (you |
|
|
770 | can use "\033" instead of "\e" (and so on), which will work with |
|
|
771 | both Xt and rxvt's own processing). |
|
|
772 | |
951 | |
773 | You can define a range of keysyms in one shot by providing a |
952 | You can define a range of keysyms in one shot by providing a |
774 | *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter |
953 | *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimiter |
775 | `/' should be a character not used by the strings. |
954 | `/' should be a character not used by the strings. |
776 | |
955 | |
777 | Its usage can be demonstrated by an example: |
956 | Its usage can be demonstrated by an example: |
778 | |
957 | |
779 | URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> |
958 | URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> |
… | |
… | |
783 | URxvt.keysym.Meta-Control-0x61: \033<M-C-a> |
962 | URxvt.keysym.Meta-Control-0x61: \033<M-C-a> |
784 | URxvt.keysym.Meta-Control-0x62: \033<M-C-b> |
963 | URxvt.keysym.Meta-Control-0x62: \033<M-C-b> |
785 | URxvt.keysym.Meta-Control-0x63: \033<M-C-c> |
964 | URxvt.keysym.Meta-Control-0x63: \033<M-C-c> |
786 | |
965 | |
787 | If *string* takes the form of "command:STRING", the specified STRING |
966 | If *string* takes the form of "command:STRING", the specified STRING |
788 | is interpreted and executed as rxvt's control sequence. For example |
967 | is interpreted and executed as urxvt's control sequence. For example |
789 | the following means "change the current locale to "zh_CN.GBK" when |
968 | the following means "change the current locale to "zh_CN.GBK" when |
790 | Control-Meta-c is being pressed": |
969 | Control-Meta-c is being pressed": |
791 | |
970 | |
792 | URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 |
971 | URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 |
|
|
972 | |
|
|
973 | If *string* takes the form "perl:STRING", then the specified STRING |
|
|
974 | is passed to the "on_keyboard_command" perl handler. See the |
|
|
975 | urxvtperl(3) manpage. For example, the selection extension |
|
|
976 | (activated via "urxvt -pe selection") listens for "selection:rot13" |
|
|
977 | events: |
|
|
978 | |
|
|
979 | URxvt.keysym.M-C-c: perl:selection:rot13 |
|
|
980 | |
|
|
981 | Due the the large number of modifier combinations, a defined key |
|
|
982 | mapping will match if at *at least* the specified identifiers are |
|
|
983 | being set, and no other key mappings with those and more bits are |
|
|
984 | being defined. That means that defining a key map for "a" will |
|
|
985 | automatically provide definitions for "Meta-a", "Shift-a" and so on, |
|
|
986 | unless some of those are defined mappings themselves. |
|
|
987 | |
|
|
988 | Unfortunately, this will override built-in key mappings. For example |
|
|
989 | if you overwrite the "Insert" key you will disable urxvt's |
|
|
990 | "Shift-Insert" mapping. To re-enable that, you can poke "holes" into |
|
|
991 | the user-defined keymap using the "builtin:" replacement: |
|
|
992 | |
|
|
993 | URxvt.keysym.Insert: <my insert key sequence> |
|
|
994 | URxvt.keysym.S-Insert: builtin: |
|
|
995 | |
|
|
996 | The first line defines a mapping for "Insert" and *any* combination |
|
|
997 | of modifiers. The second line re-establishes the default mapping for |
|
|
998 | "Shift-Insert". |
793 | |
999 | |
794 | The following example will map Control-Meta-1 and Control-Meta-2 to |
1000 | The following example will map Control-Meta-1 and Control-Meta-2 to |
795 | the fonts "suxuseuro" and "9x15bold", so you can have some limited |
1001 | the fonts "suxuseuro" and "9x15bold", so you can have some limited |
796 | font-switching at runtime: |
1002 | font-switching at runtime: |
797 | |
1003 | |
798 | URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 |
1004 | URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 |
799 | URxvt.keysym.M-C-2: command:\033]50;9x15bold\007 |
1005 | URxvt.keysym.M-C-2: command:\033]50;9x15bold\007 |
800 | |
1006 | |
801 | Other things are possible, e.g. resizing (see rxvt(7) for more |
1007 | Other things are possible, e.g. resizing (see urxvt(7) for more |
802 | info): |
1008 | info): |
803 | |
1009 | |
804 | URxvt.keysym.M-C-3: command:\033[8;25;80t |
1010 | URxvt.keysym.M-C-3: command:\033[8;25;80t |
805 | URxvt.keysym.M-C-4: command:\033[8;48;110t |
1011 | URxvt.keysym.M-C-4: command:\033[8;48;110t |
806 | |
1012 | |
|
|
1013 | perl-ext-common: *string* |
|
|
1014 | perl-ext: *string* |
|
|
1015 | Comma-separated list(s) of perl extension scripts (default: |
|
|
1016 | "default") to use in this terminal instance; option -pe. |
|
|
1017 | |
|
|
1018 | Extension names can be prefixed with a "-" sign to prohibit using |
|
|
1019 | them. This can be useful to selectively disable some extensions |
|
|
1020 | loaded by default, or specified via the "perl-ext-common" resource. |
|
|
1021 | For example, "default,-selection" will use all the default extension |
|
|
1022 | except "selection". |
|
|
1023 | |
|
|
1024 | Extension names can also be followed by an argument in angle |
|
|
1025 | brackets (e.g. "searchable-scrollback<M-s>", which binds the hotkey |
|
|
1026 | for searchable scrollback to Alt/Meta-s). Mentioning the same |
|
|
1027 | extension multiple times with different arguments will pass multiple |
|
|
1028 | arguments to the extension. |
|
|
1029 | |
|
|
1030 | Each extension is looked up in the library directories, loaded if |
|
|
1031 | necessary, and bound to the current terminal instance. |
|
|
1032 | |
|
|
1033 | If both of these resources are the empty string, then the perl |
|
|
1034 | interpreter will not be initialized. The idea behind two options is |
|
|
1035 | that perl-ext-common will be used for extensions that should be |
|
|
1036 | available to all instances, while perl-ext is used for specific |
|
|
1037 | instances. |
|
|
1038 | |
|
|
1039 | perl-eval: *string* |
|
|
1040 | Perl code to be evaluated when all extensions have been registered. |
|
|
1041 | See the urxvtperl(3) manpage. Due to security reasons, this resource |
|
|
1042 | will be ignored when running setuid/setgid. |
|
|
1043 | |
|
|
1044 | perl-lib: *path* |
|
|
1045 | Colon-separated list of additional directories that hold extension |
|
|
1046 | scripts. When looking for extensions specified by the "perl" |
|
|
1047 | resource, urxvt will first look in these directories and then in |
|
|
1048 | /usr/local/lib/urxvt/perl/. Due to security reasons, this resource |
|
|
1049 | will be ignored when running setuid/setgid. |
|
|
1050 | |
|
|
1051 | See the urxvtperl(3) manpage. |
|
|
1052 | |
|
|
1053 | selection.pattern-*idx*: *perl-regex* |
|
|
1054 | Additional selection patterns, see the urxvtperl(3) manpage for |
|
|
1055 | details. |
|
|
1056 | |
|
|
1057 | selection-autotransform.*idx*: *perl-transform* |
|
|
1058 | Selection auto-transform patterns, see the urxvtperl(3) manpage for |
|
|
1059 | details. |
|
|
1060 | |
|
|
1061 | searchable-scrollback: *keysym* |
|
|
1062 | Sets the hotkey that starts the incremental scrollback buffer search |
|
|
1063 | (default: "M-s"). |
|
|
1064 | |
|
|
1065 | urlLauncher: *string* |
|
|
1066 | Specifies the program to be started with a URL argument. Used by the |
|
|
1067 | "selection-popup" and "matcher" perl extensions. |
|
|
1068 | |
|
|
1069 | transient-for: *windowid* |
|
|
1070 | Compile *frills*: Sets the WM_TRANSIENT_FOR property to the given |
|
|
1071 | window id. |
|
|
1072 | |
|
|
1073 | override-redirect: *boolean* |
|
|
1074 | Compile *frills*: Sets override-redirect for the terminal window, |
|
|
1075 | making it almost invisible to window managers; option |
|
|
1076 | -override-redirect. |
|
|
1077 | |
|
|
1078 | iso14755_52: *boolean* |
|
|
1079 | Turn on/off ISO 14755 5.2 mode (default enabled). |
|
|
1080 | |
807 | THE SCROLLBAR |
1081 | THE SCROLLBAR |
808 | Lines of text that scroll off the top of the rxvt window (resource: |
1082 | Lines of text that scroll off the top of the urxvt window (resource: |
809 | saveLines) and can be scrolled back using the scrollbar or by |
1083 | saveLines) and can be scrolled back using the scrollbar or by |
810 | keystrokes. The normal rxvt scrollbar has arrows and its behaviour is |
1084 | keystrokes. The normal urxvt scrollbar has arrows and its behaviour is |
811 | fairly intuitive. The xterm-scrollbar is without arrows and its |
1085 | fairly intuitive. The xterm-scrollbar is without arrows and its |
812 | behaviour mimics that of *xterm* |
1086 | behaviour mimics that of *xterm* |
813 | |
1087 | |
814 | Scroll down with Button1 (xterm-scrollbar) or Shift-Next. Scroll up with |
1088 | Scroll down with Button1 (xterm-scrollbar) or Shift-Next. Scroll up with |
815 | Button3 (xterm-scrollbar) or Shift-Prior. Continuous scroll with |
1089 | Button3 (xterm-scrollbar) or Shift-Prior. Continuous scroll with |
… | |
… | |
824 | disabled -- on the assumption that we are using a fullscreen |
1098 | disabled -- on the assumption that we are using a fullscreen |
825 | application. Instead, pressing Button1 and Button3 sends ESC [ 6 ~ |
1099 | application. Instead, pressing Button1 and Button3 sends ESC [ 6 ~ |
826 | (Next) and ESC [ 5 ~ (Prior), respectively. Similarly, clicking on the |
1100 | (Next) and ESC [ 5 ~ (Prior), respectively. Similarly, clicking on the |
827 | up and down arrows sends ESC [ A (Up) and ESC [ B (Down), respectively. |
1101 | up and down arrows sends ESC [ A (Up) and ESC [ B (Down), respectively. |
828 | |
1102 | |
829 | TEXT SELECTION AND INSERTION |
1103 | THE SELECTION: SELECTING AND PASTING TEXT |
830 | The behaviour of text selection and insertion mechanism is similar to |
1104 | The behaviour of text selection and insertion/pasting mechanism is |
831 | *xterm*(1). |
1105 | similar to *xterm*(1). |
832 | |
1106 | |
833 | Selection: |
1107 | Selecting: |
834 | Left click at the beginning of the region, drag to the end of the |
1108 | Left click at the beginning of the region, drag to the end of the |
835 | region and release; Right click to extend the marked region; Left |
1109 | region and release; Right click to extend the marked region; Left |
836 | double-click to select a word; Left triple-click to select the |
1110 | double-click to select a word; Left triple-click to select the |
837 | entire logical line (which can span multiple screen lines), unless |
1111 | entire logical line (which can span multiple screen lines), unless |
838 | modified by resource tripleclickwords. |
1112 | modified by resource tripleclickwords. |
839 | |
1113 | |
840 | Starting a selection while pressing the Meta key (or Meta+Ctrl keys) |
1114 | Starting a selection while pressing the Meta key (or Meta+Ctrl keys) |
841 | (Compile: *frills*) will create a rectangular selection instead of a |
1115 | (Compile: *frills*) will create a rectangular selection instead of a |
842 | normal one. |
1116 | normal one. In this mode, every selected row becomes its own line in |
|
|
1117 | the selection, and trailing whitespace is visually underlined and |
|
|
1118 | removed from the selection. |
843 | |
1119 | |
844 | Insertion: |
1120 | Pasting: |
845 | Pressing and releasing the Middle mouse button (or Shift-Insert) in |
1121 | Pressing and releasing the Middle mouse button in an urxvt window |
846 | an rxvt window causes the current text selection to be inserted as |
1122 | causes the value of the PRIMARY selection (or CLIPBOARD with the |
847 | if it had been typed on the keyboard. |
1123 | Meta modifier) to be inserted as if it had been typed on the |
|
|
1124 | keyboard. |
|
|
1125 | |
|
|
1126 | Pressing Shift-Insert causes the value of the PRIMARY selection to |
|
|
1127 | be inserted too. |
848 | |
1128 | |
849 | CHANGING FONTS |
1129 | CHANGING FONTS |
850 | Changing fonts (or font sizes, respectively) via the keypad is not yet |
1130 | Changing fonts (or font sizes, respectively) via the keypad is not yet |
851 | supported in rxvt-unicode. Bug me if you need this. |
1131 | supported in rxvt-unicode. Bug me if you need this. |
852 | |
1132 | |
853 | You can, however, switch fonts at runtime using escape sequences (and |
1133 | You can, however, switch fonts at runtime using escape sequences, e.g.: |
854 | therefore using the menubar), e.g.: |
|
|
855 | |
1134 | |
856 | printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic" |
1135 | printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic" |
|
|
1136 | |
|
|
1137 | You can use keyboard shortcuts, too: |
|
|
1138 | |
|
|
1139 | URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007 |
|
|
1140 | URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007 |
857 | |
1141 | |
858 | rxvt-unicode will automatically re-apply these fonts to the output so |
1142 | rxvt-unicode will automatically re-apply these fonts to the output so |
859 | far. |
1143 | far. |
860 | |
1144 | |
861 | ISO 14755 SUPPORT |
1145 | ISO 14755 SUPPORT |
862 | ISO 14755 is a standard for entering and viewing unicode characters and |
1146 | ISO 14755 is a standard for entering and viewing unicode characters and |
863 | character codes using the keyboard. It consists of 4 parts. The first |
1147 | character codes using the keyboard. It consists of 4 parts. The first |
864 | part is available rxvt-unicode has been compiled with "--enable-frills", |
1148 | part is available if rxvt-unicode has been compiled with |
865 | the rest is available when rxvt-unicode was compiled with |
1149 | "--enable-frills", the rest is available when rxvt-unicode was compiled |
866 | "--enable-iso14755". |
1150 | with "--enable-iso14755". |
867 | |
1151 | |
868 | * 5.1: Basic method |
1152 | * 5.1: Basic method |
869 | This allows you to enter unicode characters using their hexcode. |
1153 | This allows you to enter unicode characters using their hexcode. |
870 | |
1154 | |
871 | Start by pressing and holding both "Control" and "Shift", then enter |
1155 | Start by pressing and holding both "Control" and "Shift", then enter |
… | |
… | |
885 | This mode lets you input characters representing the keycap symbols |
1169 | This mode lets you input characters representing the keycap symbols |
886 | of your keyboard, if representable in the current locale encoding. |
1170 | of your keyboard, if representable in the current locale encoding. |
887 | |
1171 | |
888 | Start by pressing "Control" and "Shift" together, then releasing |
1172 | Start by pressing "Control" and "Shift" together, then releasing |
889 | them. The next special key (cursor keys, home etc.) you enter will |
1173 | them. The next special key (cursor keys, home etc.) you enter will |
890 | not invoke it's usual function but instead will insert the |
1174 | not invoke its usual function but instead will insert the |
891 | corresponding keycap symbol. The symbol will only be entered when |
1175 | corresponding keycap symbol. The symbol will only be entered when |
892 | the key has been released, otherwise pressing e.g. "Shift" would |
1176 | the key has been released, otherwise pressing e.g. "Shift" would |
893 | enter the symbol for "ISO Level 2 Switch", although your intention |
1177 | enter the symbol for "ISO Level 2 Switch", although your intention |
894 | might have been to enter a reverse tab (Shift-Tab). |
1178 | might have been to enter a reverse tab (Shift-Tab). |
895 | |
1179 | |
… | |
… | |
916 | |
1200 | |
917 | With respect to conformance, rxvt-unicode is supposed to be compliant to |
1201 | With respect to conformance, rxvt-unicode is supposed to be compliant to |
918 | both scenario A and B of ISO 14755, including part 5.2. |
1202 | both scenario A and B of ISO 14755, including part 5.2. |
919 | |
1203 | |
920 | LOGIN STAMP |
1204 | LOGIN STAMP |
921 | rxvt tries to write an entry into the *utmp*(5) file so that it can be |
1205 | urxvt tries to write an entry into the *utmp*(5) file so that it can be |
922 | seen via the *who(1)* command, and can accept messages. To allow this |
1206 | seen via the *who(1)* command, and can accept messages. To allow this |
923 | feature, rxvt may need to be installed setuid root on some systems or |
1207 | feature, urxvt may need to be installed setuid root on some systems or |
924 | setgid to root or to some other group on others. |
1208 | setgid to root or to some other group on others. |
925 | |
1209 | |
926 | COLORS AND GRAPHICS |
1210 | COLORS AND GRAPHICS |
927 | In addition to the default foreground and background colours, rxvt can |
1211 | In addition to the default foreground and background colours, urxvt can |
928 | display up to 16 colours (8 ANSI colours plus high-intensity bold/blink |
1212 | display up to 16 colours (8 ANSI colours plus high-intensity bold/blink |
929 | versions of the same). Here is a list of the colours with their rgb.txt |
1213 | versions of the same). Here is a list of the colours with their names. |
930 | names. |
|
|
931 | |
1214 | |
932 | color0 (black) = Black |
1215 | color0 (black) = Black |
933 | color1 (red) = Red3 |
1216 | color1 (red) = Red3 |
934 | color2 (green) = Green3 |
1217 | color2 (green) = Green3 |
935 | color3 (yellow) = Yellow3 |
1218 | color3 (yellow) = Yellow3 |
… | |
… | |
951 | It is also possible to specify the colour values of foreground, |
1234 | It is also possible to specify the colour values of foreground, |
952 | background, cursorColor, cursorColor2, colorBD, colorUL as a number |
1235 | background, cursorColor, cursorColor2, colorBD, colorUL as a number |
953 | 0-15, as a convenient shorthand to reference the colour name of |
1236 | 0-15, as a convenient shorthand to reference the colour name of |
954 | color0-color15. |
1237 | color0-color15. |
955 | |
1238 | |
|
|
1239 | In addition to the colours defined above, urxvt offers an additional 72 |
|
|
1240 | colours. The first 64 of those (with indices 16 to 79) consist of a |
|
|
1241 | 4*4*4 RGB colour cube (i.e. *index = r * 16 + g * 4 + b + 16*), followed |
|
|
1242 | by 8 additional shades of gray (with indices 80 to 87). |
|
|
1243 | |
|
|
1244 | Together, all those colours implement the 88 colour xterm colours. Only |
|
|
1245 | the first 16 can be changed using resources currently, the rest can only |
|
|
1246 | be changed via command sequences ("escape codes"). |
|
|
1247 | |
956 | Note that -rv ("reverseVideo: True") simulates reverse video by always |
1248 | Note that -rv ("reverseVideo: True") simulates reverse video by always |
957 | swapping the foreground/background colours. This is in contrast to |
1249 | swapping the foreground/background colours. This is in contrast to |
958 | *xterm*(1) where the colours are only swapped if they have not otherwise |
1250 | *xterm*(1) where the colours are only swapped if they have not otherwise |
959 | been specified. For example, |
1251 | been specified. For example, |
960 | |
1252 | |
961 | rxvt -fg Black -bg White -rv |
1253 | urxvt -fg Black -bg White -rv |
962 | would yield White on Black, while on *xterm*(1) it would yield Black |
1254 | would yield White on Black, while on *xterm*(1) it would yield Black |
963 | on White. |
1255 | on White. |
964 | |
1256 | |
|
|
1257 | ALPHA CHANNEL SUPPORT |
|
|
1258 | If Xft support has been compiled in and as long as Xft/Xrender/X don't |
|
|
1259 | get their act together, rxvt-unicode will support |
|
|
1260 | "rgba:rrrr/gggg/bbbb/aaaa" (recommended, but MUST have 4 |
|
|
1261 | digits/component) colour specifications, in addition to the ones |
|
|
1262 | provided by X, where the additional A component specifies opacity |
|
|
1263 | (alpha) values. The minimum value of 0 is completely transparent). You |
|
|
1264 | can also prefix any color with "[percent]", where "percent" is a decimal |
|
|
1265 | percentage (0-100) that specifies the opacity of the color, where 0 is |
|
|
1266 | completely transparent and 100 is completelxy opaque. |
|
|
1267 | |
|
|
1268 | You probably need to specify "-depth 32", too, and have the luck that |
|
|
1269 | your X-server uses ARGB pixel layout, as X is far from just supporting |
|
|
1270 | ARGB visuals out of the box, and rxvt-unicode just fudges around. |
|
|
1271 | |
|
|
1272 | For example, the following selects an almost completely transparent red |
|
|
1273 | background, and an almost opaque pink foreground: |
|
|
1274 | |
|
|
1275 | urxvt -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink" |
|
|
1276 | |
|
|
1277 | *Please note that transparency of any kind if completely unsupported by |
|
|
1278 | the author. Don't bug him with installation questions!* |
|
|
1279 | |
965 | ENVIRONMENT |
1280 | ENVIRONMENT |
966 | rxvt sets and/or uses the following environment variables: |
1281 | urxvt sets and/or uses the following environment variables: |
967 | |
1282 | |
968 | TERM |
1283 | TERM |
969 | Normally set to "rxvt-unicode", unless overwritten at configure |
1284 | Normally set to "rxvt-unicode", unless overwritten at configure |
970 | time, via resources or on the commandline. |
1285 | time, via resources or on the command line. |
971 | |
1286 | |
972 | COLORTERM |
1287 | COLORTERM |
973 | Either "rxvt", "rxvt-xpm", depending on wether rxvt was compiled |
1288 | Either "rxvt", "rxvt-xpm", depending on whether urxvt was compiled |
974 | with XPM support, and optionally with the added extension "-mono" to |
1289 | with background image support, and optionally with the added |
975 | indicate that rxvt-unicode runs on a monochrome screen. |
1290 | extension "-mono" to indicate that rxvt-unicode runs on a monochrome |
|
|
1291 | screen. |
976 | |
1292 | |
977 | COLORFGBG |
1293 | COLORFGBG |
978 | Set to a string of the form "fg;bg" or "fg;xpm;bg", where "fg" is |
1294 | Set to a string of the form "fg;bg" or "fg;xpm;bg", where "fg" is |
979 | the colour code used as default foreground/text colour (or the |
1295 | the colour code used as default foreground/text colour (or the |
980 | string "default" to indicate that the default-colour escape sequence |
1296 | string "default" to indicate that the default-colour escape sequence |
981 | is to be used), "bg" is the colour code used as default background |
1297 | is to be used), "bg" is the colour code used as default background |
982 | colour (or the string "default"), and "xpm" is the string "default" |
1298 | colour (or the string "default"), and "xpm" is the string "default" |
983 | if rxvt was compiled with XPM support. Libraries like "ncurses" and |
1299 | if urxvt was compiled with background image support. Libraries like |
984 | "slang" can (and do) use this information to optimize screen output. |
1300 | "ncurses" and "slang" can (and do) use this information to optimize |
|
|
1301 | screen output. |
985 | |
1302 | |
986 | WINDOWID |
1303 | WINDOWID |
987 | Set to the (decimal) X Window ID of the rxvt window (the toplevel |
1304 | Set to the (decimal) X Window ID of the urxvt window (the toplevel |
988 | window, which usually has subwindows for the scrollbar, the terminal |
1305 | window, which usually has subwindows for the scrollbar, the terminal |
989 | window and so on). |
1306 | window and so on). |
990 | |
1307 | |
991 | TERMINFO |
1308 | TERMINFO |
992 | Set to the terminfo directory iff rxvt was configured with |
1309 | Set to the terminfo directory iff urxvt was configured with |
993 | "--with-terminfo=PATH". |
1310 | "--with-terminfo=PATH". |
994 | |
1311 | |
995 | DISPLAY |
1312 | DISPLAY |
996 | Used by rxvt to connect to the display and set to the correct |
1313 | Used by urxvt to connect to the display and set to the correct |
997 | display in it's child processes. |
1314 | display in its child processes. |
998 | |
1315 | |
999 | SHELL |
1316 | SHELL |
1000 | 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". |
1001 | |
1318 | |
1002 | RXVTPATH |
|
|
1003 | The path where rxvt looks for support files such as menu and xpm |
|
|
1004 | files. |
|
|
1005 | |
|
|
1006 | PATH |
|
|
1007 | Used in the same way as "RXVTPATH". |
|
|
1008 | |
|
|
1009 | RXVT_SOCKET |
1319 | RXVT_SOCKET |
1010 | The unix domain socket path used by rxvtc(1) and rxvtd(1). |
1320 | The unix domain socket path used by urxvtc(1) and urxvtd(1). |
1011 | |
1321 | |
1012 | Default "$HOME/.rxvt-unicode-<nodename". |
1322 | Default $HOME/.rxvt-unicode-*<nodename*. |
1013 | |
1323 | |
1014 | HOME |
1324 | HOME |
1015 | Used to locate the default directory for the unix domain socket for |
1325 | Used to locate the default directory for the unix domain socket for |
1016 | daemon communications and to locate various resource files (such as |
1326 | daemon communications and to locate various resource files (such as |
1017 | ".Xdefaults") |
1327 | ".Xdefaults") |
… | |
… | |
1019 | XAPPLRESDIR |
1329 | XAPPLRESDIR |
1020 | Directory where various X resource files are being located. |
1330 | Directory where various X resource files are being located. |
1021 | |
1331 | |
1022 | XENVIRONMENT |
1332 | XENVIRONMENT |
1023 | If set and accessible, gives the name of a X resource file to be |
1333 | If set and accessible, gives the name of a X resource file to be |
1024 | loaded by rxvt. |
1334 | loaded by urxvt. |
1025 | |
1335 | |
1026 | FILES |
1336 | FILES |
1027 | /usr/lib/X11/rgb.txt |
1337 | /usr/lib/X11/rgb.txt |
1028 | Color names. |
1338 | Color names. |
1029 | |
1339 | |
1030 | SEE ALSO |
1340 | SEE ALSO |
1031 | rxvt(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) |
1341 | urxvt(7), urxvtc(1), urxvtd(1), xterm(1), sh(1), resize(1), X(1), |
1032 | |
1342 | pty(4), tty(4), utmp(5) |
1033 | BUGS |
|
|
1034 | Check the BUGS file for an up-to-date list. |
|
|
1035 | |
|
|
1036 | Cursor change support is not yet implemented. |
|
|
1037 | |
|
|
1038 | Click-and-drag doesn't work with X11 mouse report overriding. |
|
|
1039 | |
1343 | |
1040 | CURRENT PROJECT COORDINATOR |
1344 | CURRENT PROJECT COORDINATOR |
1041 | Project Coordinator |
1345 | Project Coordinator |
1042 | Marc A. Lehmann <rxvt-unicode@schmorp.de> |
1346 | Marc A. Lehmann <rxvt-unicode@schmorp.de> |
1043 | |
1347 | |
1044 | <http://software.schmorp.de/#rxvt-unicode> |
1348 | <http://software.schmorp.de/pkg/rxvt-unicode.html> |
1045 | |
1349 | |
1046 | AUTHORS |
1350 | AUTHORS |
1047 | John Bovey |
1351 | John Bovey |
1048 | University of Kent, 1992, wrote the original Xvt. |
1352 | University of Kent, 1992, wrote the original Xvt. |
1049 | |
1353 | |
… | |
… | |
1060 | |
1364 | |
1061 | Oezguer Kesim <kesim@math.fu-berlin.de> |
1365 | Oezguer Kesim <kesim@math.fu-berlin.de> |
1062 | Project Coordinator (changes.txt 2.21a to 2.4.5) |
1366 | Project Coordinator (changes.txt 2.21a to 2.4.5) |
1063 | |
1367 | |
1064 | Geoff Wing <gcw@pobox.com> |
1368 | Geoff Wing <gcw@pobox.com> |
1065 | Rewrote screen display and text selection routines. Project |
1369 | Rewrote screen display and text selection routines. |
|
|
1370 | |
1066 | Coordinator (changes.txt 2.4.6 - rxvt-unicode) |
1371 | Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) |
1067 | |
1372 | |
1068 | Marc Alexander Lehmann <rxvt-unicode@schmorp.de> |
1373 | Marc Alexander Lehmann <rxvt-unicode@schmorp.de> |
1069 | Forked rxvt-unicode, rewrote most of the display code and internal |
1374 | Forked rxvt-unicode, unicode support, rewrote almost all the code, |
1070 | character handling to store text in unicode, improve xterm |
1375 | perl extension, random hacks, numerous bugfixes and extensions. |
1071 | compatibility and apply numerous other bugfixes and extensions. |
|
|
1072 | |
1376 | |
1073 | Project Coordinator (Changes 1.0 -) |
1377 | Project Coordinator (Changes 1.0 -) |
1074 | |
1378 | |
|
|
1379 | Emanuele Giaquinta <e.giaquinta@glauco.it> |
|
|
1380 | Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing. |
|
|
1381 | |