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.54 by root, Fri Feb 11 18:55:39 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<-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
… …
663 710
664Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use 711Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use
665B<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
666B<Shift-Print> to include the scrollback as well. 713B<Shift-Print> to include the scrollback as well.
667 714
715The string will be interpreted as if typed into the shell as-is.
716
668=item B<scrollBar:> I<boolean> 717=item B<scrollBar:> I<boolean>
669 718
670B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 719B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
671disable the scrollbar; option B<+sb>. 720disable the scrollbar; option B<+sb>.
672 721
… …
692B<+si>. 741B<+si>.
693 742
694=item B<scrollWithBuffer:> I<boolean> 743=item B<scrollWithBuffer:> I<boolean>
695 744
696B<True>: scroll with scrollback buffer when tty receives new lines (and 745B<True>: scroll with scrollback buffer when tty receives new lines (and
697B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll 746B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
698with scrollback buffer when tty recieves new lines; option B<-sw>. 747with scrollback buffer when tty recieves new lines; option B<+sw>.
699 748
700=item B<scrollTtyKeypress:> I<boolean> 749=item B<scrollTtyKeypress:> I<boolean>
701 750
702B<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
703are those which are intercepted by rxvt-unicode for special handling and 752are those which are intercepted by rxvt-unicode for special handling and
… …
768 817
769Mouse pointer background colour. 818Mouse pointer background colour.
770 819
771=item B<pointerBlankDelay:> I<number> 820=item B<pointerBlankDelay:> I<number>
772 821
773Specifies 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.
774 824
775=item B<backspacekey:> I<string> 825=item B<backspacekey:> I<string>
776 826
777The 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>
778or 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>
… …
909is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 959is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
910example 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>
911when Control-Meta-c is being pressed": 961when Control-Meta-c is being pressed":
912 962
913 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>.
914 983
915The 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
916the 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
917font-switching at runtime: 986font-switching at runtime:
918 987
… …
1218 1287
1219=over 4 1288=over 4
1220 1289
1221=item Project Coordinator 1290=item Project Coordinator
1222 1291
1223@@RXVT_MAINT@@ L<@@RXVT_MAINTEMAIL@@> 1292Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1224 1293
1225L<@@RXVT_WEBPAGE@@> 1294L<http://software.schmorp.de/#rxvt-unicode>
1226 1295
1227=back 1296=back
1228 1297
1229=head1 AUTHORS 1298=head1 AUTHORS
1230 1299
… …
1255=item Geoff Wing L<< <gcw@pobox.com> >> 1324=item Geoff Wing L<< <gcw@pobox.com> >>
1256 1325
1257Rewrote screen display and text selection routines. Project Coordinator 1326Rewrote screen display and text selection routines. Project Coordinator
1258(changes.txt 2.4.6 - rxvt-unicode) 1327(changes.txt 2.4.6 - rxvt-unicode)
1259 1328
1260=item Marc Alexander Lehmann L<< <rxvt@schmorp.de> >> 1329=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1261 1330
1262Forked rxvt-unicode, rewrote most of the display code and internal 1331Forked rxvt-unicode, rewrote most of the display code and internal
1263character handling to store text in unicode, improve xterm 1332character handling to store text in unicode, improve xterm
1264compatibility and apply numerous other bugfixes and extensions. 1333compatibility and apply numerous other bugfixes and extensions.
1265 1334

Diff Legend

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