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 4.8, is a colour vt102 terminal emulator intended |
9 | rxvt-unicode, version 7.0, 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. |
17 | questions and answer to them and some common problems. That document is |
|
|
18 | also accessible on the World-Wide-Web at |
|
|
19 | <http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>. |
18 | |
20 | |
19 | RXVT-UNICODE VS. RXVT |
21 | RXVT-UNICODE VS. RXVT |
20 | Unlike the original rxvt, rxvt-unicode stores all text in Unicode |
22 | Unlike the original rxvt, rxvt-unicode stores all text in Unicode |
21 | 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 |
22 | world. Being a terminal emulator, however, some things are very |
24 | world. Being a terminal emulator, however, some things are very |
… | |
… | |
50 | 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 |
51 | 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 |
52 | without most of it's features to get a lean binary. It also comes with a |
54 | without most of it's features to get a lean binary. It also comes with a |
53 | 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 |
54 | 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 |
55 | drastically reduces memory usage. See rxvtd(1) (daemon) and rxvtc(1) |
57 | drastically reduces memory usage. See urxvtd(1) (daemon) and urxvtc(1) |
56 | (client). |
58 | (client). |
57 | |
59 | |
58 | It also makes technical information about escape sequences (which have |
60 | It also makes technical information about escape sequences (which have |
59 | been extended) easier accessible: see rxvt(7) for technical reference |
61 | been extended) easier accessible: see urxvt(7) for technical reference |
60 | documentation (escape sequences etc.). |
62 | documentation (escape sequences etc.). |
61 | |
63 | |
62 | OPTIONS |
64 | OPTIONS |
63 | 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 |
64 | keeping with the smaller-is-better philosophy, options may be eliminated |
66 | keeping with the smaller-is-better philosophy, options may be eliminated |
65 | 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 |
66 | may not accurately reflect the version installed on your system. `rxvt |
68 | may not accurately reflect the version installed on your system. `urxvt |
67 | -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. |
68 | Option descriptions may be prefixed with which compile option each is |
70 | Option descriptions may be prefixed with which compile option each is |
69 | dependent upon. e.g. `Compile *XIM*:' requires *XIM* on the *Options* |
71 | dependent upon. e.g. `Compile *XIM*:' requires *XIM* on the *Options* |
70 | 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 |
71 | compiled into your version. |
73 | compiled into your version. |
72 | |
74 | |
73 | 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 |
74 | (--/++ option) so the potential command-line options are far greater |
76 | (--/++ option) so the potential command-line options are far greater |
75 | than those listed. For example: `rxvt --loginShell --color1 Orange'. |
77 | than those listed. For example: `urxvt --loginShell --color1 Orange'. |
76 | |
78 | |
77 | The following options are available: |
79 | The following options are available: |
78 | |
80 | |
79 | -help, --help |
81 | -help, --help |
80 | Print out a message describing available options. |
82 | Print out a message describing available options. |
… | |
… | |
91 | Turn on/off simulated reverse video; resource reverseVideo. |
93 | Turn on/off simulated reverse video; resource reverseVideo. |
92 | |
94 | |
93 | -j|+j |
95 | -j|+j |
94 | Turn on/off jump scrolling; resource jumpScroll. |
96 | Turn on/off jump scrolling; resource jumpScroll. |
95 | |
97 | |
96 | -ip|+ip |
98 | -ip|+ip | -tr|+tr |
97 | Turn on/off inheriting parent window's pixmap. Alternative form is |
99 | Turn on/off inheriting parent window's pixmap. Alternative form is |
98 | -tr; resource inheritPixmap. |
100 | -tr; resource inheritPixmap. |
99 | |
101 | |
100 | -fade *number* |
102 | -fade *number* |
101 | Fade the text by the given percentage when focus is lost. resource |
103 | Fade the text by the given percentage when focus is lost. Small |
102 | fading. |
104 | values fade a little only, 100 completely replaces all colours by |
|
|
105 | the fade colour; resource fading. |
|
|
106 | |
|
|
107 | -fadecolor *colour* |
|
|
108 | Fade to this colour when fading is used (see -fade). The default |
|
|
109 | colour is black. resource fadeColor. |
103 | |
110 | |
104 | -tint *colour* |
111 | -tint *colour* |
105 | Tint the transparent background pixmap with the given colour when |
112 | Tint the transparent background pixmap with the given colour when |
106 | transparency is enabled with -tr or -ip. See also the -sh option |
113 | transparency is enabled with -tr or -ip. This only works for |
|
|
114 | non-tiled backgrounds, currently. See also the -sh option that can |
107 | that can be used to brighten or darken the image in addition to |
115 | be used to brighten or darken the image in addition to tinting it; |
108 | tinting it. |
116 | resource *tintColor*. Example: |
|
|
117 | |
|
|
118 | urxvt -tr -tint blue -sh 40 |
109 | |
119 | |
110 | -sh *number* Darken (0 .. 100) or lighten (-1 .. -100) the transparent |
120 | -sh *number* Darken (0 .. 100) or lighten (-1 .. -100) the transparent |
111 | background image in addition to tinting it (i.e. -tint must be |
121 | background image in addition to tinting it (i.e. -tint must be |
112 | specified, too, e.g. "-tint white"). |
122 | specified, too, e.g. "-tint white"). |
113 | |
123 | |
… | |
… | |
136 | The colour of the border around the text area and between the |
146 | The colour of the border around the text area and between the |
137 | scrollbar and the text; resource borderColor. |
147 | scrollbar and the text; resource borderColor. |
138 | |
148 | |
139 | -fn *fontlist* |
149 | -fn *fontlist* |
140 | Select the fonts to be used. This is a comma separated list of font |
150 | Select the fonts to be used. This is a comma separated list of font |
141 | names that are used in turn when trying to display Unicode |
151 | names that are checked in order when trying to find glyphs for |
142 | characters. The first font defines the cell size for characters; |
152 | characters. The first font defines the cell size for characters; |
143 | other fonts might be smaller, but not (in general) larger. A |
153 | other fonts might be smaller, but not (in general) larger. A |
144 | (hopefully) reasonable default font list is always appended to it. |
154 | (hopefully) reasonable default font list is always appended to it. |
145 | See resource font for more details. |
155 | See resource font for more details. |
146 | |
156 | |
147 | In short, to specify an X11 core font, just specify it's name or |
157 | In short, to specify an X11 core font, just specify it's name or |
148 | prefix it with "x:". To specify an XFT-font, you need to prefix it |
158 | prefix it with "x:". To specify an XFT-font, you need to prefix it |
149 | with "xft:", e.g.: |
159 | with "xft:", e.g.: |
150 | |
160 | |
151 | rxvt -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" |
161 | urxvt -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" |
152 | rxvt -fn "9x15bold,xft:Bitstream Vera Sans Mono" |
162 | urxvt -fn "9x15bold,xft:Bitstream Vera Sans Mono" |
153 | |
163 | |
154 | See also the question "How does rxvt-unicode choose fonts?" in the |
164 | See also the question "How does rxvt-unicode choose fonts?" in the |
155 | FAQ section of rxvt(7). |
165 | FAQ section of urxvt(7). |
156 | |
166 | |
157 | -fb *fontlist* |
167 | -fb *fontlist* |
158 | Compile font-styles: The bold font list to use when bold characters |
168 | Compile *font-styles*: The bold font list to use when bold |
159 | are to be printed. See resource boldFont for details. |
169 | characters are to be printed. See resource boldFont for details. |
160 | |
170 | |
161 | -fi *fontlist* |
171 | -fi *fontlist* |
162 | Compile font-styles: The italic font list to use when bold |
172 | Compile *font-styles*: The italic font list to use when *italic* |
163 | characters are to be printed. See resource italicFont for details. |
173 | characters are to be printed. See resource italicFont for details. |
164 | |
174 | |
165 | -fbi *fontlist* |
175 | -fbi *fontlist* |
166 | Compile font-styles: The bold italic font list to use when bold |
176 | Compile *font-styles*: The bold italic font list to use when *bold |
167 | characters are to be printed. See resource boldItalicFont for |
177 | italic* characters are to be printed. See resource boldItalicFont |
|
|
178 | for details. |
|
|
179 | |
|
|
180 | -is|+is |
|
|
181 | Compile *font-styles*: Bold/Italic font styles imply high intensity |
|
|
182 | foreground/background (default). See resource intensityStyles for |
168 | details. |
183 | details. |
169 | |
184 | |
170 | -name *name* |
185 | -name *name* |
171 | Specify the application name under which resources are to be |
186 | Specify the application name under which resources are to be |
172 | obtained, rather than the default executable file name. Name should |
187 | obtained, rather than the default executable file name. Name should |
… | |
… | |
202 | |
217 | |
203 | -sr|+sr |
218 | -sr|+sr |
204 | Put scrollbar on right/left; resource scrollBar_right. |
219 | Put scrollbar on right/left; resource scrollBar_right. |
205 | |
220 | |
206 | -st|+st |
221 | -st|+st |
207 | Display normal (non XTerm/NeXT) scrollbar without/with a trough; |
222 | Display rxvt (non XTerm/NeXT) scrollbar without/with a trough; |
208 | resource scrollBar_floating. |
223 | resource scrollBar_floating. |
209 | |
224 | |
210 | -ptab|+ptab |
225 | -ptab|+ptab |
211 | If enabled (default), "Horizontal Tab" characters are being stored |
226 | If enabled (default), "Horizontal Tab" characters are being stored |
212 | as actual wide characters in the screen buffer, which makes it |
227 | as actual wide characters in the screen buffer, which makes it |
… | |
… | |
237 | |
252 | |
238 | -bl Compile *frills*: Set MWM hints to request a borderless window, i.e. |
253 | -bl Compile *frills*: Set MWM hints to request a borderless window, i.e. |
239 | if honoured by the WM, the rxvt-unicode window will not have window |
254 | if honoured by the WM, the rxvt-unicode window will not have window |
240 | decorations; resource borderLess. |
255 | decorations; resource borderLess. |
241 | |
256 | |
|
|
257 | -sbg |
|
|
258 | Compile *frills*: Disable the usage of the built-in block |
|
|
259 | graphics/line drawing characters and just rely on what the specified |
|
|
260 | fonts provide. Use this if you have a good font and want to use its |
|
|
261 | block graphic glyphs; resource skipBuiltinGlyphs. |
|
|
262 | |
242 | -lsp *number* |
263 | -lsp *number* |
243 | Compile *frills*: Lines (pixel height) to insert between each row of |
264 | Compile *frills*: Lines (pixel height) to insert between each row of |
244 | the display. Useful to work around font rendering problems; resource |
265 | the display. Useful to work around font rendering problems; resource |
245 | linespace. |
266 | linespace. |
246 | |
267 | |
… | |
… | |
249 | TERM environment variable. This terminal type must exist in the |
270 | TERM environment variable. This terminal type must exist in the |
250 | *termcap(5)* database and should have *li#* and *co#* entries; |
271 | *termcap(5)* database and should have *li#* and *co#* entries; |
251 | resource termName. |
272 | resource termName. |
252 | |
273 | |
253 | -e *command [arguments]* |
274 | -e *command [arguments]* |
254 | Run the command with its command-line arguments in the rxvt window; |
275 | Run the command with its command-line arguments in the urxvt window; |
255 | also sets the window title and icon name to be the basename of the |
276 | also sets the window title and icon name to be the basename of the |
256 | program being executed if neither *-title* (*-T*) nor *-n* are given |
277 | program being executed if neither *-title* (*-T*) nor *-n* are given |
257 | on the command line. If this option is used, it must be the last on |
278 | on the command line. If this option is used, it must be the last on |
258 | the command-line. If there is no -e option then the default is to |
279 | the command-line. If there is no -e option then the default is to |
259 | run the program specified by the SHELL environment variable or, |
280 | run the program specified by the SHELL environment variable or, |
260 | failing that, *sh(1)*. |
281 | failing that, *sh(1)*. |
261 | |
282 | |
|
|
283 | Please note that you must specify a program with arguments. If you |
|
|
284 | want to run shell commands, you have to specify the shell, like |
|
|
285 | this: |
|
|
286 | |
|
|
287 | urxvt -e sh -c "shell commands" |
|
|
288 | |
262 | -title *text* |
289 | -title *text* |
263 | Window title (-T still respected); the default title is the basename |
290 | Window title (-T still respected); the default title is the basename |
264 | of the program specified after the -e option, if any, otherwise the |
291 | of the program specified after the -e option, if any, otherwise the |
265 | application name; resource title. |
292 | application name; resource title. |
266 | |
293 | |
… | |
… | |
277 | |
304 | |
278 | -im *text* |
305 | -im *text* |
279 | Compile *XIM*: input method name. resource inputMethod. |
306 | Compile *XIM*: input method name. resource inputMethod. |
280 | |
307 | |
281 | -imlocale *string* |
308 | -imlocale *string* |
282 | The locale to use for opening the IM. You can use an LC_CTYPE of |
309 | The locale to use for opening the IM. You can use an "LC_CTYPE" of |
283 | e.g. de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the |
310 | e.g. "de_DE.UTF-8" for normal text processing but "ja_JP.EUC-JP" for |
284 | input extension to be able to input japanese characters while |
311 | the input extension to be able to input japanese characters while |
285 | staying in another locale. |
312 | staying in another locale. resource imLocale. |
|
|
313 | |
|
|
314 | -imfont *fontset* |
|
|
315 | Set the font set to use for the X Input Method, see resource imFont |
|
|
316 | for more info. |
|
|
317 | |
|
|
318 | -tcw |
|
|
319 | Change the meaning of triple-click selection with the left mouse |
|
|
320 | button. Instead of selecting a full line it will extend the |
|
|
321 | selection the end of the logical line only. resource |
|
|
322 | tripleclickwords. |
286 | |
323 | |
287 | -insecure |
324 | -insecure |
288 | Enable "insecure" mode, which currently enables most of the escape |
325 | Enable "insecure" mode, which currently enables most of the escape |
289 | sequences that echo strings. See the resource insecure for more |
326 | sequences that echo strings. See the resource insecure for more |
290 | info. |
327 | info. |
… | |
… | |
299 | |
336 | |
300 | -ssr|+ssr |
337 | -ssr|+ssr |
301 | Turn on/off secondary screen scroll (default enabled); resource |
338 | Turn on/off secondary screen scroll (default enabled); resource |
302 | secondaryScroll. |
339 | secondaryScroll. |
303 | |
340 | |
304 | -xrm *resourcestring* |
341 | -hold|+hold |
305 | No effect on rxvt-unicode. Simply passes through an argument to be |
342 | Turn on/off hold window after exit support. If enabled, urxvt will |
306 | made available in the instance's argument list. Appears in |
343 | not immediately destroy its window when the program executed within |
307 | *WM_COMMAND* in some window managers. |
344 | it exits. Instead, it will wait till it is being killed or closed by |
|
|
345 | the user; resource hold. |
|
|
346 | |
|
|
347 | -keysym.*sym* *string* |
|
|
348 | Remap a key symbol. See resource keysym. |
|
|
349 | |
|
|
350 | -embed *windowid* |
|
|
351 | Tells urxvt to embed it's windows into an already-existing window, |
|
|
352 | which enables applications to easily embed a terminal. |
|
|
353 | |
|
|
354 | Right now, urxvt will first unmap/map the specified window, so it |
|
|
355 | shouldn't be a top-level window. urxvt will also reconfigure it |
|
|
356 | quite a bit, so don't expect it to keep some specific state. It's |
|
|
357 | best to create an extra subwindow for urxvt and leave it alone. |
|
|
358 | |
|
|
359 | The window will not be destroyed when urxvt exits. |
|
|
360 | |
|
|
361 | It might be useful to know that urxvt will not close file |
|
|
362 | descriptors passed to it (except for stdin/out/err, of course), so |
|
|
363 | you can use file descriptors to communicate with the programs within |
|
|
364 | the terminal. This works regardless of wether the "-embed" option |
|
|
365 | was used or not. |
|
|
366 | |
|
|
367 | Here is a short Gtk2-perl snippet that illustrates how this option |
|
|
368 | can be used (a longer example is in doc/embed): |
|
|
369 | |
|
|
370 | my $rxvt = new Gtk2::Socket; |
|
|
371 | $rxvt->signal_connect_after (realize => sub { |
|
|
372 | my $xid = $_[0]->window->get_xid; |
|
|
373 | system "urxvt -embed $xid &"; |
|
|
374 | }); |
|
|
375 | |
|
|
376 | -pty-fd *file descriptor* |
|
|
377 | Tells urxvt NOT to execute any commands or create a new pty/tty pair |
|
|
378 | but instead use the given filehandle as the tty master. This is |
|
|
379 | useful if you want to drive urxvt as a generic terminal emulator |
|
|
380 | without having to run a program within it. |
|
|
381 | |
|
|
382 | If this switch is given, urxvt will not create any utmp/wtmp entries |
|
|
383 | and will not tinker with pty/tty permissions - you have to do that |
|
|
384 | yourself if you want that. |
|
|
385 | |
|
|
386 | As an extremely special case, specifying -1 will completely suppress |
|
|
387 | pty/tty operations. |
|
|
388 | |
|
|
389 | Here is a example in perl that illustrates how this option can be |
|
|
390 | used (a longer example is in doc/pty-fd): |
|
|
391 | |
|
|
392 | use IO::Pty; |
|
|
393 | use Fcntl; |
|
|
394 | |
|
|
395 | my $pty = new IO::Pty; |
|
|
396 | fcntl $pty, F_SETFD, 0; # clear close-on-exec |
|
|
397 | system "urxvt -pty-fd " . (fileno $pty) . "&"; |
|
|
398 | close $pty; |
|
|
399 | |
|
|
400 | # now communicate with rxvt |
|
|
401 | my $slave = $pty->slave; |
|
|
402 | while (<$slave>) { print $slave "got <$_>\n" } |
|
|
403 | |
|
|
404 | -pe *string* |
|
|
405 | Comma-separated list of perl extension scripts to use (or not to |
|
|
406 | use) in this terminal instance. See resource perl-ext for details. |
308 | |
407 | |
309 | RESOURCES (available also as long-options) |
408 | RESOURCES (available also as long-options) |
310 | Note: `rxvt --help' gives a list of all resources (long options) |
409 | Note: `urxvt --help' gives a list of all resources (long options) |
311 | compiled into your version. |
410 | compiled into your version. |
312 | |
411 | |
313 | There are two different methods that rxvt can use to get the Xresource |
|
|
314 | data: using the X libraries (Xrm*-functions) or internal Xresources |
|
|
315 | reader (~/.Xdefaults). For the first method (ie. rxvt -h lists |
|
|
316 | XGetDefaults), you can set and change the resources using X11 tools like |
412 | You can set and change the resources using X11 tools like xrdb. Many |
317 | xset. Many distribution do also load settings from the ~/.Xresources |
413 | distribution do also load settings from the ~/.Xresources file when X |
318 | file when X starts. |
414 | starts. urxvt will consult the following files/resources in order, with |
|
|
415 | later settings overwriting earlier ones: |
319 | |
416 | |
320 | If compiled with internal Xresources support (i.e. rxvt -h lists |
417 | 1. system-wide app-defaults file, either locale-dependent OR global |
321 | .Xdefaults) then rxvt accepts application defaults set in |
418 | 2. app-defaults file in $XAPPLRESDIR |
322 | XAPPLOADDIR/URxvt (compile-time defined: usually |
419 | 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults |
323 | /usr/lib/X11/app-defaults/URxvt) and resources set in ~/.Xdefaults, or |
420 | 4. SCREEN_RESOURCES for the current screen |
324 | ~/.Xresources if ~/.Xdefaults does not exist. Note that when reading X |
421 | 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> |
325 | resources, rxvt recognizes two class names: XTerm and URxvt. The class |
422 | |
326 | name Rxvt allows resources common to both rxvt and the original *rxvt* |
423 | Note that when reading X resources, urxvt recognizes two class names: |
327 | to be easily configured, while the class name URxvt allows resources |
424 | Rxvt and URxvt. The class name Rxvt allows resources common to both |
328 | unique to rxvt, notably colours and key-handling, to be shared between |
425 | urxvt and the original *rxvt* to be easily configured, while the class |
|
|
426 | name URxvt allows resources unique to urxvt, to be shared between |
329 | different rxvt configurations. If no resources are specified, suitable |
427 | different urxvt configurations. If no resources are specified, suitable |
330 | defaults will be used. Command-line arguments can be used to override |
428 | defaults will be used. Command-line arguments can be used to override |
331 | resource settings. The following resources are allowed: |
429 | resource settings. The following resources are supported (you might want |
|
|
430 | to check the urxvtperl(3) manpage for additional settings by perl |
|
|
431 | extensions not documented here): |
332 | |
432 | |
333 | geometry: *geom* |
433 | geometry: *geom* |
334 | Create the window with the specified X window geometry [default |
434 | Create the window with the specified X window geometry [default |
335 | 80x24]; option -geometry. |
435 | 80x24]; option -geometry. |
336 | |
436 | |
… | |
… | |
350 | 1=red, 2=green, 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but |
450 | 1=red, 2=green, 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but |
351 | the actual colour names used are listed in the COLORS AND GRAPHICS |
451 | the actual colour names used are listed in the COLORS AND GRAPHICS |
352 | section. |
452 | section. |
353 | |
453 | |
354 | Colours higher than 15 cannot be set using resources (yet), but can |
454 | Colours higher than 15 cannot be set using resources (yet), but can |
355 | be changed using an escape command (see rxvt(7)). |
455 | be changed using an escape command (see urxvt(7)). |
356 | |
456 | |
357 | Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm |
457 | Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm |
358 | with 88 colour support). Colours 80-87 are evenly spaces grey steps. |
458 | with 88 colour support). Colours 80-87 are evenly spaces grey steps. |
359 | |
459 | |
360 | colorBD: *colour* |
460 | colorBD: *colour* |
… | |
… | |
399 | True: make the background inherit the parent windows' pixmap, giving |
499 | True: make the background inherit the parent windows' pixmap, giving |
400 | artificial transparency. False: do not inherit the parent windows' |
500 | artificial transparency. False: do not inherit the parent windows' |
401 | pixmap. |
501 | pixmap. |
402 | |
502 | |
403 | fading: *number* |
503 | fading: *number* |
404 | Fade the text by the given percentage when focus is lost. |
504 | Fade the text by the given percentage when focus is lost; option |
|
|
505 | -fade. |
|
|
506 | |
|
|
507 | fadeColor: *colour* |
|
|
508 | Fade to this colour, when fading is used (see fading:). The default |
|
|
509 | colour is black; option -fadecolor. |
405 | |
510 | |
406 | tintColor: *colour* |
511 | tintColor: *colour* |
407 | Tint the transparent background pixmap with the given colour. |
512 | Tint the transparent background pixmap with the given colour; option |
|
|
513 | -tint. |
408 | |
514 | |
409 | shading: *number* |
515 | shading: *number* |
410 | Darken (0 .. 100) or lighten (-1 .. -100) the transparent background |
516 | Darken (0 .. 100) or lighten (-1 .. -100) the transparent background |
411 | image in addition to tinting it. |
517 | image in addition to tinting it. |
412 | |
518 | |
413 | scrollColor: *colour* |
519 | scrollColor: *colour* |
414 | Use the specified colour for the scrollbar [default #B2B2B2]. |
520 | Use the specified colour for the scrollbar [default #B2B2B2]. |
415 | |
521 | |
416 | troughColor: *colour* |
522 | troughColor: *colour* |
417 | Use the specified colour for the scrollbar's trough area [default |
523 | Use the specified colour for the scrollbar's trough area [default |
418 | #969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. |
524 | #969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar. |
419 | |
525 | |
420 | borderColor: *colour* |
526 | borderColor: *colour* |
421 | The colour of the border around the text area and between the |
527 | The colour of the border around the text area and between the |
422 | scrollbar and the text. |
528 | scrollbar and the text. |
423 | |
529 | |
… | |
… | |
443 | menus), in addition to the paths specified by the RXVTPATH and PATH |
549 | menus), in addition to the paths specified by the RXVTPATH and PATH |
444 | environment variables. |
550 | environment variables. |
445 | |
551 | |
446 | font: *fontlist* |
552 | font: *fontlist* |
447 | Select the fonts to be used. This is a comma separated list of font |
553 | Select the fonts to be used. This is a comma separated list of font |
448 | names that are used in turn when trying to display Unicode |
554 | names that are checked in order when trying to find glyphs for |
449 | characters. The first font defines the cell size for characters; |
555 | characters. The first font defines the cell size for characters; |
450 | other fonts might be smaller, but not larger. A reasonable default |
556 | other fonts might be smaller, but not (in general) larger. A |
451 | font list is always appended to it. option -fn. |
557 | (hopefully) reasonable default font list is always appended to it; |
|
|
558 | option -fn. |
452 | |
559 | |
453 | Each font can either be a standard X11 core font (XLFD) name, with |
560 | Each font can either be a standard X11 core font (XLFD) name, with |
454 | optional prefix "x:" or a Xft font (Compile *xft*), prefixed with |
561 | optional prefix "x:" or a Xft font (Compile *xft*), prefixed with |
455 | "xft:". |
562 | "xft:". |
456 | |
563 | |
… | |
… | |
502 | tried. |
609 | tried. |
503 | |
610 | |
504 | If set, but empty, then this specific style is disabled and the |
611 | If set, but empty, then this specific style is disabled and the |
505 | normal text font will being used for the given style. |
612 | normal text font will being used for the given style. |
506 | |
613 | |
|
|
614 | intensityStyles: *boolean* |
|
|
615 | When font styles are not enabled, or this option is enabled (True, |
|
|
616 | option -is, the default), bold and italic font styles imply high |
|
|
617 | intensity foreground/backround colours. Disabling this option |
|
|
618 | (False, option +is) disables this behaviour, the high intensity |
|
|
619 | colours are not reachable. |
|
|
620 | |
507 | selectstyle: *mode* |
621 | selectstyle: *mode* |
508 | Set mouse selection style to old which is 2.20, oldword which is |
622 | Set mouse selection style to old which is 2.20, oldword which is |
509 | xterm style with 2.20 old word selection, or anything else which |
623 | xterm style with 2.20 old word selection, or anything else which |
510 | gives xterm style selection. |
624 | gives xterm style selection. |
511 | |
625 | |
512 | scrollstyle: *mode* |
626 | scrollstyle: *mode* |
513 | Set scrollbar style to rxvt, plain, next or xterm. plain is the |
627 | Set scrollbar style to rxvt, plain, next or xterm. plain is the |
514 | author's favourite.. |
628 | author's favourite. |
515 | |
629 | |
516 | title: *string* |
630 | title: *string* |
517 | Set window title string, the default title is the command-line |
631 | Set window title string, the default title is the command-line |
518 | specified after the -e option, if any, otherwise the application |
632 | specified after the -e option, if any, otherwise the application |
519 | name; option -title. |
633 | name; option -title. |
… | |
… | |
544 | print-pipe: *string* |
658 | print-pipe: *string* |
545 | Specify a command pipe for vt100 printer [default *lpr(1)*]. Use |
659 | Specify a command pipe for vt100 printer [default *lpr(1)*]. Use |
546 | Print to initiate a screen dump to the printer and Ctrl-Print or |
660 | Print to initiate a screen dump to the printer and Ctrl-Print or |
547 | Shift-Print to include the scrollback as well. |
661 | Shift-Print to include the scrollback as well. |
548 | |
662 | |
|
|
663 | The string will be interpreted as if typed into the shell as-is. |
|
|
664 | |
|
|
665 | Example: |
|
|
666 | |
|
|
667 | URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) |
|
|
668 | |
|
|
669 | This creates a new file in your home directory with the screen |
|
|
670 | contents everytime you hit "Print". |
|
|
671 | |
549 | scrollBar: *boolean* |
672 | scrollBar: *boolean* |
550 | True: enable the scrollbar [default]; option -sb. False: disable the |
673 | True: enable the scrollbar [default]; option -sb. False: disable the |
551 | scrollbar; option +sb. |
674 | scrollbar; option +sb. |
552 | |
675 | |
553 | scrollBar_right: *boolean* |
676 | scrollBar_right: *boolean* |
… | |
… | |
566 | True: scroll to bottom when tty receives output; option -si. False: |
689 | True: scroll to bottom when tty receives output; option -si. False: |
567 | do not scroll to bottom when tty receives output; option +si. |
690 | do not scroll to bottom when tty receives output; option +si. |
568 | |
691 | |
569 | scrollWithBuffer: *boolean* |
692 | scrollWithBuffer: *boolean* |
570 | True: scroll with scrollback buffer when tty receives new lines (and |
693 | True: scroll with scrollback buffer when tty receives new lines (and |
571 | scrollTtyOutput is False); option +sw. False: do not scroll with |
694 | scrollTtyOutput is False); option -sw. False: do not scroll with |
572 | scrollback buffer when tty recieves new lines; option -sw. |
695 | scrollback buffer when tty recieves new lines; option +sw. |
573 | |
696 | |
574 | scrollTtyKeypress: *boolean* |
697 | scrollTtyKeypress: *boolean* |
575 | True: scroll to bottom when a non-special key is pressed. Special |
698 | True: scroll to bottom when a non-special key is pressed. Special |
576 | keys are those which are intercepted by rxvt-unicode for special |
699 | keys are those which are intercepted by rxvt-unicode for special |
577 | handling and are not passed onto the shell; option -sk. False: do |
700 | handling and are not passed onto the shell; option -sk. False: do |
… | |
… | |
592 | borderLess: *boolean* |
715 | borderLess: *boolean* |
593 | Set MWM hints to request a borderless window, i.e. if honoured by |
716 | Set MWM hints to request a borderless window, i.e. if honoured by |
594 | the WM, the rxvt-unicode window will not have window decorations; |
717 | the WM, the rxvt-unicode window will not have window decorations; |
595 | option -bl. |
718 | option -bl. |
596 | |
719 | |
|
|
720 | skipBuiltinGlyphs: *boolean* |
|
|
721 | Compile *frills*: Disable the usage of the built-in block |
|
|
722 | graphics/line drawing characters and just rely on what the specified |
|
|
723 | fonts provide. Use this if you have a good font and want to use its |
|
|
724 | block graphic glyphs; option -sbg. |
|
|
725 | |
597 | termName: *termname* |
726 | termName: *termname* |
598 | Specifies the terminal type name to be set in the TERM environment |
727 | Specifies the terminal type name to be set in the TERM environment |
599 | variable; option -tn. |
728 | variable; option -tn. |
600 | |
729 | |
601 | linespace: *number* |
730 | linespace: *number* |
… | |
… | |
629 | pointerColor2: *colour* |
758 | pointerColor2: *colour* |
630 | Mouse pointer background colour. |
759 | Mouse pointer background colour. |
631 | |
760 | |
632 | pointerBlankDelay: *number* |
761 | pointerBlankDelay: *number* |
633 | Specifies number of seconds before blanking the pointer [default 2]. |
762 | Specifies number of seconds before blanking the pointer [default 2]. |
|
|
763 | Use a large number (e.g. 987654321) to effectively disable the |
|
|
764 | timeout. |
634 | |
765 | |
635 | backspacekey: *string* |
766 | backspacekey: *string* |
636 | The string to send when the backspace key is pressed. If set to DEC |
767 | The string to send when the backspace key is pressed. If set to DEC |
637 | or unset it will send Delete (code 127) or, if shifted, Backspace |
768 | or unset it will send Delete (code 127) or, if shifted, Backspace |
638 | (code 8) - which can be reversed with the appropriate DEC private |
769 | (code 8) - which can be reversed with the appropriate DEC private |
… | |
… | |
654 | |
785 | |
655 | inputMethod: *name* |
786 | inputMethod: *name* |
656 | *name* of inputMethod to use; option -im. |
787 | *name* of inputMethod to use; option -im. |
657 | |
788 | |
658 | imLocale: *name* |
789 | imLocale: *name* |
659 | The locale to use for opening the IM. You can use an LC_CTYPE of |
790 | The locale to use for opening the IM. You can use an "LC_CTYPE" of |
660 | e.g. de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the |
791 | e.g. "de_DE.UTF-8" for normal text processing but "ja_JP.EUC-JP" for |
661 | input extension to be able to input japanese characters while |
792 | the input extension to be able to input japanese characters while |
662 | staying in another locale. option -imlocale. |
793 | staying in another locale; option -imlocale. |
|
|
794 | |
|
|
795 | imFont: *fontset* |
|
|
796 | Specify the font-set used for XIM styles "OverTheSpot" or |
|
|
797 | "OffTheSpot". It must be a standard X font set (XLFD patterns |
|
|
798 | separated by commas), i.e. it's not in the same format as the other |
|
|
799 | font lists used in urxvt. The default will be set-up to chose *any* |
|
|
800 | suitable found found, preferably one or two pixels differing in size |
|
|
801 | to the base font. option -imfont. |
|
|
802 | |
|
|
803 | tripleclickwords: *boolean* |
|
|
804 | Change the meaning of triple-click selection with the left mouse |
|
|
805 | button. Instead of selecting a full line it will extend the |
|
|
806 | selection to the end of the logical line only; option -tcw. |
663 | |
807 | |
664 | insecure: *boolean* |
808 | insecure: *boolean* |
665 | Enables "insecure" mode. Rxvt-unicode offers some escape sequences |
809 | Enables "insecure" mode. Rxvt-unicode offers some escape sequences |
666 | that echo arbitrary strings like the icon name or the locale. This |
810 | that echo arbitrary strings like the icon name or the locale. This |
667 | could be abused if somebody gets 8-bit-clean access to your display, |
811 | could be abused if somebody gets 8-bit-clean access to your display, |
668 | whether throuh a mail client displaying mail bodies unfiltered or |
812 | whether through a mail client displaying mail bodies unfiltered or |
669 | though write(1). Therefore, these sequences are disabled by default. |
813 | through write(1) or any other means. Therefore, these sequences are |
670 | (Note that other terminals, including xterm, have these sequences |
814 | disabled by default. (Note that many other terminals, including |
671 | enabled by default). You can enable them by setting this boolean |
815 | xterm, have these sequences enabled by default, which doesn't make |
672 | resource or specifying -insecure as an option. At the moment, this |
816 | it safer, though). |
673 | enabled display-answer, locale, findfont, icon label and window |
817 | |
674 | title requests as well as dynamic menubar dispatch. |
818 | You can enable them by setting this boolean resource or specifying |
|
|
819 | -insecure as an option. At the moment, this enables display-answer, |
|
|
820 | locale, findfont, icon label and window title requests as well as |
|
|
821 | dynamic menubar dispatch. |
675 | |
822 | |
676 | modifier: *modifier* |
823 | modifier: *modifier* |
677 | Set the key to be interpreted as the Meta key to: alt, meta, hyper, |
824 | Set the key to be interpreted as the Meta key to: alt, meta, hyper, |
678 | super, mod1, mod2, mod3, mod4, mod5; option -mod. |
825 | super, mod1, mod2, mod3, mod4, mod5; option -mod. |
679 | |
826 | |
… | |
… | |
689 | Turn on/off secondary screen scroll (default enabled). If the this |
836 | Turn on/off secondary screen scroll (default enabled). If the this |
690 | option is enabled, scrolls on the secondary screen will change the |
837 | option is enabled, scrolls on the secondary screen will change the |
691 | scrollback buffer and switching to/from the secondary screen will |
838 | scrollback buffer and switching to/from the secondary screen will |
692 | instead scroll the screen up. |
839 | instead scroll the screen up. |
693 | |
840 | |
|
|
841 | hold: *bool* |
|
|
842 | Turn on/off hold window after exit support. If enabled, urxvt will |
|
|
843 | not immediately destroy its window when the program executed within |
|
|
844 | it exits. Instead, it will wait till it is being killed or closed by |
|
|
845 | the user. |
|
|
846 | |
694 | keysym.*sym*: *string* |
847 | keysym.*sym*: *string* |
695 | Compile *frills*: Associate *string* with keysym *sym*. The |
848 | Compile *frills*: Associate *string* with keysym *sym*. The |
696 | intervening resource name keysym. cannot be omitted. |
849 | intervening resource name keysym. cannot be omitted. |
697 | |
850 | |
698 | The format of *sym* is "*(modifiers-)key*", where *modifiers* can be |
851 | The format of *sym* is "*(modifiers-)key*", where *modifiers* can be |
… | |
… | |
700 | Meta, Lock, Mod1, Mod2, Mod3, Mod4, Mod5, and the abbreviated I, K, |
853 | Meta, Lock, Mod1, Mod2, Mod3, Mod4, Mod5, and the abbreviated I, K, |
701 | C, N, S, M, A, L, 1, 2, 3, 4, 5. |
854 | C, N, S, M, A, L, 1, 2, 3, 4, 5. |
702 | |
855 | |
703 | The NumLock, Meta and ISOLevel3 modifiers are usually aliased to |
856 | The NumLock, Meta and ISOLevel3 modifiers are usually aliased to |
704 | whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 |
857 | whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 |
705 | Shift/AltGr keys are being mapped. AppKeypad is a artificial |
858 | Shift/AltGr keys are being mapped. AppKeypad is a synthetic modifier |
706 | modifier mapped to the current application keymap mode state. |
859 | mapped to the current application keymap mode state. |
707 | |
860 | |
708 | The spellings of *key* can be obtained by using xev(1) command or |
861 | The spellings of *key* can be obtained by using xev(1) command or |
709 | searching keysym macros from /usr/X11R6/include/X11/keysymdef.h and |
862 | searching keysym macros from /usr/X11R6/include/X11/keysymdef.h and |
710 | omitting the prefix XK_. Alternatively you can specify *key* by its |
863 | omitting the prefix XK_. Alternatively you can specify *key* by its |
711 | hex keysym value (0x0000 - 0xFFFF). Note that the lookup of *sym*s |
864 | hex keysym value (0x0000 - 0xFFFF). Note that the lookup of *sym*s |
… | |
… | |
716 | "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab, |
869 | "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab, |
717 | "\000": octal number) or verbatim control characters ("^?": delete, |
870 | "\000": octal number) or verbatim control characters ("^?": delete, |
718 | "^@": null, "^A" ...) and may be enclosed with double quotes so that |
871 | "^@": null, "^A" ...) and may be enclosed with double quotes so that |
719 | it can start or end with whitespace. |
872 | it can start or end with whitespace. |
720 | |
873 | |
|
|
874 | Please note that you need to double the "\" in resource files, as |
|
|
875 | Xlib itself does it's own de-escaping (you can use "\033" instead of |
|
|
876 | "\e" (and so on), which will work with both Xt and urxvt's own |
|
|
877 | processing). |
|
|
878 | |
721 | You can define a range of keysyms in one shot by providing a |
879 | You can define a range of keysyms in one shot by providing a |
722 | *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter |
880 | *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter |
723 | `/' should be a character not used by the strings. |
881 | `/' should be a character not used by the strings. |
724 | |
882 | |
725 | Its usage can be demonstrated by an example: |
883 | Its usage can be demonstrated by an example: |
726 | |
884 | |
727 | URxvt.keysym.M-C-0x61: list|\e<M-C-|abc|> |
885 | URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> |
728 | |
886 | |
729 | The above line is equivalent to the following three lines: |
887 | The above line is equivalent to the following three lines: |
730 | |
888 | |
731 | URxvt.keysym.Meta-Control-0x61: \e<M-C-a> |
889 | URxvt.keysym.Meta-Control-0x61: \033<M-C-a> |
732 | URxvt.keysym.Meta-Control-0x62: \e<M-C-b> |
890 | URxvt.keysym.Meta-Control-0x62: \033<M-C-b> |
733 | URxvt.keysym.Meta-Control-0x63: \e<M-C-c> |
891 | URxvt.keysym.Meta-Control-0x63: \033<M-C-c> |
734 | |
892 | |
735 | If *string* takes the form of "proto:STRING", the specified STRING |
893 | If *string* takes the form of "command:STRING", the specified STRING |
736 | is interpreted and executed as rxvt's control sequence. For example, |
894 | is interpreted and executed as urxvt's control sequence. For example |
737 | "proto:\033]701;zh_CN.GBK\007" means: change the current locale to |
895 | the following means "change the current locale to "zh_CN.GBK" when |
738 | "zh_CN.GBK". |
896 | Control-Meta-c is being pressed": |
|
|
897 | |
|
|
898 | URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 |
|
|
899 | |
|
|
900 | If *string* takes the form "perl:STRING", then the specified STRING |
|
|
901 | is passed to the "on_keyboard_command" perl handler. See the |
|
|
902 | urxvtperl(3) manpage. For example, the selection extension |
|
|
903 | (activated via "urxvt -pe selection") listens for "selection:rot13" |
|
|
904 | events: |
|
|
905 | |
|
|
906 | URxvt.keysym.M-C-c: perl:selection:rot13 |
|
|
907 | |
|
|
908 | Due the the large number of modifier combinations, a defined key |
|
|
909 | mapping will match if at *at least* the specified identifiers are |
|
|
910 | being set, and no other key mappings with those and more bits are |
|
|
911 | being defined. That means that defining a key map for "a" will |
|
|
912 | automatically provide definitions for "Meta-a", "Shift-a" and so on, |
|
|
913 | unless some of those are defined mappings themselves. |
|
|
914 | |
|
|
915 | Unfortunately, this will override built-in key mappings. For example |
|
|
916 | if you overwrite the "Insert" key you will disable urxvt's |
|
|
917 | "Shift-Insert" mapping. To re-enable that, you can poke "holes" into |
|
|
918 | the user-defined keymap using the "builtin:" replacement: |
|
|
919 | |
|
|
920 | URxvt.keysym.Insert: <my insert key sequence> |
|
|
921 | URxvt.keysym.S-Insert: builtin: |
|
|
922 | |
|
|
923 | The first line defines a mapping for "Insert" and *any* combination |
|
|
924 | of modifiers. The second line re-establishes the default mapping for |
|
|
925 | "Shift-Insert". |
|
|
926 | |
|
|
927 | The following example will map Control-Meta-1 and Control-Meta-2 to |
|
|
928 | the fonts "suxuseuro" and "9x15bold", so you can have some limited |
|
|
929 | font-switching at runtime: |
|
|
930 | |
|
|
931 | URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 |
|
|
932 | URxvt.keysym.M-C-2: command:\033]50;9x15bold\007 |
|
|
933 | |
|
|
934 | Other things are possible, e.g. resizing (see urxvt(7) for more |
|
|
935 | info): |
|
|
936 | |
|
|
937 | URxvt.keysym.M-C-3: command:\033[8;25;80t |
|
|
938 | URxvt.keysym.M-C-4: command:\033[8;48;110t |
|
|
939 | |
|
|
940 | perl-ext-common: *string* |
|
|
941 | perl-ext: *string* |
|
|
942 | Comma-separated list(s) of perl extension scripts (default: |
|
|
943 | "default") to use in this terminal instance; option -pe. |
|
|
944 | |
|
|
945 | Extension names can be prefixed with a "-" sign to prohibit using |
|
|
946 | them. This can be useful to selectively disable some extensions |
|
|
947 | loaded by default, or specified via the "perl-ext-common" resource. |
|
|
948 | For example, "default,-selection" will use all the default extension |
|
|
949 | except "selection". |
|
|
950 | |
|
|
951 | Extension names can also be followed by an argument in angle |
|
|
952 | brackets (e.g. "searchable-scrollback<M-s>", which binds the hotkey |
|
|
953 | for searchable scorllback to Alt/Meta-s). Mentioning the same |
|
|
954 | extension multiple times with different arguments will pass multiple |
|
|
955 | arguments to the extension. |
|
|
956 | |
|
|
957 | Each extension is looked up in the library directories, loaded if |
|
|
958 | necessary, and bound to the current terminal instance. |
|
|
959 | |
|
|
960 | If both of these resources are the empty string, then the perl |
|
|
961 | interpreter will not be initialized. The idea behind two options is |
|
|
962 | that perl-ext-common will be used for extensions that should be |
|
|
963 | available to all instances, while perl-ext is used for specific |
|
|
964 | instances. |
|
|
965 | |
|
|
966 | perl-eval: *string* |
|
|
967 | Perl code to be evaluated when all extensions have been registered. |
|
|
968 | See the urxvtperl(3) manpage. Due to security reasons, this resource |
|
|
969 | will be ignored when running setuid/setgid. |
|
|
970 | |
|
|
971 | perl-lib: *path* |
|
|
972 | Colon-separated list of additional directories that hold extension |
|
|
973 | scripts. When looking for extensions specified by the "perl" |
|
|
974 | resource, urxvt will first look in these directories and then in |
|
|
975 | /usr/local/lib/urxvt/perl/. Due to security reasons, this resource |
|
|
976 | will be ignored when running setuid/setgid. |
|
|
977 | |
|
|
978 | See the urxvtperl(3) manpage. |
|
|
979 | |
|
|
980 | selection.pattern-*idx*: *perl-regex* |
|
|
981 | Additional selection patterns, see the urxvtperl(3) manpage for |
|
|
982 | details. |
|
|
983 | |
|
|
984 | selection-autotransform.*idx*: *perl-transform* |
|
|
985 | Selection auto-transform patterns, see the urxvtperl(3) manpage for |
|
|
986 | details. |
|
|
987 | |
|
|
988 | searchable-scrollback: *keysym* |
|
|
989 | Sets the hotkey that starts the incremental scrollback buffer search |
|
|
990 | (default: "M-s"). |
|
|
991 | |
|
|
992 | urlLauncher: *string* |
|
|
993 | Specifies the program to be started with a URL argument. Used by the |
|
|
994 | "selection-popup" and "mark-urls" perl extensions. |
|
|
995 | |
|
|
996 | transient-for: *windowid* |
|
|
997 | Sets the WM_TRANSIENT_FOR property to the given window iw. |
739 | |
998 | |
740 | THE SCROLLBAR |
999 | THE SCROLLBAR |
741 | Lines of text that scroll off the top of the rxvt window (resource: |
1000 | Lines of text that scroll off the top of the urxvt window (resource: |
742 | saveLines) and can be scrolled back using the scrollbar or by |
1001 | saveLines) and can be scrolled back using the scrollbar or by |
743 | keystrokes. The normal rxvt scrollbar has arrows and its behaviour is |
1002 | keystrokes. The normal urxvt scrollbar has arrows and its behaviour is |
744 | fairly intuitive. The xterm-scrollbar is without arrows and its |
1003 | fairly intuitive. The xterm-scrollbar is without arrows and its |
745 | behaviour mimics that of *xterm* |
1004 | behaviour mimics that of *xterm* |
746 | |
1005 | |
747 | Scroll down with Button1 (xterm-scrollbar) or Shift-Next. Scroll up with |
1006 | Scroll down with Button1 (xterm-scrollbar) or Shift-Next. Scroll up with |
748 | Button3 (xterm-scrollbar) or Shift-Prior. Continuous scroll with |
1007 | Button3 (xterm-scrollbar) or Shift-Prior. Continuous scroll with |
… | |
… | |
753 | normal text selection/insertion, hold either the Shift or the Meta (Alt) |
1012 | normal text selection/insertion, hold either the Shift or the Meta (Alt) |
754 | key while performing the desired mouse action. |
1013 | key while performing the desired mouse action. |
755 | |
1014 | |
756 | If mouse reporting mode is active, the normal scrollbar actions are |
1015 | If mouse reporting mode is active, the normal scrollbar actions are |
757 | disabled -- on the assumption that we are using a fullscreen |
1016 | disabled -- on the assumption that we are using a fullscreen |
758 | application. Instead, pressing Button1 and Button3 sends ESC[6~ (Next) |
1017 | application. Instead, pressing Button1 and Button3 sends ESC [ 6 ~ |
759 | and ESC[5~ (Prior), respectively. Similarly, clicking on the up and down |
1018 | (Next) and ESC [ 5 ~ (Prior), respectively. Similarly, clicking on the |
760 | arrows sends ESC[A (Up) and ESC[B (Down), respectively. |
1019 | up and down arrows sends ESC [ A (Up) and ESC [ B (Down), respectively. |
761 | |
1020 | |
762 | TEXT SELECTION AND INSERTION |
1021 | TEXT SELECTION AND INSERTION |
763 | The behaviour of text selection and insertion mechanism is similar to |
1022 | The behaviour of text selection and insertion mechanism is similar to |
764 | *xterm*(1). |
1023 | *xterm*(1). |
765 | |
1024 | |
766 | Selection: |
1025 | Selection: |
767 | Left click at the beginning of the region, drag to the end of the |
1026 | Left click at the beginning of the region, drag to the end of the |
768 | region and release; Right click to extend the marked region; Left |
1027 | region and release; Right click to extend the marked region; Left |
769 | double-click to select a word; Left triple-click to select the |
1028 | double-click to select a word; Left triple-click to select the |
770 | entire line. |
1029 | entire logical line (which can span multiple screen lines), unless |
|
|
1030 | modified by resource tripleclickwords. |
771 | |
1031 | |
772 | Starting a selection while pressing the Meta key (or Meta+Ctrl keys) |
1032 | Starting a selection while pressing the Meta key (or Meta+Ctrl keys) |
773 | (Compile: *frills*) will create a rectangular selection instead of a |
1033 | (Compile: *frills*) will create a rectangular selection instead of a |
774 | normal one. |
1034 | normal one. In this mode, every selected row becomes its own line in |
|
|
1035 | the selection, and trailing whitespace is visually underlined and |
|
|
1036 | removed from the selection. |
775 | |
1037 | |
776 | Insertion: |
1038 | Insertion: |
777 | Pressing and releasing the Middle mouse button (or Shift-Insert) in |
1039 | Pressing and releasing the Middle mouse button (or Shift-Insert) in |
778 | an rxvt window causes the current text selection to be inserted as |
1040 | an urxvt window causes the current text selection to be inserted as |
779 | if it had been typed on the keyboard. |
1041 | if it had been typed on the keyboard. |
780 | |
1042 | |
781 | CHANGING FONTS |
1043 | CHANGING FONTS |
782 | Changing fonts (or font sizes, respectively) via the keypad is not yet |
1044 | Changing fonts (or font sizes, respectively) via the keypad is not yet |
783 | supported in rxvt-unicode. Bug me if you need this. |
1045 | supported in rxvt-unicode. Bug me if you need this. |
784 | |
1046 | |
785 | You can, however, switch fonts at runtime using escape sequences (and |
1047 | You can, however, switch fonts at runtime using escape sequences (and |
786 | therefore using the menubar), e.g.: |
1048 | therefore using the menubar), e.g.: |
787 | |
1049 | |
788 | printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic" |
1050 | printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic" |
789 | |
1051 | |
790 | rxvt-unicode will automatically re-apply these fonts to the output so |
1052 | rxvt-unicode will automatically re-apply these fonts to the output so |
791 | far. |
1053 | far. |
792 | |
1054 | |
793 | ISO 14755 SUPPORT |
1055 | ISO 14755 SUPPORT |
… | |
… | |
795 | character codes using the keyboard. It consists of 4 parts. The first |
1057 | character codes using the keyboard. It consists of 4 parts. The first |
796 | part is available rxvt-unicode has been compiled with "--enable-frills", |
1058 | part is available rxvt-unicode has been compiled with "--enable-frills", |
797 | the rest is available when rxvt-unicode was compiled with |
1059 | the rest is available when rxvt-unicode was compiled with |
798 | "--enable-iso14755". |
1060 | "--enable-iso14755". |
799 | |
1061 | |
800 | 5.1: Basic method |
1062 | * 5.1: Basic method |
801 | This allows you to enter unicode characters using their hexcode. |
1063 | This allows you to enter unicode characters using their hexcode. |
802 | |
1064 | |
803 | Start by pressing and holding both "Control" and "Shift", then enter |
1065 | Start by pressing and holding both "Control" and "Shift", then enter |
804 | hex-digits (between one and six). Releasing "Control" and "Shift" |
1066 | hex-digits (between one and six). Releasing "Control" and "Shift" |
805 | will commit the character as if it were typed directly. While |
1067 | will commit the character as if it were typed directly. While |
… | |
… | |
811 | address, which you cannot type. Fortunately, the card has the e-mail |
1073 | address, which you cannot type. Fortunately, the card has the e-mail |
812 | address printed as hexcodes, e.g. "671d 65e5". You can enter this |
1074 | address printed as hexcodes, e.g. "671d 65e5". You can enter this |
813 | easily by pressing "Control" and "Shift", followed by |
1075 | easily by pressing "Control" and "Shift", followed by |
814 | "6-7-1-D-SPACE-6-5-E-5", followed by releasing the modifier keys. |
1076 | "6-7-1-D-SPACE-6-5-E-5", followed by releasing the modifier keys. |
815 | |
1077 | |
816 | 5.2: Keyboard symbols entry method |
1078 | * 5.2: Keyboard symbols entry method |
817 | This mode lets you input characters representing the keycap symbols |
1079 | This mode lets you input characters representing the keycap symbols |
818 | of your keyboard, if representable in the current locale encoding. |
1080 | of your keyboard, if representable in the current locale encoding. |
819 | |
1081 | |
820 | Start by pressing "Control" and "Shift" together, then releasing |
1082 | Start by pressing "Control" and "Shift" together, then releasing |
821 | them. The next special key (cursor keys, home etc.) you enter will |
1083 | them. The next special key (cursor keys, home etc.) you enter will |
… | |
… | |
823 | corresponding keycap symbol. The symbol will only be entered when |
1085 | corresponding keycap symbol. The symbol will only be entered when |
824 | the key has been released, otherwise pressing e.g. "Shift" would |
1086 | the key has been released, otherwise pressing e.g. "Shift" would |
825 | enter the symbol for "ISO Level 2 Switch", although your intention |
1087 | enter the symbol for "ISO Level 2 Switch", although your intention |
826 | might have been to enter a reverse tab (Shift-Tab). |
1088 | might have been to enter a reverse tab (Shift-Tab). |
827 | |
1089 | |
828 | 5.3: Screen-selection entry method |
1090 | * 5.3: Screen-selection entry method |
829 | While this is implemented already (it's basically the selection |
1091 | While this is implemented already (it's basically the selection |
830 | mechanism), it could be extended by displaying a unicode character |
1092 | mechanism), it could be extended by displaying a unicode character |
831 | map. |
1093 | map. |
832 | |
1094 | |
833 | 5.4: Feedback method for identifying displayed characters for later |
1095 | * 5.4: Feedback method for identifying displayed characters for later |
834 | input |
1096 | input |
835 | This method lets you display the unicode character code associated |
1097 | This method lets you display the unicode character code associated |
836 | with characters already displayed. |
1098 | with characters already displayed. |
837 | |
1099 | |
838 | You enter this mode by holding down "Control" and "Shift" together, |
1100 | You enter this mode by holding down "Control" and "Shift" together, |
… | |
… | |
848 | |
1110 | |
849 | With respect to conformance, rxvt-unicode is supposed to be compliant to |
1111 | With respect to conformance, rxvt-unicode is supposed to be compliant to |
850 | both scenario A and B of ISO 14755, including part 5.2. |
1112 | both scenario A and B of ISO 14755, including part 5.2. |
851 | |
1113 | |
852 | LOGIN STAMP |
1114 | LOGIN STAMP |
853 | rxvt tries to write an entry into the *utmp*(5) file so that it can be |
1115 | urxvt tries to write an entry into the *utmp*(5) file so that it can be |
854 | seen via the *who(1)* command, and can accept messages. To allow this |
1116 | seen via the *who(1)* command, and can accept messages. To allow this |
855 | feature, rxvt must be installed setuid root on some systems. |
1117 | feature, urxvt may need to be installed setuid root on some systems or |
|
|
1118 | setgid to root or to some other group on others. |
856 | |
1119 | |
857 | COLORS AND GRAPHICS |
1120 | COLORS AND GRAPHICS |
858 | In addition to the default foreground and background colours, rxvt can |
1121 | In addition to the default foreground and background colours, urxvt can |
859 | display up to 16 colours (8 ANSI colours plus high-intensity bold/blink |
1122 | display up to 16 colours (8 ANSI colours plus high-intensity bold/blink |
860 | versions of the same). Here is a list of the colours with their rgb.txt |
1123 | versions of the same). Here is a list of the colours with their rgb.txt |
861 | names. |
1124 | names. |
862 | |
1125 | |
863 | color0 (black) = Black |
1126 | color0 (black) = Black |
… | |
… | |
887 | Note that -rv ("reverseVideo: True") simulates reverse video by always |
1150 | Note that -rv ("reverseVideo: True") simulates reverse video by always |
888 | swapping the foreground/background colours. This is in contrast to |
1151 | swapping the foreground/background colours. This is in contrast to |
889 | *xterm*(1) where the colours are only swapped if they have not otherwise |
1152 | *xterm*(1) where the colours are only swapped if they have not otherwise |
890 | been specified. For example, |
1153 | been specified. For example, |
891 | |
1154 | |
892 | rxvt -fg Black -bg White -rv |
1155 | urxvt -fg Black -bg White -rv |
893 | would yield White on Black, while on *xterm*(1) it would yield Black |
1156 | would yield White on Black, while on *xterm*(1) it would yield Black |
894 | on White. |
1157 | on White. |
895 | |
1158 | |
896 | ENVIRONMENT |
1159 | ENVIRONMENT |
897 | rxvt sets the environment variables TERM, COLORTERM and COLORFGBG. The |
1160 | urxvt sets and/or uses the following environment variables: |
898 | environment variable WINDOWID is set to the X window id number of the |
1161 | |
899 | rxvt window and it also uses and sets the environment variable DISPLAY |
1162 | TERM |
900 | to specify which display terminal to use. rxvt uses the environment |
1163 | Normally set to "rxvt-unicode", unless overwritten at configure |
901 | variables RXVTPATH and PATH to find XPM files. |
1164 | time, via resources or on the commandline. |
|
|
1165 | |
|
|
1166 | COLORTERM |
|
|
1167 | Either "rxvt", "rxvt-xpm", depending on wether urxvt was compiled |
|
|
1168 | with XPM support, and optionally with the added extension "-mono" to |
|
|
1169 | indicate that rxvt-unicode runs on a monochrome screen. |
|
|
1170 | |
|
|
1171 | COLORFGBG |
|
|
1172 | Set to a string of the form "fg;bg" or "fg;xpm;bg", where "fg" is |
|
|
1173 | the colour code used as default foreground/text colour (or the |
|
|
1174 | string "default" to indicate that the default-colour escape sequence |
|
|
1175 | is to be used), "bg" is the colour code used as default background |
|
|
1176 | colour (or the string "default"), and "xpm" is the string "default" |
|
|
1177 | if urxvt was compiled with XPM support. Libraries like "ncurses" and |
|
|
1178 | "slang" can (and do) use this information to optimize screen output. |
|
|
1179 | |
|
|
1180 | WINDOWID |
|
|
1181 | Set to the (decimal) X Window ID of the urxvt window (the toplevel |
|
|
1182 | window, which usually has subwindows for the scrollbar, the terminal |
|
|
1183 | window and so on). |
|
|
1184 | |
|
|
1185 | TERMINFO |
|
|
1186 | Set to the terminfo directory iff urxvt was configured with |
|
|
1187 | "--with-terminfo=PATH". |
|
|
1188 | |
|
|
1189 | DISPLAY |
|
|
1190 | Used by urxvt to connect to the display and set to the correct |
|
|
1191 | display in it's child processes. |
|
|
1192 | |
|
|
1193 | SHELL |
|
|
1194 | The shell to be used for command execution, defaults to "/bin/sh". |
|
|
1195 | |
|
|
1196 | RXVTPATH |
|
|
1197 | The path where urxvt looks for support files such as menu and xpm |
|
|
1198 | files. |
|
|
1199 | |
|
|
1200 | PATH |
|
|
1201 | Used in the same way as "RXVTPATH". |
|
|
1202 | |
|
|
1203 | RXVT_SOCKET |
|
|
1204 | The unix domain socket path used by urxvtc(1) and urxvtd(1). |
|
|
1205 | |
|
|
1206 | Default $HOME/.rxvt-unicode-*<nodename*. |
|
|
1207 | |
|
|
1208 | HOME |
|
|
1209 | Used to locate the default directory for the unix domain socket for |
|
|
1210 | daemon communications and to locate various resource files (such as |
|
|
1211 | ".Xdefaults") |
|
|
1212 | |
|
|
1213 | XAPPLRESDIR |
|
|
1214 | Directory where various X resource files are being located. |
|
|
1215 | |
|
|
1216 | XENVIRONMENT |
|
|
1217 | If set and accessible, gives the name of a X resource file to be |
|
|
1218 | loaded by urxvt. |
902 | |
1219 | |
903 | FILES |
1220 | FILES |
904 | /etc/utmp |
|
|
905 | System file for login records. |
|
|
906 | |
|
|
907 | /usr/lib/X11/rgb.txt |
1221 | /usr/lib/X11/rgb.txt |
908 | Color names. |
1222 | Color names. |
909 | |
1223 | |
910 | SEE ALSO |
1224 | SEE ALSO |
911 | rxvt(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) |
1225 | urxvt(7), urxvtc(1), urxvtd(1), xterm(1), sh(1), resize(1), X(1), |
912 | |
1226 | pty(4), tty(4), utmp(5) |
913 | BUGS |
|
|
914 | Check the BUGS file for an up-to-date list. |
|
|
915 | |
|
|
916 | Cursor change support is not yet implemented. |
|
|
917 | |
|
|
918 | Click-and-drag doesn't work with X11 mouse report overriding. |
|
|
919 | |
1227 | |
920 | CURRENT PROJECT COORDINATOR |
1228 | CURRENT PROJECT COORDINATOR |
921 | Project Coordinator |
1229 | Project Coordinator |
922 | Marc A. Lehmann rxvt@schmorp.de |
1230 | Marc A. Lehmann <rxvt-unicode@schmorp.de> |
923 | |
1231 | |
924 | Web page maintainter |
|
|
925 | Marc A. Lehmann rxvt@schmorp.de |
|
|
926 | |
|
|
927 | <http://software.schmorp.de/> |
1232 | <http://software.schmorp.de/#rxvt-unicode> |
928 | |
1233 | |
929 | AUTHORS |
1234 | AUTHORS |
930 | John Bovey |
1235 | John Bovey |
931 | University of Kent, 1992, wrote the original Xvt. |
1236 | University of Kent, 1992, wrote the original Xvt. |
932 | |
1237 | |
… | |
… | |
946 | |
1251 | |
947 | Geoff Wing <gcw@pobox.com> |
1252 | Geoff Wing <gcw@pobox.com> |
948 | Rewrote screen display and text selection routines. Project |
1253 | Rewrote screen display and text selection routines. Project |
949 | Coordinator (changes.txt 2.4.6 - rxvt-unicode) |
1254 | Coordinator (changes.txt 2.4.6 - rxvt-unicode) |
950 | |
1255 | |
951 | Marc Alexander Lehmann <rxvt@schmorp.de> |
1256 | Marc Alexander Lehmann <rxvt-unicode@schmorp.de> |
952 | Forked rxvt-unicode, rewrote most of the display code and internal |
1257 | Forked rxvt-unicode, rewrote most of the display code and internal |
953 | character handling to store text in unicode, improve xterm |
1258 | character handling to store text in unicode, improve xterm |
954 | compatibility and apply numerous other bugfixes and extensions. |
1259 | compatibility and apply numerous other bugfixes and extensions. |
955 | |
1260 | |
956 | Project Coordinator (Changes 1.0 -) |
1261 | Project Coordinator (Changes 1.0 -) |