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.103 by root, Tue Jan 24 17:31: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>
946default. (Note that many other terminals, including xterm, have these 943default. (Note that many other terminals, including xterm, have these
947sequences enabled by default, which doesn't make it safer, though). 944sequences enabled by default, which doesn't make it safer, though).
948 945
949You can enable them by setting this boolean resource or specifying 946You can enable them by setting this boolean resource or specifying
950B<-insecure> as an option. At the moment, this enables display-answer, 947B<-insecure> as an option. At the moment, this enables display-answer,
951locale, findfont, icon label and window title requests as well as dynamic 948locale, findfont, icon label and window title requests.
952menubar dispatch.
953 949
954=item B<modifier:> I<modifier> 950=item B<modifier:> I<modifier>
955 951
956Set the key to be interpreted as the Meta key to: B<alt>, B<meta>, 952Set 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 953B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
961 957
962Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E) 958Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
963character is passed through. It may contain escape values as described 959character is passed through. It may contain escape values as described
964in the entry on B<keysym> following. 960in the entry on B<keysym> following.
965 961
966=item B<secondaryScreen:> I<bool> 962=item B<secondaryScreen:> I<boolean>
967 963
968Turn on/off secondary screen (default enabled). 964Turn on/off secondary screen (default enabled).
969 965
970=item B<secondaryScroll:> I<bool> 966=item B<secondaryScroll:> I<boolean>
971 967
972Turn on/off secondary screen scroll (default enabled). If the this 968Turn on/off secondary screen scroll (default enabled). If the this
973option is enabled, scrolls on the secondary screen will change the 969option is enabled, scrolls on the secondary screen will change the
974scrollback buffer and switching to/from the secondary screen will 970scrollback buffer and switching to/from the secondary screen will
975instead scroll the screen up. 971instead scroll the screen up.
976 972
977=item B<hold>: I<bool> 973=item B<hold>: I<boolean>
978 974
979Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 975Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
980will not immediately destroy its window when the program executed within 976will 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 977it exits. Instead, it will wait till it is being killed or closed by the
982user. 978user.
1115F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource 1111F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
1116will be ignored when running setuid/setgid. 1112will be ignored when running setuid/setgid.
1117 1113
1118See the @@RXVT_NAME@@perl(3) manpage. 1114See the @@RXVT_NAME@@perl(3) manpage.
1119 1115
1116=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1117
1118Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
1119details.
1120
1121=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1122
1123Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1124for details.
1125
1120=item B<searchable-scrollback:> I<keysym> 1126=item B<searchable-scrollback:> I<keysym>
1121 1127
1122Sets the hotkey that starts the incremental scrollback buffer search 1128Sets the hotkey that starts the incremental scrollback buffer search
1123(default: C<M-s>). 1129(default: C<M-s>).
1124 1130
1127Specifies the program to be started with a URL argument. Used by the 1133Specifies the program to be started with a URL argument. Used by the
1128C<selection-popup> and C<mark-urls> perl extensions. 1134C<selection-popup> and C<mark-urls> perl extensions.
1129 1135
1130=item B<transient-for>: I<windowid> 1136=item B<transient-for>: I<windowid>
1131 1137
1132Sets the WM_TRANSIENT_FOR property to the given window iw. 1138Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1139
1140=item B<override-redirect>: I<boolean>
1141
1142Compile I<frills>: Sets override-redirect for the terminal window, making
1143it almost invisible to window managers; option B<-override-redirect>.
1133 1144
1134=back 1145=back
1135 1146
1136=head1 THE SCROLLBAR 1147=head1 THE SCROLLBAR
1137 1148
1179selection, and trailing whitespace is visually underlined and removed from 1190selection, and trailing whitespace is visually underlined and removed from
1180the selection. 1191the selection.
1181 1192
1182=item B<Insertion>: 1193=item B<Insertion>:
1183 1194
1184Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1195Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1185an B<@@RXVT_NAME@@> window causes the current text selection to be 1196window causes the value of the PRIMARY selection (or CLIPBOARD with the
1186inserted as if it had been typed on the keyboard. 1197Meta modifier) to be inserted as if it had been typed on the keyboard.
1198
1199Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1200inserted too.
1187 1201
1188=back 1202=back
1189 1203
1190=head1 CHANGING FONTS 1204=head1 CHANGING FONTS
1191 1205
1192Changing fonts (or font sizes, respectively) via the keypad is not yet 1206Changing fonts (or font sizes, respectively) via the keypad is not yet
1193supported in rxvt-unicode. Bug me if you need this. 1207supported in rxvt-unicode. Bug me if you need this.
1194 1208
1195You can, however, switch fonts at runtime using escape sequences (and 1209You can, however, switch fonts at runtime using escape sequences, e.g.:
1196therefore using the menubar), e.g.:
1197 1210
1198 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic" 1211 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1212
1213You can use keyboard shortcuts, too:
1214
1215 URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
1216 URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1199 1217
1200rxvt-unicode will automatically re-apply these fonts to the output so far. 1218rxvt-unicode will automatically re-apply these fonts to the output so far.
1201 1219
1202=head1 ISO 14755 SUPPORT 1220=head1 ISO 14755 SUPPORT
1203 1221
1365 1383
1366=item B<SHELL> 1384=item B<SHELL>
1367 1385
1368The shell to be used for command execution, defaults to C</bin/sh>. 1386The shell to be used for command execution, defaults to C</bin/sh>.
1369 1387
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> 1388=item B<RXVT_SOCKET>
1380 1389
1381The unix domain socket path used by @@RXVT_NAME@@c(1) and 1390The unix domain socket path used by @@RXVT_NAME@@c(1) and
1382@@RXVT_NAME@@d(1). 1391@@RXVT_NAME@@d(1).
1383 1392
1452 1461
1453Project Coordinator (changes.txt 2.21a to 2.4.5) 1462Project Coordinator (changes.txt 2.21a to 2.4.5)
1454 1463
1455=item Geoff Wing L<< <gcw@pobox.com> >> 1464=item Geoff Wing L<< <gcw@pobox.com> >>
1456 1465
1457Rewrote screen display and text selection routines. Project Coordinator 1466Rewrote screen display and text selection routines.
1467
1458(changes.txt 2.4.6 - rxvt-unicode) 1468Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1459 1469
1460=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1470=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1461 1471
1462Forked rxvt-unicode, rewrote most of the display code and internal 1472Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1463character handling to store text in unicode, improve xterm 1473extension, random hacks, numerous bugfixes and extensions.
1464compatibility and apply numerous other bugfixes and extensions.
1465 1474
1466Project Coordinator (Changes 1.0 -) 1475Project Coordinator (Changes 1.0 -)
1467 1476
1477=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1478
1479Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
1480
1468=back 1481=back
1469 1482

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines