… | |
… | |
28 | world. Being a terminal emulator, however, some things are very difficult, |
28 | world. Being a terminal emulator, however, some things are very difficult, |
29 | especially cursive scripts such as arabic, vertically written scripts |
29 | especially cursive scripts such as arabic, vertically written scripts |
30 | like mongolian or scripts requiring extremely complex combining rules, |
30 | like mongolian or scripts requiring extremely complex combining rules, |
31 | like tibetan or devenagari. Don't expect pretty output when using these |
31 | like tibetan or devenagari. Don't expect pretty output when using these |
32 | scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work |
32 | scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work |
33 | fine, though. A somewhat difficult case are left-to-right scripts, such |
33 | fine, though. A somewhat difficult case are right-to-left scripts, such |
34 | as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms |
34 | as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms |
35 | belong into the application, not the terminal emulator (too many things -- |
35 | belong into the application, not the terminal emulator (too many things -- |
36 | such as cursor-movement while editing -- break otherwise), but that might |
36 | such as cursor-movement while editing -- break otherwise), but that might |
37 | change. |
37 | change. |
38 | |
38 | |
39 | If you are looking for a terminal that supports more exotic scripts, let |
39 | If you are looking for a terminal that supports more exotic scripts, let |
40 | me recommend C<mlterm>, which is a very userfriendly, lean and clean |
40 | me recommend C<mlterm>, which is a very user friendly, lean and clean |
41 | terminal emulator. In fact, the reason rxvt-unicode was born was solely |
41 | terminal emulator. In fact, the reason rxvt-unicode was born was solely |
42 | because the author couldn't get C<mlterm> to use one font for latin1 and |
42 | because the author couldn't get C<mlterm> to use one font for latin1 and |
43 | another for japanese. |
43 | another for japanese. |
44 | |
44 | |
45 | Therefore another design rationale was the use of multiple fonts to |
45 | Therefore another design rationale was the use of multiple fonts to |
46 | display characters: The idea of a single unicode font which many other |
46 | display characters: The idea of a single unicode font which many other |
47 | programs force onto it's users never made sense to me: You should be able |
47 | programs force onto its users never made sense to me: You should be able |
48 | to choose any font for any script freely. |
48 | to choose any font for any script freely. |
49 | |
49 | |
50 | Apart from that, rxvt-unicode is also much better internationalised than |
50 | Apart from that, rxvt-unicode is also much better internationalised than |
51 | it's predecessor, supports things such as XFT and ISO 14755 that are handy |
51 | its predecessor, supports things such as XFT and ISO 14755 that are handy |
52 | in i18n-environments, is faster, and has a lot less bugs than the original |
52 | in i18n-environments, is faster, and has a lot bugs less than the original |
53 | rxvt. This all in addition to dozens of other small improvements. |
53 | rxvt. This all in addition to dozens of other small improvements. |
54 | |
54 | |
55 | It is still faithfully following the original rxvt idea of being lean |
55 | It is still faithfully following the original rxvt idea of being lean |
56 | and nice on resources: for example, you can still configure rxvt-unicode |
56 | and nice on resources: for example, you can still configure rxvt-unicode |
57 | without most of it's features to get a lean binary. It also comes with |
57 | without most of its features to get a lean binary. It also comes with |
58 | a client/daemon pair that lets you open any number of terminal windows |
58 | a client/daemon pair that lets you open any number of terminal windows |
59 | from within a single process, which makes startup time very fast and |
59 | from within a single process, which makes startup time very fast and |
60 | drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and |
60 | drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and |
61 | @@RXVT_NAME@@c(1) (client). |
61 | @@RXVT_NAME@@c(1) (client). |
62 | |
62 | |
63 | It also makes technical information about escape sequences (which have |
63 | It also makes technical information about escape sequences (which have |
64 | been extended) easier accessible: see @@RXVT_NAME@@(7) for technical |
64 | been extended) more accessible: see @@RXVT_NAME@@(7) for technical |
65 | reference documentation (escape sequences etc.). |
65 | reference documentation (escape sequences etc.). |
66 | |
66 | |
67 | =head1 OPTIONS |
67 | =head1 OPTIONS |
68 | |
68 | |
69 | The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed |
69 | The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed |
… | |
… | |
93 | |
93 | |
94 | Attempt to open a window on the named X display (B<-d> still |
94 | Attempt to open a window on the named X display (B<-d> still |
95 | respected). In the absence of this option, the display specified by the |
95 | respected). In the absence of this option, the display specified by the |
96 | B<DISPLAY> environment variable is used. |
96 | B<DISPLAY> environment variable is used. |
97 | |
97 | |
|
|
98 | =item B<-depth> I<bitdepth> |
|
|
99 | |
|
|
100 | Compile I<xft>: Attempt to find a visual with the given bit depth; |
|
|
101 | resource B<depth>. |
|
|
102 | |
98 | =item B<-geometry> I<geom> |
103 | =item B<-geometry> I<geom> |
99 | |
104 | |
100 | Window geometry (B<-g> still respected); resource B<geometry>. |
105 | Window geometry (B<-g> still respected); resource B<geometry>. |
101 | |
106 | |
102 | =item B<-rv>|B<+rv> |
107 | =item B<-rv>|B<+rv> |
… | |
… | |
105 | |
110 | |
106 | =item B<-j>|B<+j> |
111 | =item B<-j>|B<+j> |
107 | |
112 | |
108 | Turn on/off jump scrolling; resource B<jumpScroll>. |
113 | Turn on/off jump scrolling; resource B<jumpScroll>. |
109 | |
114 | |
110 | =item B<-ip>|B<+ip> |
115 | =item B<-ip>|B<+ip> | B<-tr>|B<+tr> |
111 | |
116 | |
112 | Turn on/off inheriting parent window's pixmap. Alternative form is |
117 | Turn on/off inheriting parent window's pixmap. Alternative form is |
113 | B<-tr>; resource B<inheritPixmap>. |
118 | B<-tr>; resource B<inheritPixmap>. |
114 | |
119 | |
|
|
120 | I<Please note that transparency of any kind if completely unsupported by |
|
|
121 | the author. Don't bug him with installation questions! Read the FAQ (man 7 |
|
|
122 | @@RXVT_NAME@@)!> |
|
|
123 | |
115 | =item B<-fade> I<number> |
124 | =item B<-fade> I<number> |
116 | |
125 | |
117 | Fade the text by the given percentage when focus is lost. resource B<fading>. |
126 | Fade the text by the given percentage when focus is lost. Small values |
|
|
127 | fade a little only, 100 completely replaces all colours by the fade |
|
|
128 | colour; resource B<fading>. |
|
|
129 | |
|
|
130 | =item B<-fadecolor> I<colour> |
|
|
131 | |
|
|
132 | Fade to this colour when fading is used (see B<-fade>). The default colour |
|
|
133 | is opaque black. resource B<fadeColor>. |
118 | |
134 | |
119 | =item B<-tint> I<colour> |
135 | =item B<-tint> I<colour> |
120 | |
136 | |
121 | Tint the transparent background pixmap with the given colour when |
137 | Tint the transparent background pixmap with the given colour when |
122 | transparency is enabled with B<-tr> or B<-ip>. See also the B<-sh> |
138 | transparency is enabled with B<-tr> or B<-ip>. This only works for |
123 | option that can be used to brighten or darken the image in addition to |
139 | non-tiled backgrounds, currently. See also the B<-sh> option that can be |
124 | tinting it. |
140 | used to brighten or darken the image in addition to tinting it; resource |
|
|
141 | I<tintColor>. Example: |
|
|
142 | |
|
|
143 | @@RXVT_NAME@@ -tr -tint blue -sh 40 |
125 | |
144 | |
126 | =item B<-sh> |
145 | =item B<-sh> |
127 | |
146 | |
128 | I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent |
147 | I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent |
129 | background image in addition to tinting it (i.e. B<-tint> must be |
148 | background image in addition to tinting it (i.e. B<-tint> must be |
… | |
… | |
162 | resource B<borderColor>. |
181 | resource B<borderColor>. |
163 | |
182 | |
164 | =item B<-fn> I<fontlist> |
183 | =item B<-fn> I<fontlist> |
165 | |
184 | |
166 | Select the fonts to be used. This is a comma separated list of font names |
185 | Select the fonts to be used. This is a comma separated list of font names |
167 | that are used in turn when trying to display Unicode characters. The |
186 | that are checked in order when trying to find glyphs for characters. The |
168 | first font defines the cell size for characters; other fonts might be |
187 | first font defines the cell size for characters; other fonts might be |
169 | smaller, but not (in general) larger. A (hopefully) reasonable default |
188 | smaller, but not (in general) larger. A (hopefully) reasonable default |
170 | font list is always appended to it. See resource B<font> for more details. |
189 | font list is always appended to it. See resource B<font> for more details. |
171 | |
190 | |
172 | In short, to specify an X11 core font, just specify it's name or prefix it |
191 | In short, to specify an X11 core font, just specify its name or prefix it |
173 | with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>, |
192 | with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>, |
174 | e.g.: |
193 | e.g.: |
175 | |
194 | |
176 | @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" |
195 | @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" |
177 | @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono" |
196 | @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono" |
… | |
… | |
179 | See also the question "How does rxvt-unicode choose fonts?" in the FAQ |
198 | See also the question "How does rxvt-unicode choose fonts?" in the FAQ |
180 | section of @@RXVT_NAME@@(7). |
199 | section of @@RXVT_NAME@@(7). |
181 | |
200 | |
182 | =item B<-fb> I<fontlist> |
201 | =item B<-fb> I<fontlist> |
183 | |
202 | |
184 | Compile font-styles: The bold font list to use when bold characters are to |
203 | Compile I<font-styles>: The bold font list to use when B<bold> characters |
185 | be printed. See resource B<boldFont> for details. |
204 | are to be printed. See resource B<boldFont> for details. |
186 | |
205 | |
187 | =item B<-fi> I<fontlist> |
206 | =item B<-fi> I<fontlist> |
188 | |
207 | |
189 | Compile font-styles: The italic font list to use when bold characters are to |
208 | Compile I<font-styles>: The italic font list to use when I<italic> |
190 | be printed. See resource B<italicFont> for details. |
209 | characters are to be printed. See resource B<italicFont> for details. |
191 | |
210 | |
192 | =item B<-fbi> I<fontlist> |
211 | =item B<-fbi> I<fontlist> |
193 | |
212 | |
194 | Compile font-styles: The bold italic font list to use when bold characters are to |
213 | Compile I<font-styles>: The bold italic font list to use when B<< I<bold |
195 | be printed. See resource B<boldItalicFont> for details. |
214 | italic> >> characters are to be printed. See resource B<boldItalicFont> |
|
|
215 | for details. |
|
|
216 | |
|
|
217 | =item B<-is>|B<+is> |
|
|
218 | |
|
|
219 | Compile I<font-styles>: Bold/Italic font styles imply high intensity |
|
|
220 | foreground/background (default). See resource B<intensityStyles> for |
|
|
221 | details. |
196 | |
222 | |
197 | =item B<-name> I<name> |
223 | =item B<-name> I<name> |
198 | |
224 | |
199 | Specify the application name under which resources are to be obtained, |
225 | Specify the application name under which resources are to be obtained, |
200 | rather than the default executable file name. Name should not contain |
226 | rather than the default executable file name. Name should not contain |
… | |
… | |
238 | |
264 | |
239 | Put scrollbar on right/left; resource B<scrollBar_right>. |
265 | Put scrollbar on right/left; resource B<scrollBar_right>. |
240 | |
266 | |
241 | =item B<-st>|B<+st> |
267 | =item B<-st>|B<+st> |
242 | |
268 | |
243 | Display normal (non XTerm/NeXT) scrollbar without/with a trough; |
269 | Display rxvt (non XTerm/NeXT) scrollbar without/with a trough; |
244 | resource B<scrollBar_floating>. |
270 | resource B<scrollBar_floating>. |
245 | |
271 | |
246 | =item B<-ptab>|B<+ptab> |
272 | =item B<-ptab>|B<+ptab> |
247 | |
273 | |
248 | If enabled (default), "Horizontal Tab" characters are being stored as |
274 | If enabled (default), "Horizontal Tab" characters are being stored as |
… | |
… | |
279 | =item B<-bl> |
305 | =item B<-bl> |
280 | |
306 | |
281 | Compile I<frills>: Set MWM hints to request a borderless window, i.e. |
307 | Compile I<frills>: Set MWM hints to request a borderless window, i.e. |
282 | if honoured by the WM, the rxvt-unicode window will not have window |
308 | if honoured by the WM, the rxvt-unicode window will not have window |
283 | decorations; resource B<borderLess>. |
309 | decorations; resource B<borderLess>. |
|
|
310 | |
|
|
311 | =item B<-override-redirect> |
|
|
312 | |
|
|
313 | Compile I<frills>: Sets override-redirect on the window; resource |
|
|
314 | B<override-redirect>. |
|
|
315 | |
|
|
316 | =item B<-sbg> |
|
|
317 | |
|
|
318 | Compile I<frills>: Disable the usage of the built-in block graphics/line |
|
|
319 | drawing characters and just rely on what the specified fonts provide. Use |
|
|
320 | this if you have a good font and want to use its block graphic glyphs; |
|
|
321 | resource B<skipBuiltinGlyphs>. |
284 | |
322 | |
285 | =item B<-lsp> I<number> |
323 | =item B<-lsp> I<number> |
286 | |
324 | |
287 | Compile I<frills>: Lines (pixel height) to insert between each row of |
325 | Compile I<frills>: Lines (pixel height) to insert between each row of |
288 | the display. Useful to work around font rendering problems; resource |
326 | the display. Useful to work around font rendering problems; resource |
… | |
… | |
303 | given on the command line. If this option is used, it must be the last |
341 | given on the command line. If this option is used, it must be the last |
304 | on the command-line. If there is no B<-e> option then the default is to |
342 | on the command-line. If there is no B<-e> option then the default is to |
305 | run the program specified by the B<SHELL> environment variable or, |
343 | run the program specified by the B<SHELL> environment variable or, |
306 | failing that, I<sh(1)>. |
344 | failing that, I<sh(1)>. |
307 | |
345 | |
|
|
346 | Please note that you must specify a program with arguments. If you want to |
|
|
347 | run shell commands, you have to specify the shell, like this: |
|
|
348 | |
|
|
349 | @@RXVT_NAME@@ -e sh -c "shell commands" |
|
|
350 | |
308 | =item B<-title> I<text> |
351 | =item B<-title> I<text> |
309 | |
352 | |
310 | Window title (B<-T> still respected); the default title is the basename |
353 | Window title (B<-T> still respected); the default title is the basename |
311 | of the program specified after the B<-e> option, if any, otherwise the |
354 | of the program specified after the B<-e> option, if any, otherwise the |
312 | application name; resource B<title>. |
355 | application name; resource B<title>. |
… | |
… | |
368 | =item B<-ssr>|B<+ssr> |
411 | =item B<-ssr>|B<+ssr> |
369 | |
412 | |
370 | Turn on/off secondary screen scroll (default enabled); resource |
413 | Turn on/off secondary screen scroll (default enabled); resource |
371 | B<secondaryScroll>. |
414 | B<secondaryScroll>. |
372 | |
415 | |
|
|
416 | =item B<-hold>|B<+hold> |
|
|
417 | |
|
|
418 | Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ |
|
|
419 | will not immediately destroy its window when the program executed within |
|
|
420 | it exits. Instead, it will wait till it is being killed or closed by the |
|
|
421 | user; resource B<hold>. |
|
|
422 | |
373 | =item B<-keysym.>I<sym>: I<string> |
423 | =item B<-keysym.>I<sym> I<string> |
374 | |
424 | |
375 | Remap a key symbol. See resource B<keysym>. |
425 | Remap a key symbol. See resource B<keysym>. |
376 | |
426 | |
377 | =item B<-embed>: I<windowid> |
427 | =item B<-embed> I<windowid> |
378 | |
428 | |
379 | Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window, |
429 | Tells @@RXVT_NAME@@ to embed its windows into an already-existing window, |
380 | which enables applications to easily embed a terminal. |
430 | which enables applications to easily embed a terminal. |
381 | |
431 | |
382 | Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it |
432 | Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it |
383 | shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it |
433 | shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it |
384 | quite a bit, so don't expect it to keep some specific state. It's best to |
434 | quite a bit, so don't expect it to keep some specific state. It's best to |
… | |
… | |
387 | The window will not be destroyed when @@RXVT_NAME@@ exits. |
437 | The window will not be destroyed when @@RXVT_NAME@@ exits. |
388 | |
438 | |
389 | It might be useful to know that @@RXVT_NAME@@ will not close file |
439 | It might be useful to know that @@RXVT_NAME@@ will not close file |
390 | descriptors passed to it (except for stdin/out/err, of course), so you |
440 | descriptors passed to it (except for stdin/out/err, of course), so you |
391 | can use file descriptors to communicate with the programs within the |
441 | can use file descriptors to communicate with the programs within the |
392 | terminal. This works regardless of wether the C<-embed> option was used or |
442 | terminal. This works regardless of whether the C<-embed> option was used or |
393 | not. |
443 | not. |
|
|
444 | |
|
|
445 | Here is a short Gtk2-perl snippet that illustrates how this option can be |
|
|
446 | used (a longer example is in F<doc/embed>): |
|
|
447 | |
|
|
448 | my $rxvt = new Gtk2::Socket; |
|
|
449 | $rxvt->signal_connect_after (realize => sub { |
|
|
450 | my $xid = $_[0]->window->get_xid; |
|
|
451 | system "@@RXVT_NAME@@ -embed $xid &"; |
|
|
452 | }); |
|
|
453 | |
|
|
454 | =item B<-pty-fd> I<file descriptor> |
|
|
455 | |
|
|
456 | Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty |
|
|
457 | pair but instead use the given file descriptor as the tty master. This is |
|
|
458 | useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator |
|
|
459 | without having to run a program within it. |
|
|
460 | |
|
|
461 | If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp |
|
|
462 | entries and will not tinker with pty/tty permissions - you have to do that |
|
|
463 | yourself if you want that. |
|
|
464 | |
|
|
465 | As an extremely special case, specifying C<-1> will completely suppress |
|
|
466 | pty/tty operations. |
|
|
467 | |
|
|
468 | Here is a example in perl that illustrates how this option can be used (a |
|
|
469 | longer example is in F<doc/pty-fd>): |
|
|
470 | |
|
|
471 | use IO::Pty; |
|
|
472 | use Fcntl; |
|
|
473 | |
|
|
474 | my $pty = new IO::Pty; |
|
|
475 | fcntl $pty, F_SETFD, 0; # clear close-on-exec |
|
|
476 | system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&"; |
|
|
477 | close $pty; |
|
|
478 | |
|
|
479 | # now communicate with rxvt |
|
|
480 | my $slave = $pty->slave; |
|
|
481 | while (<$slave>) { print $slave "got <$_>\n" } |
|
|
482 | |
|
|
483 | =item B<-pe> I<string> |
|
|
484 | |
|
|
485 | Comma-separated list of perl extension scripts to use (or not to use) in |
|
|
486 | this terminal instance. See resource B<perl-ext> for details. |
394 | |
487 | |
395 | =back |
488 | =back |
396 | |
489 | |
397 | =head1 RESOURCES (available also as long-options) |
490 | =head1 RESOURCES (available also as long-options) |
398 | |
491 | |
399 | Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long |
492 | Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long |
400 | options) compiled into your version. |
493 | options) compiled into your version. |
401 | |
494 | |
402 | There are two different methods that @@RXVT_NAME@@ can use to get the |
495 | You can set and change the resources using X11 tools like B<xrdb>. Many |
403 | Xresource data: using the X libraries (Xrm*-functions) or internal |
496 | distribution do also load settings from the B<~/.Xresources> file when X |
404 | Xresources reader (B<~/.Xdefaults>). For the first method (ie. |
497 | starts. @@RXVT_NAME@@ will consult the following files/resources in order, |
405 | B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the |
498 | with later settings overwriting earlier ones: |
406 | resources using X11 tools like B<xrdb>. Many distribution do also load |
|
|
407 | settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@ |
|
|
408 | will consult the following files/resources in order, with later settings |
|
|
409 | overwriting earlier ones: |
|
|
410 | |
499 | |
411 | 1. system-wide app-defaults file, either locale-dependent OR global |
500 | 1. system-wide app-defaults file, either locale-dependent OR global |
412 | 2. app-defaults file in $XAPPLRESDIR |
501 | 2. app-defaults file in $XAPPLRESDIR |
413 | 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults |
502 | 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults |
414 | 4. SCREEN_RESOURCES for the current screen |
503 | 4. SCREEN_RESOURCES for the current screen |
415 | 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> |
504 | 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> |
416 | |
505 | |
417 | If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h> |
|
|
418 | lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults |
|
|
419 | set in XAPPLOADDIR/URxvt (compile-time defined: usually |
|
|
420 | B</usr/lib/X11/app-defaults/URxvt>) and resources set in |
|
|
421 | B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist. |
|
|
422 | Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two |
506 | Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class |
423 | class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows |
507 | names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources |
424 | resources common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be |
508 | common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily |
425 | easily configured, while the class name B<URxvt> allows resources |
509 | configured, while the class name B<URxvt> allows resources unique to |
426 | unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be |
510 | B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@> |
427 | shared between different B<@@RXVT_NAME@@> configurations. If no |
511 | configurations. If no resources are specified, suitable defaults will |
428 | resources are specified, suitable defaults will be used. Command-line |
512 | be used. Command-line arguments can be used to override resource |
429 | arguments can be used to override resource settings. The following |
513 | settings. The following resources are supported (you might want to |
430 | resources are allowed: |
514 | check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl |
|
|
515 | extensions not documented here): |
431 | |
516 | |
432 | =over 4 |
517 | =over 4 |
|
|
518 | |
|
|
519 | =item B<depth:> I<bitdepth> |
|
|
520 | |
|
|
521 | Compile I<xft>: Attempt to find a visual with the given bit depth; |
|
|
522 | option B<-depth>. |
433 | |
523 | |
434 | =item B<geometry:> I<geom> |
524 | =item B<geometry:> I<geom> |
435 | |
525 | |
436 | Create the window with the specified X window geometry [default 80x24]; |
526 | Create the window with the specified X window geometry [default 80x24]; |
437 | option B<-geometry>. |
527 | option B<-geometry>. |
… | |
… | |
511 | |
601 | |
512 | B<True>: make the background inherit the parent windows' pixmap, giving |
602 | B<True>: make the background inherit the parent windows' pixmap, giving |
513 | artificial transparency. B<False>: do not inherit the parent windows' |
603 | artificial transparency. B<False>: do not inherit the parent windows' |
514 | pixmap. |
604 | pixmap. |
515 | |
605 | |
|
|
606 | I<Please note that transparency of any kind if completely unsupported by |
|
|
607 | the author. Don't bug him with installation questions!> |
|
|
608 | |
516 | =item B<fading:> I<number> |
609 | =item B<fading:> I<number> |
517 | |
610 | |
518 | Fade the text by the given percentage when focus is lost. |
611 | Fade the text by the given percentage when focus is lost; option B<-fade>. |
|
|
612 | |
|
|
613 | =item B<fadeColor:> I<colour> |
|
|
614 | |
|
|
615 | Fade to this colour, when fading is used (see B<fading:>). The default |
|
|
616 | colour is black; option B<-fadecolor>. |
519 | |
617 | |
520 | =item B<tintColor:> I<colour> |
618 | =item B<tintColor:> I<colour> |
521 | |
619 | |
522 | Tint the transparent background pixmap with the given colour. |
620 | Tint the transparent background pixmap with the given colour; option |
|
|
621 | B<-tint>. |
523 | |
622 | |
524 | =item B<shading:> I<number> |
623 | =item B<shading:> I<number> |
525 | |
624 | |
526 | Darken (0 .. 100) or lighten (-1 .. -100) the transparent background |
625 | Darken (0 .. 100) or lighten (-1 .. -100) the transparent background |
527 | image in addition to tinting it. |
626 | image in addition to tinting it. |
… | |
… | |
531 | Use the specified colour for the scrollbar [default #B2B2B2]. |
630 | Use the specified colour for the scrollbar [default #B2B2B2]. |
532 | |
631 | |
533 | =item B<troughColor:> I<colour> |
632 | =item B<troughColor:> I<colour> |
534 | |
633 | |
535 | Use the specified colour for the scrollbar's trough area [default |
634 | Use the specified colour for the scrollbar's trough area [default |
536 | #969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. |
635 | #969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar. |
537 | |
636 | |
538 | =item B<borderColor:> I<colour> |
637 | =item B<borderColor:> I<colour> |
539 | |
638 | |
540 | The colour of the border around the text area and between the scrollbar |
639 | The colour of the border around the text area and between the scrollbar |
541 | and the text. |
640 | and the text. |
… | |
… | |
550 | of 1 displays the image without any scaling. A scale of 2 to 9 |
649 | of 1 displays the image without any scaling. A scale of 2 to 9 |
551 | specifies an integer number of images in that direction. No image will |
650 | specifies an integer number of images in that direction. No image will |
552 | be magnified beyond 10 times its original size. The maximum permitted |
651 | be magnified beyond 10 times its original size. The maximum permitted |
553 | scale is 1000. [default 0x0+50+50] |
652 | scale is 1000. [default 0x0+50+50] |
554 | |
653 | |
555 | =item B<menu:> I<file[;tag]> |
|
|
556 | |
|
|
557 | Read in the specified menu file (note the `.menu' extension is |
|
|
558 | optional) and also optionally specify a starting tag to find. See the |
|
|
559 | reference documentation for details on the syntax for the menuBar. |
|
|
560 | |
|
|
561 | =item B<path:> I<path> |
654 | =item B<path:> I<path> |
562 | |
655 | |
563 | Specify the colon-delimited search path for finding files (XPM and |
656 | Specify the colon-delimited search path for finding XPM files. |
564 | menus), in addition to the paths specified by the B<RXVTPATH> and |
|
|
565 | B<PATH> environment variables. |
|
|
566 | |
657 | |
567 | =item B<font:> I<fontlist> |
658 | =item B<font:> I<fontlist> |
568 | |
659 | |
569 | Select the fonts to be used. This is a comma separated list of font |
660 | Select the fonts to be used. This is a comma separated list of font names |
570 | names that are used in turn when trying to display Unicode characters. |
661 | that are checked in order when trying to find glyphs for characters. The |
571 | The first font defines the cell size for characters; other fonts might |
662 | first font defines the cell size for characters; other fonts might be |
572 | be smaller, but not larger. A reasonable default font list is always |
663 | smaller, but not (in general) larger. A (hopefully) reasonable default |
573 | appended to it. option B<-fn>. |
664 | font list is always appended to it; option B<-fn>. |
574 | |
665 | |
575 | Each font can either be a standard X11 core font (XLFD) name, with |
666 | Each font can either be a standard X11 core font (XLFD) name, with |
576 | optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>. |
667 | optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>. |
577 | |
668 | |
578 | In addition, each font can be prefixed with additional hints and |
669 | In addition, each font can be prefixed with additional hints and |
… | |
… | |
580 | hint currently is C<codeset=codeset-name>, and this is only used for Xft |
671 | hint currently is C<codeset=codeset-name>, and this is only used for Xft |
581 | fonts. |
672 | fonts. |
582 | |
673 | |
583 | For example, this font resource |
674 | For example, this font resource |
584 | |
675 | |
585 | URxvt*font: 9x15bold,\ |
676 | URxvt.font: 9x15bold,\ |
586 | -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\ |
677 | -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\ |
587 | -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \ |
678 | -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \ |
588 | [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ |
679 | [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ |
589 | xft:Code2000:antialias=false |
680 | xft:Code2000:antialias=false |
590 | |
681 | |
… | |
… | |
624 | not possible, replacement fonts of the desired shape will be tried. |
715 | not possible, replacement fonts of the desired shape will be tried. |
625 | |
716 | |
626 | If set, but empty, then this specific style is disabled and the normal |
717 | If set, but empty, then this specific style is disabled and the normal |
627 | text font will being used for the given style. |
718 | text font will being used for the given style. |
628 | |
719 | |
|
|
720 | =item B<intensityStyles:> I<boolean> |
|
|
721 | |
|
|
722 | When font styles are not enabled, or this option is enabled (B<True>, |
|
|
723 | option B<-is>, the default), bold and italic font styles imply high |
|
|
724 | intensity foreground/background colours. Disabling this option (B<False>, |
|
|
725 | option B<+is>) disables this behaviour, the high intensity colours are not |
|
|
726 | reachable. |
|
|
727 | |
629 | =item B<selectstyle:> I<mode> |
728 | =item B<selectstyle:> I<mode> |
630 | |
729 | |
631 | Set mouse selection style to B<old> which is 2.20, B<oldword> which is |
730 | Set mouse selection style to B<old> which is 2.20, B<oldword> which is |
632 | xterm style with 2.20 old word selection, or anything else which gives |
731 | xterm style with 2.20 old word selection, or anything else which gives |
633 | xterm style selection. |
732 | xterm style selection. |
634 | |
733 | |
635 | =item B<scrollstyle:> I<mode> |
734 | =item B<scrollstyle:> I<mode> |
636 | |
735 | |
637 | Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is |
736 | Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is |
638 | the author's favourite.. |
737 | the author's favourite. |
639 | |
738 | |
640 | =item B<title:> I<string> |
739 | =item B<title:> I<string> |
641 | |
740 | |
642 | Set window title string, the default title is the command-line |
741 | Set window title string, the default title is the command-line |
643 | specified after the B<-e> option, if any, otherwise the application |
742 | specified after the B<-e> option, if any, otherwise the application |
… | |
… | |
675 | |
774 | |
676 | Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use |
775 | Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use |
677 | B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or |
776 | B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or |
678 | B<Shift-Print> to include the scrollback as well. |
777 | B<Shift-Print> to include the scrollback as well. |
679 | |
778 | |
|
|
779 | The string will be interpreted as if typed into the shell as-is. |
|
|
780 | |
|
|
781 | Example: |
|
|
782 | |
|
|
783 | URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) |
|
|
784 | |
|
|
785 | This creates a new file in your home directory with the screen contents |
|
|
786 | every time you hit C<Print>. |
|
|
787 | |
680 | =item B<scrollBar:> I<boolean> |
788 | =item B<scrollBar:> I<boolean> |
681 | |
789 | |
682 | B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: |
790 | B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: |
683 | disable the scrollbar; option B<+sb>. |
791 | disable the scrollbar; option B<+sb>. |
684 | |
792 | |
… | |
… | |
704 | B<+si>. |
812 | B<+si>. |
705 | |
813 | |
706 | =item B<scrollWithBuffer:> I<boolean> |
814 | =item B<scrollWithBuffer:> I<boolean> |
707 | |
815 | |
708 | B<True>: scroll with scrollback buffer when tty receives new lines (and |
816 | B<True>: scroll with scrollback buffer when tty receives new lines (and |
709 | B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll |
817 | B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll |
710 | with scrollback buffer when tty recieves new lines; option B<-sw>. |
818 | with scrollback buffer when tty receives new lines; option B<+sw>. |
711 | |
819 | |
712 | =item B<scrollTtyKeypress:> I<boolean> |
820 | =item B<scrollTtyKeypress:> I<boolean> |
713 | |
821 | |
714 | B<True>: scroll to bottom when a non-special key is pressed. Special keys |
822 | B<True>: scroll to bottom when a non-special key is pressed. Special keys |
715 | are those which are intercepted by rxvt-unicode for special handling and |
823 | are those which are intercepted by rxvt-unicode for special handling and |
… | |
… | |
734 | =item B<borderLess:> I<boolean> |
842 | =item B<borderLess:> I<boolean> |
735 | |
843 | |
736 | Set MWM hints to request a borderless window, i.e. if honoured by the |
844 | Set MWM hints to request a borderless window, i.e. if honoured by the |
737 | WM, the rxvt-unicode window will not have window decorations; option B<-bl>. |
845 | WM, the rxvt-unicode window will not have window decorations; option B<-bl>. |
738 | |
846 | |
|
|
847 | =item B<skipBuiltinGlyphs:> I<boolean> |
|
|
848 | |
|
|
849 | Compile I<frills>: Disable the usage of the built-in block graphics/line |
|
|
850 | drawing characters and just rely on what the specified fonts provide. Use |
|
|
851 | this if you have a good font and want to use its block graphic glyphs; |
|
|
852 | option B<-sbg>. |
|
|
853 | |
739 | =item B<termName:> I<termname> |
854 | =item B<termName:> I<termname> |
740 | |
855 | |
741 | Specifies the terminal type name to be set in the B<TERM> environment |
856 | Specifies the terminal type name to be set in the B<TERM> environment |
742 | variable; option B<-tn>. |
857 | variable; option B<-tn>. |
743 | |
858 | |
… | |
… | |
780 | |
895 | |
781 | Mouse pointer background colour. |
896 | Mouse pointer background colour. |
782 | |
897 | |
783 | =item B<pointerBlankDelay:> I<number> |
898 | =item B<pointerBlankDelay:> I<number> |
784 | |
899 | |
785 | Specifies number of seconds before blanking the pointer [default 2]. |
900 | Specifies number of seconds before blanking the pointer [default 2]. Use a |
|
|
901 | large number (e.g. C<987654321>) to effectively disable the timeout. |
786 | |
902 | |
787 | =item B<backspacekey:> I<string> |
903 | =item B<backspacekey:> I<string> |
788 | |
904 | |
789 | The string to send when the backspace key is pressed. If set to B<DEC> |
905 | The string to send when the backspace key is pressed. If set to B<DEC> |
790 | or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace> |
906 | or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace> |
… | |
… | |
797 | pressed. If unset it will send the sequence traditionally associated |
913 | pressed. If unset it will send the sequence traditionally associated |
798 | with the B<Execute> key. |
914 | with the B<Execute> key. |
799 | |
915 | |
800 | =item B<cutchars:> I<string> |
916 | =item B<cutchars:> I<string> |
801 | |
917 | |
802 | The characters used as delimiters for double-click word selection. The |
918 | The characters used as delimiters for double-click word selection |
803 | built-in default: |
919 | (whitespace delimiting is added automatically if resource is given). |
|
|
920 | |
|
|
921 | When the selection extension is in use (the default if compiled in, see |
|
|
922 | the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these characters |
|
|
923 | will be created (if the resource exists, otherwise, no regex will be |
|
|
924 | created). In this mode, characters outside ISO-8859-1 can be used. |
|
|
925 | |
|
|
926 | When the selection extension is not used, only ISO-8859-1 characters can |
|
|
927 | be used. If not specified, the built-in default is used: |
804 | |
928 | |
805 | B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> |
929 | B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> |
806 | |
930 | |
807 | =item B<preeditType:> I<style> |
931 | =item B<preeditType:> I<style> |
808 | |
932 | |
… | |
… | |
815 | =item B<imLocale:> I<name> |
939 | =item B<imLocale:> I<name> |
816 | |
940 | |
817 | The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g. |
941 | The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g. |
818 | C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the |
942 | C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the |
819 | input extension to be able to input japanese characters while staying in |
943 | input extension to be able to input japanese characters while staying in |
820 | another locale. option B<-imlocale>. |
944 | another locale; option B<-imlocale>. |
821 | |
945 | |
822 | =item B<imFont:> I<fontset> |
946 | =item B<imFont:> I<fontset> |
823 | |
947 | |
824 | Specify the font-set used for XIM styles C<OverTheSpot> or |
948 | Specify the font-set used for XIM styles C<OverTheSpot> or |
825 | C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated |
949 | C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated |
… | |
… | |
830 | |
954 | |
831 | =item B<tripleclickwords:> I<boolean> |
955 | =item B<tripleclickwords:> I<boolean> |
832 | |
956 | |
833 | Change the meaning of triple-click selection with the left mouse |
957 | Change the meaning of triple-click selection with the left mouse |
834 | button. Instead of selecting a full line it will extend the selection to |
958 | button. Instead of selecting a full line it will extend the selection to |
835 | the end of the logical line only. option B<-tcw>. |
959 | the end of the logical line only; option B<-tcw>. |
836 | |
960 | |
837 | =item B<insecure:> I<boolean> |
961 | =item B<insecure:> I<boolean> |
838 | |
962 | |
839 | Enables "insecure" mode. Rxvt-unicode offers some escape sequences that |
963 | Enables "insecure" mode. Rxvt-unicode offers some escape sequences that |
840 | echo arbitrary strings like the icon name or the locale. This could be |
964 | echo arbitrary strings like the icon name or the locale. This could be |
841 | abused if somebody gets 8-bit-clean access to your display, whether |
965 | abused if somebody gets 8-bit-clean access to your display, whether |
842 | throuh a mail client displaying mail bodies unfiltered or though |
966 | through a mail client displaying mail bodies unfiltered or through |
843 | write(1). Therefore, these sequences are disabled by default. (Note |
967 | write(1) or any other means. Therefore, these sequences are disabled by |
844 | that other terminals, including xterm, have these sequences |
968 | default. (Note that many other terminals, including xterm, have these |
845 | enabled by default). You can enable them by setting this boolean |
969 | sequences enabled by default, which doesn't make it safer, though). |
846 | resource or specifying B<-insecure> as an option. At the moment, this |
970 | |
847 | enabled display-answer, locale, findfont, icon label and window title |
971 | You can enable them by setting this boolean resource or specifying |
848 | requests as well as dynamic menubar dispatch. |
972 | B<-insecure> as an option. At the moment, this enables display-answer, |
|
|
973 | locale, findfont, icon label and window title requests. |
849 | |
974 | |
850 | =item B<modifier:> I<modifier> |
975 | =item B<modifier:> I<modifier> |
851 | |
976 | |
852 | Set the key to be interpreted as the Meta key to: B<alt>, B<meta>, |
977 | Set the key to be interpreted as the Meta key to: B<alt>, B<meta>, |
853 | B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option |
978 | B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option |
… | |
… | |
857 | |
982 | |
858 | Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E) |
983 | Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E) |
859 | character is passed through. It may contain escape values as described |
984 | character is passed through. It may contain escape values as described |
860 | in the entry on B<keysym> following. |
985 | in the entry on B<keysym> following. |
861 | |
986 | |
862 | =item B<secondaryScreen:> I<bool> |
987 | =item B<secondaryScreen:> I<boolean> |
863 | |
988 | |
864 | Turn on/off secondary screen (default enabled). |
989 | Turn on/off secondary screen (default enabled). |
865 | |
990 | |
866 | =item B<secondaryScroll:> I<bool> |
991 | =item B<secondaryScroll:> I<boolean> |
867 | |
992 | |
868 | Turn on/off secondary screen scroll (default enabled). If the this |
993 | Turn on/off secondary screen scroll (default enabled). If the this |
869 | option is enabled, scrolls on the secondary screen will change the |
994 | option is enabled, scrolls on the secondary screen will change the |
870 | scrollback buffer and switching to/from the secondary screen will |
995 | scrollback buffer and switching to/from the secondary screen will |
871 | instead scroll the screen up. |
996 | instead scroll the screen up. |
|
|
997 | |
|
|
998 | =item B<hold>: I<boolean> |
|
|
999 | |
|
|
1000 | Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ |
|
|
1001 | will not immediately destroy its window when the program executed within |
|
|
1002 | it exits. Instead, it will wait till it is being killed or closed by the |
|
|
1003 | user. |
872 | |
1004 | |
873 | =item B<keysym.>I<sym>: I<string> |
1005 | =item B<keysym.>I<sym>: I<string> |
874 | |
1006 | |
875 | Compile I<frills>: Associate I<string> with keysym I<sym>. The |
1007 | Compile I<frills>: Associate I<string> with keysym I<sym>. The |
876 | intervening resource name B<keysym.> cannot be omitted. |
1008 | intervening resource name B<keysym.> cannot be omitted. |
… | |
… | |
894 | |
1026 | |
895 | I<string> may contain escape values (C<\a>: bell, C<\b>: backspace, |
1027 | I<string> may contain escape values (C<\a>: bell, C<\b>: backspace, |
896 | C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, |
1028 | C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, |
897 | C<\000>: octal number) or verbatim control characters (C<^?>: delete, |
1029 | C<\000>: octal number) or verbatim control characters (C<^?>: delete, |
898 | C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it |
1030 | C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it |
899 | can start or end with whitespace. |
1031 | can start or end with whitespace. B<This feature is deprecated and will |
|
|
1032 | be removed>. |
900 | |
1033 | |
901 | Please note that you need to double the C<\> when using |
1034 | Please note that you need to double the C<\> in resource files, as |
902 | C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can |
1035 | Xlib itself does its own de-escaping (you can use C<\033> instead of |
903 | use C<\033> instead of C<\e> (and so on), which will work with both Xt and |
1036 | C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own |
904 | @@RXVT_NAME@@'s own processing). |
1037 | processing). |
905 | |
1038 | |
906 | You can define a range of keysyms in one shot by providing a I<string> |
1039 | You can define a range of keysyms in one shot by providing a I<string> |
907 | with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' |
1040 | with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' |
908 | should be a character not used by the strings. |
1041 | should be a character not used by the strings. |
909 | |
1042 | |
910 | Its usage can be demonstrated by an example: |
1043 | Its usage can be demonstrated by an example: |
911 | |
1044 | |
912 | URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> |
1045 | URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> |
… | |
… | |
922 | example the following means "change the current locale to C<zh_CN.GBK> |
1055 | example the following means "change the current locale to C<zh_CN.GBK> |
923 | when Control-Meta-c is being pressed": |
1056 | when Control-Meta-c is being pressed": |
924 | |
1057 | |
925 | URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 |
1058 | URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 |
926 | |
1059 | |
|
|
1060 | If I<string> takes the form C<perl:STRING>, then the specified B<STRING> |
|
|
1061 | is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3) |
|
|
1062 | manpage. For example, the F<selection> extension (activated via |
|
|
1063 | C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events: |
|
|
1064 | |
|
|
1065 | URxvt.keysym.M-C-c: perl:selection:rot13 |
|
|
1066 | |
|
|
1067 | Due the the large number of modifier combinations, a defined key mapping |
|
|
1068 | will match if at I<at least> the specified identifiers are being set, and |
|
|
1069 | no other key mappings with those and more bits are being defined. That |
|
|
1070 | means that defining a key map for C<a> will automatically provide |
|
|
1071 | definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined |
|
|
1072 | mappings themselves. |
|
|
1073 | |
|
|
1074 | Unfortunately, this will override built-in key mappings. For example |
|
|
1075 | if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s |
|
|
1076 | C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the |
|
|
1077 | user-defined keymap using the C<builtin:> replacement: |
|
|
1078 | |
|
|
1079 | URxvt.keysym.Insert: <my insert key sequence> |
|
|
1080 | URxvt.keysym.S-Insert: builtin: |
|
|
1081 | |
|
|
1082 | The first line defines a mapping for C<Insert> and I<any> combination |
|
|
1083 | of modifiers. The second line re-establishes the default mapping for |
|
|
1084 | C<Shift-Insert>. |
|
|
1085 | |
927 | The following example will map Control-Meta-1 and Control-Meta-2 to |
1086 | The following example will map Control-Meta-1 and Control-Meta-2 to |
928 | the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited |
1087 | the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited |
929 | font-switching at runtime: |
1088 | font-switching at runtime: |
930 | |
1089 | |
931 | URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 |
1090 | URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 |
… | |
… | |
934 | Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more |
1093 | Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more |
935 | info): |
1094 | info): |
936 | |
1095 | |
937 | URxvt.keysym.M-C-3: command:\033[8;25;80t |
1096 | URxvt.keysym.M-C-3: command:\033[8;25;80t |
938 | URxvt.keysym.M-C-4: command:\033[8;48;110t |
1097 | URxvt.keysym.M-C-4: command:\033[8;48;110t |
|
|
1098 | |
|
|
1099 | =item B<perl-ext-common>: I<string> |
|
|
1100 | |
|
|
1101 | =item B<perl-ext>: I<string> |
|
|
1102 | |
|
|
1103 | Comma-separated list(s) of perl extension scripts (default: C<default>) to |
|
|
1104 | use in this terminal instance; option B<-pe>. |
|
|
1105 | |
|
|
1106 | Extension names can be prefixed with a C<-> sign to prohibit using |
|
|
1107 | them. This can be useful to selectively disable some extensions loaded |
|
|
1108 | by default, or specified via the C<perl-ext-common> resource. For |
|
|
1109 | example, C<default,-selection> will use all the default extension except |
|
|
1110 | C<selection>. |
|
|
1111 | |
|
|
1112 | Extension names can also be followed by an argument in angle brackets |
|
|
1113 | (e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for |
|
|
1114 | searchable scrollback to Alt/Meta-s). Mentioning the same extension |
|
|
1115 | multiple times with different arguments will pass multiple arguments to |
|
|
1116 | the extension. |
|
|
1117 | |
|
|
1118 | Each extension is looked up in the library directories, loaded if |
|
|
1119 | necessary, and bound to the current terminal instance. |
|
|
1120 | |
|
|
1121 | If both of these resources are the empty string, then the perl |
|
|
1122 | interpreter will not be initialized. The idea behind two options is that |
|
|
1123 | B<perl-ext-common> will be used for extensions that should be available to |
|
|
1124 | all instances, while B<perl-ext> is used for specific instances. |
|
|
1125 | |
|
|
1126 | =item B<perl-eval>: I<string> |
|
|
1127 | |
|
|
1128 | Perl code to be evaluated when all extensions have been registered. See |
|
|
1129 | the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource |
|
|
1130 | will be ignored when running setuid/setgid. |
|
|
1131 | |
|
|
1132 | =item B<perl-lib>: I<path> |
|
|
1133 | |
|
|
1134 | Colon-separated list of additional directories that hold extension |
|
|
1135 | scripts. When looking for extensions specified by the C<perl> resource, |
|
|
1136 | @@RXVT_NAME@@ will first look in these directories and then in |
|
|
1137 | F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource |
|
|
1138 | will be ignored when running setuid/setgid. |
|
|
1139 | |
|
|
1140 | See the @@RXVT_NAME@@perl(3) manpage. |
|
|
1141 | |
|
|
1142 | =item B<< selection.pattern-I<idx> >>: I<perl-regex> |
|
|
1143 | |
|
|
1144 | Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for |
|
|
1145 | details. |
|
|
1146 | |
|
|
1147 | =item B<< selection-autotransform.I<idx> >>: I<perl-transform> |
|
|
1148 | |
|
|
1149 | Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage |
|
|
1150 | for details. |
|
|
1151 | |
|
|
1152 | =item B<searchable-scrollback:> I<keysym> |
|
|
1153 | |
|
|
1154 | Sets the hotkey that starts the incremental scrollback buffer search |
|
|
1155 | (default: C<M-s>). |
|
|
1156 | |
|
|
1157 | =item B<urlLauncher>: I<string> |
|
|
1158 | |
|
|
1159 | Specifies the program to be started with a URL argument. Used by the |
|
|
1160 | C<selection-popup> and C<mark-urls> perl extensions. |
|
|
1161 | |
|
|
1162 | =item B<transient-for>: I<windowid> |
|
|
1163 | |
|
|
1164 | Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id. |
|
|
1165 | |
|
|
1166 | =item B<override-redirect>: I<boolean> |
|
|
1167 | |
|
|
1168 | Compile I<frills>: Sets override-redirect for the terminal window, making |
|
|
1169 | it almost invisible to window managers; option B<-override-redirect>. |
939 | |
1170 | |
940 | =back |
1171 | =back |
941 | |
1172 | |
942 | =head1 THE SCROLLBAR |
1173 | =head1 THE SCROLLBAR |
943 | |
1174 | |
… | |
… | |
978 | to select a word; Left triple-click to select the entire logical line |
1209 | to select a word; Left triple-click to select the entire logical line |
979 | (which can span multiple screen lines), unless modified by resource |
1210 | (which can span multiple screen lines), unless modified by resource |
980 | B<tripleclickwords>. |
1211 | B<tripleclickwords>. |
981 | |
1212 | |
982 | Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys) |
1213 | Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys) |
983 | (Compile: I<frills>) will create a rectangular selection instead of a normal |
1214 | (Compile: I<frills>) will create a rectangular selection instead of a |
984 | one. |
1215 | normal one. In this mode, every selected row becomes its own line in the |
|
|
1216 | selection, and trailing whitespace is visually underlined and removed from |
|
|
1217 | the selection. |
985 | |
1218 | |
986 | =item B<Insertion>: |
1219 | =item B<Insertion>: |
987 | |
1220 | |
988 | Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in |
1221 | Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@> |
989 | an B<@@RXVT_NAME@@> window causes the current text selection to be |
1222 | window causes the value of the PRIMARY selection (or CLIPBOARD with the |
990 | inserted as if it had been typed on the keyboard. |
1223 | Meta modifier) to be inserted as if it had been typed on the keyboard. |
|
|
1224 | |
|
|
1225 | Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be |
|
|
1226 | inserted too. |
991 | |
1227 | |
992 | =back |
1228 | =back |
993 | |
1229 | |
994 | =head1 CHANGING FONTS |
1230 | =head1 CHANGING FONTS |
995 | |
1231 | |
996 | Changing fonts (or font sizes, respectively) via the keypad is not yet |
1232 | Changing fonts (or font sizes, respectively) via the keypad is not yet |
997 | supported in rxvt-unicode. Bug me if you need this. |
1233 | supported in rxvt-unicode. Bug me if you need this. |
998 | |
1234 | |
999 | You can, however, switch fonts at runtime using escape sequences (and |
1235 | You can, however, switch fonts at runtime using escape sequences, e.g.: |
1000 | therefore using the menubar), e.g.: |
|
|
1001 | |
1236 | |
1002 | printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic" |
1237 | printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic" |
|
|
1238 | |
|
|
1239 | You can use keyboard shortcuts, too: |
|
|
1240 | |
|
|
1241 | URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007 |
|
|
1242 | URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007 |
1003 | |
1243 | |
1004 | rxvt-unicode will automatically re-apply these fonts to the output so far. |
1244 | rxvt-unicode will automatically re-apply these fonts to the output so far. |
1005 | |
1245 | |
1006 | =head1 ISO 14755 SUPPORT |
1246 | =head1 ISO 14755 SUPPORT |
1007 | |
1247 | |
… | |
… | |
1035 | This mode lets you input characters representing the keycap symbols of |
1275 | This mode lets you input characters representing the keycap symbols of |
1036 | your keyboard, if representable in the current locale encoding. |
1276 | your keyboard, if representable in the current locale encoding. |
1037 | |
1277 | |
1038 | Start by pressing C<Control> and C<Shift> together, then releasing |
1278 | Start by pressing C<Control> and C<Shift> together, then releasing |
1039 | them. The next special key (cursor keys, home etc.) you enter will not |
1279 | them. The next special key (cursor keys, home etc.) you enter will not |
1040 | invoke it's usual function but instead will insert the corresponding |
1280 | invoke its usual function but instead will insert the corresponding |
1041 | keycap symbol. The symbol will only be entered when the key has been |
1281 | keycap symbol. The symbol will only be entered when the key has been |
1042 | released, otherwise pressing e.g. C<Shift> would enter the symbol for |
1282 | released, otherwise pressing e.g. C<Shift> would enter the symbol for |
1043 | C<ISO Level 2 Switch>, although your intention might have been to enter a |
1283 | C<ISO Level 2 Switch>, although your intention might have been to enter a |
1044 | reverse tab (Shift-Tab). |
1284 | reverse tab (Shift-Tab). |
1045 | |
1285 | |
… | |
… | |
1078 | =head1 COLORS AND GRAPHICS |
1318 | =head1 COLORS AND GRAPHICS |
1079 | |
1319 | |
1080 | In addition to the default foreground and background colours, |
1320 | In addition to the default foreground and background colours, |
1081 | B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus |
1321 | B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus |
1082 | high-intensity bold/blink versions of the same). Here is a list of the |
1322 | high-intensity bold/blink versions of the same). Here is a list of the |
1083 | colours with their B<rgb.txt> names. |
1323 | colours with their names. |
1084 | |
1324 | |
1085 | =begin table |
1325 | =begin table |
1086 | |
1326 | |
1087 | B<color0> (black) = Black |
1327 | B<color0> (black) = Black |
1088 | B<color1> (red) = Red3 |
1328 | B<color1> (red) = Red3 |
… | |
… | |
1108 | It is also possible to specify the colour values of B<foreground>, |
1348 | It is also possible to specify the colour values of B<foreground>, |
1109 | B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as |
1349 | B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as |
1110 | a number 0-15, as a convenient shorthand to reference the colour name of |
1350 | a number 0-15, as a convenient shorthand to reference the colour name of |
1111 | color0-color15. |
1351 | color0-color15. |
1112 | |
1352 | |
|
|
1353 | In addition to the colours defined above, @@RXVT_NAME@@ offers an |
|
|
1354 | additional 72 colours. The first 64 of those (with indices 16 to 79) |
|
|
1355 | consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b + |
|
|
1356 | 16>), followed by 8 additional shades of gray (with indices 80 to 87). |
|
|
1357 | |
|
|
1358 | Together, all those colours implement the 88 colour xterm colours. Only |
|
|
1359 | the first 16 can be changed using resources currently, the rest can only |
|
|
1360 | be changed via command sequences ("escape codes"). |
|
|
1361 | |
1113 | Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by |
1362 | Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by |
1114 | always swapping the foreground/background colours. This is in contrast to |
1363 | always swapping the foreground/background colours. This is in contrast to |
1115 | I<xterm>(1) where the colours are only swapped if they have not otherwise |
1364 | I<xterm>(1) where the colours are only swapped if they have not otherwise |
1116 | been specified. For example, |
1365 | been specified. For example, |
1117 | |
1366 | |
… | |
… | |
1122 | would yield White on Black, while on I<xterm>(1) it would yield Black |
1371 | would yield White on Black, while on I<xterm>(1) it would yield Black |
1123 | on White. |
1372 | on White. |
1124 | |
1373 | |
1125 | =back |
1374 | =back |
1126 | |
1375 | |
|
|
1376 | =head2 ALPHA CHANNEL SUPPORT |
|
|
1377 | |
|
|
1378 | If Xft support has been compiled in and as long as Xft/Xrender/X don't get |
|
|
1379 | their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa> |
|
|
1380 | (recommended, but B<MUST> have 4 digits/component) colour specifications, |
|
|
1381 | in addition to the ones provided by X, where the additional A component |
|
|
1382 | specifies opacity (alpha) values. The minimum value of C<0> is completely |
|
|
1383 | transparent). You can also prefix any color with C<[a]>, where C<a> is on |
|
|
1384 | to four hex digits specifiying the opacity value. |
|
|
1385 | |
|
|
1386 | You probably need to specify B<"-depth 32">, too, and have the luck that |
|
|
1387 | your X-server uses ARGB pixel layout, as X is far from just supporting |
|
|
1388 | ARGB visuals out of the box, and rxvt-unicode just fudges around. |
|
|
1389 | |
|
|
1390 | For example, the following selects an almost completely transparent red |
|
|
1391 | background, and an almost opaque pink foreground: |
|
|
1392 | |
|
|
1393 | @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/2222 -fg "[e]pink" |
|
|
1394 | |
|
|
1395 | I<Please note that transparency of any kind if completely unsupported by |
|
|
1396 | the author. Don't bug him with installation questions!> |
|
|
1397 | |
1127 | =head1 ENVIRONMENT |
1398 | =head1 ENVIRONMENT |
1128 | |
1399 | |
1129 | B<@@RXVT_NAME@@> sets and/or uses the following environment variables: |
1400 | B<@@RXVT_NAME@@> sets and/or uses the following environment variables: |
1130 | |
1401 | |
1131 | =over 4 |
1402 | =over 4 |
1132 | |
1403 | |
1133 | =item B<TERM> |
1404 | =item B<TERM> |
1134 | |
1405 | |
1135 | Normally set to C<rxvt-unicode>, unless overwritten at configure time, via |
1406 | Normally set to C<rxvt-unicode>, unless overwritten at configure time, via |
1136 | resources or on the commandline. |
1407 | resources or on the command line. |
1137 | |
1408 | |
1138 | =item B<COLORTERM> |
1409 | =item B<COLORTERM> |
1139 | |
1410 | |
1140 | Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was |
1411 | Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was |
1141 | compiled with XPM support, and optionally with the added extension |
1412 | compiled with XPM support, and optionally with the added extension |
1142 | C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. |
1413 | C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. |
1143 | |
1414 | |
1144 | =item B<COLORFGBG> |
1415 | =item B<COLORFGBG> |
1145 | |
1416 | |
… | |
… | |
1163 | C<--with-terminfo=PATH>. |
1434 | C<--with-terminfo=PATH>. |
1164 | |
1435 | |
1165 | =item B<DISPLAY> |
1436 | =item B<DISPLAY> |
1166 | |
1437 | |
1167 | Used by @@RXVT_NAME@@ to connect to the display and set to the correct |
1438 | Used by @@RXVT_NAME@@ to connect to the display and set to the correct |
1168 | display in it's child processes. |
1439 | display in its child processes. |
1169 | |
1440 | |
1170 | =item B<SHELL> |
1441 | =item B<SHELL> |
1171 | |
1442 | |
1172 | The shell to be used for command execution, defaults to C</bin/sh>. |
1443 | The shell to be used for command execution, defaults to C</bin/sh>. |
1173 | |
|
|
1174 | =item B<RXVTPATH> |
|
|
1175 | |
|
|
1176 | The path where @@RXVT_NAME@@ looks for support files such as menu and xpm |
|
|
1177 | files. |
|
|
1178 | |
|
|
1179 | =item B<PATH> |
|
|
1180 | |
|
|
1181 | Used in the same way as C<RXVTPATH>. |
|
|
1182 | |
1444 | |
1183 | =item B<RXVT_SOCKET> |
1445 | =item B<RXVT_SOCKET> |
1184 | |
1446 | |
1185 | The unix domain socket path used by @@RXVT_NAME@@c(1) and |
1447 | The unix domain socket path used by @@RXVT_NAME@@c(1) and |
1186 | @@RXVT_NAME@@d(1). |
1448 | @@RXVT_NAME@@d(1). |
1187 | |
1449 | |
1188 | Default C<< $HOME/.rxvt-unicode-<nodename >>. |
1450 | Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>. |
1189 | |
1451 | |
1190 | =item B<HOME> |
1452 | =item B<HOME> |
1191 | |
1453 | |
1192 | Used to locate the default directory for the unix domain socket for |
1454 | Used to locate the default directory for the unix domain socket for |
1193 | daemon communications and to locate various resource files (such as |
1455 | daemon communications and to locate various resource files (such as |
… | |
… | |
1214 | |
1476 | |
1215 | =back |
1477 | =back |
1216 | |
1478 | |
1217 | =head1 SEE ALSO |
1479 | =head1 SEE ALSO |
1218 | |
1480 | |
1219 | @@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) |
1481 | @@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) |
1220 | |
|
|
1221 | =head1 BUGS |
|
|
1222 | |
|
|
1223 | Check the BUGS file for an up-to-date list. |
|
|
1224 | |
|
|
1225 | Cursor change support is not yet implemented. |
|
|
1226 | |
|
|
1227 | Click-and-drag doesn't work with X11 mouse report overriding. |
|
|
1228 | |
1482 | |
1229 | =head1 CURRENT PROJECT COORDINATOR |
1483 | =head1 CURRENT PROJECT COORDINATOR |
1230 | |
1484 | |
1231 | =over 4 |
1485 | =over 4 |
1232 | |
1486 | |
1233 | =item Project Coordinator |
1487 | =item Project Coordinator |
1234 | |
1488 | |
1235 | Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> |
1489 | Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> |
1236 | |
1490 | |
1237 | L<http://software.schmorp.de/#rxvt-unicode> |
1491 | L<http://software.schmorp.de/pkg/rxvt-unicode.html> |
1238 | |
1492 | |
1239 | =back |
1493 | =back |
1240 | |
1494 | |
1241 | =head1 AUTHORS |
1495 | =head1 AUTHORS |
1242 | |
1496 | |
… | |
… | |
1264 | |
1518 | |
1265 | Project Coordinator (changes.txt 2.21a to 2.4.5) |
1519 | Project Coordinator (changes.txt 2.21a to 2.4.5) |
1266 | |
1520 | |
1267 | =item Geoff Wing L<< <gcw@pobox.com> >> |
1521 | =item Geoff Wing L<< <gcw@pobox.com> >> |
1268 | |
1522 | |
1269 | Rewrote screen display and text selection routines. Project Coordinator |
1523 | Rewrote screen display and text selection routines. |
|
|
1524 | |
1270 | (changes.txt 2.4.6 - rxvt-unicode) |
1525 | Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) |
1271 | |
1526 | |
1272 | =item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> |
1527 | =item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> |
1273 | |
1528 | |
1274 | Forked rxvt-unicode, rewrote most of the display code and internal |
1529 | Forked rxvt-unicode, unicode support, rewrote almost all the code, perl |
1275 | character handling to store text in unicode, improve xterm |
1530 | extension, random hacks, numerous bugfixes and extensions. |
1276 | compatibility and apply numerous other bugfixes and extensions. |
|
|
1277 | |
1531 | |
1278 | Project Coordinator (Changes 1.0 -) |
1532 | Project Coordinator (Changes 1.0 -) |
1279 | |
1533 | |
|
|
1534 | =item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >> |
|
|
1535 | |
|
|
1536 | Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing. |
|
|
1537 | |
1280 | =back |
1538 | =back |
1281 | |
1539 | |