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.32 by root, Mon Jan 2 21:41:51 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 -pe *string*
396 Colon-separated list of perl extension scripts to use in this
397 terminal instance. See resource perl-ext.
377 398
378RESOURCES (available also as long-options) 399RESOURCES (available also as long-options)
379 Note: `rxvt --help' gives a list of all resources (long options) 400 Note: `rxvt --help' gives a list of all resources (long options)
380 compiled into your version. 401 compiled into your version.
381 402
… …
528 font: *fontlist* 549 font: *fontlist*
529 Select the fonts to be used. This is a comma separated list of font 550 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 551 names that are used in turn when trying to display Unicode
531 characters. The first font defines the cell size for characters; 552 characters. The first font defines the cell size for characters;
532 other fonts might be smaller, but not larger. A reasonable default 553 other fonts might be smaller, but not larger. A reasonable default
533 font list is always appended to it. option -fn. 554 font list is always appended to it; option -fn.
534 555
535 Each font can either be a standard X11 core font (XLFD) name, with 556 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 557 optional prefix "x:" or a Xft font (Compile *xft*), prefixed with
537 "xft:". 558 "xft:".
538 559
… …
584 tried. 605 tried.
585 606
586 If set, but empty, then this specific style is disabled and the 607 If set, but empty, then this specific style is disabled and the
587 normal text font will being used for the given style. 608 normal text font will being used for the given style.
588 609
610 intensityStyles: *boolean*
611 When font styles are not enabled, or this option is enabled (True,
612 option -is, the default), bold and italic font styles imply high
613 intensity foreground/backround colours. Disabling this option
614 (False, option +is) disables this behaviour, the high intensity
615 colours are not reachable.
616
589 selectstyle: *mode* 617 selectstyle: *mode*
590 Set mouse selection style to old which is 2.20, oldword which is 618 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 619 xterm style with 2.20 old word selection, or anything else which
592 gives xterm style selection. 620 gives xterm style selection.
593 621
… …
750 778
751 imLocale: *name* 779 imLocale: *name*
752 The locale to use for opening the IM. You can use an "LC_CTYPE" of 780 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 781 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 782 the input extension to be able to input japanese characters while
755 staying in another locale. option -imlocale. 783 staying in another locale; option -imlocale.
756 784
757 imFont: *fontset* 785 imFont: *fontset*
758 Specify the font-set used for XIM styles "OverTheSpot" or 786 Specify the font-set used for XIM styles "OverTheSpot" or
759 "OffTheSpot". It must be a standard X font set (XLFD patterns 787 "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 788 separated by commas), i.e. it's not in the same format as the other
… …
763 to the base font. option -imfont. 791 to the base font. option -imfont.
764 792
765 tripleclickwords: *boolean* 793 tripleclickwords: *boolean*
766 Change the meaning of triple-click selection with the left mouse 794 Change the meaning of triple-click selection with the left mouse
767 button. Instead of selecting a full line it will extend the 795 button. Instead of selecting a full line it will extend the
768 selection to the end of the logical line only. option -tcw. 796 selection to the end of the logical line only; option -tcw.
769 797
770 insecure: *boolean* 798 insecure: *boolean*
771 Enables "insecure" mode. Rxvt-unicode offers some escape sequences 799 Enables "insecure" mode. Rxvt-unicode offers some escape sequences
772 that echo arbitrary strings like the icon name or the locale. This 800 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, 801 could be abused if somebody gets 8-bit-clean access to your display,
774 whether throuh a mail client displaying mail bodies unfiltered or 802 whether through a mail client displaying mail bodies unfiltered or
775 though write(1). Therefore, these sequences are disabled by default. 803 through write(1) or any other means. Therefore, these sequences are
776 (Note that other terminals, including xterm, have these sequences 804 disabled by default. (Note that many other terminals, including
777 enabled by default). You can enable them by setting this boolean 805 xterm, have these sequences enabled by default, which doesn't make
778 resource or specifying -insecure as an option. At the moment, this 806 it safer, though).
779 enabled display-answer, locale, findfont, icon label and window 807
780 title requests as well as dynamic menubar dispatch. 808 You can enable them by setting this boolean resource or specifying
809 -insecure as an option. At the moment, this enables display-answer,
810 locale, findfont, icon label and window title requests as well as
811 dynamic menubar dispatch.
781 812
782 modifier: *modifier* 813 modifier: *modifier*
783 Set the key to be interpreted as the Meta key to: alt, meta, hyper, 814 Set the key to be interpreted as the Meta key to: alt, meta, hyper,
784 super, mod1, mod2, mod3, mod4, mod5; option -mod. 815 super, mod1, mod2, mod3, mod4, mod5; option -mod.
785 816
… …
794 secondaryScroll: *bool* 825 secondaryScroll: *bool*
795 Turn on/off secondary screen scroll (default enabled). If the this 826 Turn on/off secondary screen scroll (default enabled). If the this
796 option is enabled, scrolls on the secondary screen will change the 827 option is enabled, scrolls on the secondary screen will change the
797 scrollback buffer and switching to/from the secondary screen will 828 scrollback buffer and switching to/from the secondary screen will
798 instead scroll the screen up. 829 instead scroll the screen up.
830
831 hold: *bool*
832 Turn on/off hold window after exit support. If enabled, rxvt will
833 not immediately destroy its window when the program executed within
834 it exits. Instead, it will wait till it is being killed or closed by
835 the user.
799 836
800 keysym.*sym*: *string* 837 keysym.*sym*: *string*
801 Compile *frills*: Associate *string* with keysym *sym*. The 838 Compile *frills*: Associate *string* with keysym *sym*. The
802 intervening resource name keysym. cannot be omitted. 839 intervening resource name keysym. cannot be omitted.
803 840
… …
848 the following means "change the current locale to "zh_CN.GBK" when 885 the following means "change the current locale to "zh_CN.GBK" when
849 Control-Meta-c is being pressed": 886 Control-Meta-c is being pressed":
850 887
851 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 888 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
852 889
890 If *string* takes the form "perl:STRING", then the specified STRING
891 is passed to the "on_keyboard_command" perl handler. See the
892 rxvtperl(3) manpage. For example, the selection extension (activated
893 via "rxvt -pe selection") listens for "selection:rot13" events:
894
895 URxvt.keysym.M-C-c: perl:selection:rot13
896
853 Due the the large number of modifier combinations, a defined key 897 Due the the large number of modifier combinations, a defined key
854 mapping will match if at *at least* the specified identifiers are 898 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 899 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 900 being defined. That means that defining a key map for "a" will
857 automatically provide definitions for "Meta-a", "Shift-a" and so on, 901 automatically provide definitions for "Meta-a", "Shift-a" and so on,
… …
880 info): 924 info):
881 925
882 URxvt.keysym.M-C-3: command:\033[8;25;80t 926 URxvt.keysym.M-C-3: command:\033[8;25;80t
883 URxvt.keysym.M-C-4: command:\033[8;48;110t 927 URxvt.keysym.M-C-4: command:\033[8;48;110t
884 928
929 perl-ext: *string*
930 Colon-separated list of perl extension scripts to use in this
931 terminal instance. Each extension is looked up in the library
932 directories, loaded if necessary, and bound to the current terminal
933 instance; option -pe.
934
935 perl-eval: *string*
936 Perl code to be evaluated when all extensions have been registered.
937 See the rxvtperl(3) manpage.
938
939 perl-lib: *path*
940 Colon-separated list of additional directories that hold extension
941 scripts. When looking for extensions specified by the "perl"
942 resource, rxvt will first look in these directories and then in
943 /opt/rxvt/lib/urxvt/perl/.
944
945 See the rxvtperl(3) manpage.
946
885THE SCROLLBAR 947THE SCROLLBAR
886 Lines of text that scroll off the top of the rxvt window (resource: 948 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 949 saveLines) and can be scrolled back using the scrollbar or by
888 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is 950 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is
889 fairly intuitive. The xterm-scrollbar is without arrows and its 951 fairly intuitive. The xterm-scrollbar is without arrows and its
… …
915 entire logical line (which can span multiple screen lines), unless 977 entire logical line (which can span multiple screen lines), unless
916 modified by resource tripleclickwords. 978 modified by resource tripleclickwords.
917 979
918 Starting a selection while pressing the Meta key (or Meta+Ctrl keys) 980 Starting a selection while pressing the Meta key (or Meta+Ctrl keys)
919 (Compile: *frills*) will create a rectangular selection instead of a 981 (Compile: *frills*) will create a rectangular selection instead of a
920 normal one. 982 normal one. In this mode, every selected row becomes its own line in
983 the selection, and trailing whitespace is visually underlined and
984 removed from the selection.
921 985
922 Insertion: 986 Insertion:
923 Pressing and releasing the Middle mouse button (or Shift-Insert) in 987 Pressing and releasing the Middle mouse button (or Shift-Insert) in
924 an rxvt window causes the current text selection to be inserted as 988 an rxvt window causes the current text selection to be inserted as
925 if it had been typed on the keyboard. 989 if it had been typed on the keyboard.
… …
929 supported in rxvt-unicode. Bug me if you need this. 993 supported in rxvt-unicode. Bug me if you need this.
930 994
931 You can, however, switch fonts at runtime using escape sequences (and 995 You can, however, switch fonts at runtime using escape sequences (and
932 therefore using the menubar), e.g.: 996 therefore using the menubar), e.g.:
933 997
934 printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic" 998 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
935 999
936 rxvt-unicode will automatically re-apply these fonts to the output so 1000 rxvt-unicode will automatically re-apply these fonts to the output so
937 far. 1001 far.
938 1002
939ISO 14755 SUPPORT 1003ISO 14755 SUPPORT

Diff Legend

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