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.24 by root, Tue Oct 25 20:04:59 2005 UTC vs.
Revision 1.30 by root, Mon Jan 2 19:36:07 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 6.2, 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
… …
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 characters are to be printed. See resource boldItalicFont for
178 details. 178 details.
179 179
180 -is|+is
181 Compile font-styles: Bold/Italic font styles imply high intensity
182 foreground/background (default). See resource intensityStyles for
183 details.
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
183 not contain `.' or `*' characters. Also sets the icon and title 188 not contain `.' or `*' characters. Also sets the icon and title
184 name. 189 name.
… …
267 on the command line. If this option is used, it must be the last on 272 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 273 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, 274 run the program specified by the SHELL environment variable or,
270 failing that, *sh(1)*. 275 failing that, *sh(1)*.
271 276
277 Please note that you must specify a program with arguments. If you
278 want to run shell commands, you have to specify the shell, like
279 this:
280
281 rxvt -e sh -c "shell commands"
282
272 -title *text* 283 -title *text*
273 Window title (-T still respected); the default title is the basename 284 Window title (-T still respected); the default title is the basename
274 of the program specified after the -e option, if any, otherwise the 285 of the program specified after the -e option, if any, otherwise the
275 application name; resource title. 286 application name; resource title.
276 287
… …
319 330
320 -ssr|+ssr 331 -ssr|+ssr
321 Turn on/off secondary screen scroll (default enabled); resource 332 Turn on/off secondary screen scroll (default enabled); resource
322 secondaryScroll. 333 secondaryScroll.
323 334
335 -hold|+hold
336 Turn on/off hold window after exit support. If enabled, rxvt will
337 not immediately destroy its window when the program executed within
338 it exits. Instead, it will wait till it is being killed or closed by
339 the user; resource hold.
340
324 -keysym.*sym* *string* 341 -keysym.*sym* *string*
325 Remap a key symbol. See resource keysym. 342 Remap a key symbol. See resource keysym.
326 343
327 -embed *windowid* 344 -embed *windowid*
328 Tells rxvt to embed it's windows into an already-existing window, 345 Tells rxvt to embed it's windows into an already-existing window,
… …
372 close $pty; 389 close $pty;
373 390
374 # now communicate with rxvt 391 # now communicate with rxvt
375 my $slave = $pty->slave; 392 my $slave = $pty->slave;
376 while (<$slave>) { print $slave "got <$_>\n" } 393 while (<$slave>) { print $slave "got <$_>\n" }
394
395 -perl *string*
396 Used by perl extension. See resource perl.
377 397
378RESOURCES (available also as long-options) 398RESOURCES (available also as long-options)
379 Note: `rxvt --help' gives a list of all resources (long options) 399 Note: `rxvt --help' gives a list of all resources (long options)
380 compiled into your version. 400 compiled into your version.
381 401
… …
528 font: *fontlist* 548 font: *fontlist*
529 Select the fonts to be used. This is a comma separated list of font 549 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 550 names that are used in turn when trying to display Unicode
531 characters. The first font defines the cell size for characters; 551 characters. The first font defines the cell size for characters;
532 other fonts might be smaller, but not larger. A reasonable default 552 other fonts might be smaller, but not larger. A reasonable default
533 font list is always appended to it. option -fn. 553 font list is always appended to it; option -fn.
534 554
535 Each font can either be a standard X11 core font (XLFD) name, with 555 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 556 optional prefix "x:" or a Xft font (Compile *xft*), prefixed with
537 "xft:". 557 "xft:".
538 558
… …
584 tried. 604 tried.
585 605
586 If set, but empty, then this specific style is disabled and the 606 If set, but empty, then this specific style is disabled and the
587 normal text font will being used for the given style. 607 normal text font will being used for the given style.
588 608
609 intensityStyles: *boolean*
610 When font styles are not enabled, or this option is enabled (True,
611 option -is, the default), bold and italic font styles imply high
612 intensity foreground/backround colours. Disabling this option
613 (False, option +is) disables this behaviour, the high intensity
614 colours are not reachable.
615
589 selectstyle: *mode* 616 selectstyle: *mode*
590 Set mouse selection style to old which is 2.20, oldword which is 617 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 618 xterm style with 2.20 old word selection, or anything else which
592 gives xterm style selection. 619 gives xterm style selection.
593 620
… …
750 777
751 imLocale: *name* 778 imLocale: *name*
752 The locale to use for opening the IM. You can use an "LC_CTYPE" of 779 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 780 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 781 the input extension to be able to input japanese characters while
755 staying in another locale. option -imlocale. 782 staying in another locale; option -imlocale.
756 783
757 imFont: *fontset* 784 imFont: *fontset*
758 Specify the font-set used for XIM styles "OverTheSpot" or 785 Specify the font-set used for XIM styles "OverTheSpot" or
759 "OffTheSpot". It must be a standard X font set (XLFD patterns 786 "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 787 separated by commas), i.e. it's not in the same format as the other
… …
763 to the base font. option -imfont. 790 to the base font. option -imfont.
764 791
765 tripleclickwords: *boolean* 792 tripleclickwords: *boolean*
766 Change the meaning of triple-click selection with the left mouse 793 Change the meaning of triple-click selection with the left mouse
767 button. Instead of selecting a full line it will extend the 794 button. Instead of selecting a full line it will extend the
768 selection to the end of the logical line only. option -tcw. 795 selection to the end of the logical line only; option -tcw.
769 796
770 insecure: *boolean* 797 insecure: *boolean*
771 Enables "insecure" mode. Rxvt-unicode offers some escape sequences 798 Enables "insecure" mode. Rxvt-unicode offers some escape sequences
772 that echo arbitrary strings like the icon name or the locale. This 799 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, 800 could be abused if somebody gets 8-bit-clean access to your display,
774 whether throuh a mail client displaying mail bodies unfiltered or 801 whether through a mail client displaying mail bodies unfiltered or
775 though write(1). Therefore, these sequences are disabled by default. 802 through write(1) or any other means. Therefore, these sequences are
776 (Note that other terminals, including xterm, have these sequences 803 disabled by default. (Note that many other terminals, including
777 enabled by default). You can enable them by setting this boolean 804 xterm, have these sequences enabled by default, which doesn't make
778 resource or specifying -insecure as an option. At the moment, this 805 it safer, though).
779 enabled display-answer, locale, findfont, icon label and window 806
780 title requests as well as dynamic menubar dispatch. 807 You can enable them by setting this boolean resource or specifying
808 -insecure as an option. At the moment, this enables display-answer,
809 locale, findfont, icon label and window title requests as well as
810 dynamic menubar dispatch.
781 811
782 modifier: *modifier* 812 modifier: *modifier*
783 Set the key to be interpreted as the Meta key to: alt, meta, hyper, 813 Set the key to be interpreted as the Meta key to: alt, meta, hyper,
784 super, mod1, mod2, mod3, mod4, mod5; option -mod. 814 super, mod1, mod2, mod3, mod4, mod5; option -mod.
785 815
… …
794 secondaryScroll: *bool* 824 secondaryScroll: *bool*
795 Turn on/off secondary screen scroll (default enabled). If the this 825 Turn on/off secondary screen scroll (default enabled). If the this
796 option is enabled, scrolls on the secondary screen will change the 826 option is enabled, scrolls on the secondary screen will change the
797 scrollback buffer and switching to/from the secondary screen will 827 scrollback buffer and switching to/from the secondary screen will
798 instead scroll the screen up. 828 instead scroll the screen up.
829
830 hold: *bool*
831 Turn on/off hold window after exit support. If enabled, rxvt will
832 not immediately destroy its window when the program executed within
833 it exits. Instead, it will wait till it is being killed or closed by
834 the user.
799 835
800 keysym.*sym*: *string* 836 keysym.*sym*: *string*
801 Compile *frills*: Associate *string* with keysym *sym*. The 837 Compile *frills*: Associate *string* with keysym *sym*. The
802 intervening resource name keysym. cannot be omitted. 838 intervening resource name keysym. cannot be omitted.
803 839
… …
880 info): 916 info):
881 917
882 URxvt.keysym.M-C-3: command:\033[8;25;80t 918 URxvt.keysym.M-C-3: command:\033[8;25;80t
883 URxvt.keysym.M-C-4: command:\033[8;48;110t 919 URxvt.keysym.M-C-4: command:\033[8;48;110t
884 920
921 perl: *string*
922 Used by perl extension and is free for any use, as it is not
923 interpreted by rxvt-unicode itself; option perl.
924
925 perl-eval: *string*
926 Perl code to be evaluated when all extensions have been loaded. See
927 the rxvtperl(3) manpage.
928
929 perl-lib: *path*
930 Additional directory that holds extension scripts that are loaded
931 and enabled for this terminal instance, in addition to scripts
932 stored in /opt/rxvt/lib/urxvt/perl-ext/, which are global to all
933 terminal instances.
934
935 See the rxvtperl(3) manpage.
936
885THE SCROLLBAR 937THE SCROLLBAR
886 Lines of text that scroll off the top of the rxvt window (resource: 938 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 939 saveLines) and can be scrolled back using the scrollbar or by
888 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is 940 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is
889 fairly intuitive. The xterm-scrollbar is without arrows and its 941 fairly intuitive. The xterm-scrollbar is without arrows and its
… …
915 entire logical line (which can span multiple screen lines), unless 967 entire logical line (which can span multiple screen lines), unless
916 modified by resource tripleclickwords. 968 modified by resource tripleclickwords.
917 969
918 Starting a selection while pressing the Meta key (or Meta+Ctrl keys) 970 Starting a selection while pressing the Meta key (or Meta+Ctrl keys)
919 (Compile: *frills*) will create a rectangular selection instead of a 971 (Compile: *frills*) will create a rectangular selection instead of a
920 normal one. 972 normal one. In this mode, every selected row becomes its own line in
973 the selection, and trailing whitespace is visually underlined and
974 removed from the selection.
921 975
922 Insertion: 976 Insertion:
923 Pressing and releasing the Middle mouse button (or Shift-Insert) in 977 Pressing and releasing the Middle mouse button (or Shift-Insert) in
924 an rxvt window causes the current text selection to be inserted as 978 an rxvt window causes the current text selection to be inserted as
925 if it had been typed on the keyboard. 979 if it had been typed on the keyboard.
… …
929 supported in rxvt-unicode. Bug me if you need this. 983 supported in rxvt-unicode. Bug me if you need this.
930 984
931 You can, however, switch fonts at runtime using escape sequences (and 985 You can, however, switch fonts at runtime using escape sequences (and
932 therefore using the menubar), e.g.: 986 therefore using the menubar), e.g.:
933 987
934 printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic" 988 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
935 989
936 rxvt-unicode will automatically re-apply these fonts to the output so 990 rxvt-unicode will automatically re-apply these fonts to the output so
937 far. 991 far.
938 992
939ISO 14755 SUPPORT 993ISO 14755 SUPPORT
… …
1107 1161
1108SEE ALSO 1162SEE ALSO
1109 rxvt(7), rxvtc(1), rxvtd(1), xterm(1), sh(1), resize(1), X(1), pty(4), 1163 rxvt(7), rxvtc(1), rxvtd(1), xterm(1), sh(1), resize(1), X(1), pty(4),
1110 tty(4), utmp(5) 1164 tty(4), utmp(5)
1111 1165
1112BUGS
1113 Check the BUGS file for an up-to-date list.
1114
1115 Cursor change support is not yet implemented.
1116
1117 Click-and-drag doesn't work with X11 mouse report overriding.
1118
1119CURRENT PROJECT COORDINATOR 1166CURRENT PROJECT COORDINATOR
1120 Project Coordinator 1167 Project Coordinator
1121 Marc A. Lehmann <rxvt-unicode@schmorp.de> 1168 Marc A. Lehmann <rxvt-unicode@schmorp.de>
1122 1169
1123 <http://software.schmorp.de/#rxvt-unicode> 1170 <http://software.schmorp.de/#rxvt-unicode>

Diff Legend

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