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.94 by root, Thu Jan 12 05:37:34 2006 UTC vs.
Revision 1.105 by root, Wed Jan 25 13:26:48 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(whitespace delimiting is added automatically if resource is given).
903
904When the selection extension is in use (the default if compiled in, see
905the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these characters
906will be created (if the resource exists, otherwise, no regex will be
907created). In this mode, characters outside ISO-8859-1 can be used.
908
909When the selection extension is not used, only ISO-8859-1 characters can
910be used. If not specified, the built-in default is used:
906 911
907B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 912B<< BACKSLASH `"'&()*,;<=>?@[]{|} >>
908 913
909=item B<preeditType:> I<style> 914=item B<preeditType:> I<style>
910 915
946default. (Note that many other terminals, including xterm, have these 951default. (Note that many other terminals, including xterm, have these
947sequences enabled by default, which doesn't make it safer, though). 952sequences enabled by default, which doesn't make it safer, though).
948 953
949You can enable them by setting this boolean resource or specifying 954You can enable them by setting this boolean resource or specifying
950B<-insecure> as an option. At the moment, this enables display-answer, 955B<-insecure> as an option. At the moment, this enables display-answer,
951locale, findfont, icon label and window title requests as well as dynamic 956locale, findfont, icon label and window title requests.
952menubar dispatch.
953 957
954=item B<modifier:> I<modifier> 958=item B<modifier:> I<modifier>
955 959
956Set the key to be interpreted as the Meta key to: B<alt>, B<meta>, 960Set 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 961B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
961 965
962Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E) 966Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
963character is passed through. It may contain escape values as described 967character is passed through. It may contain escape values as described
964in the entry on B<keysym> following. 968in the entry on B<keysym> following.
965 969
966=item B<secondaryScreen:> I<bool> 970=item B<secondaryScreen:> I<boolean>
967 971
968Turn on/off secondary screen (default enabled). 972Turn on/off secondary screen (default enabled).
969 973
970=item B<secondaryScroll:> I<bool> 974=item B<secondaryScroll:> I<boolean>
971 975
972Turn on/off secondary screen scroll (default enabled). If the this 976Turn on/off secondary screen scroll (default enabled). If the this
973option is enabled, scrolls on the secondary screen will change the 977option is enabled, scrolls on the secondary screen will change the
974scrollback buffer and switching to/from the secondary screen will 978scrollback buffer and switching to/from the secondary screen will
975instead scroll the screen up. 979instead scroll the screen up.
976 980
977=item B<hold>: I<bool> 981=item B<hold>: I<boolean>
978 982
979Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 983Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
980will not immediately destroy its window when the program executed within 984will 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 985it exits. Instead, it will wait till it is being killed or closed by the
982user. 986user.
1115F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource 1119F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
1116will be ignored when running setuid/setgid. 1120will be ignored when running setuid/setgid.
1117 1121
1118See the @@RXVT_NAME@@perl(3) manpage. 1122See the @@RXVT_NAME@@perl(3) manpage.
1119 1123
1124=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1125
1126Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
1127details.
1128
1129=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1130
1131Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1132for details.
1133
1120=item B<searchable-scrollback:> I<keysym> 1134=item B<searchable-scrollback:> I<keysym>
1121 1135
1122Sets the hotkey that starts the incremental scrollback buffer search 1136Sets the hotkey that starts the incremental scrollback buffer search
1123(default: C<M-s>). 1137(default: C<M-s>).
1124 1138
1127Specifies the program to be started with a URL argument. Used by the 1141Specifies the program to be started with a URL argument. Used by the
1128C<selection-popup> and C<mark-urls> perl extensions. 1142C<selection-popup> and C<mark-urls> perl extensions.
1129 1143
1130=item B<transient-for>: I<windowid> 1144=item B<transient-for>: I<windowid>
1131 1145
1132Sets the WM_TRANSIENT_FOR property to the given window iw. 1146Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1147
1148=item B<override-redirect>: I<boolean>
1149
1150Compile I<frills>: Sets override-redirect for the terminal window, making
1151it almost invisible to window managers; option B<-override-redirect>.
1133 1152
1134=back 1153=back
1135 1154
1136=head1 THE SCROLLBAR 1155=head1 THE SCROLLBAR
1137 1156
1179selection, and trailing whitespace is visually underlined and removed from 1198selection, and trailing whitespace is visually underlined and removed from
1180the selection. 1199the selection.
1181 1200
1182=item B<Insertion>: 1201=item B<Insertion>:
1183 1202
1184Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1203Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1185an B<@@RXVT_NAME@@> window causes the current text selection to be 1204window causes the value of the PRIMARY selection (or CLIPBOARD with the
1186inserted as if it had been typed on the keyboard. 1205Meta modifier) to be inserted as if it had been typed on the keyboard.
1206
1207Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1208inserted too.
1187 1209
1188=back 1210=back
1189 1211
1190=head1 CHANGING FONTS 1212=head1 CHANGING FONTS
1191 1213
1192Changing fonts (or font sizes, respectively) via the keypad is not yet 1214Changing fonts (or font sizes, respectively) via the keypad is not yet
1193supported in rxvt-unicode. Bug me if you need this. 1215supported in rxvt-unicode. Bug me if you need this.
1194 1216
1195You can, however, switch fonts at runtime using escape sequences (and 1217You can, however, switch fonts at runtime using escape sequences, e.g.:
1196therefore using the menubar), e.g.:
1197 1218
1198 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic" 1219 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1220
1221You can use keyboard shortcuts, too:
1222
1223 URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
1224 URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1199 1225
1200rxvt-unicode will automatically re-apply these fonts to the output so far. 1226rxvt-unicode will automatically re-apply these fonts to the output so far.
1201 1227
1202=head1 ISO 14755 SUPPORT 1228=head1 ISO 14755 SUPPORT
1203 1229
1365 1391
1366=item B<SHELL> 1392=item B<SHELL>
1367 1393
1368The shell to be used for command execution, defaults to C</bin/sh>. 1394The shell to be used for command execution, defaults to C</bin/sh>.
1369 1395
1370=item B<RXVTPATH>
1371
1372The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1373files.
1374
1375=item B<PATH>
1376
1377Used in the same way as C<RXVTPATH>.
1378
1379=item B<RXVT_SOCKET> 1396=item B<RXVT_SOCKET>
1380 1397
1381The unix domain socket path used by @@RXVT_NAME@@c(1) and 1398The unix domain socket path used by @@RXVT_NAME@@c(1) and
1382@@RXVT_NAME@@d(1). 1399@@RXVT_NAME@@d(1).
1383 1400
1452 1469
1453Project Coordinator (changes.txt 2.21a to 2.4.5) 1470Project Coordinator (changes.txt 2.21a to 2.4.5)
1454 1471
1455=item Geoff Wing L<< <gcw@pobox.com> >> 1472=item Geoff Wing L<< <gcw@pobox.com> >>
1456 1473
1457Rewrote screen display and text selection routines. Project Coordinator 1474Rewrote screen display and text selection routines.
1475
1458(changes.txt 2.4.6 - rxvt-unicode) 1476Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1459 1477
1460=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1478=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1461 1479
1462Forked rxvt-unicode, rewrote most of the display code and internal 1480Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1463character handling to store text in unicode, improve xterm 1481extension, random hacks, numerous bugfixes and extensions.
1464compatibility and apply numerous other bugfixes and extensions.
1465 1482
1466Project Coordinator (Changes 1.0 -) 1483Project Coordinator (Changes 1.0 -)
1467 1484
1485=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1486
1487Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
1488
1468=back 1489=back
1469 1490

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines