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.65 by root, Thu Jun 30 14:00:49 2005 UTC vs.
Revision 1.83 by root, Tue Jan 3 22:28:07 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
… …
179See also the question "How does rxvt-unicode choose fonts?" in the FAQ 189See also the question "How does rxvt-unicode choose fonts?" in the FAQ
180section of @@RXVT_NAME@@(7). 190section of @@RXVT_NAME@@(7).
181 191
182=item B<-fb> I<fontlist> 192=item B<-fb> I<fontlist>
183 193
184Compile font-styles: The bold font list to use when bold characters are to 194Compile font-styles: The bold font list to use when B<bold> characters are to
185be printed. See resource B<boldFont> for details. 195be printed. See resource B<boldFont> for details.
186 196
187=item B<-fi> I<fontlist> 197=item B<-fi> I<fontlist>
188 198
189Compile font-styles: The italic font list to use when bold characters are to 199Compile font-styles: The italic font list to use when I<italic> characters are to
190be printed. See resource B<italicFont> for details. 200be printed. See resource B<italicFont> for details.
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 B<< I<bold
195be printed. See resource B<boldItalicFont> for details. 205italic> >> characters are to be printed. See resource B<boldItalicFont>
206for details.
207
208=item B<-is>|B<+is>
209
210Compile font-styles: Bold/Italic font styles imply high intensity
211foreground/background (default). See resource B<intensityStyles> for
212details.
196 213
197=item B<-name> I<name> 214=item B<-name> I<name>
198 215
199Specify the application name under which resources are to be obtained, 216Specify the application name under which resources are to be obtained,
200rather than the default executable file name. Name should not contain 217rather 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 320given 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 321on 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, 322run the program specified by the B<SHELL> environment variable or,
306failing that, I<sh(1)>. 323failing that, I<sh(1)>.
307 324
325Please note that you must specify a program with arguments. If you want to
326run shell commands, you have to specify the shell, like this:
327
328 @@RXVT_NAME@@ -e sh -c "shell commands"
329
308=item B<-title> I<text> 330=item B<-title> I<text>
309 331
310Window title (B<-T> still respected); the default title is the basename 332Window title (B<-T> still respected); the default title is the basename
311of the program specified after the B<-e> option, if any, otherwise the 333of the program specified after the B<-e> option, if any, otherwise the
312application name; resource B<title>. 334application name; resource B<title>.
… …
367 389
368=item B<-ssr>|B<+ssr> 390=item B<-ssr>|B<+ssr>
369 391
370Turn on/off secondary screen scroll (default enabled); resource 392Turn on/off secondary screen scroll (default enabled); resource
371B<secondaryScroll>. 393B<secondaryScroll>.
394
395=item B<-hold>|B<+hold>
396
397Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
398will not immediately destroy its window when the program executed within
399it exits. Instead, it will wait till it is being killed or closed by the
400user; resource B<hold>.
372 401
373=item B<-keysym.>I<sym> I<string> 402=item B<-keysym.>I<sym> I<string>
374 403
375Remap a key symbol. See resource B<keysym>. 404Remap a key symbol. See resource B<keysym>.
376 405
… …
424 close $pty; 453 close $pty;
425 454
426 # now communicate with rxvt 455 # now communicate with rxvt
427 my $slave = $pty->slave; 456 my $slave = $pty->slave;
428 while (<$slave>) { print $slave "got <$_>\n" } 457 while (<$slave>) { print $slave "got <$_>\n" }
458
459=item B<-pe> I<string>
460
461Colon-separated list of perl extension scripts to use in this terminal instance. See resource B<perl-ext>.
429 462
430=back 463=back
431 464
432=head1 RESOURCES (available also as long-options) 465=head1 RESOURCES (available also as long-options)
433 466
… …
548artificial transparency. B<False>: do not inherit the parent windows' 581artificial transparency. B<False>: do not inherit the parent windows'
549pixmap. 582pixmap.
550 583
551=item B<fading:> I<number> 584=item B<fading:> I<number>
552 585
553Fade the text by the given percentage when focus is lost. 586Fade the text by the given percentage when focus is lost; option B<-fade>.
587
588=item B<fadeColor:> I<colour>
589
590Fade to this colour, when fading is used (see B<fading:>). The default
591colour is black; option B<-fadecolor>.
554 592
555=item B<tintColor:> I<colour> 593=item B<tintColor:> I<colour>
556 594
557Tint the transparent background pixmap with the given colour. 595Tint the transparent background pixmap with the given colour; option
596B<-tint>.
558 597
559=item B<shading:> I<number> 598=item B<shading:> I<number>
560 599
561Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 600Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
562image in addition to tinting it. 601image in addition to tinting it.
… …
603 642
604Select the fonts to be used. This is a comma separated list of font 643Select 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. 644names that are used in turn when trying to display Unicode characters.
606The first font defines the cell size for characters; other fonts might 645The first font defines the cell size for characters; other fonts might
607be smaller, but not larger. A reasonable default font list is always 646be smaller, but not larger. A reasonable default font list is always
608appended to it. option B<-fn>. 647appended to it; option B<-fn>.
609 648
610Each font can either be a standard X11 core font (XLFD) name, with 649Each 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:>. 650optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
612 651
613In addition, each font can be prefixed with additional hints and 652In addition, each font can be prefixed with additional hints and
… …
659not possible, replacement fonts of the desired shape will be tried. 698not possible, replacement fonts of the desired shape will be tried.
660 699
661If set, but empty, then this specific style is disabled and the normal 700If set, but empty, then this specific style is disabled and the normal
662text font will being used for the given style. 701text font will being used for the given style.
663 702
703=item B<intensityStyles:> I<boolean>
704
705When font styles are not enabled, or this option is enabled (B<True>,
706option B<-is>, the default), bold and italic font styles imply high
707intensity foreground/backround colours. Disabling this option (B<False>,
708option B<+is>) disables this behaviour, the high intensity colours are not
709reachable.
710
664=item B<selectstyle:> I<mode> 711=item B<selectstyle:> I<mode>
665 712
666Set mouse selection style to B<old> which is 2.20, B<oldword> which is 713Set 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 714xterm style with 2.20 old word selection, or anything else which gives
668xterm style selection. 715xterm style selection.
… …
711Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use 758Specify 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 759B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or
713B<Shift-Print> to include the scrollback as well. 760B<Shift-Print> to include the scrollback as well.
714 761
715The string will be interpreted as if typed into the shell as-is. 762The string will be interpreted as if typed into the shell as-is.
763
764Example:
765
766 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
767
768This creates a new file in your home directory with the screen contents
769everytime you hit C<Print>.
716 770
717=item B<scrollBar:> I<boolean> 771=item B<scrollBar:> I<boolean>
718 772
719B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 773B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
720disable the scrollbar; option B<+sb>. 774disable the scrollbar; option B<+sb>.
… …
853=item B<imLocale:> I<name> 907=item B<imLocale:> I<name>
854 908
855The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g. 909The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
856C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the 910C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
857input extension to be able to input japanese characters while staying in 911input extension to be able to input japanese characters while staying in
858another locale. option B<-imlocale>. 912another locale; option B<-imlocale>.
859 913
860=item B<imFont:> I<fontset> 914=item B<imFont:> I<fontset>
861 915
862Specify the font-set used for XIM styles C<OverTheSpot> or 916Specify the font-set used for XIM styles C<OverTheSpot> or
863C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated 917C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
… …
868 922
869=item B<tripleclickwords:> I<boolean> 923=item B<tripleclickwords:> I<boolean>
870 924
871Change the meaning of triple-click selection with the left mouse 925Change the meaning of triple-click selection with the left mouse
872button. Instead of selecting a full line it will extend the selection to 926button. Instead of selecting a full line it will extend the selection to
873the end of the logical line only. option B<-tcw>. 927the end of the logical line only; option B<-tcw>.
874 928
875=item B<insecure:> I<boolean> 929=item B<insecure:> I<boolean>
876 930
877Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 931Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
878echo arbitrary strings like the icon name or the locale. This could be 932echo arbitrary strings like the icon name or the locale. This could be
879abused if somebody gets 8-bit-clean access to your display, whether 933abused if somebody gets 8-bit-clean access to your display, whether
880throuh a mail client displaying mail bodies unfiltered or though 934through a mail client displaying mail bodies unfiltered or through
881write(1). Therefore, these sequences are disabled by default. (Note 935write(1) or any other means. Therefore, these sequences are disabled by
882that other terminals, including xterm, have these sequences 936default. (Note that many other terminals, including xterm, have these
883enabled by default). You can enable them by setting this boolean 937sequences enabled by default, which doesn't make it safer, though).
884resource or specifying B<-insecure> as an option. At the moment, this 938
885enabled display-answer, locale, findfont, icon label and window title 939You can enable them by setting this boolean resource or specifying
886requests as well as dynamic menubar dispatch. 940B<-insecure> as an option. At the moment, this enables display-answer,
941locale, findfont, icon label and window title requests as well as dynamic
942menubar dispatch.
887 943
888=item B<modifier:> I<modifier> 944=item B<modifier:> I<modifier>
889 945
890Set the key to be interpreted as the Meta key to: B<alt>, B<meta>, 946Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
891B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option 947B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
… …
905 961
906Turn on/off secondary screen scroll (default enabled). If the this 962Turn on/off secondary screen scroll (default enabled). If the this
907option is enabled, scrolls on the secondary screen will change the 963option is enabled, scrolls on the secondary screen will change the
908scrollback buffer and switching to/from the secondary screen will 964scrollback buffer and switching to/from the secondary screen will
909instead scroll the screen up. 965instead scroll the screen up.
966
967=item B<hold>: I<bool>
968
969Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
970will not immediately destroy its window when the program executed within
971it exits. Instead, it will wait till it is being killed or closed by the
972user.
910 973
911=item B<keysym.>I<sym>: I<string> 974=item B<keysym.>I<sym>: I<string>
912 975
913Compile I<frills>: Associate I<string> with keysym I<sym>. The 976Compile I<frills>: Associate I<string> with keysym I<sym>. The
914intervening resource name B<keysym.> cannot be omitted. 977intervening resource name B<keysym.> cannot be omitted.
… …
959is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1022is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
960example the following means "change the current locale to C<zh_CN.GBK> 1023example the following means "change the current locale to C<zh_CN.GBK>
961when Control-Meta-c is being pressed": 1024when Control-Meta-c is being pressed":
962 1025
963 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1026 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1027
1028If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1029is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)
1030manpage. For example, the F<selection> extension (activated via
1031C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1032
1033 URxvt.keysym.M-C-c: perl:selection:rot13
964 1034
965Due the the large number of modifier combinations, a defined key mapping 1035Due the the large number of modifier combinations, a defined key mapping
966will match if at I<at least> the specified identifiers are being set, and 1036will match if at I<at least> the specified identifiers are being set, and
967no other key mappings with those and more bits are being defined. That 1037no other key mappings with those and more bits are being defined. That
968means that defining a key map for C<a> will automatically provide 1038means that defining a key map for C<a> will automatically provide
… …
992info): 1062info):
993 1063
994 URxvt.keysym.M-C-3: command:\033[8;25;80t 1064 URxvt.keysym.M-C-3: command:\033[8;25;80t
995 URxvt.keysym.M-C-4: command:\033[8;48;110t 1065 URxvt.keysym.M-C-4: command:\033[8;48;110t
996 1066
1067=item B<perl-ext>: I<string>
1068
1069Colon-separated list of perl extension scripts to use in this terminal
1070instance. Each extension is looked up in the library directories, loaded
1071if necessary, and bound to the current terminal instance. If this resource
1072is empty or missing, then the perl interpreter will not be initialized;
1073option B<-pe>.
1074
1075=item B<perl-eval>: I<string>
1076
1077Perl code to be evaluated when all extensions have been registered. See the
1078@@RXVT_NAME@@perl(3) manpage.
1079
1080=item B<perl-lib>: I<path>
1081
1082Colon-separated list of additional directories that hold extension
1083scripts. When looking for extensions specified by the C<perl> resource,
1084@@RXVT_NAME@@ will first look in these directories and then in
1085F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1086
1087See the @@RXVT_NAME@@perl(3) manpage.
1088
997=back 1089=back
998 1090
999=head1 THE SCROLLBAR 1091=head1 THE SCROLLBAR
1000 1092
1001Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window 1093Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window
… …
1035to select a word; Left triple-click to select the entire logical line 1127to select a word; Left triple-click to select the entire logical line
1036(which can span multiple screen lines), unless modified by resource 1128(which can span multiple screen lines), unless modified by resource
1037B<tripleclickwords>. 1129B<tripleclickwords>.
1038 1130
1039Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys) 1131Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
1040(Compile: I<frills>) will create a rectangular selection instead of a normal 1132(Compile: I<frills>) will create a rectangular selection instead of a
1041one. 1133normal one. In this mode, every selected row becomes its own line in the
1134selection, and trailing whitespace is visually underlined and removed from
1135the selection.
1042 1136
1043=item B<Insertion>: 1137=item B<Insertion>:
1044 1138
1045Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1139Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in
1046an B<@@RXVT_NAME@@> window causes the current text selection to be 1140an B<@@RXVT_NAME@@> window causes the current text selection to be
… …
1054supported in rxvt-unicode. Bug me if you need this. 1148supported in rxvt-unicode. Bug me if you need this.
1055 1149
1056You can, however, switch fonts at runtime using escape sequences (and 1150You can, however, switch fonts at runtime using escape sequences (and
1057therefore using the menubar), e.g.: 1151therefore using the menubar), e.g.:
1058 1152
1059 printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic" 1153 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1060 1154
1061rxvt-unicode will automatically re-apply these fonts to the output so far. 1155rxvt-unicode will automatically re-apply these fonts to the output so far.
1062 1156
1063=head1 ISO 14755 SUPPORT 1157=head1 ISO 14755 SUPPORT
1064 1158
… …
1240=item B<RXVT_SOCKET> 1334=item B<RXVT_SOCKET>
1241 1335
1242The unix domain socket path used by @@RXVT_NAME@@c(1) and 1336The unix domain socket path used by @@RXVT_NAME@@c(1) and
1243@@RXVT_NAME@@d(1). 1337@@RXVT_NAME@@d(1).
1244 1338
1245Default C<< $HOME/.rxvt-unicode-<nodename >>. 1339Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.
1246 1340
1247=item B<HOME> 1341=item B<HOME>
1248 1342
1249Used to locate the default directory for the unix domain socket for 1343Used to locate the default directory for the unix domain socket for
1250daemon communications and to locate various resource files (such as 1344daemon communications and to locate various resource files (such as
… …
1271 1365
1272=back 1366=back
1273 1367
1274=head1 SEE ALSO 1368=head1 SEE ALSO
1275 1369
1276@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) 1370@@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)
1277
1278=head1 BUGS
1279
1280Check the BUGS file for an up-to-date list.
1281
1282Cursor change support is not yet implemented.
1283
1284Click-and-drag doesn't work with X11 mouse report overriding.
1285 1371
1286=head1 CURRENT PROJECT COORDINATOR 1372=head1 CURRENT PROJECT COORDINATOR
1287 1373
1288=over 4 1374=over 4
1289 1375

Diff Legend

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