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.68 by root, Thu Aug 11 02:05:07 2005 UTC

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

Diff Legend

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