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.55 by root, Mon Feb 14 10:44:50 2005 UTC vs.
Revision 1.64 by root, Fri Jun 17 12:05:31 2005 UTC

… …
238 238
239Put scrollbar on right/left; resource B<scrollBar_right>. 239Put scrollbar on right/left; resource B<scrollBar_right>.
240 240
241=item B<-st>|B<+st> 241=item B<-st>|B<+st>
242 242
243Display normal (non XTerm/NeXT) scrollbar without/with a trough; 243Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
244resource B<scrollBar_floating>. 244resource B<scrollBar_floating>.
245 245
246=item B<-ptab>|B<+ptab> 246=item B<-ptab>|B<+ptab>
247 247
248If enabled (default), "Horizontal Tab" characters are being stored as 248If enabled (default), "Horizontal Tab" characters are being stored as
… …
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<-xrm> I<resourcestring> 377=item B<-embed> I<windowid>
378 378
379No effect on rxvt-unicode. Simply passes through an argument to be made 379Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window,
380available in the instance's argument list. Appears in I<WM_COMMAND> in 380which enables applications to easily embed a terminal.
381some window managers. 381
382Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
383shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
384quite a bit, so don't expect it to keep some specific state. It's best to
385create an extra subwindow for @@RXVT_NAME@@ and leave it alone.
386
387The window will not be destroyed when @@RXVT_NAME@@ exits.
388
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
391can use file descriptors to communicate with the programs within the
392terminal. This works regardless of wether the C<-embed> option was used or
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" }
382 429
383=back 430=back
384 431
385=head1 RESOURCES (available also as long-options) 432=head1 RESOURCES (available also as long-options)
386 433
… …
519Use the specified colour for the scrollbar [default #B2B2B2]. 566Use the specified colour for the scrollbar [default #B2B2B2].
520 567
521=item B<troughColor:> I<colour> 568=item B<troughColor:> I<colour>
522 569
523Use the specified colour for the scrollbar's trough area [default 570Use the specified colour for the scrollbar's trough area [default
524#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 571#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
525 572
526=item B<borderColor:> I<colour> 573=item B<borderColor:> I<colour>
527 574
528The colour of the border around the text area and between the scrollbar 575The colour of the border around the text area and between the scrollbar
529and the text. 576and the text.
… …
621xterm style selection. 668xterm style selection.
622 669
623=item B<scrollstyle:> I<mode> 670=item B<scrollstyle:> I<mode>
624 671
625Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is 672Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
626the author's favourite.. 673the author's favourite.
627 674
628=item B<title:> I<string> 675=item B<title:> I<string>
629 676
630Set window title string, the default title is the command-line 677Set window title string, the default title is the command-line
631specified after the B<-e> option, if any, otherwise the application 678specified after the B<-e> option, if any, otherwise the application
… …
692B<+si>. 739B<+si>.
693 740
694=item B<scrollWithBuffer:> I<boolean> 741=item B<scrollWithBuffer:> I<boolean>
695 742
696B<True>: scroll with scrollback buffer when tty receives new lines (and 743B<True>: scroll with scrollback buffer when tty receives new lines (and
697B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll 744B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
698with scrollback buffer when tty recieves new lines; option B<-sw>. 745with scrollback buffer when tty recieves new lines; option B<+sw>.
699 746
700=item B<scrollTtyKeypress:> I<boolean> 747=item B<scrollTtyKeypress:> I<boolean>
701 748
702B<True>: scroll to bottom when a non-special key is pressed. Special keys 749B<True>: scroll to bottom when a non-special key is pressed. Special keys
703are those which are intercepted by rxvt-unicode for special handling and 750are those which are intercepted by rxvt-unicode for special handling and
… …
768 815
769Mouse pointer background colour. 816Mouse pointer background colour.
770 817
771=item B<pointerBlankDelay:> I<number> 818=item B<pointerBlankDelay:> I<number>
772 819
773Specifies 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.
774 822
775=item B<backspacekey:> I<string> 823=item B<backspacekey:> I<string>
776 824
777The 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>
778or 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>
… …
909is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 957is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
910example 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>
911when Control-Meta-c is being pressed": 959when Control-Meta-c is being pressed":
912 960
913 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>.
914 981
915The 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
916the 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
917font-switching at runtime: 984font-switching at runtime:
918 985

Diff Legend

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