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.56 by root, Mon Feb 14 18:47:54 2005 UTC vs.
Revision 1.65 by root, Thu Jun 30 14:00:49 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<-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
383shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure 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 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. 385create an extra subwindow for @@RXVT_NAME@@ and leave it alone.
386
387The window will not be destroyed when @@RXVT_NAME@@ exits.
386 388
387It 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
388descriptors 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
389can use file descriptors to communicate with the programs within the 391can use file descriptors to communicate with the programs within the
390terminal. 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
391not. 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" }
392 429
393=back 430=back
394 431
395=head1 RESOURCES (available also as long-options) 432=head1 RESOURCES (available also as long-options)
396 433
… …
529Use the specified colour for the scrollbar [default #B2B2B2]. 566Use the specified colour for the scrollbar [default #B2B2B2].
530 567
531=item B<troughColor:> I<colour> 568=item B<troughColor:> I<colour>
532 569
533Use the specified colour for the scrollbar's trough area [default 570Use the specified colour for the scrollbar's trough area [default
534#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 571#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
535 572
536=item B<borderColor:> I<colour> 573=item B<borderColor:> I<colour>
537 574
538The 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
539and the text. 576and the text.
… …
631xterm style selection. 668xterm style selection.
632 669
633=item B<scrollstyle:> I<mode> 670=item B<scrollstyle:> I<mode>
634 671
635Set 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
636the author's favourite.. 673the author's favourite.
637 674
638=item B<title:> I<string> 675=item B<title:> I<string>
639 676
640Set window title string, the default title is the command-line 677Set window title string, the default title is the command-line
641specified after the B<-e> option, if any, otherwise the application 678specified after the B<-e> option, if any, otherwise the application
… …
673 710
674Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use 711Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use
675B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or 712B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or
676B<Shift-Print> to include the scrollback as well. 713B<Shift-Print> to include the scrollback as well.
677 714
715The string will be interpreted as if typed into the shell as-is.
716
678=item B<scrollBar:> I<boolean> 717=item B<scrollBar:> I<boolean>
679 718
680B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 719B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
681disable the scrollbar; option B<+sb>. 720disable the scrollbar; option B<+sb>.
682 721
… …
702B<+si>. 741B<+si>.
703 742
704=item B<scrollWithBuffer:> I<boolean> 743=item B<scrollWithBuffer:> I<boolean>
705 744
706B<True>: scroll with scrollback buffer when tty receives new lines (and 745B<True>: scroll with scrollback buffer when tty receives new lines (and
707B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll 746B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
708with scrollback buffer when tty recieves new lines; option B<-sw>. 747with scrollback buffer when tty recieves new lines; option B<+sw>.
709 748
710=item B<scrollTtyKeypress:> I<boolean> 749=item B<scrollTtyKeypress:> I<boolean>
711 750
712B<True>: scroll to bottom when a non-special key is pressed. Special keys 751B<True>: scroll to bottom when a non-special key is pressed. Special keys
713are those which are intercepted by rxvt-unicode for special handling and 752are those which are intercepted by rxvt-unicode for special handling and
… …
778 817
779Mouse pointer background colour. 818Mouse pointer background colour.
780 819
781=item B<pointerBlankDelay:> I<number> 820=item B<pointerBlankDelay:> I<number>
782 821
783Specifies number of seconds before blanking the pointer [default 2]. 822Specifies number of seconds before blanking the pointer [default 2]. Use a
823large number (e.g. C<987654321>) to effectively disable the timeout.
784 824
785=item B<backspacekey:> I<string> 825=item B<backspacekey:> I<string>
786 826
787The string to send when the backspace key is pressed. If set to B<DEC> 827The string to send when the backspace key is pressed. If set to B<DEC>
788or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace> 828or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>
… …
919is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 959is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
920example the following means "change the current locale to C<zh_CN.GBK> 960example the following means "change the current locale to C<zh_CN.GBK>
921when Control-Meta-c is being pressed": 961when Control-Meta-c is being pressed":
922 962
923 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 963 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
964
965Due the the large number of modifier combinations, a defined key mapping
966will match if at I<at least> the specified identifiers are being set, and
967no other key mappings with those and more bits are being defined. That
968means that defining a key map for C<a> will automatically provide
969definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
970mappings themselves.
971
972Unfortunately, this will override built-in key mappings. For example
973if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s
974C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the
975user-defined keymap using the C<builtin:> replacement:
976
977 URxvt.keysym.Insert: <my insert key sequence>
978 URxvt.keysym.S-Insert: builtin:
979
980The first line defines a mapping for C<Insert> and I<any> combination
981of modifiers. The second line re-establishes the default mapping for
982C<Shift-Insert>.
924 983
925The following example will map Control-Meta-1 and Control-Meta-2 to 984The following example will map Control-Meta-1 and Control-Meta-2 to
926the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited 985the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
927font-switching at runtime: 986font-switching at runtime:
928 987

Diff Legend

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