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.85 by root, Wed Jan 4 20:43:37 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 I<font-styles>: The bold font list to use when B<bold> characters
185be printed. See resource B<boldFont> for details. 195are to be 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 I<font-styles>: The italic font list to use when I<italic>
190be printed. See resource B<italicFont> for details. 200characters are to be 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 I<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 I<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
279=item B<-bl> 296=item B<-bl>
280 297
281Compile I<frills>: Set MWM hints to request a borderless window, i.e. 298Compile I<frills>: Set MWM hints to request a borderless window, i.e.
282if honoured by the WM, the rxvt-unicode window will not have window 299if honoured by the WM, the rxvt-unicode window will not have window
283decorations; resource B<borderLess>. 300decorations; resource B<borderLess>.
301
302=item B<-sbg>
303
304Compile I<frills>: Disable the usage of the built-in block graphics/line
305drawing characters and just rely on what the specified fonts provide. Use
306this if you have a good font and want to use its block graphic glyphs;
307resource B<skipBuiltinGlyphs>.
284 308
285=item B<-lsp> I<number> 309=item B<-lsp> I<number>
286 310
287Compile I<frills>: Lines (pixel height) to insert between each row of 311Compile I<frills>: Lines (pixel height) to insert between each row of
288the display. Useful to work around font rendering problems; resource 312the display. Useful to work around font rendering problems; resource
303given on the command line. If this option is used, it must be the last 327given 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 328on 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, 329run the program specified by the B<SHELL> environment variable or,
306failing that, I<sh(1)>. 330failing that, I<sh(1)>.
307 331
332Please note that you must specify a program with arguments. If you want to
333run shell commands, you have to specify the shell, like this:
334
335 @@RXVT_NAME@@ -e sh -c "shell commands"
336
308=item B<-title> I<text> 337=item B<-title> I<text>
309 338
310Window title (B<-T> still respected); the default title is the basename 339Window title (B<-T> still respected); the default title is the basename
311of the program specified after the B<-e> option, if any, otherwise the 340of the program specified after the B<-e> option, if any, otherwise the
312application name; resource B<title>. 341application name; resource B<title>.
367 396
368=item B<-ssr>|B<+ssr> 397=item B<-ssr>|B<+ssr>
369 398
370Turn on/off secondary screen scroll (default enabled); resource 399Turn on/off secondary screen scroll (default enabled); resource
371B<secondaryScroll>. 400B<secondaryScroll>.
401
402=item B<-hold>|B<+hold>
403
404Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
405will not immediately destroy its window when the program executed within
406it exits. Instead, it will wait till it is being killed or closed by the
407user; resource B<hold>.
372 408
373=item B<-keysym.>I<sym> I<string> 409=item B<-keysym.>I<sym> I<string>
374 410
375Remap a key symbol. See resource B<keysym>. 411Remap a key symbol. See resource B<keysym>.
376 412
424 close $pty; 460 close $pty;
425 461
426 # now communicate with rxvt 462 # now communicate with rxvt
427 my $slave = $pty->slave; 463 my $slave = $pty->slave;
428 while (<$slave>) { print $slave "got <$_>\n" } 464 while (<$slave>) { print $slave "got <$_>\n" }
465
466=item B<-pe> I<string>
467
468Colon-separated list of perl extension scripts to use in this terminal
469instance. See resource B<perl-ext>.
429 470
430=back 471=back
431 472
432=head1 RESOURCES (available also as long-options) 473=head1 RESOURCES (available also as long-options)
433 474
548artificial transparency. B<False>: do not inherit the parent windows' 589artificial transparency. B<False>: do not inherit the parent windows'
549pixmap. 590pixmap.
550 591
551=item B<fading:> I<number> 592=item B<fading:> I<number>
552 593
553Fade the text by the given percentage when focus is lost. 594Fade the text by the given percentage when focus is lost; option B<-fade>.
595
596=item B<fadeColor:> I<colour>
597
598Fade to this colour, when fading is used (see B<fading:>). The default
599colour is black; option B<-fadecolor>.
554 600
555=item B<tintColor:> I<colour> 601=item B<tintColor:> I<colour>
556 602
557Tint the transparent background pixmap with the given colour. 603Tint the transparent background pixmap with the given colour; option
604B<-tint>.
558 605
559=item B<shading:> I<number> 606=item B<shading:> I<number>
560 607
561Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 608Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
562image in addition to tinting it. 609image in addition to tinting it.
603 650
604Select the fonts to be used. This is a comma separated list of font 651Select 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. 652names that are used in turn when trying to display Unicode characters.
606The first font defines the cell size for characters; other fonts might 653The first font defines the cell size for characters; other fonts might
607be smaller, but not larger. A reasonable default font list is always 654be smaller, but not larger. A reasonable default font list is always
608appended to it. option B<-fn>. 655appended to it; option B<-fn>.
609 656
610Each font can either be a standard X11 core font (XLFD) name, with 657Each 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:>. 658optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
612 659
613In addition, each font can be prefixed with additional hints and 660In addition, each font can be prefixed with additional hints and
659not possible, replacement fonts of the desired shape will be tried. 706not possible, replacement fonts of the desired shape will be tried.
660 707
661If set, but empty, then this specific style is disabled and the normal 708If set, but empty, then this specific style is disabled and the normal
662text font will being used for the given style. 709text font will being used for the given style.
663 710
711=item B<intensityStyles:> I<boolean>
712
713When font styles are not enabled, or this option is enabled (B<True>,
714option B<-is>, the default), bold and italic font styles imply high
715intensity foreground/backround colours. Disabling this option (B<False>,
716option B<+is>) disables this behaviour, the high intensity colours are not
717reachable.
718
664=item B<selectstyle:> I<mode> 719=item B<selectstyle:> I<mode>
665 720
666Set mouse selection style to B<old> which is 2.20, B<oldword> which is 721Set 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 722xterm style with 2.20 old word selection, or anything else which gives
668xterm style selection. 723xterm style selection.
711Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use 766Specify 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 767B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or
713B<Shift-Print> to include the scrollback as well. 768B<Shift-Print> to include the scrollback as well.
714 769
715The string will be interpreted as if typed into the shell as-is. 770The string will be interpreted as if typed into the shell as-is.
771
772Example:
773
774 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
775
776This creates a new file in your home directory with the screen contents
777everytime you hit C<Print>.
716 778
717=item B<scrollBar:> I<boolean> 779=item B<scrollBar:> I<boolean>
718 780
719B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 781B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
720disable the scrollbar; option B<+sb>. 782disable the scrollbar; option B<+sb>.
771=item B<borderLess:> I<boolean> 833=item B<borderLess:> I<boolean>
772 834
773Set MWM hints to request a borderless window, i.e. if honoured by the 835Set MWM hints to request a borderless window, i.e. if honoured by the
774WM, the rxvt-unicode window will not have window decorations; option B<-bl>. 836WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
775 837
838=item B<skipBuiltinGlyphs:> I<boolean>
839
840Compile I<frills>: Disable the usage of the built-in block graphics/line
841drawing characters and just rely on what the specified fonts provide. Use
842this if you have a good font and want to use its block graphic glyphs;
843option B<-sbg>.
844
776=item B<termName:> I<termname> 845=item B<termName:> I<termname>
777 846
778Specifies the terminal type name to be set in the B<TERM> environment 847Specifies the terminal type name to be set in the B<TERM> environment
779variable; option B<-tn>. 848variable; option B<-tn>.
780 849
853=item B<imLocale:> I<name> 922=item B<imLocale:> I<name>
854 923
855The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g. 924The 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 925C<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 926input extension to be able to input japanese characters while staying in
858another locale. option B<-imlocale>. 927another locale; option B<-imlocale>.
859 928
860=item B<imFont:> I<fontset> 929=item B<imFont:> I<fontset>
861 930
862Specify the font-set used for XIM styles C<OverTheSpot> or 931Specify the font-set used for XIM styles C<OverTheSpot> or
863C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated 932C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
868 937
869=item B<tripleclickwords:> I<boolean> 938=item B<tripleclickwords:> I<boolean>
870 939
871Change the meaning of triple-click selection with the left mouse 940Change the meaning of triple-click selection with the left mouse
872button. Instead of selecting a full line it will extend the selection to 941button. Instead of selecting a full line it will extend the selection to
873the end of the logical line only. option B<-tcw>. 942the end of the logical line only; option B<-tcw>.
874 943
875=item B<insecure:> I<boolean> 944=item B<insecure:> I<boolean>
876 945
877Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 946Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
878echo arbitrary strings like the icon name or the locale. This could be 947echo arbitrary strings like the icon name or the locale. This could be
879abused if somebody gets 8-bit-clean access to your display, whether 948abused if somebody gets 8-bit-clean access to your display, whether
880throuh a mail client displaying mail bodies unfiltered or though 949through a mail client displaying mail bodies unfiltered or through
881write(1). Therefore, these sequences are disabled by default. (Note 950write(1) or any other means. Therefore, these sequences are disabled by
882that other terminals, including xterm, have these sequences 951default. (Note that many other terminals, including xterm, have these
883enabled by default). You can enable them by setting this boolean 952sequences enabled by default, which doesn't make it safer, though).
884resource or specifying B<-insecure> as an option. At the moment, this 953
885enabled display-answer, locale, findfont, icon label and window title 954You can enable them by setting this boolean resource or specifying
886requests as well as dynamic menubar dispatch. 955B<-insecure> as an option. At the moment, this enables display-answer,
956locale, findfont, icon label and window title requests as well as dynamic
957menubar dispatch.
887 958
888=item B<modifier:> I<modifier> 959=item B<modifier:> I<modifier>
889 960
890Set the key to be interpreted as the Meta key to: B<alt>, B<meta>, 961Set 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 962B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
905 976
906Turn on/off secondary screen scroll (default enabled). If the this 977Turn on/off secondary screen scroll (default enabled). If the this
907option is enabled, scrolls on the secondary screen will change the 978option is enabled, scrolls on the secondary screen will change the
908scrollback buffer and switching to/from the secondary screen will 979scrollback buffer and switching to/from the secondary screen will
909instead scroll the screen up. 980instead scroll the screen up.
981
982=item B<hold>: I<bool>
983
984Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
985will not immediately destroy its window when the program executed within
986it exits. Instead, it will wait till it is being killed or closed by the
987user.
910 988
911=item B<keysym.>I<sym>: I<string> 989=item B<keysym.>I<sym>: I<string>
912 990
913Compile I<frills>: Associate I<string> with keysym I<sym>. The 991Compile I<frills>: Associate I<string> with keysym I<sym>. The
914intervening resource name B<keysym.> cannot be omitted. 992intervening resource name B<keysym.> cannot be omitted.
959is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1037is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
960example the following means "change the current locale to C<zh_CN.GBK> 1038example the following means "change the current locale to C<zh_CN.GBK>
961when Control-Meta-c is being pressed": 1039when Control-Meta-c is being pressed":
962 1040
963 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1041 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1042
1043If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1044is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)
1045manpage. For example, the F<selection> extension (activated via
1046C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1047
1048 URxvt.keysym.M-C-c: perl:selection:rot13
964 1049
965Due the the large number of modifier combinations, a defined key mapping 1050Due 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 1051will 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 1052no other key mappings with those and more bits are being defined. That
968means that defining a key map for C<a> will automatically provide 1053means that defining a key map for C<a> will automatically provide
992info): 1077info):
993 1078
994 URxvt.keysym.M-C-3: command:\033[8;25;80t 1079 URxvt.keysym.M-C-3: command:\033[8;25;80t
995 URxvt.keysym.M-C-4: command:\033[8;48;110t 1080 URxvt.keysym.M-C-4: command:\033[8;48;110t
996 1081
1082=item B<perl-ext-common>: I<string>
1083
1084=item B<perl-ext>: I<string>
1085
1086Colon-separated list(s) of perl extension scripts to use in this terminal
1087instance. Each extension is looked up in the library directories, loaded
1088if necessary, and bound to the current terminal instance. If this
1089resource is empty or missing, then the perl interpreter will not be
1090initialized. The idea behind two options is that B<perl-ext-common> will
1091be used for extensions that should be available to all instances, while
1092B<perl-ext> is used for specific instances; option B<-pe>.
1093
1094=item B<perl-eval>: I<string>
1095
1096Perl code to be evaluated when all extensions have been registered. See the
1097@@RXVT_NAME@@perl(3) manpage.
1098
1099=item B<perl-lib>: I<path>
1100
1101Colon-separated list of additional directories that hold extension
1102scripts. When looking for extensions specified by the C<perl> resource,
1103@@RXVT_NAME@@ will first look in these directories and then in
1104F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1105
1106See the @@RXVT_NAME@@perl(3) manpage.
1107
997=back 1108=back
998 1109
999=head1 THE SCROLLBAR 1110=head1 THE SCROLLBAR
1000 1111
1001Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window 1112Lines 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 1146to select a word; Left triple-click to select the entire logical line
1036(which can span multiple screen lines), unless modified by resource 1147(which can span multiple screen lines), unless modified by resource
1037B<tripleclickwords>. 1148B<tripleclickwords>.
1038 1149
1039Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys) 1150Starting 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 1151(Compile: I<frills>) will create a rectangular selection instead of a
1041one. 1152normal one. In this mode, every selected row becomes its own line in the
1153selection, and trailing whitespace is visually underlined and removed from
1154the selection.
1042 1155
1043=item B<Insertion>: 1156=item B<Insertion>:
1044 1157
1045Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1158Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in
1046an B<@@RXVT_NAME@@> window causes the current text selection to be 1159an B<@@RXVT_NAME@@> window causes the current text selection to be
1054supported in rxvt-unicode. Bug me if you need this. 1167supported in rxvt-unicode. Bug me if you need this.
1055 1168
1056You can, however, switch fonts at runtime using escape sequences (and 1169You can, however, switch fonts at runtime using escape sequences (and
1057therefore using the menubar), e.g.: 1170therefore using the menubar), e.g.:
1058 1171
1059 printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic" 1172 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1060 1173
1061rxvt-unicode will automatically re-apply these fonts to the output so far. 1174rxvt-unicode will automatically re-apply these fonts to the output so far.
1062 1175
1063=head1 ISO 14755 SUPPORT 1176=head1 ISO 14755 SUPPORT
1064 1177
1240=item B<RXVT_SOCKET> 1353=item B<RXVT_SOCKET>
1241 1354
1242The unix domain socket path used by @@RXVT_NAME@@c(1) and 1355The unix domain socket path used by @@RXVT_NAME@@c(1) and
1243@@RXVT_NAME@@d(1). 1356@@RXVT_NAME@@d(1).
1244 1357
1245Default C<< $HOME/.rxvt-unicode-<nodename >>. 1358Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.
1246 1359
1247=item B<HOME> 1360=item B<HOME>
1248 1361
1249Used to locate the default directory for the unix domain socket for 1362Used to locate the default directory for the unix domain socket for
1250daemon communications and to locate various resource files (such as 1363daemon communications and to locate various resource files (such as
1271 1384
1272=back 1385=back
1273 1386
1274=head1 SEE ALSO 1387=head1 SEE ALSO
1275 1388
1276@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) 1389@@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 1390
1286=head1 CURRENT PROJECT COORDINATOR 1391=head1 CURRENT PROJECT COORDINATOR
1287 1392
1288=over 4 1393=over 4
1289 1394

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines