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.67 by root, Thu Jul 7 19:37:46 2005 UTC vs.
Revision 1.81 by root, Mon Jan 2 21:41:51 2006 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
191 201
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.
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.
196 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
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>.
367 388
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>.
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>.
372 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
424 close $pty; 452 close $pty;
425 453
426 # now communicate with rxvt 454 # now communicate with rxvt
427 my $slave = $pty->slave; 455 my $slave = $pty->slave;
428 while (<$slave>) { print $slave "got <$_>\n" } 456 while (<$slave>) { print $slave "got <$_>\n" }
457
458=item B<-pe> I<string>
459
460Colon-separated list of perl extension scripts to use in this terminal instance. See resource B<perl-ext>.
429 461
430=back 462=back
431 463
432=head1 RESOURCES (available also as long-options) 464=head1 RESOURCES (available also as long-options)
433 465
548artificial transparency. B<False>: do not inherit the parent windows' 580artificial transparency. B<False>: do not inherit the parent windows'
549pixmap. 581pixmap.
550 582
551=item B<fading:> I<number> 583=item B<fading:> I<number>
552 584
553Fade the text by the given percentage when focus is lost. 585Fade the text by the given percentage when focus is lost; option B<-fade>.
586
587=item B<fadeColor:> I<colour>
588
589Fade to this colour, when fading is used (see B<fading:>). The default
590colour is black; option B<-fadecolor>.
554 591
555=item B<tintColor:> I<colour> 592=item B<tintColor:> I<colour>
556 593
557Tint the transparent background pixmap with the given colour. 594Tint the transparent background pixmap with the given colour; option
595B<-tint>.
558 596
559=item B<shading:> I<number> 597=item B<shading:> I<number>
560 598
561Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 599Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
562image in addition to tinting it. 600image in addition to tinting it.
603 641
604Select the fonts to be used. This is a comma separated list of font 642Select the fonts to be used. This is a comma separated list of font
605names that are used in turn when trying to display Unicode characters. 643names that are used in turn when trying to display Unicode characters.
606The first font defines the cell size for characters; other fonts might 644The first font defines the cell size for characters; other fonts might
607be smaller, but not larger. A reasonable default font list is always 645be smaller, but not larger. A reasonable default font list is always
608appended to it. option B<-fn>. 646appended to it; option B<-fn>.
609 647
610Each font can either be a standard X11 core font (XLFD) name, with 648Each font can either be a standard X11 core font (XLFD) name, with
611optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>. 649optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
612 650
613In addition, each font can be prefixed with additional hints and 651In addition, each font can be prefixed with additional hints and
659not possible, replacement fonts of the desired shape will be tried. 697not possible, replacement fonts of the desired shape will be tried.
660 698
661If set, but empty, then this specific style is disabled and the normal 699If set, but empty, then this specific style is disabled and the normal
662text font will being used for the given style. 700text font will being used for the given style.
663 701
702=item B<intensityStyles:> I<boolean>
703
704When font styles are not enabled, or this option is enabled (B<True>,
705option B<-is>, the default), bold and italic font styles imply high
706intensity foreground/backround colours. Disabling this option (B<False>,
707option B<+is>) disables this behaviour, the high intensity colours are not
708reachable.
709
664=item B<selectstyle:> I<mode> 710=item B<selectstyle:> I<mode>
665 711
666Set mouse selection style to B<old> which is 2.20, B<oldword> which is 712Set mouse selection style to B<old> which is 2.20, B<oldword> which is
667xterm style with 2.20 old word selection, or anything else which gives 713xterm style with 2.20 old word selection, or anything else which gives
668xterm style selection. 714xterm style selection.
860=item B<imLocale:> I<name> 906=item B<imLocale:> I<name>
861 907
862The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g. 908The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
863C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the 909C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
864input extension to be able to input japanese characters while staying in 910input extension to be able to input japanese characters while staying in
865another locale. option B<-imlocale>. 911another locale; option B<-imlocale>.
866 912
867=item B<imFont:> I<fontset> 913=item B<imFont:> I<fontset>
868 914
869Specify the font-set used for XIM styles C<OverTheSpot> or 915Specify the font-set used for XIM styles C<OverTheSpot> or
870C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated 916C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
875 921
876=item B<tripleclickwords:> I<boolean> 922=item B<tripleclickwords:> I<boolean>
877 923
878Change the meaning of triple-click selection with the left mouse 924Change the meaning of triple-click selection with the left mouse
879button. Instead of selecting a full line it will extend the selection to 925button. Instead of selecting a full line it will extend the selection to
880the end of the logical line only. option B<-tcw>. 926the end of the logical line only; option B<-tcw>.
881 927
882=item B<insecure:> I<boolean> 928=item B<insecure:> I<boolean>
883 929
884Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 930Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
885echo arbitrary strings like the icon name or the locale. This could be 931echo arbitrary strings like the icon name or the locale. This could be
886abused if somebody gets 8-bit-clean access to your display, whether 932abused if somebody gets 8-bit-clean access to your display, whether
887throuh a mail client displaying mail bodies unfiltered or though 933through a mail client displaying mail bodies unfiltered or through
888write(1). Therefore, these sequences are disabled by default. (Note 934write(1) or any other means. Therefore, these sequences are disabled by
889that other terminals, including xterm, have these sequences 935default. (Note that many other terminals, including xterm, have these
890enabled by default). You can enable them by setting this boolean 936sequences enabled by default, which doesn't make it safer, though).
891resource or specifying B<-insecure> as an option. At the moment, this 937
892enabled display-answer, locale, findfont, icon label and window title 938You can enable them by setting this boolean resource or specifying
893requests as well as dynamic menubar dispatch. 939B<-insecure> as an option. At the moment, this enables display-answer,
940locale, findfont, icon label and window title requests as well as dynamic
941menubar dispatch.
894 942
895=item B<modifier:> I<modifier> 943=item B<modifier:> I<modifier>
896 944
897Set the key to be interpreted as the Meta key to: B<alt>, B<meta>, 945Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
898B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option 946B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
912 960
913Turn on/off secondary screen scroll (default enabled). If the this 961Turn on/off secondary screen scroll (default enabled). If the this
914option is enabled, scrolls on the secondary screen will change the 962option is enabled, scrolls on the secondary screen will change the
915scrollback buffer and switching to/from the secondary screen will 963scrollback buffer and switching to/from the secondary screen will
916instead scroll the screen up. 964instead scroll the screen up.
965
966=item B<hold>: I<bool>
967
968Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
969will not immediately destroy its window when the program executed within
970it exits. Instead, it will wait till it is being killed or closed by the
971user.
917 972
918=item B<keysym.>I<sym>: I<string> 973=item B<keysym.>I<sym>: I<string>
919 974
920Compile I<frills>: Associate I<string> with keysym I<sym>. The 975Compile I<frills>: Associate I<string> with keysym I<sym>. The
921intervening resource name B<keysym.> cannot be omitted. 976intervening resource name B<keysym.> cannot be omitted.
966is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1021is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
967example the following means "change the current locale to C<zh_CN.GBK> 1022example the following means "change the current locale to C<zh_CN.GBK>
968when Control-Meta-c is being pressed": 1023when Control-Meta-c is being pressed":
969 1024
970 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1025 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1026
1027If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1028is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)
1029manpage. For example, the F<selection> extension (activated via
1030C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1031
1032 URxvt.keysym.M-C-c: perl:selection:rot13
971 1033
972Due the the large number of modifier combinations, a defined key mapping 1034Due the the large number of modifier combinations, a defined key mapping
973will match if at I<at least> the specified identifiers are being set, and 1035will match if at I<at least> the specified identifiers are being set, and
974no other key mappings with those and more bits are being defined. That 1036no other key mappings with those and more bits are being defined. That
975means that defining a key map for C<a> will automatically provide 1037means that defining a key map for C<a> will automatically provide
999info): 1061info):
1000 1062
1001 URxvt.keysym.M-C-3: command:\033[8;25;80t 1063 URxvt.keysym.M-C-3: command:\033[8;25;80t
1002 URxvt.keysym.M-C-4: command:\033[8;48;110t 1064 URxvt.keysym.M-C-4: command:\033[8;48;110t
1003 1065
1066=item B<perl-ext>: I<string>
1067
1068Colon-separated list of perl extension scripts to use in this terminal
1069instance. Each extension is looked up in the library directories, loaded
1070if necessary, and bound to the current terminal instance; option B<-pe>.
1071
1072=item B<perl-eval>: I<string>
1073
1074Perl code to be evaluated when all extensions have been registered. See the
1075@@RXVT_NAME@@perl(3) manpage.
1076
1077=item B<perl-lib>: I<path>
1078
1079Colon-separated list of additional directories that hold extension
1080scripts. When looking for extensions specified by the C<perl> resource,
1081@@RXVT_NAME@@ will first look in these directories and then in
1082F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1083
1084See the @@RXVT_NAME@@perl(3) manpage.
1085
1004=back 1086=back
1005 1087
1006=head1 THE SCROLLBAR 1088=head1 THE SCROLLBAR
1007 1089
1008Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window 1090Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window
1042to select a word; Left triple-click to select the entire logical line 1124to select a word; Left triple-click to select the entire logical line
1043(which can span multiple screen lines), unless modified by resource 1125(which can span multiple screen lines), unless modified by resource
1044B<tripleclickwords>. 1126B<tripleclickwords>.
1045 1127
1046Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys) 1128Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
1047(Compile: I<frills>) will create a rectangular selection instead of a normal 1129(Compile: I<frills>) will create a rectangular selection instead of a
1048one. 1130normal one. In this mode, every selected row becomes its own line in the
1131selection, and trailing whitespace is visually underlined and removed from
1132the selection.
1049 1133
1050=item B<Insertion>: 1134=item B<Insertion>:
1051 1135
1052Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1136Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in
1053an B<@@RXVT_NAME@@> window causes the current text selection to be 1137an B<@@RXVT_NAME@@> window causes the current text selection to be
1061supported in rxvt-unicode. Bug me if you need this. 1145supported in rxvt-unicode. Bug me if you need this.
1062 1146
1063You can, however, switch fonts at runtime using escape sequences (and 1147You can, however, switch fonts at runtime using escape sequences (and
1064therefore using the menubar), e.g.: 1148therefore using the menubar), e.g.:
1065 1149
1066 printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic" 1150 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1067 1151
1068rxvt-unicode will automatically re-apply these fonts to the output so far. 1152rxvt-unicode will automatically re-apply these fonts to the output so far.
1069 1153
1070=head1 ISO 14755 SUPPORT 1154=head1 ISO 14755 SUPPORT
1071 1155
1280 1364
1281=head1 SEE ALSO 1365=head1 SEE ALSO
1282 1366
1283@@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) 1367@@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)
1284 1368
1285=head1 BUGS
1286
1287Check the BUGS file for an up-to-date list.
1288
1289Cursor change support is not yet implemented.
1290
1291Click-and-drag doesn't work with X11 mouse report overriding.
1292
1293=head1 CURRENT PROJECT COORDINATOR 1369=head1 CURRENT PROJECT COORDINATOR
1294 1370
1295=over 4 1371=over 4
1296 1372
1297=item Project Coordinator 1373=item Project Coordinator

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines