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.61 by root, Sat Feb 19 01:07:57 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
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>.
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.
566Use the specified colour for the scrollbar [default #B2B2B2]. 604Use the specified colour for the scrollbar [default #B2B2B2].
567 605
568=item B<troughColor:> I<colour> 606=item B<troughColor:> I<colour>
569 607
570Use the specified colour for the scrollbar's trough area [default 608Use the specified colour for the scrollbar's trough area [default
571#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 609#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
572 610
573=item B<borderColor:> I<colour> 611=item B<borderColor:> I<colour>
574 612
575The colour of the border around the text area and between the scrollbar 613The colour of the border around the text area and between the scrollbar
576and the text. 614and the text.
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.
669 715
670=item B<scrollstyle:> I<mode> 716=item B<scrollstyle:> I<mode>
671 717
672Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is 718Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
673the author's favourite.. 719the author's favourite.
674 720
675=item B<title:> I<string> 721=item B<title:> I<string>
676 722
677Set window title string, the default title is the command-line 723Set window title string, the default title is the command-line
678specified after the B<-e> option, if any, otherwise the application 724specified after the B<-e> option, if any, otherwise the application
709=item B<print-pipe:> I<string> 755=item B<print-pipe:> I<string>
710 756
711Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use 757Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use
712B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or 758B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or
713B<Shift-Print> to include the scrollback as well. 759B<Shift-Print> to include the scrollback as well.
760
761The string will be interpreted as if typed into the shell as-is.
762
763Example:
764
765 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
766
767This creates a new file in your home directory with the screen contents
768everytime you hit C<Print>.
714 769
715=item B<scrollBar:> I<boolean> 770=item B<scrollBar:> I<boolean>
716 771
717B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 772B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
718disable the scrollbar; option B<+sb>. 773disable the scrollbar; option B<+sb>.
815 870
816Mouse pointer background colour. 871Mouse pointer background colour.
817 872
818=item B<pointerBlankDelay:> I<number> 873=item B<pointerBlankDelay:> I<number>
819 874
820Specifies number of seconds before blanking the pointer [default 2]. 875Specifies number of seconds before blanking the pointer [default 2]. Use a
876large number (e.g. C<987654321>) to effectively disable the timeout.
821 877
822=item B<backspacekey:> I<string> 878=item B<backspacekey:> I<string>
823 879
824The string to send when the backspace key is pressed. If set to B<DEC> 880The string to send when the backspace key is pressed. If set to B<DEC>
825or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace> 881or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>
850=item B<imLocale:> I<name> 906=item B<imLocale:> I<name>
851 907
852The 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.
853C<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
854input extension to be able to input japanese characters while staying in 910input extension to be able to input japanese characters while staying in
855another locale. option B<-imlocale>. 911another locale; option B<-imlocale>.
856 912
857=item B<imFont:> I<fontset> 913=item B<imFont:> I<fontset>
858 914
859Specify the font-set used for XIM styles C<OverTheSpot> or 915Specify the font-set used for XIM styles C<OverTheSpot> or
860C<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
865 921
866=item B<tripleclickwords:> I<boolean> 922=item B<tripleclickwords:> I<boolean>
867 923
868Change the meaning of triple-click selection with the left mouse 924Change the meaning of triple-click selection with the left mouse
869button. 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
870the end of the logical line only. option B<-tcw>. 926the end of the logical line only; option B<-tcw>.
871 927
872=item B<insecure:> I<boolean> 928=item B<insecure:> I<boolean>
873 929
874Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 930Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
875echo 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
876abused if somebody gets 8-bit-clean access to your display, whether 932abused if somebody gets 8-bit-clean access to your display, whether
877throuh a mail client displaying mail bodies unfiltered or though 933through a mail client displaying mail bodies unfiltered or through
878write(1). Therefore, these sequences are disabled by default. (Note 934write(1) or any other means. Therefore, these sequences are disabled by
879that other terminals, including xterm, have these sequences 935default. (Note that many other terminals, including xterm, have these
880enabled by default). You can enable them by setting this boolean 936sequences enabled by default, which doesn't make it safer, though).
881resource or specifying B<-insecure> as an option. At the moment, this 937
882enabled display-answer, locale, findfont, icon label and window title 938You can enable them by setting this boolean resource or specifying
883requests 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.
884 942
885=item B<modifier:> I<modifier> 943=item B<modifier:> I<modifier>
886 944
887Set 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>,
888B<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
902 960
903Turn on/off secondary screen scroll (default enabled). If the this 961Turn on/off secondary screen scroll (default enabled). If the this
904option is enabled, scrolls on the secondary screen will change the 962option is enabled, scrolls on the secondary screen will change the
905scrollback buffer and switching to/from the secondary screen will 963scrollback buffer and switching to/from the secondary screen will
906instead 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.
907 972
908=item B<keysym.>I<sym>: I<string> 973=item B<keysym.>I<sym>: I<string>
909 974
910Compile I<frills>: Associate I<string> with keysym I<sym>. The 975Compile I<frills>: Associate I<string> with keysym I<sym>. The
911intervening resource name B<keysym.> cannot be omitted. 976intervening resource name B<keysym.> cannot be omitted.
957example 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>
958when Control-Meta-c is being pressed": 1023when Control-Meta-c is being pressed":
959 1024
960 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
961 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
1033
1034Due the the large number of modifier combinations, a defined key mapping
1035will match if at I<at least> the specified identifiers are being set, and
1036no other key mappings with those and more bits are being defined. That
1037means that defining a key map for C<a> will automatically provide
1038definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1039mappings themselves.
1040
1041Unfortunately, this will override built-in key mappings. For example
1042if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s
1043C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the
1044user-defined keymap using the C<builtin:> replacement:
1045
1046 URxvt.keysym.Insert: <my insert key sequence>
1047 URxvt.keysym.S-Insert: builtin:
1048
1049The first line defines a mapping for C<Insert> and I<any> combination
1050of modifiers. The second line re-establishes the default mapping for
1051C<Shift-Insert>.
1052
962The following example will map Control-Meta-1 and Control-Meta-2 to 1053The following example will map Control-Meta-1 and Control-Meta-2 to
963the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited 1054the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
964font-switching at runtime: 1055font-switching at runtime:
965 1056
966 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 1057 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
969Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more 1060Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
970info): 1061info):
971 1062
972 URxvt.keysym.M-C-3: command:\033[8;25;80t 1063 URxvt.keysym.M-C-3: command:\033[8;25;80t
973 URxvt.keysym.M-C-4: command:\033[8;48;110t 1064 URxvt.keysym.M-C-4: command:\033[8;48;110t
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.
974 1085
975=back 1086=back
976 1087
977=head1 THE SCROLLBAR 1088=head1 THE SCROLLBAR
978 1089
1013to 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
1014(which can span multiple screen lines), unless modified by resource 1125(which can span multiple screen lines), unless modified by resource
1015B<tripleclickwords>. 1126B<tripleclickwords>.
1016 1127
1017Starting 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)
1018(Compile: I<frills>) will create a rectangular selection instead of a normal 1129(Compile: I<frills>) will create a rectangular selection instead of a
1019one. 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.
1020 1133
1021=item B<Insertion>: 1134=item B<Insertion>:
1022 1135
1023Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1136Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in
1024an B<@@RXVT_NAME@@> window causes the current text selection to be 1137an B<@@RXVT_NAME@@> window causes the current text selection to be
1032supported in rxvt-unicode. Bug me if you need this. 1145supported in rxvt-unicode. Bug me if you need this.
1033 1146
1034You can, however, switch fonts at runtime using escape sequences (and 1147You can, however, switch fonts at runtime using escape sequences (and
1035therefore using the menubar), e.g.: 1148therefore using the menubar), e.g.:
1036 1149
1037 printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic" 1150 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1038 1151
1039rxvt-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.
1040 1153
1041=head1 ISO 14755 SUPPORT 1154=head1 ISO 14755 SUPPORT
1042 1155
1218=item B<RXVT_SOCKET> 1331=item B<RXVT_SOCKET>
1219 1332
1220The unix domain socket path used by @@RXVT_NAME@@c(1) and 1333The unix domain socket path used by @@RXVT_NAME@@c(1) and
1221@@RXVT_NAME@@d(1). 1334@@RXVT_NAME@@d(1).
1222 1335
1223Default C<< $HOME/.rxvt-unicode-<nodename >>. 1336Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.
1224 1337
1225=item B<HOME> 1338=item B<HOME>
1226 1339
1227Used to locate the default directory for the unix domain socket for 1340Used to locate the default directory for the unix domain socket for
1228daemon communications and to locate various resource files (such as 1341daemon communications and to locate various resource files (such as
1249 1362
1250=back 1363=back
1251 1364
1252=head1 SEE ALSO 1365=head1 SEE ALSO
1253 1366
1254@@RXVT_NAME@@(7), 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)
1255
1256=head1 BUGS
1257
1258Check the BUGS file for an up-to-date list.
1259
1260Cursor change support is not yet implemented.
1261
1262Click-and-drag doesn't work with X11 mouse report overriding.
1263 1368
1264=head1 CURRENT PROJECT COORDINATOR 1369=head1 CURRENT PROJECT COORDINATOR
1265 1370
1266=over 4 1371=over 4
1267 1372

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines