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.90 by root, Mon Jan 9 01:36:56 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
… …
476=head1 RESOURCES (available also as long-options) 481=head1 RESOURCES (available also as long-options)
477 482
478Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long 483Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
479options) compiled into your version. 484options) compiled into your version.
480 485
481There are two different methods that @@RXVT_NAME@@ can use to get the 486You can set and change the resources using X11 tools like B<xrdb>. Many
482Xresource data: using the X libraries (Xrm*-functions) or internal 487distribution do also load settings from the B<~/.Xresources> file when X
483Xresources reader (B<~/.Xdefaults>). For the first method (ie. 488starts. @@RXVT_NAME@@ will consult the following files/resources in order,
484B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the 489with later settings overwriting earlier ones:
485resources using X11 tools like B<xrdb>. Many distribution do also load
486settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
487will consult the following files/resources in order, with later settings
488overwriting earlier ones:
489 490
490 1. system-wide app-defaults file, either locale-dependent OR global 491 1. system-wide app-defaults file, either locale-dependent OR global
491 2. app-defaults file in $XAPPLRESDIR 492 2. app-defaults file in $XAPPLRESDIR
492 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 493 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
493 4. SCREEN_RESOURCES for the current screen 494 4. SCREEN_RESOURCES for the current screen
494 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 495 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
495 496
496If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
497lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
498set in XAPPLOADDIR/URxvt (compile-time defined: usually
499B</usr/lib/X11/app-defaults/URxvt>) and resources set in
500B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.
501Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two 497Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
502class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows 498names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
503resources common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be 499common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
504easily configured, while the class name B<URxvt> allows resources 500configured, while the class name B<URxvt> allows resources unique to
505unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be 501B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
506shared between different B<@@RXVT_NAME@@> configurations. If no 502configurations. If no resources are specified, suitable defaults will
507resources are specified, suitable defaults will be used. Command-line 503be used. Command-line arguments can be used to override resource
508arguments can be used to override resource settings. The following 504settings. The following resources are supported (you might want to
509resources are allowed: 505check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
506extensions not documented here):
510 507
511=over 4 508=over 4
512 509
513=item B<geometry:> I<geom> 510=item B<geometry:> I<geom>
514 511
… …
635of 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
636specifies an integer number of images in that direction. No image will 633specifies an integer number of images in that direction. No image will
637be magnified beyond 10 times its original size. The maximum permitted 634be magnified beyond 10 times its original size. The maximum permitted
638scale is 1000. [default 0x0+50+50] 635scale is 1000. [default 0x0+50+50]
639 636
640=item B<menu:> I<file[;tag]>
641
642Read in the specified menu file (note the `.menu' extension is
643optional) and also optionally specify a starting tag to find. See the
644reference documentation for details on the syntax for the menuBar.
645
646=item B<path:> I<path> 637=item B<path:> I<path>
647 638
648Specify the colon-delimited search path for finding files (XPM and 639Specify the colon-delimited search path for finding XPM files.
649menus), in addition to the paths specified by the B<RXVTPATH> and
650B<PATH> environment variables.
651 640
652=item B<font:> I<fontlist> 641=item B<font:> I<fontlist>
653 642
654Select 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
655names that are used in turn when trying to display Unicode characters. 644that are checked in order when trying to find glyphs for characters. The
656The first font defines the cell size for characters; other fonts might 645first font defines the cell size for characters; other fonts might be
657be smaller, but not larger. A reasonable default font list is always 646smaller, but not (in general) larger. A (hopefully) reasonable default
658appended to it; option B<-fn>. 647font list is always appended to it; option B<-fn>.
659 648
660Each 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
661optional 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:>.
662 651
663In addition, each font can be prefixed with additional hints and 652In addition, each font can be prefixed with additional hints and
… …
665hint 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
666fonts. 655fonts.
667 656
668For example, this font resource 657For example, this font resource
669 658
670 URxvt*font: 9x15bold,\ 659 URxvt.font: 9x15bold,\
671 -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,\
672 -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, \
673 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ 662 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
674 xft:Code2000:antialias=false 663 xft:Code2000:antialias=false
675 664
… …
772 761
773The 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.
774 763
775Example: 764Example:
776 765
777 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 766 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
778 767
779This 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
780everytime you hit C<Print>. 769everytime you hit C<Print>.
781 770
782=item B<scrollBar:> I<boolean> 771=item B<scrollBar:> I<boolean>
… …
954default. (Note that many other terminals, including xterm, have these 943default. (Note that many other terminals, including xterm, have these
955sequences enabled by default, which doesn't make it safer, though). 944sequences enabled by default, which doesn't make it safer, though).
956 945
957You can enable them by setting this boolean resource or specifying 946You can enable them by setting this boolean resource or specifying
958B<-insecure> as an option. At the moment, this enables display-answer, 947B<-insecure> as an option. At the moment, this enables display-answer,
959locale, findfont, icon label and window title requests as well as dynamic 948locale, findfont, icon label and window title requests.
960menubar dispatch.
961 949
962=item B<modifier:> I<modifier> 950=item B<modifier:> I<modifier>
963 951
964Set 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>,
965B<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
… …
969 957
970Specify 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)
971character is passed through. It may contain escape values as described 959character is passed through. It may contain escape values as described
972in the entry on B<keysym> following. 960in the entry on B<keysym> following.
973 961
974=item B<secondaryScreen:> I<bool> 962=item B<secondaryScreen:> I<boolean>
975 963
976Turn on/off secondary screen (default enabled). 964Turn on/off secondary screen (default enabled).
977 965
978=item B<secondaryScroll:> I<bool> 966=item B<secondaryScroll:> I<boolean>
979 967
980Turn on/off secondary screen scroll (default enabled). If the this 968Turn on/off secondary screen scroll (default enabled). If the this
981option is enabled, scrolls on the secondary screen will change the 969option is enabled, scrolls on the secondary screen will change the
982scrollback buffer and switching to/from the secondary screen will 970scrollback buffer and switching to/from the secondary screen will
983instead scroll the screen up. 971instead scroll the screen up.
984 972
985=item B<hold>: I<bool> 973=item B<hold>: I<boolean>
986 974
987Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 975Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
988will not immediately destroy its window when the program executed within 976will not immediately destroy its window when the program executed within
989it 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
990user. 978user.
… …
1015C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, 1003C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,
1016C<\000>: octal number) or verbatim control characters (C<^?>: delete, 1004C<\000>: octal number) or verbatim control characters (C<^?>: delete,
1017C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it 1005C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1018can start or end with whitespace. 1006can start or end with whitespace.
1019 1007
1020Please note that you need to double the C<\> when using 1008Please note that you need to double the C<\> in resource files, as
1021C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can 1009Xlib itself does it's own de-escaping (you can use C<\033> instead of
1022use C<\033> instead of C<\e> (and so on), which will work with both Xt and 1010C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1023@@RXVT_NAME@@'s own processing). 1011processing).
1024 1012
1025You can define a range of keysyms in one shot by providing a I<string> 1013You can define a range of keysyms in one shot by providing a I<string>
1026with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' 1014with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'
1027should be a character not used by the strings. 1015should be a character not used by the strings.
1028 1016
… …
1088 1076
1089Comma-separated list(s) of perl extension scripts (default: C<default>) to 1077Comma-separated list(s) of perl extension scripts (default: C<default>) to
1090use in this terminal instance; option B<-pe>. 1078use in this terminal instance; option B<-pe>.
1091 1079
1092Extension names can be prefixed with a C<-> sign to prohibit using 1080Extension names can be prefixed with a C<-> sign to prohibit using
1093it. This can be useful to selectively disable some extensions loaded 1081them. This can be useful to selectively disable some extensions loaded
1094by default, or specified via the C<perl-ext-common> resource. For 1082by default, or specified via the C<perl-ext-common> resource. For
1095example, C<default,-selection> will use all the default extension except 1083example, C<default,-selection> will use all the default extension except
1096C<selection>. 1084C<selection>.
1085
1086Extension names can also be followed by an argument in angle brackets
1087(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
1088searchable scorllback to Alt/Meta-s). Mentioning the same extension
1089multiple times with different arguments will pass multiple arguments to
1090the extension.
1097 1091
1098Each extension is looked up in the library directories, loaded if 1092Each extension is looked up in the library directories, loaded if
1099necessary, and bound to the current terminal instance. 1093necessary, and bound to the current terminal instance.
1100 1094
1101If both of these resources are the empty string, then the perl 1095If both of these resources are the empty string, then the perl
… …
1117F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource 1111F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
1118will be ignored when running setuid/setgid. 1112will be ignored when running setuid/setgid.
1119 1113
1120See the @@RXVT_NAME@@perl(3) manpage. 1114See the @@RXVT_NAME@@perl(3) manpage.
1121 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
1126=item B<searchable-scrollback:> I<keysym>
1127
1128Sets the hotkey that starts the incremental scrollback buffer search
1129(default: C<M-s>).
1130
1131=item B<urlLauncher>: I<string>
1132
1133Specifies the program to be started with a URL argument. Used by the
1134C<selection-popup> and C<mark-urls> perl extensions.
1135
1122=item B<transient-for>: I<windowid> 1136=item B<transient-for>: I<windowid>
1123 1137
1124Sets 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>.
1125 1144
1126=back 1145=back
1127 1146
1128=head1 THE SCROLLBAR 1147=head1 THE SCROLLBAR
1129 1148
… …
1171selection, and trailing whitespace is visually underlined and removed from 1190selection, and trailing whitespace is visually underlined and removed from
1172the selection. 1191the selection.
1173 1192
1174=item B<Insertion>: 1193=item B<Insertion>:
1175 1194
1176Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1195Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1177an B<@@RXVT_NAME@@> window causes the current text selection to be 1196window causes the value of the PRIMARY selection (or CLIPBOARD with the
1178inserted 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.
1179 1201
1180=back 1202=back
1181 1203
1182=head1 CHANGING FONTS 1204=head1 CHANGING FONTS
1183 1205
1184Changing fonts (or font sizes, respectively) via the keypad is not yet 1206Changing fonts (or font sizes, respectively) via the keypad is not yet
1185supported in rxvt-unicode. Bug me if you need this. 1207supported in rxvt-unicode. Bug me if you need this.
1186 1208
1187You can, however, switch fonts at runtime using escape sequences (and 1209You can, however, switch fonts at runtime using escape sequences, e.g.:
1188therefore using the menubar), e.g.:
1189 1210
1190 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
1191 1217
1192rxvt-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.
1193 1219
1194=head1 ISO 14755 SUPPORT 1220=head1 ISO 14755 SUPPORT
1195 1221
… …
1357 1383
1358=item B<SHELL> 1384=item B<SHELL>
1359 1385
1360The 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>.
1361 1387
1362=item B<RXVTPATH>
1363
1364The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1365files.
1366
1367=item B<PATH>
1368
1369Used in the same way as C<RXVTPATH>.
1370
1371=item B<RXVT_SOCKET> 1388=item B<RXVT_SOCKET>
1372 1389
1373The unix domain socket path used by @@RXVT_NAME@@c(1) and 1390The unix domain socket path used by @@RXVT_NAME@@c(1) and
1374@@RXVT_NAME@@d(1). 1391@@RXVT_NAME@@d(1).
1375 1392
… …
1444 1461
1445Project Coordinator (changes.txt 2.21a to 2.4.5) 1462Project Coordinator (changes.txt 2.21a to 2.4.5)
1446 1463
1447=item Geoff Wing L<< <gcw@pobox.com> >> 1464=item Geoff Wing L<< <gcw@pobox.com> >>
1448 1465
1449Rewrote screen display and text selection routines. Project Coordinator 1466Rewrote screen display and text selection routines.
1467
1450(changes.txt 2.4.6 - rxvt-unicode) 1468Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1451 1469
1452=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1470=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1453 1471
1454Forked rxvt-unicode, rewrote most of the display code and internal 1472Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1455character handling to store text in unicode, improve xterm 1473extension, random hacks, numerous bugfixes and extensions.
1456compatibility and apply numerous other bugfixes and extensions.
1457 1474
1458Project Coordinator (Changes 1.0 -) 1475Project Coordinator (Changes 1.0 -)
1459 1476
1477=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1478
1479Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
1480
1460=back 1481=back
1461 1482

Diff Legend

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