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

Comparing cvsroot/rxvt-unicode/doc/rxvt.1.txt (file contents):
Revision 1.28 by root, Tue Dec 27 12:24:09 2005 UTC vs.
Revision 1.36 by root, Wed Jan 4 21:37:55 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 6.1, is a colour vt102 terminal emulator intended 9 rxvt-unicode, version 6.3, 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.
384 close $pty; 395 close $pty;
385 396
386 # now communicate with rxvt 397 # now communicate with rxvt
387 my $slave = $pty->slave; 398 my $slave = $pty->slave;
388 while (<$slave>) { print $slave "got <$_>\n" } 399 while (<$slave>) { print $slave "got <$_>\n" }
400
401 -pe *string*
402 Colon-separated list of perl extension scripts to use in this
403 terminal instance. See resource perl-ext.
389 404
390RESOURCES (available also as long-options) 405RESOURCES (available also as long-options)
391 Note: `rxvt --help' gives a list of all resources (long options) 406 Note: `rxvt --help' gives a list of all resources (long options)
392 compiled into your version. 407 compiled into your version.
393 408
540 font: *fontlist* 555 font: *fontlist*
541 Select the fonts to be used. This is a comma separated list of font 556 Select the fonts to be used. This is a comma separated list of font
542 names that are used in turn when trying to display Unicode 557 names that are used in turn when trying to display Unicode
543 characters. The first font defines the cell size for characters; 558 characters. The first font defines the cell size for characters;
544 other fonts might be smaller, but not larger. A reasonable default 559 other fonts might be smaller, but not larger. A reasonable default
545 font list is always appended to it. option -fn. 560 font list is always appended to it; option -fn.
546 561
547 Each font can either be a standard X11 core font (XLFD) name, with 562 Each font can either be a standard X11 core font (XLFD) name, with
548 optional prefix "x:" or a Xft font (Compile *xft*), prefixed with 563 optional prefix "x:" or a Xft font (Compile *xft*), prefixed with
549 "xft:". 564 "xft:".
550 565
596 tried. 611 tried.
597 612
598 If set, but empty, then this specific style is disabled and the 613 If set, but empty, then this specific style is disabled and the
599 normal text font will being used for the given style. 614 normal text font will being used for the given style.
600 615
616 intensityStyles: *boolean*
617 When font styles are not enabled, or this option is enabled (True,
618 option -is, the default), bold and italic font styles imply high
619 intensity foreground/backround colours. Disabling this option
620 (False, option +is) disables this behaviour, the high intensity
621 colours are not reachable.
622
601 selectstyle: *mode* 623 selectstyle: *mode*
602 Set mouse selection style to old which is 2.20, oldword which is 624 Set mouse selection style to old which is 2.20, oldword which is
603 xterm style with 2.20 old word selection, or anything else which 625 xterm style with 2.20 old word selection, or anything else which
604 gives xterm style selection. 626 gives xterm style selection.
605 627
695 borderLess: *boolean* 717 borderLess: *boolean*
696 Set MWM hints to request a borderless window, i.e. if honoured by 718 Set MWM hints to request a borderless window, i.e. if honoured by
697 the WM, the rxvt-unicode window will not have window decorations; 719 the WM, the rxvt-unicode window will not have window decorations;
698 option -bl. 720 option -bl.
699 721
722 skipBuiltinGlyphs: *boolean*
723 Compile *frills*: Disable the usage of the built-in block
724 graphics/line drawing characters and just rely on what the specified
725 fonts provide. Use this if you have a good font and want to use its
726 block graphic glyphs; option -sbg.
727
700 termName: *termname* 728 termName: *termname*
701 Specifies the terminal type name to be set in the TERM environment 729 Specifies the terminal type name to be set in the TERM environment
702 variable; option -tn. 730 variable; option -tn.
703 731
704 linespace: *number* 732 linespace: *number*
762 790
763 imLocale: *name* 791 imLocale: *name*
764 The locale to use for opening the IM. You can use an "LC_CTYPE" of 792 The locale to use for opening the IM. You can use an "LC_CTYPE" of
765 e.g. "de_DE.UTF-8" for normal text processing but "ja_JP.EUC-JP" for 793 e.g. "de_DE.UTF-8" for normal text processing but "ja_JP.EUC-JP" for
766 the input extension to be able to input japanese characters while 794 the input extension to be able to input japanese characters while
767 staying in another locale. option -imlocale. 795 staying in another locale; option -imlocale.
768 796
769 imFont: *fontset* 797 imFont: *fontset*
770 Specify the font-set used for XIM styles "OverTheSpot" or 798 Specify the font-set used for XIM styles "OverTheSpot" or
771 "OffTheSpot". It must be a standard X font set (XLFD patterns 799 "OffTheSpot". It must be a standard X font set (XLFD patterns
772 separated by commas), i.e. it's not in the same format as the other 800 separated by commas), i.e. it's not in the same format as the other
775 to the base font. option -imfont. 803 to the base font. option -imfont.
776 804
777 tripleclickwords: *boolean* 805 tripleclickwords: *boolean*
778 Change the meaning of triple-click selection with the left mouse 806 Change the meaning of triple-click selection with the left mouse
779 button. Instead of selecting a full line it will extend the 807 button. Instead of selecting a full line it will extend the
780 selection to the end of the logical line only. option -tcw. 808 selection to the end of the logical line only; option -tcw.
781 809
782 insecure: *boolean* 810 insecure: *boolean*
783 Enables "insecure" mode. Rxvt-unicode offers some escape sequences 811 Enables "insecure" mode. Rxvt-unicode offers some escape sequences
784 that echo arbitrary strings like the icon name or the locale. This 812 that echo arbitrary strings like the icon name or the locale. This
785 could be abused if somebody gets 8-bit-clean access to your display, 813 could be abused if somebody gets 8-bit-clean access to your display,
869 the following means "change the current locale to "zh_CN.GBK" when 897 the following means "change the current locale to "zh_CN.GBK" when
870 Control-Meta-c is being pressed": 898 Control-Meta-c is being pressed":
871 899
872 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 900 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
873 901
902 If *string* takes the form "perl:STRING", then the specified STRING
903 is passed to the "on_keyboard_command" perl handler. See the
904 rxvtperl(3) manpage. For example, the selection extension (activated
905 via "rxvt -pe selection") listens for "selection:rot13" events:
906
907 URxvt.keysym.M-C-c: perl:selection:rot13
908
874 Due the the large number of modifier combinations, a defined key 909 Due the the large number of modifier combinations, a defined key
875 mapping will match if at *at least* the specified identifiers are 910 mapping will match if at *at least* the specified identifiers are
876 being set, and no other key mappings with those and more bits are 911 being set, and no other key mappings with those and more bits are
877 being defined. That means that defining a key map for "a" will 912 being defined. That means that defining a key map for "a" will
878 automatically provide definitions for "Meta-a", "Shift-a" and so on, 913 automatically provide definitions for "Meta-a", "Shift-a" and so on,
900 Other things are possible, e.g. resizing (see rxvt(7) for more 935 Other things are possible, e.g. resizing (see rxvt(7) for more
901 info): 936 info):
902 937
903 URxvt.keysym.M-C-3: command:\033[8;25;80t 938 URxvt.keysym.M-C-3: command:\033[8;25;80t
904 URxvt.keysym.M-C-4: command:\033[8;48;110t 939 URxvt.keysym.M-C-4: command:\033[8;48;110t
940
941 perl-ext-common: *string*
942 perl-ext: *string*
943 Colon-separated list(s) of perl extension scripts to use in this
944 terminal instance. Each extension is looked up in the library
945 directories, loaded if necessary, and bound to the current terminal
946 instance. If this resource is empty or missing, then the perl
947 interpreter will not be initialized. The idea behind two options is
948 that perl-ext-common will be used for extensions that should be
949 available to all instances, while perl-ext is used for specific
950 instances; option -pe.
951
952 perl-eval: *string*
953 Perl code to be evaluated when all extensions have been registered.
954 See the rxvtperl(3) manpage.
955
956 perl-lib: *path*
957 Colon-separated list of additional directories that hold extension
958 scripts. When looking for extensions specified by the "perl"
959 resource, rxvt will first look in these directories and then in
960 /opt/rxvt/lib/urxvt/perl/.
961
962 See the rxvtperl(3) manpage.
905 963
906THE SCROLLBAR 964THE SCROLLBAR
907 Lines of text that scroll off the top of the rxvt window (resource: 965 Lines of text that scroll off the top of the rxvt window (resource:
908 saveLines) and can be scrolled back using the scrollbar or by 966 saveLines) and can be scrolled back using the scrollbar or by
909 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is 967 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines