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.93 by root, Wed Jan 11 23:08:54 2006 UTC vs.
Revision 1.104 by root, Wed Jan 25 13:24:45 2006 UTC

172resource B<borderColor>. 172resource B<borderColor>.
173 173
174=item B<-fn> I<fontlist> 174=item B<-fn> I<fontlist>
175 175
176Select the fonts to be used. This is a comma separated list of font names 176Select the fonts to be used. This is a comma separated list of font names
177that are used in turn when trying to display Unicode characters. The 177that are checked in order when trying to find glyphs for characters. The
178first font defines the cell size for characters; other fonts might be 178first font defines the cell size for characters; other fonts might be
179smaller, but not (in general) larger. A (hopefully) reasonable default 179smaller, but not (in general) larger. A (hopefully) reasonable default
180font list is always appended to it. See resource B<font> for more details. 180font list is always appended to it. See resource B<font> for more details.
181 181
182In short, to specify an X11 core font, just specify it's name or prefix it 182In short, to specify an X11 core font, just specify it's name or prefix it
296=item B<-bl> 296=item B<-bl>
297 297
298Compile 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.
299if 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
300decorations; resource B<borderLess>. 300decorations; resource B<borderLess>.
301
302=item B<-override-redirect>
303
304Compile I<frills>: Sets override-redirect on the window; resource
305B<override-redirect>.
301 306
302=item B<-sbg> 307=item B<-sbg>
303 308
304Compile I<frills>: Disable the usage of the built-in block graphics/line 309Compile I<frills>: Disable the usage of the built-in block graphics/line
305drawing characters and just rely on what the specified fonts provide. Use 310drawing characters and just rely on what the specified fonts provide. Use
627of 1 displays the image without any scaling. A scale of 2 to 9 632of 1 displays the image without any scaling. A scale of 2 to 9
628specifies an integer number of images in that direction. No image will 633specifies an integer number of images in that direction. No image will
629be magnified beyond 10 times its original size. The maximum permitted 634be magnified beyond 10 times its original size. The maximum permitted
630scale is 1000. [default 0x0+50+50] 635scale is 1000. [default 0x0+50+50]
631 636
632=item B<menu:> I<file[;tag]>
633
634Read in the specified menu file (note the `.menu' extension is
635optional) and also optionally specify a starting tag to find. See the
636reference documentation for details on the syntax for the menuBar.
637
638=item B<path:> I<path> 637=item B<path:> I<path>
639 638
640Specify the colon-delimited search path for finding files (XPM and 639Specify the colon-delimited search path for finding XPM files.
641menus), in addition to the paths specified by the B<RXVTPATH> and
642B<PATH> environment variables.
643 640
644=item B<font:> I<fontlist> 641=item B<font:> I<fontlist>
645 642
646Select 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 names
647names that are used in turn when trying to display Unicode characters. 644that are checked in order when trying to find glyphs for characters. The
648The first font defines the cell size for characters; other fonts might 645first font defines the cell size for characters; other fonts might be
649be smaller, but not larger. A reasonable default font list is always 646smaller, but not (in general) larger. A (hopefully) reasonable default
650appended to it; option B<-fn>. 647font list is always appended to it; option B<-fn>.
651 648
652Each 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
653optional 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:>.
654 651
655In addition, each font can be prefixed with additional hints and 652In addition, each font can be prefixed with additional hints and
657hint currently is C<codeset=codeset-name>, and this is only used for Xft 654hint currently is C<codeset=codeset-name>, and this is only used for Xft
658fonts. 655fonts.
659 656
660For example, this font resource 657For example, this font resource
661 658
662 URxvt*font: 9x15bold,\ 659 URxvt.font: 9x15bold,\
663 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\ 660 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
664 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \ 661 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
665 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ 662 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
666 xft:Code2000:antialias=false 663 xft:Code2000:antialias=false
667 664
764 761
765The 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.
766 763
767Example: 764Example:
768 765
769 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 766 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
770 767
771This creates a new file in your home directory with the screen contents 768This creates a new file in your home directory with the screen contents
772everytime you hit C<Print>. 769everytime you hit C<Print>.
773 770
774=item B<scrollBar:> I<boolean> 771=item B<scrollBar:> I<boolean>
899pressed. If unset it will send the sequence traditionally associated 896pressed. If unset it will send the sequence traditionally associated
900with the B<Execute> key. 897with the B<Execute> key.
901 898
902=item B<cutchars:> I<string> 899=item B<cutchars:> I<string>
903 900
904The characters used as delimiters for double-click word selection. The 901The characters used as delimiters for double-click word selection.
905built-in default: 902
903When the selection extension is in use (the default if compiled in, see
904the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these characters
905will be created (if the resource exists, otherwise, no regex will be
906created). In this mode, characters outside ISO-8859-1 can be used.
907
908When the selection extension is not used, only ISO-8859-1 characters can
909be used. If not specified, the built-in default is used:
906 910
907B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 911B<< BACKSLASH `"'&()*,;<=>?@[]{|} >>
908 912
909=item B<preeditType:> I<style> 913=item B<preeditType:> I<style>
910 914
946default. (Note that many other terminals, including xterm, have these 950default. (Note that many other terminals, including xterm, have these
947sequences enabled by default, which doesn't make it safer, though). 951sequences enabled by default, which doesn't make it safer, though).
948 952
949You can enable them by setting this boolean resource or specifying 953You can enable them by setting this boolean resource or specifying
950B<-insecure> as an option. At the moment, this enables display-answer, 954B<-insecure> as an option. At the moment, this enables display-answer,
951locale, findfont, icon label and window title requests as well as dynamic 955locale, findfont, icon label and window title requests.
952menubar dispatch.
953 956
954=item B<modifier:> I<modifier> 957=item B<modifier:> I<modifier>
955 958
956Set the key to be interpreted as the Meta key to: B<alt>, B<meta>, 959Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
957B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option 960B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
961 964
962Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E) 965Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
963character is passed through. It may contain escape values as described 966character is passed through. It may contain escape values as described
964in the entry on B<keysym> following. 967in the entry on B<keysym> following.
965 968
966=item B<secondaryScreen:> I<bool> 969=item B<secondaryScreen:> I<boolean>
967 970
968Turn on/off secondary screen (default enabled). 971Turn on/off secondary screen (default enabled).
969 972
970=item B<secondaryScroll:> I<bool> 973=item B<secondaryScroll:> I<boolean>
971 974
972Turn on/off secondary screen scroll (default enabled). If the this 975Turn on/off secondary screen scroll (default enabled). If the this
973option is enabled, scrolls on the secondary screen will change the 976option is enabled, scrolls on the secondary screen will change the
974scrollback buffer and switching to/from the secondary screen will 977scrollback buffer and switching to/from the secondary screen will
975instead scroll the screen up. 978instead scroll the screen up.
976 979
977=item B<hold>: I<bool> 980=item B<hold>: I<boolean>
978 981
979Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 982Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
980will not immediately destroy its window when the program executed within 983will not immediately destroy its window when the program executed within
981it exits. Instead, it will wait till it is being killed or closed by the 984it exits. Instead, it will wait till it is being killed or closed by the
982user. 985user.
1115F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource 1118F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
1116will be ignored when running setuid/setgid. 1119will be ignored when running setuid/setgid.
1117 1120
1118See the @@RXVT_NAME@@perl(3) manpage. 1121See the @@RXVT_NAME@@perl(3) manpage.
1119 1122
1123=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1124
1125Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
1126details.
1127
1128=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1129
1130Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1131for details.
1132
1133=item B<searchable-scrollback:> I<keysym>
1134
1135Sets the hotkey that starts the incremental scrollback buffer search
1136(default: C<M-s>).
1137
1120=item B<urlLauncher>: I<string> 1138=item B<urlLauncher>: I<string>
1121 1139
1122Specifies the program to be started with a URL argument. Used by the 1140Specifies the program to be started with a URL argument. Used by the
1123C<selection-popup> and C<mark-urls> perl extensions. 1141C<selection-popup> and C<mark-urls> perl extensions.
1124 1142
1125=item B<transient-for>: I<windowid> 1143=item B<transient-for>: I<windowid>
1126 1144
1127Sets the WM_TRANSIENT_FOR property to the given window iw. 1145Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1146
1147=item B<override-redirect>: I<boolean>
1148
1149Compile I<frills>: Sets override-redirect for the terminal window, making
1150it almost invisible to window managers; option B<-override-redirect>.
1128 1151
1129=back 1152=back
1130 1153
1131=head1 THE SCROLLBAR 1154=head1 THE SCROLLBAR
1132 1155
1174selection, and trailing whitespace is visually underlined and removed from 1197selection, and trailing whitespace is visually underlined and removed from
1175the selection. 1198the selection.
1176 1199
1177=item B<Insertion>: 1200=item B<Insertion>:
1178 1201
1179Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1202Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1180an B<@@RXVT_NAME@@> window causes the current text selection to be 1203window causes the value of the PRIMARY selection (or CLIPBOARD with the
1181inserted as if it had been typed on the keyboard. 1204Meta modifier) to be inserted as if it had been typed on the keyboard.
1205
1206Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1207inserted too.
1182 1208
1183=back 1209=back
1184 1210
1185=head1 CHANGING FONTS 1211=head1 CHANGING FONTS
1186 1212
1187Changing fonts (or font sizes, respectively) via the keypad is not yet 1213Changing fonts (or font sizes, respectively) via the keypad is not yet
1188supported in rxvt-unicode. Bug me if you need this. 1214supported in rxvt-unicode. Bug me if you need this.
1189 1215
1190You can, however, switch fonts at runtime using escape sequences (and 1216You can, however, switch fonts at runtime using escape sequences, e.g.:
1191therefore using the menubar), e.g.:
1192 1217
1193 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic" 1218 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1219
1220You can use keyboard shortcuts, too:
1221
1222 URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
1223 URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1194 1224
1195rxvt-unicode will automatically re-apply these fonts to the output so far. 1225rxvt-unicode will automatically re-apply these fonts to the output so far.
1196 1226
1197=head1 ISO 14755 SUPPORT 1227=head1 ISO 14755 SUPPORT
1198 1228
1360 1390
1361=item B<SHELL> 1391=item B<SHELL>
1362 1392
1363The shell to be used for command execution, defaults to C</bin/sh>. 1393The shell to be used for command execution, defaults to C</bin/sh>.
1364 1394
1365=item B<RXVTPATH>
1366
1367The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1368files.
1369
1370=item B<PATH>
1371
1372Used in the same way as C<RXVTPATH>.
1373
1374=item B<RXVT_SOCKET> 1395=item B<RXVT_SOCKET>
1375 1396
1376The unix domain socket path used by @@RXVT_NAME@@c(1) and 1397The unix domain socket path used by @@RXVT_NAME@@c(1) and
1377@@RXVT_NAME@@d(1). 1398@@RXVT_NAME@@d(1).
1378 1399
1447 1468
1448Project Coordinator (changes.txt 2.21a to 2.4.5) 1469Project Coordinator (changes.txt 2.21a to 2.4.5)
1449 1470
1450=item Geoff Wing L<< <gcw@pobox.com> >> 1471=item Geoff Wing L<< <gcw@pobox.com> >>
1451 1472
1452Rewrote screen display and text selection routines. Project Coordinator 1473Rewrote screen display and text selection routines.
1474
1453(changes.txt 2.4.6 - rxvt-unicode) 1475Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1454 1476
1455=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1477=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1456 1478
1457Forked rxvt-unicode, rewrote most of the display code and internal 1479Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1458character handling to store text in unicode, improve xterm 1480extension, random hacks, numerous bugfixes and extensions.
1459compatibility and apply numerous other bugfixes and extensions.
1460 1481
1461Project Coordinator (Changes 1.0 -) 1482Project Coordinator (Changes 1.0 -)
1462 1483
1484=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1485
1486Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
1487
1463=back 1488=back
1464 1489

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines