ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.1.txt
(Generate patch)

Comparing rxvt-unicode/doc/rxvt.1.txt (file contents):
Revision 1.25 by root, Tue Oct 25 20:22:39 2005 UTC vs.
Revision 1.43 by root, Thu Jan 12 05:37:34 2006 UTC

4 4
5SYNOPSIS 5SYNOPSIS
6 rxvt [options] [-e command [ args ]] 6 rxvt [options] [-e command [ args ]]
7 7
8DESCRIPTION 8DESCRIPTION
9 rxvt-unicode, version 5.8, is a colour vt102 terminal emulator intended 9 rxvt-unicode, version 7.0, is a colour vt102 terminal emulator intended
10 as an *xterm*(1) replacement for users who do not require features such 10 as an *xterm*(1) replacement for users who do not require features such
11 as Tektronix 4014 emulation and toolkit-style configurability. As a 11 as Tektronix 4014 emulation and toolkit-style configurability. As a
12 result, rxvt-unicode uses much less swap space -- a significant 12 result, rxvt-unicode uses much less swap space -- a significant
13 advantage on a machine serving many X sessions. 13 advantage on a machine serving many X sessions.
14 14
163 163
164 See also the question "How does rxvt-unicode choose fonts?" in the 164 See also the question "How does rxvt-unicode choose fonts?" in the
165 FAQ section of rxvt(7). 165 FAQ section of rxvt(7).
166 166
167 -fb *fontlist* 167 -fb *fontlist*
168 Compile font-styles: The bold font list to use when bold characters 168 Compile *font-styles*: The bold font list to use when bold
169 are to be printed. See resource boldFont for details. 169 characters are to be printed. See resource boldFont for details.
170 170
171 -fi *fontlist* 171 -fi *fontlist*
172 Compile font-styles: The italic font list to use when bold 172 Compile *font-styles*: The italic font list to use when *italic*
173 characters are to be printed. See resource italicFont for details. 173 characters are to be printed. See resource italicFont for details.
174 174
175 -fbi *fontlist* 175 -fbi *fontlist*
176 Compile font-styles: The bold italic font list to use when bold 176 Compile *font-styles*: The bold italic font list to use when *bold
177 characters are to be printed. See resource boldItalicFont for 177 italic* characters are to be printed. See resource boldItalicFont
178 for details.
179
180 -is|+is
181 Compile *font-styles*: Bold/Italic font styles imply high intensity
182 foreground/background (default). See resource intensityStyles for
178 details. 183 details.
179 184
180 -name *name* 185 -name *name*
181 Specify the application name under which resources are to be 186 Specify the application name under which resources are to be
182 obtained, rather than the default executable file name. Name should 187 obtained, rather than the default executable file name. Name should
246 externalBorder. 251 externalBorder.
247 252
248 -bl Compile *frills*: Set MWM hints to request a borderless window, i.e. 253 -bl Compile *frills*: Set MWM hints to request a borderless window, i.e.
249 if honoured by the WM, the rxvt-unicode window will not have window 254 if honoured by the WM, the rxvt-unicode window will not have window
250 decorations; resource borderLess. 255 decorations; resource borderLess.
256
257 -sbg
258 Compile *frills*: Disable the usage of the built-in block
259 graphics/line drawing characters and just rely on what the specified
260 fonts provide. Use this if you have a good font and want to use its
261 block graphic glyphs; resource skipBuiltinGlyphs.
251 262
252 -lsp *number* 263 -lsp *number*
253 Compile *frills*: Lines (pixel height) to insert between each row of 264 Compile *frills*: Lines (pixel height) to insert between each row of
254 the display. Useful to work around font rendering problems; resource 265 the display. Useful to work around font rendering problems; resource
255 linespace. 266 linespace.
267 on the command line. If this option is used, it must be the last on 278 on the command line. If this option is used, it must be the last on
268 the command-line. If there is no -e option then the default is to 279 the command-line. If there is no -e option then the default is to
269 run the program specified by the SHELL environment variable or, 280 run the program specified by the SHELL environment variable or,
270 failing that, *sh(1)*. 281 failing that, *sh(1)*.
271 282
283 Please note that you must specify a program with arguments. If you
284 want to run shell commands, you have to specify the shell, like
285 this:
286
287 rxvt -e sh -c "shell commands"
288
272 -title *text* 289 -title *text*
273 Window title (-T still respected); the default title is the basename 290 Window title (-T still respected); the default title is the basename
274 of the program specified after the -e option, if any, otherwise the 291 of the program specified after the -e option, if any, otherwise the
275 application name; resource title. 292 application name; resource title.
276 293
319 336
320 -ssr|+ssr 337 -ssr|+ssr
321 Turn on/off secondary screen scroll (default enabled); resource 338 Turn on/off secondary screen scroll (default enabled); resource
322 secondaryScroll. 339 secondaryScroll.
323 340
341 -hold|+hold
342 Turn on/off hold window after exit support. If enabled, rxvt will
343 not immediately destroy its window when the program executed within
344 it exits. Instead, it will wait till it is being killed or closed by
345 the user; resource hold.
346
324 -keysym.*sym* *string* 347 -keysym.*sym* *string*
325 Remap a key symbol. See resource keysym. 348 Remap a key symbol. See resource keysym.
326 349
327 -embed *windowid* 350 -embed *windowid*
328 Tells rxvt to embed it's windows into an already-existing window, 351 Tells rxvt to embed it's windows into an already-existing window,
348 $rxvt->signal_connect_after (realize => sub { 371 $rxvt->signal_connect_after (realize => sub {
349 my $xid = $_[0]->window->get_xid; 372 my $xid = $_[0]->window->get_xid;
350 system "rxvt -embed $xid &"; 373 system "rxvt -embed $xid &";
351 }); 374 });
352 375
353 -pty-fd *fileno* 376 -pty-fd *file descriptor*
354 Tells rxvt NOT to execute any commands or create a new pty/tty pair 377 Tells rxvt NOT to execute any commands or create a new pty/tty pair
355 but instead use the given filehandle as the tty master. This is 378 but instead use the given filehandle as the tty master. This is
356 useful if you want to drive rxvt as a generic terminal emulator 379 useful if you want to drive rxvt as a generic terminal emulator
357 without having to run a program within it. 380 without having to run a program within it.
358 381
359 If this switch is given, rxvt will not create any utmp/wtmp entries 382 If this switch is given, rxvt will not create any utmp/wtmp entries
360 and will not tinker with pty/tty permissions - you have to do that 383 and will not tinker with pty/tty permissions - you have to do that
361 yourself if you want that. 384 yourself if you want that.
362 385
386 As an extremely special case, specifying -1 will completely suppress
387 pty/tty operations.
388
363 Here is a example in perl that illustrates how this option can be 389 Here is a example in perl that illustrates how this option can be
364 used (a longer example is in doc/pty-fd): 390 used (a longer example is in doc/pty-fd):
365 391
366 use IO::Pty; 392 use IO::Pty;
367 use Fcntl; 393 use Fcntl;
373 399
374 # now communicate with rxvt 400 # now communicate with rxvt
375 my $slave = $pty->slave; 401 my $slave = $pty->slave;
376 while (<$slave>) { print $slave "got <$_>\n" } 402 while (<$slave>) { print $slave "got <$_>\n" }
377 403
404 -pe *string*
405 Comma-separated list of perl extension scripts to use (or not to
406 use) in this terminal instance. See resource perl-ext for details.
407
378RESOURCES (available also as long-options) 408RESOURCES (available also as long-options)
379 Note: `rxvt --help' gives a list of all resources (long options) 409 Note: `rxvt --help' gives a list of all resources (long options)
380 compiled into your version. 410 compiled into your version.
381 411
382 There are two different methods that rxvt can use to get the Xresource
383 data: using the X libraries (Xrm*-functions) or internal Xresources
384 reader (~/.Xdefaults). For the first method (ie. rxvt -h lists
385 XGetDefaults), you can set and change the resources using X11 tools like 412 You can set and change the resources using X11 tools like xrdb. Many
386 xrdb. Many distribution do also load settings from the ~/.Xresources 413 distribution do also load settings from the ~/.Xresources file when X
387 file when X starts. rxvt will consult the following files/resources in 414 starts. rxvt will consult the following files/resources in order, with
388 order, with later settings overwriting earlier ones: 415 later settings overwriting earlier ones:
389 416
390 1. system-wide app-defaults file, either locale-dependent OR global 417 1. system-wide app-defaults file, either locale-dependent OR global
391 2. app-defaults file in $XAPPLRESDIR 418 2. app-defaults file in $XAPPLRESDIR
392 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 419 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
393 4. SCREEN_RESOURCES for the current screen 420 4. SCREEN_RESOURCES for the current screen
394 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 421 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
395 422
396 If compiled with internal Xresources support (i.e. rxvt -h lists 423 Note that when reading X resources, rxvt recognizes two class names:
397 .Xdefaults) then rxvt accepts application defaults set in 424 Rxvt and URxvt. The class name Rxvt allows resources common to both rxvt
398 XAPPLOADDIR/URxvt (compile-time defined: usually 425 and the original *rxvt* to be easily configured, while the class name
399 /usr/lib/X11/app-defaults/URxvt) and resources set in ~/.Xdefaults, or 426 URxvt allows resources unique to rxvt, to be shared between different
400 ~/.Xresources if ~/.Xdefaults does not exist. Note that when reading X
401 resources, rxvt recognizes two class names: XTerm and URxvt. The class
402 name Rxvt allows resources common to both rxvt and the original *rxvt*
403 to be easily configured, while the class name URxvt allows resources
404 unique to rxvt, notably colours and key-handling, to be shared between
405 different rxvt configurations. If no resources are specified, suitable 427 rxvt configurations. If no resources are specified, suitable defaults
406 defaults will be used. Command-line arguments can be used to override 428 will be used. Command-line arguments can be used to override resource
407 resource settings. The following resources are allowed: 429 settings. The following resources are supported (you might want to check
430 the rxvtperl(3) manpage for additional settings by perl extensions not
431 documented here):
408 432
409 geometry: *geom* 433 geometry: *geom*
410 Create the window with the specified X window geometry [default 434 Create the window with the specified X window geometry [default
411 80x24]; option -geometry. 435 80x24]; option -geometry.
412 436
528 font: *fontlist* 552 font: *fontlist*
529 Select the fonts to be used. This is a comma separated list of font 553 Select the fonts to be used. This is a comma separated list of font
530 names that are used in turn when trying to display Unicode 554 names that are used in turn when trying to display Unicode
531 characters. The first font defines the cell size for characters; 555 characters. The first font defines the cell size for characters;
532 other fonts might be smaller, but not larger. A reasonable default 556 other fonts might be smaller, but not larger. A reasonable default
533 font list is always appended to it. option -fn. 557 font list is always appended to it; option -fn.
534 558
535 Each font can either be a standard X11 core font (XLFD) name, with 559 Each font can either be a standard X11 core font (XLFD) name, with
536 optional prefix "x:" or a Xft font (Compile *xft*), prefixed with 560 optional prefix "x:" or a Xft font (Compile *xft*), prefixed with
537 "xft:". 561 "xft:".
538 562
584 tried. 608 tried.
585 609
586 If set, but empty, then this specific style is disabled and the 610 If set, but empty, then this specific style is disabled and the
587 normal text font will being used for the given style. 611 normal text font will being used for the given style.
588 612
613 intensityStyles: *boolean*
614 When font styles are not enabled, or this option is enabled (True,
615 option -is, the default), bold and italic font styles imply high
616 intensity foreground/backround colours. Disabling this option
617 (False, option +is) disables this behaviour, the high intensity
618 colours are not reachable.
619
589 selectstyle: *mode* 620 selectstyle: *mode*
590 Set mouse selection style to old which is 2.20, oldword which is 621 Set mouse selection style to old which is 2.20, oldword which is
591 xterm style with 2.20 old word selection, or anything else which 622 xterm style with 2.20 old word selection, or anything else which
592 gives xterm style selection. 623 gives xterm style selection.
593 624
683 borderLess: *boolean* 714 borderLess: *boolean*
684 Set MWM hints to request a borderless window, i.e. if honoured by 715 Set MWM hints to request a borderless window, i.e. if honoured by
685 the WM, the rxvt-unicode window will not have window decorations; 716 the WM, the rxvt-unicode window will not have window decorations;
686 option -bl. 717 option -bl.
687 718
719 skipBuiltinGlyphs: *boolean*
720 Compile *frills*: Disable the usage of the built-in block
721 graphics/line drawing characters and just rely on what the specified
722 fonts provide. Use this if you have a good font and want to use its
723 block graphic glyphs; option -sbg.
724
688 termName: *termname* 725 termName: *termname*
689 Specifies the terminal type name to be set in the TERM environment 726 Specifies the terminal type name to be set in the TERM environment
690 variable; option -tn. 727 variable; option -tn.
691 728
692 linespace: *number* 729 linespace: *number*
750 787
751 imLocale: *name* 788 imLocale: *name*
752 The locale to use for opening the IM. You can use an "LC_CTYPE" of 789 The locale to use for opening the IM. You can use an "LC_CTYPE" of
753 e.g. "de_DE.UTF-8" for normal text processing but "ja_JP.EUC-JP" for 790 e.g. "de_DE.UTF-8" for normal text processing but "ja_JP.EUC-JP" for
754 the input extension to be able to input japanese characters while 791 the input extension to be able to input japanese characters while
755 staying in another locale. option -imlocale. 792 staying in another locale; option -imlocale.
756 793
757 imFont: *fontset* 794 imFont: *fontset*
758 Specify the font-set used for XIM styles "OverTheSpot" or 795 Specify the font-set used for XIM styles "OverTheSpot" or
759 "OffTheSpot". It must be a standard X font set (XLFD patterns 796 "OffTheSpot". It must be a standard X font set (XLFD patterns
760 separated by commas), i.e. it's not in the same format as the other 797 separated by commas), i.e. it's not in the same format as the other
763 to the base font. option -imfont. 800 to the base font. option -imfont.
764 801
765 tripleclickwords: *boolean* 802 tripleclickwords: *boolean*
766 Change the meaning of triple-click selection with the left mouse 803 Change the meaning of triple-click selection with the left mouse
767 button. Instead of selecting a full line it will extend the 804 button. Instead of selecting a full line it will extend the
768 selection to the end of the logical line only. option -tcw. 805 selection to the end of the logical line only; option -tcw.
769 806
770 insecure: *boolean* 807 insecure: *boolean*
771 Enables "insecure" mode. Rxvt-unicode offers some escape sequences 808 Enables "insecure" mode. Rxvt-unicode offers some escape sequences
772 that echo arbitrary strings like the icon name or the locale. This 809 that echo arbitrary strings like the icon name or the locale. This
773 could be abused if somebody gets 8-bit-clean access to your display, 810 could be abused if somebody gets 8-bit-clean access to your display,
774 whether throuh a mail client displaying mail bodies unfiltered or 811 whether through a mail client displaying mail bodies unfiltered or
775 though write(1). Therefore, these sequences are disabled by default. 812 through write(1) or any other means. Therefore, these sequences are
776 (Note that other terminals, including xterm, have these sequences 813 disabled by default. (Note that many other terminals, including
777 enabled by default). You can enable them by setting this boolean 814 xterm, have these sequences enabled by default, which doesn't make
778 resource or specifying -insecure as an option. At the moment, this 815 it safer, though).
779 enabled display-answer, locale, findfont, icon label and window 816
780 title requests as well as dynamic menubar dispatch. 817 You can enable them by setting this boolean resource or specifying
818 -insecure as an option. At the moment, this enables display-answer,
819 locale, findfont, icon label and window title requests as well as
820 dynamic menubar dispatch.
781 821
782 modifier: *modifier* 822 modifier: *modifier*
783 Set the key to be interpreted as the Meta key to: alt, meta, hyper, 823 Set the key to be interpreted as the Meta key to: alt, meta, hyper,
784 super, mod1, mod2, mod3, mod4, mod5; option -mod. 824 super, mod1, mod2, mod3, mod4, mod5; option -mod.
785 825
794 secondaryScroll: *bool* 834 secondaryScroll: *bool*
795 Turn on/off secondary screen scroll (default enabled). If the this 835 Turn on/off secondary screen scroll (default enabled). If the this
796 option is enabled, scrolls on the secondary screen will change the 836 option is enabled, scrolls on the secondary screen will change the
797 scrollback buffer and switching to/from the secondary screen will 837 scrollback buffer and switching to/from the secondary screen will
798 instead scroll the screen up. 838 instead scroll the screen up.
839
840 hold: *bool*
841 Turn on/off hold window after exit support. If enabled, rxvt will
842 not immediately destroy its window when the program executed within
843 it exits. Instead, it will wait till it is being killed or closed by
844 the user.
799 845
800 keysym.*sym*: *string* 846 keysym.*sym*: *string*
801 Compile *frills*: Associate *string* with keysym *sym*. The 847 Compile *frills*: Associate *string* with keysym *sym*. The
802 intervening resource name keysym. cannot be omitted. 848 intervening resource name keysym. cannot be omitted.
803 849
822 "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab, 868 "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab,
823 "\000": octal number) or verbatim control characters ("^?": delete, 869 "\000": octal number) or verbatim control characters ("^?": delete,
824 "^@": null, "^A" ...) and may be enclosed with double quotes so that 870 "^@": null, "^A" ...) and may be enclosed with double quotes so that
825 it can start or end with whitespace. 871 it can start or end with whitespace.
826 872
827 Please note that you need to double the "\" when using 873 Please note that you need to double the "\" in resource files, as
828 "--enable-xgetdefault", as X itself does it's own de-escaping (you 874 Xlib itself does it's own de-escaping (you can use "\033" instead of
829 can use "\033" instead of "\e" (and so on), which will work with 875 "\e" (and so on), which will work with both Xt and rxvt's own
830 both Xt and rxvt's own processing). 876 processing).
831 877
832 You can define a range of keysyms in one shot by providing a 878 You can define a range of keysyms in one shot by providing a
833 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter 879 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter
834 `/' should be a character not used by the strings. 880 `/' should be a character not used by the strings.
835 881
847 is interpreted and executed as rxvt's control sequence. For example 893 is interpreted and executed as rxvt's control sequence. For example
848 the following means "change the current locale to "zh_CN.GBK" when 894 the following means "change the current locale to "zh_CN.GBK" when
849 Control-Meta-c is being pressed": 895 Control-Meta-c is being pressed":
850 896
851 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 897 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
898
899 If *string* takes the form "perl:STRING", then the specified STRING
900 is passed to the "on_keyboard_command" perl handler. See the
901 rxvtperl(3) manpage. For example, the selection extension (activated
902 via "rxvt -pe selection") listens for "selection:rot13" events:
903
904 URxvt.keysym.M-C-c: perl:selection:rot13
852 905
853 Due the the large number of modifier combinations, a defined key 906 Due the the large number of modifier combinations, a defined key
854 mapping will match if at *at least* the specified identifiers are 907 mapping will match if at *at least* the specified identifiers are
855 being set, and no other key mappings with those and more bits are 908 being set, and no other key mappings with those and more bits are
856 being defined. That means that defining a key map for "a" will 909 being defined. That means that defining a key map for "a" will
880 info): 933 info):
881 934
882 URxvt.keysym.M-C-3: command:\033[8;25;80t 935 URxvt.keysym.M-C-3: command:\033[8;25;80t
883 URxvt.keysym.M-C-4: command:\033[8;48;110t 936 URxvt.keysym.M-C-4: command:\033[8;48;110t
884 937
938 perl-ext-common: *string*
939 perl-ext: *string*
940 Comma-separated list(s) of perl extension scripts (default:
941 "default") to use in this terminal instance; option -pe.
942
943 Extension names can be prefixed with a "-" sign to prohibit using
944 them. This can be useful to selectively disable some extensions
945 loaded by default, or specified via the "perl-ext-common" resource.
946 For example, "default,-selection" will use all the default extension
947 except "selection".
948
949 Extension names can also be followed by an argument in angle
950 brackets (e.g. "searchable-scrollback<M-s>", which binds the hotkey
951 for searchable scorllback to Alt/Meta-s). Mentioning the same
952 extension multiple times with different arguments will pass multiple
953 arguments to the extension.
954
955 Each extension is looked up in the library directories, loaded if
956 necessary, and bound to the current terminal instance.
957
958 If both of these resources are the empty string, then the perl
959 interpreter will not be initialized. The idea behind two options is
960 that perl-ext-common will be used for extensions that should be
961 available to all instances, while perl-ext is used for specific
962 instances.
963
964 perl-eval: *string*
965 Perl code to be evaluated when all extensions have been registered.
966 See the rxvtperl(3) manpage. Due to security reasons, this resource
967 will be ignored when running setuid/setgid.
968
969 perl-lib: *path*
970 Colon-separated list of additional directories that hold extension
971 scripts. When looking for extensions specified by the "perl"
972 resource, rxvt will first look in these directories and then in
973 /opt/rxvt/lib/urxvt/perl/. Due to security reasons, this resource
974 will be ignored when running setuid/setgid.
975
976 See the rxvtperl(3) manpage.
977
978 searchable-scrollback: *keysym*
979 Sets the hotkey that starts the incremental scrollback buffer search
980 (default: "M-s").
981
982 urlLauncher: *string*
983 Specifies the program to be started with a URL argument. Used by the
984 "selection-popup" and "mark-urls" perl extensions.
985
986 transient-for: *windowid*
987 Sets the WM_TRANSIENT_FOR property to the given window iw.
988
885THE SCROLLBAR 989THE SCROLLBAR
886 Lines of text that scroll off the top of the rxvt window (resource: 990 Lines of text that scroll off the top of the rxvt window (resource:
887 saveLines) and can be scrolled back using the scrollbar or by 991 saveLines) and can be scrolled back using the scrollbar or by
888 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is 992 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is
889 fairly intuitive. The xterm-scrollbar is without arrows and its 993 fairly intuitive. The xterm-scrollbar is without arrows and its
915 entire logical line (which can span multiple screen lines), unless 1019 entire logical line (which can span multiple screen lines), unless
916 modified by resource tripleclickwords. 1020 modified by resource tripleclickwords.
917 1021
918 Starting a selection while pressing the Meta key (or Meta+Ctrl keys) 1022 Starting a selection while pressing the Meta key (or Meta+Ctrl keys)
919 (Compile: *frills*) will create a rectangular selection instead of a 1023 (Compile: *frills*) will create a rectangular selection instead of a
920 normal one. 1024 normal one. In this mode, every selected row becomes its own line in
1025 the selection, and trailing whitespace is visually underlined and
1026 removed from the selection.
921 1027
922 Insertion: 1028 Insertion:
923 Pressing and releasing the Middle mouse button (or Shift-Insert) in 1029 Pressing and releasing the Middle mouse button (or Shift-Insert) in
924 an rxvt window causes the current text selection to be inserted as 1030 an rxvt window causes the current text selection to be inserted as
925 if it had been typed on the keyboard. 1031 if it had been typed on the keyboard.
929 supported in rxvt-unicode. Bug me if you need this. 1035 supported in rxvt-unicode. Bug me if you need this.
930 1036
931 You can, however, switch fonts at runtime using escape sequences (and 1037 You can, however, switch fonts at runtime using escape sequences (and
932 therefore using the menubar), e.g.: 1038 therefore using the menubar), e.g.:
933 1039
934 printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic" 1040 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
935 1041
936 rxvt-unicode will automatically re-apply these fonts to the output so 1042 rxvt-unicode will automatically re-apply these fonts to the output so
937 far. 1043 far.
938 1044
939ISO 14755 SUPPORT 1045ISO 14755 SUPPORT

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines