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.56 by root, Mon Feb 14 18:47:54 2005 UTC vs.
Revision 1.76 by root, Sat Dec 31 16:06:48 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
192=item B<-fbi> I<fontlist> 202=item B<-fbi> I<fontlist>
193 203
194Compile font-styles: The bold italic font list to use when bold characters are to 204Compile font-styles: The bold italic font list to use when bold characters are to
195be printed. See resource B<boldItalicFont> for details. 205be printed. See resource B<boldItalicFont> for details.
196 206
207=item B<-is>|B<+is>
208
209Compile font-styles: Bold/Italic font styles imply high intensity
210foreground/background (default). See resource B<intensityStyles> for
211details.
212
197=item B<-name> I<name> 213=item B<-name> I<name>
198 214
199Specify the application name under which resources are to be obtained, 215Specify the application name under which resources are to be obtained,
200rather than the default executable file name. Name should not contain 216rather than the default executable file name. Name should not contain
201`.' or `*' characters. Also sets the icon and title name. 217`.' or `*' characters. Also sets the icon and title name.
238 254
239Put scrollbar on right/left; resource B<scrollBar_right>. 255Put scrollbar on right/left; resource B<scrollBar_right>.
240 256
241=item B<-st>|B<+st> 257=item B<-st>|B<+st>
242 258
243Display normal (non XTerm/NeXT) scrollbar without/with a trough; 259Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
244resource B<scrollBar_floating>. 260resource B<scrollBar_floating>.
245 261
246=item B<-ptab>|B<+ptab> 262=item B<-ptab>|B<+ptab>
247 263
248If enabled (default), "Horizontal Tab" characters are being stored as 264If enabled (default), "Horizontal Tab" characters are being stored as
303given on the command line. If this option is used, it must be the last 319given on the command line. If this option is used, it must be the last
304on the command-line. If there is no B<-e> option then the default is to 320on the command-line. If there is no B<-e> option then the default is to
305run the program specified by the B<SHELL> environment variable or, 321run the program specified by the B<SHELL> environment variable or,
306failing that, I<sh(1)>. 322failing that, I<sh(1)>.
307 323
324Please note that you must specify a program with arguments. If you want to
325run shell commands, you have to specify the shell, like this:
326
327 @@RXVT_NAME@@ -e sh -c "shell commands"
328
308=item B<-title> I<text> 329=item B<-title> I<text>
309 330
310Window title (B<-T> still respected); the default title is the basename 331Window title (B<-T> still respected); the default title is the basename
311of the program specified after the B<-e> option, if any, otherwise the 332of the program specified after the B<-e> option, if any, otherwise the
312application name; resource B<title>. 333application name; resource B<title>.
368=item B<-ssr>|B<+ssr> 389=item B<-ssr>|B<+ssr>
369 390
370Turn on/off secondary screen scroll (default enabled); resource 391Turn on/off secondary screen scroll (default enabled); resource
371B<secondaryScroll>. 392B<secondaryScroll>.
372 393
394=item B<-hold>|B<+hold>
395
396Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
397will not immediately destroy its window when the program executed within
398it exits. Instead, it will wait till it is being killed or closed by the
399user; resource B<hold>.
400
373=item B<-keysym.>I<sym>: I<string> 401=item B<-keysym.>I<sym> I<string>
374 402
375Remap a key symbol. See resource B<keysym>. 403Remap a key symbol. See resource B<keysym>.
376 404
377=item B<-embed>: I<windowid> 405=item B<-embed> I<windowid>
378 406
379Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window, 407Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window,
380which enables applications to easily embed a terminal. 408which enables applications to easily embed a terminal.
381 409
382Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it 410Right 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 411shouldn'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 412quite 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. 413create an extra subwindow for @@RXVT_NAME@@ and leave it alone.
414
415The window will not be destroyed when @@RXVT_NAME@@ exits.
386 416
387It might be useful to know that @@RXVT_NAME@@ will not close file 417It might be useful to know that @@RXVT_NAME@@ will not close file
388descriptors passed to it (except for stdin/out/err, of course), so you 418descriptors passed to it (except for stdin/out/err, of course), so you
389can use file descriptors to communicate with the programs within the 419can use file descriptors to communicate with the programs within the
390terminal. This works regardless of wether the C<-embed> option was used or 420terminal. This works regardless of wether the C<-embed> option was used or
391not. 421not.
422
423Here is a short Gtk2-perl snippet that illustrates how this option can be
424used (a longer example is in F<doc/embed>):
425
426 my $rxvt = new Gtk2::Socket;
427 $rxvt->signal_connect_after (realize => sub {
428 my $xid = $_[0]->window->get_xid;
429 system "@@RXVT_NAME@@ -embed $xid &";
430 });
431
432=item B<-pty-fd> I<fileno>
433
434Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
435pair but instead use the given filehandle as the tty master. This is
436useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
437without having to run a program within it.
438
439If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
440entries and will not tinker with pty/tty permissions - you have to do that
441yourself if you want that.
442
443Here is a example in perl that illustrates how this option can be used (a
444longer example is in F<doc/pty-fd>):
445
446 use IO::Pty;
447 use Fcntl;
448
449 my $pty = new IO::Pty;
450 fcntl $pty, F_SETFD, 0; # clear close-on-exec
451 system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";
452 close $pty;
453
454 # now communicate with rxvt
455 my $slave = $pty->slave;
456 while (<$slave>) { print $slave "got <$_>\n" }
392 457
393=back 458=back
394 459
395=head1 RESOURCES (available also as long-options) 460=head1 RESOURCES (available also as long-options)
396 461
511artificial transparency. B<False>: do not inherit the parent windows' 576artificial transparency. B<False>: do not inherit the parent windows'
512pixmap. 577pixmap.
513 578
514=item B<fading:> I<number> 579=item B<fading:> I<number>
515 580
516Fade the text by the given percentage when focus is lost. 581Fade the text by the given percentage when focus is lost; option B<-fade>.
582
583=item B<fadeColor:> I<colour>
584
585Fade to this colour, when fading is used (see B<fading:>). The default
586colour is black; option B<-fadecolor>.
517 587
518=item B<tintColor:> I<colour> 588=item B<tintColor:> I<colour>
519 589
520Tint the transparent background pixmap with the given colour. 590Tint the transparent background pixmap with the given colour; option
591B<-tint>.
521 592
522=item B<shading:> I<number> 593=item B<shading:> I<number>
523 594
524Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 595Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
525image in addition to tinting it. 596image in addition to tinting it.
529Use the specified colour for the scrollbar [default #B2B2B2]. 600Use the specified colour for the scrollbar [default #B2B2B2].
530 601
531=item B<troughColor:> I<colour> 602=item B<troughColor:> I<colour>
532 603
533Use the specified colour for the scrollbar's trough area [default 604Use the specified colour for the scrollbar's trough area [default
534#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 605#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
535 606
536=item B<borderColor:> I<colour> 607=item B<borderColor:> I<colour>
537 608
538The colour of the border around the text area and between the scrollbar 609The colour of the border around the text area and between the scrollbar
539and the text. 610and the text.
622not possible, replacement fonts of the desired shape will be tried. 693not possible, replacement fonts of the desired shape will be tried.
623 694
624If set, but empty, then this specific style is disabled and the normal 695If set, but empty, then this specific style is disabled and the normal
625text font will being used for the given style. 696text font will being used for the given style.
626 697
698=item B<intensityStyles:> I<boolean>
699
700When font styles are not enabled, or this option is enabled (B<True>,
701option B<-is>, the default), bold and italic font styles imply high
702intensity foreground/backround colours. Disabling this option (B<False>,
703option B<+is>) disables this behaviour, the high intensity colours are not
704reachable.
705
627=item B<selectstyle:> I<mode> 706=item B<selectstyle:> I<mode>
628 707
629Set mouse selection style to B<old> which is 2.20, B<oldword> which is 708Set mouse selection style to B<old> which is 2.20, B<oldword> which is
630xterm style with 2.20 old word selection, or anything else which gives 709xterm style with 2.20 old word selection, or anything else which gives
631xterm style selection. 710xterm style selection.
632 711
633=item B<scrollstyle:> I<mode> 712=item B<scrollstyle:> I<mode>
634 713
635Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is 714Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
636the author's favourite.. 715the author's favourite.
637 716
638=item B<title:> I<string> 717=item B<title:> I<string>
639 718
640Set window title string, the default title is the command-line 719Set window title string, the default title is the command-line
641specified after the B<-e> option, if any, otherwise the application 720specified after the B<-e> option, if any, otherwise the application
673 752
674Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use 753Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use
675B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or 754B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or
676B<Shift-Print> to include the scrollback as well. 755B<Shift-Print> to include the scrollback as well.
677 756
757The string will be interpreted as if typed into the shell as-is.
758
759Example:
760
761 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
762
763This creates a new file in your home directory with the screen contents
764everytime you hit C<Print>.
765
678=item B<scrollBar:> I<boolean> 766=item B<scrollBar:> I<boolean>
679 767
680B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 768B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
681disable the scrollbar; option B<+sb>. 769disable the scrollbar; option B<+sb>.
682 770
702B<+si>. 790B<+si>.
703 791
704=item B<scrollWithBuffer:> I<boolean> 792=item B<scrollWithBuffer:> I<boolean>
705 793
706B<True>: scroll with scrollback buffer when tty receives new lines (and 794B<True>: scroll with scrollback buffer when tty receives new lines (and
707B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll 795B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
708with scrollback buffer when tty recieves new lines; option B<-sw>. 796with scrollback buffer when tty recieves new lines; option B<+sw>.
709 797
710=item B<scrollTtyKeypress:> I<boolean> 798=item B<scrollTtyKeypress:> I<boolean>
711 799
712B<True>: scroll to bottom when a non-special key is pressed. Special keys 800B<True>: scroll to bottom when a non-special key is pressed. Special keys
713are those which are intercepted by rxvt-unicode for special handling and 801are those which are intercepted by rxvt-unicode for special handling and
778 866
779Mouse pointer background colour. 867Mouse pointer background colour.
780 868
781=item B<pointerBlankDelay:> I<number> 869=item B<pointerBlankDelay:> I<number>
782 870
783Specifies number of seconds before blanking the pointer [default 2]. 871Specifies number of seconds before blanking the pointer [default 2]. Use a
872large number (e.g. C<987654321>) to effectively disable the timeout.
784 873
785=item B<backspacekey:> I<string> 874=item B<backspacekey:> I<string>
786 875
787The string to send when the backspace key is pressed. If set to B<DEC> 876The string to send when the backspace key is pressed. If set to B<DEC>
788or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace> 877or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>
835=item B<insecure:> I<boolean> 924=item B<insecure:> I<boolean>
836 925
837Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 926Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
838echo arbitrary strings like the icon name or the locale. This could be 927echo arbitrary strings like the icon name or the locale. This could be
839abused if somebody gets 8-bit-clean access to your display, whether 928abused if somebody gets 8-bit-clean access to your display, whether
840throuh a mail client displaying mail bodies unfiltered or though 929through a mail client displaying mail bodies unfiltered or through
841write(1). Therefore, these sequences are disabled by default. (Note 930write(1) or any other means. Therefore, these sequences are disabled by
842that other terminals, including xterm, have these sequences 931default. (Note that many other terminals, including xterm, have these
843enabled by default). You can enable them by setting this boolean 932sequences enabled by default, which doesn't make it safer, though).
844resource or specifying B<-insecure> as an option. At the moment, this 933
845enabled display-answer, locale, findfont, icon label and window title 934You can enable them by setting this boolean resource or specifying
846requests as well as dynamic menubar dispatch. 935B<-insecure> as an option. At the moment, this enables display-answer,
936locale, findfont, icon label and window title requests as well as dynamic
937menubar dispatch.
847 938
848=item B<modifier:> I<modifier> 939=item B<modifier:> I<modifier>
849 940
850Set the key to be interpreted as the Meta key to: B<alt>, B<meta>, 941Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
851B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option 942B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
865 956
866Turn on/off secondary screen scroll (default enabled). If the this 957Turn on/off secondary screen scroll (default enabled). If the this
867option is enabled, scrolls on the secondary screen will change the 958option is enabled, scrolls on the secondary screen will change the
868scrollback buffer and switching to/from the secondary screen will 959scrollback buffer and switching to/from the secondary screen will
869instead scroll the screen up. 960instead scroll the screen up.
961
962=item B<hold>: I<bool>
963
964Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
965will not immediately destroy its window when the program executed within
966it exits. Instead, it will wait till it is being killed or closed by the
967user.
870 968
871=item B<keysym.>I<sym>: I<string> 969=item B<keysym.>I<sym>: I<string>
872 970
873Compile I<frills>: Associate I<string> with keysym I<sym>. The 971Compile I<frills>: Associate I<string> with keysym I<sym>. The
874intervening resource name B<keysym.> cannot be omitted. 972intervening resource name B<keysym.> cannot be omitted.
919is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1017is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
920example the following means "change the current locale to C<zh_CN.GBK> 1018example the following means "change the current locale to C<zh_CN.GBK>
921when Control-Meta-c is being pressed": 1019when Control-Meta-c is being pressed":
922 1020
923 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1021 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1022
1023Due the the large number of modifier combinations, a defined key mapping
1024will match if at I<at least> the specified identifiers are being set, and
1025no other key mappings with those and more bits are being defined. That
1026means that defining a key map for C<a> will automatically provide
1027definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1028mappings themselves.
1029
1030Unfortunately, this will override built-in key mappings. For example
1031if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s
1032C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the
1033user-defined keymap using the C<builtin:> replacement:
1034
1035 URxvt.keysym.Insert: <my insert key sequence>
1036 URxvt.keysym.S-Insert: builtin:
1037
1038The first line defines a mapping for C<Insert> and I<any> combination
1039of modifiers. The second line re-establishes the default mapping for
1040C<Shift-Insert>.
924 1041
925The following example will map Control-Meta-1 and Control-Meta-2 to 1042The following example will map Control-Meta-1 and Control-Meta-2 to
926the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited 1043the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
927font-switching at runtime: 1044font-switching at runtime:
928 1045
976to select a word; Left triple-click to select the entire logical line 1093to select a word; Left triple-click to select the entire logical line
977(which can span multiple screen lines), unless modified by resource 1094(which can span multiple screen lines), unless modified by resource
978B<tripleclickwords>. 1095B<tripleclickwords>.
979 1096
980Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys) 1097Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
981(Compile: I<frills>) will create a rectangular selection instead of a normal 1098(Compile: I<frills>) will create a rectangular selection instead of a
982one. 1099normal one. In this mode, every selected row becomes its own line in the
1100selection, and trailing whitespace is visually underlined and removed from
1101the selection.
983 1102
984=item B<Insertion>: 1103=item B<Insertion>:
985 1104
986Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1105Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in
987an B<@@RXVT_NAME@@> window causes the current text selection to be 1106an B<@@RXVT_NAME@@> window causes the current text selection to be
995supported in rxvt-unicode. Bug me if you need this. 1114supported in rxvt-unicode. Bug me if you need this.
996 1115
997You can, however, switch fonts at runtime using escape sequences (and 1116You can, however, switch fonts at runtime using escape sequences (and
998therefore using the menubar), e.g.: 1117therefore using the menubar), e.g.:
999 1118
1000 printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic" 1119 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1001 1120
1002rxvt-unicode will automatically re-apply these fonts to the output so far. 1121rxvt-unicode will automatically re-apply these fonts to the output so far.
1003 1122
1004=head1 ISO 14755 SUPPORT 1123=head1 ISO 14755 SUPPORT
1005 1124
1181=item B<RXVT_SOCKET> 1300=item B<RXVT_SOCKET>
1182 1301
1183The unix domain socket path used by @@RXVT_NAME@@c(1) and 1302The unix domain socket path used by @@RXVT_NAME@@c(1) and
1184@@RXVT_NAME@@d(1). 1303@@RXVT_NAME@@d(1).
1185 1304
1186Default C<< $HOME/.rxvt-unicode-<nodename >>. 1305Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.
1187 1306
1188=item B<HOME> 1307=item B<HOME>
1189 1308
1190Used to locate the default directory for the unix domain socket for 1309Used to locate the default directory for the unix domain socket for
1191daemon communications and to locate various resource files (such as 1310daemon communications and to locate various resource files (such as
1212 1331
1213=back 1332=back
1214 1333
1215=head1 SEE ALSO 1334=head1 SEE ALSO
1216 1335
1217@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) 1336@@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)
1218
1219=head1 BUGS
1220
1221Check the BUGS file for an up-to-date list.
1222
1223Cursor change support is not yet implemented.
1224
1225Click-and-drag doesn't work with X11 mouse report overriding.
1226 1337
1227=head1 CURRENT PROJECT COORDINATOR 1338=head1 CURRENT PROJECT COORDINATOR
1228 1339
1229=over 4 1340=over 4
1230 1341

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines