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.69 by root, Tue Oct 25 19:04:45 2005 UTC

… …
105 105
106=item B<-j>|B<+j> 106=item B<-j>|B<+j>
107 107
108Turn on/off jump scrolling; resource B<jumpScroll>. 108Turn on/off jump scrolling; resource B<jumpScroll>.
109 109
110=item B<-ip>|B<+ip> 110=item B<-ip>|B<+ip> | B<-tr>|B<+tr>
111 111
112Turn on/off inheriting parent window's pixmap. Alternative form is 112Turn on/off inheriting parent window's pixmap. Alternative form is
113B<-tr>; resource B<inheritPixmap>. 113B<-tr>; resource B<inheritPixmap>.
114 114
115=item B<-fade> I<number> 115=item B<-fade> I<number>
116 116
117Fade the text by the given percentage when focus is lost. resource B<fading>. 117Fade the text by the given percentage when focus is lost. Small values
118fade a little only, 100 completely replaces all colours by the fade
119colour; resource B<fading>.
120
121=item B<-fadecolor> I<colour>
122
123Fade to this colour when fading is used (see B<-fade>). The default colour
124is black. resource B<fadeColor>.
118 125
119=item B<-tint> I<colour> 126=item B<-tint> I<colour>
120 127
121Tint the transparent background pixmap with the given colour when 128Tint the transparent background pixmap with the given colour when
122transparency is enabled with B<-tr> or B<-ip>. See also the B<-sh> 129transparency is enabled with B<-tr> or B<-ip>. See also the B<-sh>
123option that can be used to brighten or darken the image in addition to 130option that can be used to brighten or darken the image in addition to
124tinting it. 131tinting it; resource I<tintColor>. Example:
132
133 @@RXVT_NAME@@ -tr -tint blue -sh 40
125 134
126=item B<-sh> 135=item B<-sh>
127 136
128I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent 137I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent
129background image in addition to tinting it (i.e. B<-tint> must be 138background image in addition to tinting it (i.e. B<-tint> must be
… …
238 247
239Put scrollbar on right/left; resource B<scrollBar_right>. 248Put scrollbar on right/left; resource B<scrollBar_right>.
240 249
241=item B<-st>|B<+st> 250=item B<-st>|B<+st>
242 251
243Display normal (non XTerm/NeXT) scrollbar without/with a trough; 252Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
244resource B<scrollBar_floating>. 253resource B<scrollBar_floating>.
245 254
246=item B<-ptab>|B<+ptab> 255=item B<-ptab>|B<+ptab>
247 256
248If enabled (default), "Horizontal Tab" characters are being stored as 257If enabled (default), "Horizontal Tab" characters are being stored as
… …
368=item B<-ssr>|B<+ssr> 377=item B<-ssr>|B<+ssr>
369 378
370Turn on/off secondary screen scroll (default enabled); resource 379Turn on/off secondary screen scroll (default enabled); resource
371B<secondaryScroll>. 380B<secondaryScroll>.
372 381
373=item B<-keysym.>I<sym>: I<string> 382=item B<-keysym.>I<sym> I<string>
374 383
375Remap a key symbol. See resource B<keysym>. 384Remap a key symbol. See resource B<keysym>.
376 385
377=item B<-xrm> I<resourcestring> 386=item B<-embed> I<windowid>
378 387
379No effect on rxvt-unicode. Simply passes through an argument to be made 388Tells @@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 389which enables applications to easily embed a terminal.
381some window managers. 390
391Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
392shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
393quite a bit, so don't expect it to keep some specific state. It's best to
394create an extra subwindow for @@RXVT_NAME@@ and leave it alone.
395
396The window will not be destroyed when @@RXVT_NAME@@ exits.
397
398It might be useful to know that @@RXVT_NAME@@ will not close file
399descriptors passed to it (except for stdin/out/err, of course), so you
400can use file descriptors to communicate with the programs within the
401terminal. This works regardless of wether the C<-embed> option was used or
402not.
403
404Here is a short Gtk2-perl snippet that illustrates how this option can be
405used (a longer example is in F<doc/embed>):
406
407 my $rxvt = new Gtk2::Socket;
408 $rxvt->signal_connect_after (realize => sub {
409 my $xid = $_[0]->window->get_xid;
410 system "@@RXVT_NAME@@ -embed $xid &";
411 });
412
413=item B<-pty-fd> I<fileno>
414
415Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
416pair but instead use the given filehandle as the tty master. This is
417useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
418without having to run a program within it.
419
420If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
421entries and will not tinker with pty/tty permissions - you have to do that
422yourself if you want that.
423
424Here is a example in perl that illustrates how this option can be used (a
425longer example is in F<doc/pty-fd>):
426
427 use IO::Pty;
428 use Fcntl;
429
430 my $pty = new IO::Pty;
431 fcntl $pty, F_SETFD, 0; # clear close-on-exec
432 system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";
433 close $pty;
434
435 # now communicate with rxvt
436 my $slave = $pty->slave;
437 while (<$slave>) { print $slave "got <$_>\n" }
382 438
383=back 439=back
384 440
385=head1 RESOURCES (available also as long-options) 441=head1 RESOURCES (available also as long-options)
386 442
… …
501artificial transparency. B<False>: do not inherit the parent windows' 557artificial transparency. B<False>: do not inherit the parent windows'
502pixmap. 558pixmap.
503 559
504=item B<fading:> I<number> 560=item B<fading:> I<number>
505 561
506Fade the text by the given percentage when focus is lost. 562Fade the text by the given percentage when focus is lost; option B<-fade>.
563
564=item B<fadeColor:> I<colour>
565
566Fade to this colour, when fading is used (see B<fading:>). The default
567colour is black; option B<-fadecolor>.
507 568
508=item B<tintColor:> I<colour> 569=item B<tintColor:> I<colour>
509 570
510Tint the transparent background pixmap with the given colour. 571Tint the transparent background pixmap with the given colour; option
572B<-tint>.
511 573
512=item B<shading:> I<number> 574=item B<shading:> I<number>
513 575
514Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 576Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
515image in addition to tinting it. 577image in addition to tinting it.
… …
519Use the specified colour for the scrollbar [default #B2B2B2]. 581Use the specified colour for the scrollbar [default #B2B2B2].
520 582
521=item B<troughColor:> I<colour> 583=item B<troughColor:> I<colour>
522 584
523Use the specified colour for the scrollbar's trough area [default 585Use the specified colour for the scrollbar's trough area [default
524#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 586#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
525 587
526=item B<borderColor:> I<colour> 588=item B<borderColor:> I<colour>
527 589
528The colour of the border around the text area and between the scrollbar 590The colour of the border around the text area and between the scrollbar
529and the text. 591and the text.
… …
621xterm style selection. 683xterm style selection.
622 684
623=item B<scrollstyle:> I<mode> 685=item B<scrollstyle:> I<mode>
624 686
625Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is 687Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
626the author's favourite.. 688the author's favourite.
627 689
628=item B<title:> I<string> 690=item B<title:> I<string>
629 691
630Set window title string, the default title is the command-line 692Set window title string, the default title is the command-line
631specified after the B<-e> option, if any, otherwise the application 693specified after the B<-e> option, if any, otherwise the application
… …
663 725
664Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use 726Specify 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 727B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or
666B<Shift-Print> to include the scrollback as well. 728B<Shift-Print> to include the scrollback as well.
667 729
730The string will be interpreted as if typed into the shell as-is.
731
732Example:
733
734 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
735
736This creates a new file in your home directory with the screen contents
737everytime you hit C<Print>.
738
668=item B<scrollBar:> I<boolean> 739=item B<scrollBar:> I<boolean>
669 740
670B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 741B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
671disable the scrollbar; option B<+sb>. 742disable the scrollbar; option B<+sb>.
672 743
… …
692B<+si>. 763B<+si>.
693 764
694=item B<scrollWithBuffer:> I<boolean> 765=item B<scrollWithBuffer:> I<boolean>
695 766
696B<True>: scroll with scrollback buffer when tty receives new lines (and 767B<True>: scroll with scrollback buffer when tty receives new lines (and
697B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll 768B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
698with scrollback buffer when tty recieves new lines; option B<-sw>. 769with scrollback buffer when tty recieves new lines; option B<+sw>.
699 770
700=item B<scrollTtyKeypress:> I<boolean> 771=item B<scrollTtyKeypress:> I<boolean>
701 772
702B<True>: scroll to bottom when a non-special key is pressed. Special keys 773B<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 774are those which are intercepted by rxvt-unicode for special handling and
… …
768 839
769Mouse pointer background colour. 840Mouse pointer background colour.
770 841
771=item B<pointerBlankDelay:> I<number> 842=item B<pointerBlankDelay:> I<number>
772 843
773Specifies number of seconds before blanking the pointer [default 2]. 844Specifies number of seconds before blanking the pointer [default 2]. Use a
845large number (e.g. C<987654321>) to effectively disable the timeout.
774 846
775=item B<backspacekey:> I<string> 847=item B<backspacekey:> I<string>
776 848
777The string to send when the backspace key is pressed. If set to B<DEC> 849The 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> 850or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>
… …
909is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 981is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
910example the following means "change the current locale to C<zh_CN.GBK> 982example the following means "change the current locale to C<zh_CN.GBK>
911when Control-Meta-c is being pressed": 983when Control-Meta-c is being pressed":
912 984
913 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 985 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
986
987Due the the large number of modifier combinations, a defined key mapping
988will match if at I<at least> the specified identifiers are being set, and
989no other key mappings with those and more bits are being defined. That
990means that defining a key map for C<a> will automatically provide
991definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
992mappings themselves.
993
994Unfortunately, this will override built-in key mappings. For example
995if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s
996C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the
997user-defined keymap using the C<builtin:> replacement:
998
999 URxvt.keysym.Insert: <my insert key sequence>
1000 URxvt.keysym.S-Insert: builtin:
1001
1002The first line defines a mapping for C<Insert> and I<any> combination
1003of modifiers. The second line re-establishes the default mapping for
1004C<Shift-Insert>.
914 1005
915The following example will map Control-Meta-1 and Control-Meta-2 to 1006The 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 1007the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
917font-switching at runtime: 1008font-switching at runtime:
918 1009
… …
1171=item B<RXVT_SOCKET> 1262=item B<RXVT_SOCKET>
1172 1263
1173The unix domain socket path used by @@RXVT_NAME@@c(1) and 1264The unix domain socket path used by @@RXVT_NAME@@c(1) and
1174@@RXVT_NAME@@d(1). 1265@@RXVT_NAME@@d(1).
1175 1266
1176Default C<< $HOME/.rxvt-unicode-<nodename >>. 1267Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.
1177 1268
1178=item B<HOME> 1269=item B<HOME>
1179 1270
1180Used to locate the default directory for the unix domain socket for 1271Used to locate the default directory for the unix domain socket for
1181daemon communications and to locate various resource files (such as 1272daemon communications and to locate various resource files (such as
… …
1202 1293
1203=back 1294=back
1204 1295
1205=head1 SEE ALSO 1296=head1 SEE ALSO
1206 1297
1207@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) 1298@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1208 1299
1209=head1 BUGS 1300=head1 BUGS
1210 1301
1211Check the BUGS file for an up-to-date list. 1302Check the BUGS file for an up-to-date list.
1212 1303
… …
1218 1309
1219=over 4 1310=over 4
1220 1311
1221=item Project Coordinator 1312=item Project Coordinator
1222 1313
1223@@RXVT_MAINT@@ L<@@RXVT_MAINTEMAIL@@> 1314Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1224 1315
1225L<@@RXVT_WEBPAGE@@> 1316L<http://software.schmorp.de/#rxvt-unicode>
1226 1317
1227=back 1318=back
1228 1319
1229=head1 AUTHORS 1320=head1 AUTHORS
1230 1321
… …
1255=item Geoff Wing L<< <gcw@pobox.com> >> 1346=item Geoff Wing L<< <gcw@pobox.com> >>
1256 1347
1257Rewrote screen display and text selection routines. Project Coordinator 1348Rewrote screen display and text selection routines. Project Coordinator
1258(changes.txt 2.4.6 - rxvt-unicode) 1349(changes.txt 2.4.6 - rxvt-unicode)
1259 1350
1260=item Marc Alexander Lehmann L<< <rxvt@schmorp.de> >> 1351=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1261 1352
1262Forked rxvt-unicode, rewrote most of the display code and internal 1353Forked rxvt-unicode, rewrote most of the display code and internal
1263character handling to store text in unicode, improve xterm 1354character handling to store text in unicode, improve xterm
1264compatibility and apply numerous other bugfixes and extensions. 1355compatibility and apply numerous other bugfixes and extensions.
1265 1356

Diff Legend

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