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.58 by root, Wed Feb 16 21:49:36 2005 UTC vs.
Revision 1.63 by root, Fri Apr 22 02:09:39 2005 UTC

368=item B<-ssr>|B<+ssr> 368=item B<-ssr>|B<+ssr>
369 369
370Turn on/off secondary screen scroll (default enabled); resource 370Turn on/off secondary screen scroll (default enabled); resource
371B<secondaryScroll>. 371B<secondaryScroll>.
372 372
373=item B<-keysym.>I<sym>: I<string> 373=item B<-keysym.>I<sym> I<string>
374 374
375Remap a key symbol. See resource B<keysym>. 375Remap a key symbol. See resource B<keysym>.
376 376
377=item B<-embed>: I<windowid> 377=item B<-embed> I<windowid>
378 378
379Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window, 379Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window,
380which enables applications to easily embed a terminal. 380which enables applications to easily embed a terminal.
381 381
382Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it 382Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
389It might be useful to know that @@RXVT_NAME@@ will not close file 389It might be useful to know that @@RXVT_NAME@@ will not close file
390descriptors passed to it (except for stdin/out/err, of course), so you 390descriptors passed to it (except for stdin/out/err, of course), so you
391can use file descriptors to communicate with the programs within the 391can use file descriptors to communicate with the programs within the
392terminal. This works regardless of wether the C<-embed> option was used or 392terminal. This works regardless of wether the C<-embed> option was used or
393not. 393not.
394
395Here is a short Gtk2-perl snippet that illustrates how this option can be
396used (a longer example is in F<doc/embed>):
397
398 my $rxvt = new Gtk2::Socket;
399 $rxvt->signal_connect_after (realize => sub {
400 my $xid = $_[0]->window->get_xid;
401 system "@@RXVT_NAME@@ -embed $xid &";
402 });
403
404=item B<-pty-fd> I<fileno>
405
406Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
407pair but instead use the given filehandle as the tty master. This is
408useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
409without having to run a program within it.
410
411If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
412entries and will not tinker with pty/tty permissions - you have to do that
413yourself if you want that.
414
415Here is a example in perl that illustrates how this option can be used (a
416longer example is in F<doc/pty-fd>):
417
418 use IO::Pty;
419 use Fcntl;
420
421 my $pty = new IO::Pty;
422 fcntl $pty, F_SETFD, 0; # clear close-on-exec
423 system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";
424 close $pty;
425
426 # now communicate with rxvt
427 my $slave = $pty->slave;
428 while (<$slave>) { print $slave "got <$_>\n" }
394 429
395=back 430=back
396 431
397=head1 RESOURCES (available also as long-options) 432=head1 RESOURCES (available also as long-options)
398 433
780 815
781Mouse pointer background colour. 816Mouse pointer background colour.
782 817
783=item B<pointerBlankDelay:> I<number> 818=item B<pointerBlankDelay:> I<number>
784 819
785Specifies number of seconds before blanking the pointer [default 2]. 820Specifies number of seconds before blanking the pointer [default 2]. Use a
821large number (e.g. C<987654321>) to effectively disable the timeout.
786 822
787=item B<backspacekey:> I<string> 823=item B<backspacekey:> I<string>
788 824
789The string to send when the backspace key is pressed. If set to B<DEC> 825The string to send when the backspace key is pressed. If set to B<DEC>
790or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace> 826or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>
921is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 957is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
922example the following means "change the current locale to C<zh_CN.GBK> 958example the following means "change the current locale to C<zh_CN.GBK>
923when Control-Meta-c is being pressed": 959when Control-Meta-c is being pressed":
924 960
925 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 961 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
962
963Due the the large number of modifier combinations, a defined key mapping
964will match if at I<at least> the specified identifiers are being set, and
965no other key mappings with those and more bits are being defined. That
966means that defining a key map for C<a> will automatically provide
967definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
968mappings themselves.
969
970Unfortunately, this will override built-in key mappings. For example
971if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s
972C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the
973user-defined keymap using the C<builtin:> replacement:
974
975 URxvt.keysym.Insert: <my insert key sequence>
976 URxvt.keysym.S-Insert: builtin:
977
978The first line defines a mapping for C<Insert> and I<any> combination
979of modifiers. The second line re-establishes the default mapping for
980C<Shift-Insert>.
926 981
927The following example will map Control-Meta-1 and Control-Meta-2 to 982The following example will map Control-Meta-1 and Control-Meta-2 to
928the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited 983the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
929font-switching at runtime: 984font-switching at runtime:
930 985

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines