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.59 by root, Thu Feb 17 15:07:48 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
… …
393not. 402not.
394 403
395Here is a short Gtk2-perl snippet that illustrates how this option can be 404Here is a short Gtk2-perl snippet that illustrates how this option can be
396used (a longer example is in F<doc/embed>): 405used (a longer example is in F<doc/embed>):
397 406
398 my $rxvt = new Gtk2::DrawingArea; 407 my $rxvt = new Gtk2::Socket;
399 $...->add ($rxvt); # important to add it somewhere first 408 $rxvt->signal_connect_after (realize => sub {
400 $rxvt->realize; # now it can be realized
401 my $xid = $rxvt->window->get_xid; 409 my $xid = $_[0]->window->get_xid;
402
403 system "@@RXVT_NAME@@ -embed $xid &"; 410 system "@@RXVT_NAME@@ -embed $xid &";
411 });
404 412
405=item B<-pty-fd> I<fileno> 413=item B<-pty-fd> I<fileno>
406 414
407Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty 415Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
408pair but instead use the given filehandle as the tty master. This is 416pair but instead use the given filehandle as the tty master. This is
… …
419 use IO::Pty; 427 use IO::Pty;
420 use Fcntl; 428 use Fcntl;
421 429
422 my $pty = new IO::Pty; 430 my $pty = new IO::Pty;
423 fcntl $pty, F_SETFD, 0; # clear close-on-exec 431 fcntl $pty, F_SETFD, 0; # clear close-on-exec
424
425 system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&"; 432 system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";
433 close $pty;
426 434
427 # now communicate with rxvt 435 # now communicate with rxvt
428 my $slave = $pty->slave; 436 my $slave = $pty->slave;
429 while (<$slave>) { print $slave "got <$_>\n" } 437 while (<$slave>) { print $slave "got <$_>\n" }
430 438
… …
549artificial transparency. B<False>: do not inherit the parent windows' 557artificial transparency. B<False>: do not inherit the parent windows'
550pixmap. 558pixmap.
551 559
552=item B<fading:> I<number> 560=item B<fading:> I<number>
553 561
554Fade 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>.
555 568
556=item B<tintColor:> I<colour> 569=item B<tintColor:> I<colour>
557 570
558Tint the transparent background pixmap with the given colour. 571Tint the transparent background pixmap with the given colour; option
572B<-tint>.
559 573
560=item B<shading:> I<number> 574=item B<shading:> I<number>
561 575
562Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 576Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
563image in addition to tinting it. 577image in addition to tinting it.
… …
567Use the specified colour for the scrollbar [default #B2B2B2]. 581Use the specified colour for the scrollbar [default #B2B2B2].
568 582
569=item B<troughColor:> I<colour> 583=item B<troughColor:> I<colour>
570 584
571Use the specified colour for the scrollbar's trough area [default 585Use the specified colour for the scrollbar's trough area [default
572#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 586#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
573 587
574=item B<borderColor:> I<colour> 588=item B<borderColor:> I<colour>
575 589
576The 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
577and the text. 591and the text.
… …
669xterm style selection. 683xterm style selection.
670 684
671=item B<scrollstyle:> I<mode> 685=item B<scrollstyle:> I<mode>
672 686
673Set 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
674the author's favourite.. 688the author's favourite.
675 689
676=item B<title:> I<string> 690=item B<title:> I<string>
677 691
678Set window title string, the default title is the command-line 692Set window title string, the default title is the command-line
679specified after the B<-e> option, if any, otherwise the application 693specified after the B<-e> option, if any, otherwise the application
… …
710=item B<print-pipe:> I<string> 724=item B<print-pipe:> I<string>
711 725
712Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use 726Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use
713B<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
714B<Shift-Print> to include the scrollback as well. 728B<Shift-Print> to include the scrollback as well.
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>.
715 738
716=item B<scrollBar:> I<boolean> 739=item B<scrollBar:> I<boolean>
717 740
718B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 741B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
719disable the scrollbar; option B<+sb>. 742disable the scrollbar; option B<+sb>.
… …
816 839
817Mouse pointer background colour. 840Mouse pointer background colour.
818 841
819=item B<pointerBlankDelay:> I<number> 842=item B<pointerBlankDelay:> I<number>
820 843
821Specifies 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.
822 846
823=item B<backspacekey:> I<string> 847=item B<backspacekey:> I<string>
824 848
825The 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>
826or 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>
… …
957is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 981is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
958example 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>
959when Control-Meta-c is being pressed": 983when Control-Meta-c is being pressed":
960 984
961 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>.
962 1005
963The 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
964the 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
965font-switching at runtime: 1008font-switching at runtime:
966 1009
… …
1219=item B<RXVT_SOCKET> 1262=item B<RXVT_SOCKET>
1220 1263
1221The unix domain socket path used by @@RXVT_NAME@@c(1) and 1264The unix domain socket path used by @@RXVT_NAME@@c(1) and
1222@@RXVT_NAME@@d(1). 1265@@RXVT_NAME@@d(1).
1223 1266
1224Default C<< $HOME/.rxvt-unicode-<nodename >>. 1267Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.
1225 1268
1226=item B<HOME> 1269=item B<HOME>
1227 1270
1228Used to locate the default directory for the unix domain socket for 1271Used to locate the default directory for the unix domain socket for
1229daemon communications and to locate various resource files (such as 1272daemon communications and to locate various resource files (such as
… …
1250 1293
1251=back 1294=back
1252 1295
1253=head1 SEE ALSO 1296=head1 SEE ALSO
1254 1297
1255@@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)
1256 1299
1257=head1 BUGS 1300=head1 BUGS
1258 1301
1259Check the BUGS file for an up-to-date list. 1302Check the BUGS file for an up-to-date list.
1260 1303

Diff Legend

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