| … | |
… | |
| 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 | |
| … | |
… | |
| 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 |
| … | |
… | |
| 115 | =item B<-ip>|B<+ip> | B<-tr>|B<+tr> |
115 | =item B<-ip>|B<+ip> | B<-tr>|B<+tr> |
| 116 | |
116 | |
| 117 | Turn on/off inheriting parent window's pixmap. Alternative form is |
117 | Turn on/off inheriting parent window's pixmap. Alternative form is |
| 118 | B<-tr>; resource B<inheritPixmap>. |
118 | B<-tr>; resource B<inheritPixmap>. |
| 119 | |
119 | |
|
|
120 | I<Please note that transparency of any kind if completely unsupported by |
|
|
121 | the author. Don't bug him with installation questions!> |
|
|
122 | |
| 120 | =item B<-fade> I<number> |
123 | =item B<-fade> I<number> |
| 121 | |
124 | |
| 122 | Fade the text by the given percentage when focus is lost. Small values |
125 | Fade the text by the given percentage when focus is lost. Small values |
| 123 | fade a little only, 100 completely replaces all colours by the fade |
126 | fade a little only, 100 completely replaces all colours by the fade |
| 124 | colour; resource B<fading>. |
127 | colour; resource B<fading>. |
| 125 | |
128 | |
| 126 | =item B<-fadecolor> I<colour> |
129 | =item B<-fadecolor> I<colour> |
| 127 | |
130 | |
| 128 | Fade to this colour when fading is used (see B<-fade>). The default colour |
131 | Fade to this colour when fading is used (see B<-fade>). The default colour |
| 129 | is black. resource B<fadeColor>. |
132 | is opaque black. resource B<fadeColor>. |
| 130 | |
133 | |
| 131 | =item B<-tint> I<colour> |
134 | =item B<-tint> I<colour> |
| 132 | |
135 | |
| 133 | Tint the transparent background pixmap with the given colour when |
136 | Tint the transparent background pixmap with the given colour when |
| 134 | transparency is enabled with B<-tr> or B<-ip>. This only works for |
137 | transparency is enabled with B<-tr> or B<-ip>. This only works for |
| … | |
… | |
| 182 | that are checked in order when trying to find glyphs for characters. The |
185 | that are checked in order when trying to find glyphs for characters. The |
| 183 | first font defines the cell size for characters; other fonts might be |
186 | first font defines the cell size for characters; other fonts might be |
| 184 | smaller, but not (in general) larger. A (hopefully) reasonable default |
187 | smaller, but not (in general) larger. A (hopefully) reasonable default |
| 185 | font list is always appended to it. See resource B<font> for more details. |
188 | font list is always appended to it. See resource B<font> for more details. |
| 186 | |
189 | |
| 187 | In short, to specify an X11 core font, just specify it's name or prefix it |
190 | In short, to specify an X11 core font, just specify its name or prefix it |
| 188 | with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>, |
191 | with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>, |
| 189 | e.g.: |
192 | e.g.: |
| 190 | |
193 | |
| 191 | @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" |
194 | @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" |
| 192 | @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono" |
195 | @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono" |
| … | |
… | |
| 420 | |
423 | |
| 421 | Remap a key symbol. See resource B<keysym>. |
424 | Remap a key symbol. See resource B<keysym>. |
| 422 | |
425 | |
| 423 | =item B<-embed> I<windowid> |
426 | =item B<-embed> I<windowid> |
| 424 | |
427 | |
| 425 | Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window, |
428 | Tells @@RXVT_NAME@@ to embed its windows into an already-existing window, |
| 426 | which enables applications to easily embed a terminal. |
429 | which enables applications to easily embed a terminal. |
| 427 | |
430 | |
| 428 | Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it |
431 | Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it |
| 429 | shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it |
432 | shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it |
| 430 | quite a bit, so don't expect it to keep some specific state. It's best to |
433 | quite a bit, so don't expect it to keep some specific state. It's best to |
| … | |
… | |
| 597 | |
600 | |
| 598 | B<True>: make the background inherit the parent windows' pixmap, giving |
601 | B<True>: make the background inherit the parent windows' pixmap, giving |
| 599 | artificial transparency. B<False>: do not inherit the parent windows' |
602 | artificial transparency. B<False>: do not inherit the parent windows' |
| 600 | pixmap. |
603 | pixmap. |
| 601 | |
604 | |
|
|
605 | I<Please note that transparency of any kind if completely unsupported by |
|
|
606 | the author. Don't bug him with installation questions!> |
|
|
607 | |
| 602 | =item B<fading:> I<number> |
608 | =item B<fading:> I<number> |
| 603 | |
609 | |
| 604 | Fade the text by the given percentage when focus is lost; option B<-fade>. |
610 | Fade the text by the given percentage when focus is lost; option B<-fade>. |
| 605 | |
611 | |
| 606 | =item B<fadeColor:> I<colour> |
612 | =item B<fadeColor:> I<colour> |
| … | |
… | |
| 1022 | C<\000>: octal number) or verbatim control characters (C<^?>: delete, |
1028 | C<\000>: octal number) or verbatim control characters (C<^?>: delete, |
| 1023 | C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it |
1029 | C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it |
| 1024 | can start or end with whitespace. |
1030 | can start or end with whitespace. |
| 1025 | |
1031 | |
| 1026 | Please note that you need to double the C<\> in resource files, as |
1032 | Please note that you need to double the C<\> in resource files, as |
| 1027 | Xlib itself does it's own de-escaping (you can use C<\033> instead of |
1033 | Xlib itself does its own de-escaping (you can use C<\033> instead of |
| 1028 | C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own |
1034 | C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own |
| 1029 | processing). |
1035 | processing). |
| 1030 | |
1036 | |
| 1031 | You can define a range of keysyms in one shot by providing a I<string> |
1037 | You can define a range of keysyms in one shot by providing a I<string> |
| 1032 | with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' |
1038 | with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' |
| … | |
… | |
| 1267 | This mode lets you input characters representing the keycap symbols of |
1273 | This mode lets you input characters representing the keycap symbols of |
| 1268 | your keyboard, if representable in the current locale encoding. |
1274 | your keyboard, if representable in the current locale encoding. |
| 1269 | |
1275 | |
| 1270 | Start by pressing C<Control> and C<Shift> together, then releasing |
1276 | Start by pressing C<Control> and C<Shift> together, then releasing |
| 1271 | them. The next special key (cursor keys, home etc.) you enter will not |
1277 | them. The next special key (cursor keys, home etc.) you enter will not |
| 1272 | invoke it's usual function but instead will insert the corresponding |
1278 | invoke its usual function but instead will insert the corresponding |
| 1273 | keycap symbol. The symbol will only be entered when the key has been |
1279 | keycap symbol. The symbol will only be entered when the key has been |
| 1274 | released, otherwise pressing e.g. C<Shift> would enter the symbol for |
1280 | released, otherwise pressing e.g. C<Shift> would enter the symbol for |
| 1275 | C<ISO Level 2 Switch>, although your intention might have been to enter a |
1281 | C<ISO Level 2 Switch>, although your intention might have been to enter a |
| 1276 | reverse tab (Shift-Tab). |
1282 | reverse tab (Shift-Tab). |
| 1277 | |
1283 | |
| … | |
… | |
| 1340 | It is also possible to specify the colour values of B<foreground>, |
1346 | It is also possible to specify the colour values of B<foreground>, |
| 1341 | B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as |
1347 | B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as |
| 1342 | a number 0-15, as a convenient shorthand to reference the colour name of |
1348 | a number 0-15, as a convenient shorthand to reference the colour name of |
| 1343 | color0-color15. |
1349 | color0-color15. |
| 1344 | |
1350 | |
| 1345 | If Xft support has been compiled in and as long as Xft/Xrender/X don't get |
1351 | In addition to the colours defined above, @@RXVT_NAME@@ offers an |
| 1346 | their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa> |
1352 | additional 72 colours. The first 64 of those (with indices 16 to 79) |
| 1347 | (recommended, but B<MUST> have 4 digits/component), C<#ARGB>, C<#AARRGGBB> |
1353 | consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b + |
| 1348 | and C<#AAAARRRRGGGGBBBB> colour specifications, in addition to the ones |
1354 | 16>), followed by 8 additional shades of gray (with indices 80 to 87). |
| 1349 | provided by X, where the additional A component specifies alpha (opacity) |
1355 | |
| 1350 | values (0 is completely transparent and the maximum is opaque). You |
1356 | Together, all those colours implement the 88 colour xterm colours. Only |
| 1351 | probably need to specify B<"-depth 32">, too, and have the luck that your |
1357 | the first 16 can be changed using resources currently, the rest can only |
| 1352 | X-server uses ARGB pixel layout, as X is far from just supporting ARGB |
1358 | be changed via command sequences ("escape codes"). |
| 1353 | visuals out of the box, and rxvt-unicode just fudges around. |
|
|
| 1354 | |
1359 | |
| 1355 | Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by |
1360 | Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by |
| 1356 | always swapping the foreground/background colours. This is in contrast to |
1361 | always swapping the foreground/background colours. This is in contrast to |
| 1357 | I<xterm>(1) where the colours are only swapped if they have not otherwise |
1362 | I<xterm>(1) where the colours are only swapped if they have not otherwise |
| 1358 | been specified. For example, |
1363 | been specified. For example, |
| … | |
… | |
| 1363 | |
1368 | |
| 1364 | would yield White on Black, while on I<xterm>(1) it would yield Black |
1369 | would yield White on Black, while on I<xterm>(1) it would yield Black |
| 1365 | on White. |
1370 | on White. |
| 1366 | |
1371 | |
| 1367 | =back |
1372 | =back |
|
|
1373 | |
|
|
1374 | =head2 ALPHA CHANNEL SUPPORT |
|
|
1375 | |
|
|
1376 | If Xft support has been compiled in and as long as Xft/Xrender/X don't get |
|
|
1377 | their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa> |
|
|
1378 | (recommended, but B<MUST> have 4 digits/component) colour specifications, |
|
|
1379 | in addition to the ones provided by X, where the additional A component |
|
|
1380 | specifies opacity (alpha) values. The minimum value of C<0> is completely |
|
|
1381 | transparent). You can also prefix any color with C<[a]>, where C<a> is on |
|
|
1382 | to four hex digits specifiying the opacity value. |
|
|
1383 | |
|
|
1384 | You probably need to specify B<"-depth 32">, too, and have the luck that |
|
|
1385 | your X-server uses ARGB pixel layout, as X is far from just supporting |
|
|
1386 | ARGB visuals out of the box, and rxvt-unicode just fudges around. |
|
|
1387 | |
|
|
1388 | For example, the following selects an almost completely transparent red |
|
|
1389 | background, and an almost opaque pink foreground: |
|
|
1390 | |
|
|
1391 | @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/2222 -fg "[e]pink" |
|
|
1392 | |
|
|
1393 | I<Please note that transparency of any kind if completely unsupported by |
|
|
1394 | the author. Don't bug him with installation questions!> |
| 1368 | |
1395 | |
| 1369 | =head1 ENVIRONMENT |
1396 | =head1 ENVIRONMENT |
| 1370 | |
1397 | |
| 1371 | B<@@RXVT_NAME@@> sets and/or uses the following environment variables: |
1398 | B<@@RXVT_NAME@@> sets and/or uses the following environment variables: |
| 1372 | |
1399 | |
| … | |
… | |
| 1405 | C<--with-terminfo=PATH>. |
1432 | C<--with-terminfo=PATH>. |
| 1406 | |
1433 | |
| 1407 | =item B<DISPLAY> |
1434 | =item B<DISPLAY> |
| 1408 | |
1435 | |
| 1409 | Used by @@RXVT_NAME@@ to connect to the display and set to the correct |
1436 | Used by @@RXVT_NAME@@ to connect to the display and set to the correct |
| 1410 | display in it's child processes. |
1437 | display in its child processes. |
| 1411 | |
1438 | |
| 1412 | =item B<SHELL> |
1439 | =item B<SHELL> |
| 1413 | |
1440 | |
| 1414 | The shell to be used for command execution, defaults to C</bin/sh>. |
1441 | The shell to be used for command execution, defaults to C</bin/sh>. |
| 1415 | |
1442 | |
| … | |
… | |
| 1457 | |
1484 | |
| 1458 | =item Project Coordinator |
1485 | =item Project Coordinator |
| 1459 | |
1486 | |
| 1460 | Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> |
1487 | Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> |
| 1461 | |
1488 | |
| 1462 | L<http://software.schmorp.de/#rxvt-unicode> |
1489 | L<http://software.schmorp.de/pkg/rxvt-unicode.html> |
| 1463 | |
1490 | |
| 1464 | =back |
1491 | =back |
| 1465 | |
1492 | |
| 1466 | =head1 AUTHORS |
1493 | =head1 AUTHORS |
| 1467 | |
1494 | |
