… | |
… | |
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 |
… | |
… | |
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 |
120 | I<Please note that transparency of any kind if completely unsupported by |
121 | the author. Don't bug him with installation questions!> |
121 | the author. Don't bug him with installation questions! Read the FAQ (man 7 |
|
|
122 | @@RXVT_NAME@@)!> |
122 | |
123 | |
123 | =item B<-fade> I<number> |
124 | =item B<-fade> I<number> |
124 | |
125 | |
125 | Fade the text by the given percentage when focus is lost. Small values |
126 | Fade the text by the given percentage when focus is lost. Small values |
126 | fade a little only, 100 completely replaces all colours by the fade |
127 | fade a little only, 100 completely replaces all colours by the fade |
… | |
… | |
185 | that are checked in order when trying to find glyphs for characters. The |
186 | that are checked in order when trying to find glyphs for characters. The |
186 | 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 |
187 | smaller, but not (in general) larger. A (hopefully) reasonable default |
188 | smaller, but not (in general) larger. A (hopefully) reasonable default |
188 | 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. |
189 | |
190 | |
190 | 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 |
191 | 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:>, |
192 | e.g.: |
193 | e.g.: |
193 | |
194 | |
194 | @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" |
195 | @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" |
195 | @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono" |
196 | @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono" |
… | |
… | |
423 | |
424 | |
424 | Remap a key symbol. See resource B<keysym>. |
425 | Remap a key symbol. See resource B<keysym>. |
425 | |
426 | |
426 | =item B<-embed> I<windowid> |
427 | =item B<-embed> I<windowid> |
427 | |
428 | |
428 | 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, |
429 | which enables applications to easily embed a terminal. |
430 | which enables applications to easily embed a terminal. |
430 | |
431 | |
431 | 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 |
432 | 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 |
433 | 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 |
… | |
… | |
436 | The window will not be destroyed when @@RXVT_NAME@@ exits. |
437 | The window will not be destroyed when @@RXVT_NAME@@ exits. |
437 | |
438 | |
438 | 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 |
439 | 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 |
440 | can use file descriptors to communicate with the programs within the |
441 | can use file descriptors to communicate with the programs within the |
441 | 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 |
442 | not. |
443 | not. |
443 | |
444 | |
444 | Here is a short Gtk2-perl snippet that illustrates how this option can be |
445 | Here is a short Gtk2-perl snippet that illustrates how this option can be |
445 | used (a longer example is in F<doc/embed>): |
446 | used (a longer example is in F<doc/embed>): |
446 | |
447 | |
… | |
… | |
451 | }); |
452 | }); |
452 | |
453 | |
453 | =item B<-pty-fd> I<file descriptor> |
454 | =item B<-pty-fd> I<file descriptor> |
454 | |
455 | |
455 | Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty |
456 | Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty |
456 | pair but instead use the given filehandle as the tty master. This is |
457 | pair but instead use the given file descriptor as the tty master. This is |
457 | useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator |
458 | useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator |
458 | without having to run a program within it. |
459 | without having to run a program within it. |
459 | |
460 | |
460 | If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp |
461 | If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp |
461 | entries and will not tinker with pty/tty permissions - you have to do that |
462 | entries and will not tinker with pty/tty permissions - you have to do that |
… | |
… | |
718 | |
719 | |
719 | =item B<intensityStyles:> I<boolean> |
720 | =item B<intensityStyles:> I<boolean> |
720 | |
721 | |
721 | When font styles are not enabled, or this option is enabled (B<True>, |
722 | When font styles are not enabled, or this option is enabled (B<True>, |
722 | option B<-is>, the default), bold and italic font styles imply high |
723 | option B<-is>, the default), bold and italic font styles imply high |
723 | intensity foreground/backround colours. Disabling this option (B<False>, |
724 | intensity foreground/background colours. Disabling this option (B<False>, |
724 | option B<+is>) disables this behaviour, the high intensity colours are not |
725 | option B<+is>) disables this behaviour, the high intensity colours are not |
725 | reachable. |
726 | reachable. |
726 | |
727 | |
727 | =item B<selectstyle:> I<mode> |
728 | =item B<selectstyle:> I<mode> |
728 | |
729 | |
… | |
… | |
780 | Example: |
781 | Example: |
781 | |
782 | |
782 | URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) |
783 | URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) |
783 | |
784 | |
784 | This creates a new file in your home directory with the screen contents |
785 | This creates a new file in your home directory with the screen contents |
785 | everytime you hit C<Print>. |
786 | every time you hit C<Print>. |
786 | |
787 | |
787 | =item B<scrollBar:> I<boolean> |
788 | =item B<scrollBar:> I<boolean> |
788 | |
789 | |
789 | B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: |
790 | B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: |
790 | disable the scrollbar; option B<+sb>. |
791 | disable the scrollbar; option B<+sb>. |
… | |
… | |
812 | |
813 | |
813 | =item B<scrollWithBuffer:> I<boolean> |
814 | =item B<scrollWithBuffer:> I<boolean> |
814 | |
815 | |
815 | 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 |
816 | 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 |
817 | with scrollback buffer when tty recieves new lines; option B<+sw>. |
818 | with scrollback buffer when tty receives new lines; option B<+sw>. |
818 | |
819 | |
819 | =item B<scrollTtyKeypress:> I<boolean> |
820 | =item B<scrollTtyKeypress:> I<boolean> |
820 | |
821 | |
821 | 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 |
822 | 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 |
… | |
… | |
1025 | |
1026 | |
1026 | 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, |
1027 | 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, |
1028 | C<\000>: octal number) or verbatim control characters (C<^?>: delete, |
1029 | C<\000>: octal number) or verbatim control characters (C<^?>: delete, |
1029 | 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 |
1030 | can start or end with whitespace. |
1031 | can start or end with whitespace. B<This feature is deprecated and will |
|
|
1032 | be removed>. |
1031 | |
1033 | |
1032 | Please note that you need to double the C<\> in resource files, as |
1034 | Please note that you need to double the C<\> in resource files, as |
1033 | Xlib itself does it's own de-escaping (you can use C<\033> instead of |
1035 | Xlib itself does its own de-escaping (you can use C<\033> instead of |
1034 | C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own |
1036 | C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own |
1035 | processing). |
1037 | processing). |
1036 | |
1038 | |
1037 | 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> |
1038 | with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' |
1040 | with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' |
1039 | should be a character not used by the strings. |
1041 | should be a character not used by the strings. |
1040 | |
1042 | |
1041 | Its usage can be demonstrated by an example: |
1043 | Its usage can be demonstrated by an example: |
1042 | |
1044 | |
1043 | URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> |
1045 | URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> |
… | |
… | |
1107 | example, C<default,-selection> will use all the default extension except |
1109 | example, C<default,-selection> will use all the default extension except |
1108 | C<selection>. |
1110 | C<selection>. |
1109 | |
1111 | |
1110 | Extension names can also be followed by an argument in angle brackets |
1112 | Extension names can also be followed by an argument in angle brackets |
1111 | (e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for |
1113 | (e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for |
1112 | searchable scorllback to Alt/Meta-s). Mentioning the same extension |
1114 | searchable scrollback to Alt/Meta-s). Mentioning the same extension |
1113 | multiple times with different arguments will pass multiple arguments to |
1115 | multiple times with different arguments will pass multiple arguments to |
1114 | the extension. |
1116 | the extension. |
1115 | |
1117 | |
1116 | Each extension is looked up in the library directories, loaded if |
1118 | Each extension is looked up in the library directories, loaded if |
1117 | necessary, and bound to the current terminal instance. |
1119 | necessary, and bound to the current terminal instance. |
… | |
… | |
1273 | This mode lets you input characters representing the keycap symbols of |
1275 | This mode lets you input characters representing the keycap symbols of |
1274 | your keyboard, if representable in the current locale encoding. |
1276 | your keyboard, if representable in the current locale encoding. |
1275 | |
1277 | |
1276 | Start by pressing C<Control> and C<Shift> together, then releasing |
1278 | Start by pressing C<Control> and C<Shift> together, then releasing |
1277 | 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 |
1278 | invoke it's usual function but instead will insert the corresponding |
1280 | invoke its usual function but instead will insert the corresponding |
1279 | 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 |
1280 | 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 |
1281 | 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 |
1282 | reverse tab (Shift-Tab). |
1284 | reverse tab (Shift-Tab). |
1283 | |
1285 | |
… | |
… | |
1400 | =over 4 |
1402 | =over 4 |
1401 | |
1403 | |
1402 | =item B<TERM> |
1404 | =item B<TERM> |
1403 | |
1405 | |
1404 | 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 |
1405 | resources or on the commandline. |
1407 | resources or on the command line. |
1406 | |
1408 | |
1407 | =item B<COLORTERM> |
1409 | =item B<COLORTERM> |
1408 | |
1410 | |
1409 | 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 |
1410 | compiled with XPM support, and optionally with the added extension |
1412 | compiled with XPM support, and optionally with the added extension |
1411 | 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. |
1412 | |
1414 | |
1413 | =item B<COLORFGBG> |
1415 | =item B<COLORFGBG> |
1414 | |
1416 | |
… | |
… | |
1432 | C<--with-terminfo=PATH>. |
1434 | C<--with-terminfo=PATH>. |
1433 | |
1435 | |
1434 | =item B<DISPLAY> |
1436 | =item B<DISPLAY> |
1435 | |
1437 | |
1436 | 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 |
1437 | display in it's child processes. |
1439 | display in its child processes. |
1438 | |
1440 | |
1439 | =item B<SHELL> |
1441 | =item B<SHELL> |
1440 | |
1442 | |
1441 | 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>. |
1442 | |
1444 | |
… | |
… | |
1484 | |
1486 | |
1485 | =item Project Coordinator |
1487 | =item Project Coordinator |
1486 | |
1488 | |
1487 | Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> |
1489 | Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> |
1488 | |
1490 | |
1489 | L<http://software.schmorp.de/#rxvt-unicode> |
1491 | L<http://software.schmorp.de/pkg/rxvt-unicode.html> |
1490 | |
1492 | |
1491 | =back |
1493 | =back |
1492 | |
1494 | |
1493 | =head1 AUTHORS |
1495 | =head1 AUTHORS |
1494 | |
1496 | |