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.58 by root, Wed Feb 16 21:49:36 2005 UTC vs.
Revision 1.71 by root, Tue Oct 25 20:22:39 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>. This only works for
123option that can be used to brighten or darken the image in addition to 130non-tiled backgrounds, currently. See also the B<-sh> option that can be
124tinting it. 131used to brighten or darken the image in addition to tinting it; resource
132I<tintColor>. Example:
133
134 @@RXVT_NAME@@ -tr -tint blue -sh 40
125 135
126=item B<-sh> 136=item B<-sh>
127 137
128I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent 138I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent
129background image in addition to tinting it (i.e. B<-tint> must be 139background image in addition to tinting it (i.e. B<-tint> must be
… …
238 248
239Put scrollbar on right/left; resource B<scrollBar_right>. 249Put scrollbar on right/left; resource B<scrollBar_right>.
240 250
241=item B<-st>|B<+st> 251=item B<-st>|B<+st>
242 252
243Display normal (non XTerm/NeXT) scrollbar without/with a trough; 253Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
244resource B<scrollBar_floating>. 254resource B<scrollBar_floating>.
245 255
246=item B<-ptab>|B<+ptab> 256=item B<-ptab>|B<+ptab>
247 257
248If enabled (default), "Horizontal Tab" characters are being stored as 258If enabled (default), "Horizontal Tab" characters are being stored as
… …
368=item B<-ssr>|B<+ssr> 378=item B<-ssr>|B<+ssr>
369 379
370Turn on/off secondary screen scroll (default enabled); resource 380Turn on/off secondary screen scroll (default enabled); resource
371B<secondaryScroll>. 381B<secondaryScroll>.
372 382
373=item B<-keysym.>I<sym>: I<string> 383=item B<-keysym.>I<sym> I<string>
374 384
375Remap a key symbol. See resource B<keysym>. 385Remap a key symbol. See resource B<keysym>.
376 386
377=item B<-embed>: I<windowid> 387=item B<-embed> I<windowid>
378 388
379Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window, 389Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window,
380which enables applications to easily embed a terminal. 390which enables applications to easily embed a terminal.
381 391
382Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it 392Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
… …
389It might be useful to know that @@RXVT_NAME@@ will not close file 399It 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 400descriptors passed to it (except for stdin/out/err, of course), so you
391can use file descriptors to communicate with the programs within the 401can use file descriptors to communicate with the programs within the
392terminal. This works regardless of wether the C<-embed> option was used or 402terminal. This works regardless of wether the C<-embed> option was used or
393not. 403not.
404
405Here is a short Gtk2-perl snippet that illustrates how this option can be
406used (a longer example is in F<doc/embed>):
407
408 my $rxvt = new Gtk2::Socket;
409 $rxvt->signal_connect_after (realize => sub {
410 my $xid = $_[0]->window->get_xid;
411 system "@@RXVT_NAME@@ -embed $xid &";
412 });
413
414=item B<-pty-fd> I<fileno>
415
416Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
417pair but instead use the given filehandle as the tty master. This is
418useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
419without having to run a program within it.
420
421If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
422entries and will not tinker with pty/tty permissions - you have to do that
423yourself if you want that.
424
425Here is a example in perl that illustrates how this option can be used (a
426longer example is in F<doc/pty-fd>):
427
428 use IO::Pty;
429 use Fcntl;
430
431 my $pty = new IO::Pty;
432 fcntl $pty, F_SETFD, 0; # clear close-on-exec
433 system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";
434 close $pty;
435
436 # now communicate with rxvt
437 my $slave = $pty->slave;
438 while (<$slave>) { print $slave "got <$_>\n" }
394 439
395=back 440=back
396 441
397=head1 RESOURCES (available also as long-options) 442=head1 RESOURCES (available also as long-options)
398 443
… …
513artificial transparency. B<False>: do not inherit the parent windows' 558artificial transparency. B<False>: do not inherit the parent windows'
514pixmap. 559pixmap.
515 560
516=item B<fading:> I<number> 561=item B<fading:> I<number>
517 562
518Fade the text by the given percentage when focus is lost. 563Fade the text by the given percentage when focus is lost; option B<-fade>.
564
565=item B<fadeColor:> I<colour>
566
567Fade to this colour, when fading is used (see B<fading:>). The default
568colour is black; option B<-fadecolor>.
519 569
520=item B<tintColor:> I<colour> 570=item B<tintColor:> I<colour>
521 571
522Tint the transparent background pixmap with the given colour. 572Tint the transparent background pixmap with the given colour; option
573B<-tint>.
523 574
524=item B<shading:> I<number> 575=item B<shading:> I<number>
525 576
526Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 577Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
527image in addition to tinting it. 578image in addition to tinting it.
… …
531Use the specified colour for the scrollbar [default #B2B2B2]. 582Use the specified colour for the scrollbar [default #B2B2B2].
532 583
533=item B<troughColor:> I<colour> 584=item B<troughColor:> I<colour>
534 585
535Use the specified colour for the scrollbar's trough area [default 586Use the specified colour for the scrollbar's trough area [default
536#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 587#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
537 588
538=item B<borderColor:> I<colour> 589=item B<borderColor:> I<colour>
539 590
540The colour of the border around the text area and between the scrollbar 591The colour of the border around the text area and between the scrollbar
541and the text. 592and the text.
… …
633xterm style selection. 684xterm style selection.
634 685
635=item B<scrollstyle:> I<mode> 686=item B<scrollstyle:> I<mode>
636 687
637Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is 688Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
638the author's favourite.. 689the author's favourite.
639 690
640=item B<title:> I<string> 691=item B<title:> I<string>
641 692
642Set window title string, the default title is the command-line 693Set window title string, the default title is the command-line
643specified after the B<-e> option, if any, otherwise the application 694specified after the B<-e> option, if any, otherwise the application
… …
674=item B<print-pipe:> I<string> 725=item B<print-pipe:> I<string>
675 726
676Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use 727Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use
677B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or 728B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or
678B<Shift-Print> to include the scrollback as well. 729B<Shift-Print> to include the scrollback as well.
730
731The string will be interpreted as if typed into the shell as-is.
732
733Example:
734
735 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
736
737This creates a new file in your home directory with the screen contents
738everytime you hit C<Print>.
679 739
680=item B<scrollBar:> I<boolean> 740=item B<scrollBar:> I<boolean>
681 741
682B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 742B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
683disable the scrollbar; option B<+sb>. 743disable the scrollbar; option B<+sb>.
… …
780 840
781Mouse pointer background colour. 841Mouse pointer background colour.
782 842
783=item B<pointerBlankDelay:> I<number> 843=item B<pointerBlankDelay:> I<number>
784 844
785Specifies number of seconds before blanking the pointer [default 2]. 845Specifies number of seconds before blanking the pointer [default 2]. Use a
846large number (e.g. C<987654321>) to effectively disable the timeout.
786 847
787=item B<backspacekey:> I<string> 848=item B<backspacekey:> I<string>
788 849
789The string to send when the backspace key is pressed. If set to B<DEC> 850The string to send when the backspace key is pressed. If set to B<DEC>
790or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace> 851or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>
… …
921is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 982is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
922example the following means "change the current locale to C<zh_CN.GBK> 983example the following means "change the current locale to C<zh_CN.GBK>
923when Control-Meta-c is being pressed": 984when Control-Meta-c is being pressed":
924 985
925 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 986 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
987
988Due the the large number of modifier combinations, a defined key mapping
989will match if at I<at least> the specified identifiers are being set, and
990no other key mappings with those and more bits are being defined. That
991means that defining a key map for C<a> will automatically provide
992definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
993mappings themselves.
994
995Unfortunately, this will override built-in key mappings. For example
996if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s
997C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the
998user-defined keymap using the C<builtin:> replacement:
999
1000 URxvt.keysym.Insert: <my insert key sequence>
1001 URxvt.keysym.S-Insert: builtin:
1002
1003The first line defines a mapping for C<Insert> and I<any> combination
1004of modifiers. The second line re-establishes the default mapping for
1005C<Shift-Insert>.
926 1006
927The following example will map Control-Meta-1 and Control-Meta-2 to 1007The following example will map Control-Meta-1 and Control-Meta-2 to
928the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited 1008the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
929font-switching at runtime: 1009font-switching at runtime:
930 1010
… …
1183=item B<RXVT_SOCKET> 1263=item B<RXVT_SOCKET>
1184 1264
1185The unix domain socket path used by @@RXVT_NAME@@c(1) and 1265The unix domain socket path used by @@RXVT_NAME@@c(1) and
1186@@RXVT_NAME@@d(1). 1266@@RXVT_NAME@@d(1).
1187 1267
1188Default C<< $HOME/.rxvt-unicode-<nodename >>. 1268Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.
1189 1269
1190=item B<HOME> 1270=item B<HOME>
1191 1271
1192Used to locate the default directory for the unix domain socket for 1272Used to locate the default directory for the unix domain socket for
1193daemon communications and to locate various resource files (such as 1273daemon communications and to locate various resource files (such as
… …
1214 1294
1215=back 1295=back
1216 1296
1217=head1 SEE ALSO 1297=head1 SEE ALSO
1218 1298
1219@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) 1299@@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)
1220
1221=head1 BUGS
1222
1223Check the BUGS file for an up-to-date list.
1224
1225Cursor change support is not yet implemented.
1226
1227Click-and-drag doesn't work with X11 mouse report overriding.
1228 1300
1229=head1 CURRENT PROJECT COORDINATOR 1301=head1 CURRENT PROJECT COORDINATOR
1230 1302
1231=over 4 1303=over 4
1232 1304

Diff Legend

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