--- rxvt-unicode/doc/rxvt.1.txt 2005/02/13 08:56:27 1.12 +++ rxvt-unicode/doc/rxvt.1.txt 2005/04/22 02:09:39 1.21 @@ -6,7 +6,7 @@ rxvt [options] [-e command [ args ]] DESCRIPTION - rxvt-unicode, version 5.0, is a colour vt102 terminal emulator intended + rxvt-unicode, version 5.5, is a colour vt102 terminal emulator intended as an *xterm*(1) replacement for users who do not require features such as Tektronix 4014 emulation and toolkit-style configurability. As a result, rxvt-unicode uses much less swap space -- a significant @@ -313,13 +313,59 @@ Turn on/off secondary screen scroll (default enabled); resource secondaryScroll. - -keysym.*sym*: *string* + -keysym.*sym* *string* Remap a key symbol. See resource keysym. - -xrm *resourcestring* - No effect on rxvt-unicode. Simply passes through an argument to be - made available in the instance's argument list. Appears in - *WM_COMMAND* in some window managers. + -embed *windowid* + Tells rxvt to embed it's windows into an already-existing window, + which enables applications to easily embed a terminal. + + Right now, rxvt will first unmap/map the specified window, so it + shouldn't be a top-level window. rxvt will also reconfigure it quite + a bit, so don't expect it to keep some specific state. It's best to + create an extra subwindow for rxvt and leave it alone. + + The window will not be destroyed when rxvt exits. + + It might be useful to know that rxvt will not close file descriptors + passed to it (except for stdin/out/err, of course), so you can use + file descriptors to communicate with the programs within the + terminal. This works regardless of wether the "-embed" option was + used or not. + + Here is a short Gtk2-perl snippet that illustrates how this option + can be used (a longer example is in doc/embed): + + my $rxvt = new Gtk2::Socket; + $rxvt->signal_connect_after (realize => sub { + my $xid = $_[0]->window->get_xid; + system "rxvt -embed $xid &"; + }); + + -pty-fd *fileno* + Tells rxvt NOT to execute any commands or create a new pty/tty pair + but instead use the given filehandle as the tty master. This is + useful if you want to drive rxvt as a generic terminal emulator + without having to run a program within it. + + If this switch is given, rxvt will not create any utmp/wtmp entries + and will not tinker with pty/tty permissions - you have to do that + yourself if you want that. + + Here is a example in perl that illustrates how this option can be + used (a longer example is in doc/pty-fd): + + use IO::Pty; + use Fcntl; + + my $pty = new IO::Pty; + fcntl $pty, F_SETFD, 0; # clear close-on-exec + system "rxvt -pty-fd " . (fileno $pty) . "&"; + close $pty; + + # now communicate with rxvt + my $slave = $pty->slave; + while (<$slave>) { print $slave "got <$_>\n" } RESOURCES (available also as long-options) Note: `rxvt --help' gives a list of all resources (long options) @@ -590,8 +636,8 @@ scrollWithBuffer: *boolean* True: scroll with scrollback buffer when tty receives new lines (and - scrollTtyOutput is False); option +sw. False: do not scroll with - scrollback buffer when tty recieves new lines; option -sw. + scrollTtyOutput is False); option -sw. False: do not scroll with + scrollback buffer when tty recieves new lines; option +sw. scrollTtyKeypress: *boolean* True: scroll to bottom when a non-special key is pressed. Special @@ -653,6 +699,8 @@ pointerBlankDelay: *number* Specifies number of seconds before blanking the pointer [default 2]. + Use a large number (e.g. 987654321) to effectively disable the + timeout. backspacekey: *string* The string to send when the backspace key is pressed. If set to DEC @@ -779,6 +827,25 @@ URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 + Due the the large number of modifier combinations, a defined key + mapping will match if at *at least* the specified identifiers are + being set, and no other key mappings with those and more bits are + being defined. That means that defining a key map for "a" will + automatically provide definitions for "Meta-a", "Shift-a" and so on, + unless some of those are defined mappings themselves. + + Unfortunately, this will override built-in key mappings. For example + if you overwrite the "Insert" key you will disable rxvt's + "Shift-Insert" mapping. To re-enable that, you can poke "holes" into + the user-defined keymap using the "builtin:" replacement: + + URxvt.keysym.Insert: + URxvt.keysym.S-Insert: builtin: + + The first line defines a mapping for "Insert" and *any* combination + of modifiers. The second line re-establishes the default mapping for + "Shift-Insert". + The following example will map Control-Meta-1 and Control-Meta-2 to the fonts "suxuseuro" and "9x15bold", so you can have some limited font-switching at runtime: @@ -1027,9 +1094,9 @@ CURRENT PROJECT COORDINATOR Project Coordinator - Marc A. Lehmann rxvt@schmorp.de + Marc A. Lehmann - + AUTHORS John Bovey @@ -1053,7 +1120,7 @@ Rewrote screen display and text selection routines. Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) - Marc Alexander Lehmann + Marc Alexander Lehmann Forked rxvt-unicode, rewrote most of the display code and internal character handling to store text in unicode, improve xterm compatibility and apply numerous other bugfixes and extensions.