ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.1.pod
(Generate patch)

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.112 by root, Mon Feb 6 05:55:33 2006 UTC vs.
Revision 1.119 by root, Mon Aug 7 16:04:29 2006 UTC

… …
28world. Being a terminal emulator, however, some things are very difficult, 28world. Being a terminal emulator, however, some things are very difficult,
29especially cursive scripts such as arabic, vertically written scripts 29especially cursive scripts such as arabic, vertically written scripts
30like mongolian or scripts requiring extremely complex combining rules, 30like mongolian or scripts requiring extremely complex combining rules,
31like tibetan or devenagari. Don't expect pretty output when using these 31like tibetan or devenagari. Don't expect pretty output when using these
32scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work 32scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
33fine, though. A somewhat difficult case are left-to-right scripts, such 33fine, though. A somewhat difficult case are right-to-left scripts, such
34as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms 34as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms
35belong into the application, not the terminal emulator (too many things -- 35belong into the application, not the terminal emulator (too many things --
36such as cursor-movement while editing -- break otherwise), but that might 36such as cursor-movement while editing -- break otherwise), but that might
37change. 37change.
38 38
39If you are looking for a terminal that supports more exotic scripts, let 39If you are looking for a terminal that supports more exotic scripts, let
40me recommend C<mlterm>, which is a very userfriendly, lean and clean 40me recommend C<mlterm>, which is a very user friendly, lean and clean
41terminal emulator. In fact, the reason rxvt-unicode was born was solely 41terminal emulator. In fact, the reason rxvt-unicode was born was solely
42because the author couldn't get C<mlterm> to use one font for latin1 and 42because the author couldn't get C<mlterm> to use one font for latin1 and
43another for japanese. 43another for japanese.
44 44
45Therefore another design rationale was the use of multiple fonts to 45Therefore another design rationale was the use of multiple fonts to
46display characters: The idea of a single unicode font which many other 46display characters: The idea of a single unicode font which many other
47programs force onto it's users never made sense to me: You should be able 47programs force onto its users never made sense to me: You should be able
48to choose any font for any script freely. 48to choose any font for any script freely.
49 49
50Apart from that, rxvt-unicode is also much better internationalised than 50Apart from that, rxvt-unicode is also much better internationalised than
51it's predecessor, supports things such as XFT and ISO 14755 that are handy 51its predecessor, supports things such as XFT and ISO 14755 that are handy
52in i18n-environments, is faster, and has a lot less bugs than the original 52in i18n-environments, is faster, and has a lot bugs less than the original
53rxvt. This all in addition to dozens of other small improvements. 53rxvt. This all in addition to dozens of other small improvements.
54 54
55It is still faithfully following the original rxvt idea of being lean 55It is still faithfully following the original rxvt idea of being lean
56and nice on resources: for example, you can still configure rxvt-unicode 56and nice on resources: for example, you can still configure rxvt-unicode
57without most of it's features to get a lean binary. It also comes with 57without most of its features to get a lean binary. It also comes with
58a client/daemon pair that lets you open any number of terminal windows 58a client/daemon pair that lets you open any number of terminal windows
59from within a single process, which makes startup time very fast and 59from within a single process, which makes startup time very fast and
60drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and 60drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and
61@@RXVT_NAME@@c(1) (client). 61@@RXVT_NAME@@c(1) (client).
62 62
63It also makes technical information about escape sequences (which have 63It also makes technical information about escape sequences (which have
64been extended) easier accessible: see @@RXVT_NAME@@(7) for technical 64been extended) more accessible: see @@RXVT_NAME@@(7) for technical
65reference documentation (escape sequences etc.). 65reference documentation (escape sequences etc.).
66 66
67=head1 OPTIONS 67=head1 OPTIONS
68 68
69The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed 69The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed
… …
116 116
117Turn on/off inheriting parent window's pixmap. Alternative form is 117Turn on/off inheriting parent window's pixmap. Alternative form is
118B<-tr>; resource B<inheritPixmap>. 118B<-tr>; resource B<inheritPixmap>.
119 119
120I<Please note that transparency of any kind if completely unsupported by 120I<Please note that transparency of any kind if completely unsupported by
121the author. Don't bug him with installation questions!> 121the 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
125Fade the text by the given percentage when focus is lost. Small values 126Fade the text by the given percentage when focus is lost. Small values
126fade a little only, 100 completely replaces all colours by the fade 127fade a little only, 100 completely replaces all colours by the fade
… …
185that are checked in order when trying to find glyphs for characters. The 186that are checked in order when trying to find glyphs for characters. The
186first font defines the cell size for characters; other fonts might be 187first font defines the cell size for characters; other fonts might be
187smaller, but not (in general) larger. A (hopefully) reasonable default 188smaller, but not (in general) larger. A (hopefully) reasonable default
188font list is always appended to it. See resource B<font> for more details. 189font list is always appended to it. See resource B<font> for more details.
189 190
190In short, to specify an X11 core font, just specify it's name or prefix it 191In short, to specify an X11 core font, just specify its name or prefix it
191with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>, 192with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
192e.g.: 193e.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
424Remap a key symbol. See resource B<keysym>. 425Remap a key symbol. See resource B<keysym>.
425 426
426=item B<-embed> I<windowid> 427=item B<-embed> I<windowid>
427 428
428Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window, 429Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
429which enables applications to easily embed a terminal. 430which enables applications to easily embed a terminal.
430 431
431Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it 432Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
432shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it 433shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
433quite a bit, so don't expect it to keep some specific state. It's best to 434quite a bit, so don't expect it to keep some specific state. It's best to
… …
436The window will not be destroyed when @@RXVT_NAME@@ exits. 437The window will not be destroyed when @@RXVT_NAME@@ exits.
437 438
438It might be useful to know that @@RXVT_NAME@@ will not close file 439It might be useful to know that @@RXVT_NAME@@ will not close file
439descriptors passed to it (except for stdin/out/err, of course), so you 440descriptors passed to it (except for stdin/out/err, of course), so you
440can use file descriptors to communicate with the programs within the 441can use file descriptors to communicate with the programs within the
441terminal. This works regardless of wether the C<-embed> option was used or 442terminal. This works regardless of whether the C<-embed> option was used or
442not. 443not.
443 444
444Here is a short Gtk2-perl snippet that illustrates how this option can be 445Here is a short Gtk2-perl snippet that illustrates how this option can be
445used (a longer example is in F<doc/embed>): 446used (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
455Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty 456Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
456pair but instead use the given filehandle as the tty master. This is 457pair but instead use the given file descriptor as the tty master. This is
457useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator 458useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
458without having to run a program within it. 459without having to run a program within it.
459 460
460If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp 461If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
461entries and will not tinker with pty/tty permissions - you have to do that 462entries 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
721When font styles are not enabled, or this option is enabled (B<True>, 722When font styles are not enabled, or this option is enabled (B<True>,
722option B<-is>, the default), bold and italic font styles imply high 723option B<-is>, the default), bold and italic font styles imply high
723intensity foreground/backround colours. Disabling this option (B<False>, 724intensity foreground/background colours. Disabling this option (B<False>,
724option B<+is>) disables this behaviour, the high intensity colours are not 725option B<+is>) disables this behaviour, the high intensity colours are not
725reachable. 726reachable.
726 727
727=item B<selectstyle:> I<mode> 728=item B<selectstyle:> I<mode>
728 729
… …
780Example: 781Example:
781 782
782 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 783 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
783 784
784This creates a new file in your home directory with the screen contents 785This creates a new file in your home directory with the screen contents
785everytime you hit C<Print>. 786every time you hit C<Print>.
786 787
787=item B<scrollBar:> I<boolean> 788=item B<scrollBar:> I<boolean>
788 789
789B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 790B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
790disable the scrollbar; option B<+sb>. 791disable the scrollbar; option B<+sb>.
… …
812 813
813=item B<scrollWithBuffer:> I<boolean> 814=item B<scrollWithBuffer:> I<boolean>
814 815
815B<True>: scroll with scrollback buffer when tty receives new lines (and 816B<True>: scroll with scrollback buffer when tty receives new lines (and
816B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 817B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
817with scrollback buffer when tty recieves new lines; option B<+sw>. 818with 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
821B<True>: scroll to bottom when a non-special key is pressed. Special keys 822B<True>: scroll to bottom when a non-special key is pressed. Special keys
822are those which are intercepted by rxvt-unicode for special handling and 823are those which are intercepted by rxvt-unicode for special handling and
… …
1028C<\000>: octal number) or verbatim control characters (C<^?>: delete, 1029C<\000>: octal number) or verbatim control characters (C<^?>: delete,
1029C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it 1030C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1030can start or end with whitespace. 1031can start or end with whitespace.
1031 1032
1032Please note that you need to double the C<\> in resource files, as 1033Please note that you need to double the C<\> in resource files, as
1033Xlib itself does it's own de-escaping (you can use C<\033> instead of 1034Xlib itself does its own de-escaping (you can use C<\033> instead of
1034C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own 1035C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1035processing). 1036processing).
1036 1037
1037You can define a range of keysyms in one shot by providing a I<string> 1038You can define a range of keysyms in one shot by providing a I<string>
1038with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' 1039with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1039should be a character not used by the strings. 1040should be a character not used by the strings.
1040 1041
1041Its usage can be demonstrated by an example: 1042Its usage can be demonstrated by an example:
1042 1043
1043 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1044 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
… …
1107example, C<default,-selection> will use all the default extension except 1108example, C<default,-selection> will use all the default extension except
1108C<selection>. 1109C<selection>.
1109 1110
1110Extension names can also be followed by an argument in angle brackets 1111Extension names can also be followed by an argument in angle brackets
1111(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for 1112(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
1112searchable scorllback to Alt/Meta-s). Mentioning the same extension 1113searchable scrollback to Alt/Meta-s). Mentioning the same extension
1113multiple times with different arguments will pass multiple arguments to 1114multiple times with different arguments will pass multiple arguments to
1114the extension. 1115the extension.
1115 1116
1116Each extension is looked up in the library directories, loaded if 1117Each extension is looked up in the library directories, loaded if
1117necessary, and bound to the current terminal instance. 1118necessary, and bound to the current terminal instance.
… …
1273This mode lets you input characters representing the keycap symbols of 1274This mode lets you input characters representing the keycap symbols of
1274your keyboard, if representable in the current locale encoding. 1275your keyboard, if representable in the current locale encoding.
1275 1276
1276Start by pressing C<Control> and C<Shift> together, then releasing 1277Start by pressing C<Control> and C<Shift> together, then releasing
1277them. The next special key (cursor keys, home etc.) you enter will not 1278them. The next special key (cursor keys, home etc.) you enter will not
1278invoke it's usual function but instead will insert the corresponding 1279invoke its usual function but instead will insert the corresponding
1279keycap symbol. The symbol will only be entered when the key has been 1280keycap symbol. The symbol will only be entered when the key has been
1280released, otherwise pressing e.g. C<Shift> would enter the symbol for 1281released, otherwise pressing e.g. C<Shift> would enter the symbol for
1281C<ISO Level 2 Switch>, although your intention might have been to enter a 1282C<ISO Level 2 Switch>, although your intention might have been to enter a
1282reverse tab (Shift-Tab). 1283reverse tab (Shift-Tab).
1283 1284
… …
1400=over 4 1401=over 4
1401 1402
1402=item B<TERM> 1403=item B<TERM>
1403 1404
1404Normally set to C<rxvt-unicode>, unless overwritten at configure time, via 1405Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1405resources or on the commandline. 1406resources or on the command line.
1406 1407
1407=item B<COLORTERM> 1408=item B<COLORTERM>
1408 1409
1409Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was 1410Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1410compiled with XPM support, and optionally with the added extension 1411compiled with XPM support, and optionally with the added extension
1411C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. 1412C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.
1412 1413
1413=item B<COLORFGBG> 1414=item B<COLORFGBG>
1414 1415
… …
1432C<--with-terminfo=PATH>. 1433C<--with-terminfo=PATH>.
1433 1434
1434=item B<DISPLAY> 1435=item B<DISPLAY>
1435 1436
1436Used by @@RXVT_NAME@@ to connect to the display and set to the correct 1437Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1437display in it's child processes. 1438display in its child processes.
1438 1439
1439=item B<SHELL> 1440=item B<SHELL>
1440 1441
1441The shell to be used for command execution, defaults to C</bin/sh>. 1442The shell to be used for command execution, defaults to C</bin/sh>.
1442 1443
… …
1484 1485
1485=item Project Coordinator 1486=item Project Coordinator
1486 1487
1487Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1488Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1488 1489
1489L<http://software.schmorp.de/#rxvt-unicode> 1490L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1490 1491
1491=back 1492=back
1492 1493
1493=head1 AUTHORS 1494=head1 AUTHORS
1494 1495

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines