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.27 by root, Thu Dec 22 16:44:10 2005 UTC vs.
Revision 1.37 by root, Sat Jan 7 04:19:43 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.0, 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.
360 $rxvt->signal_connect_after (realize => sub { 371 $rxvt->signal_connect_after (realize => sub {
361 my $xid = $_[0]->window->get_xid; 372 my $xid = $_[0]->window->get_xid;
362 system "rxvt -embed $xid &"; 373 system "rxvt -embed $xid &";
363 }); 374 });
364 375
365 -pty-fd *fileno* 376 -pty-fd *file descriptor*
366 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
367 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
368 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
369 without having to run a program within it. 380 without having to run a program within it.
370 381
371 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
372 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
373 yourself if you want that. 384 yourself if you want that.
374 385
386 As an extremely special case, specifying -1 will completely suppress
387 pty/tty operations.
388
375 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
376 used (a longer example is in doc/pty-fd): 390 used (a longer example is in doc/pty-fd):
377 391
378 use IO::Pty; 392 use IO::Pty;
379 use Fcntl; 393 use Fcntl;
384 close $pty; 398 close $pty;
385 399
386 # now communicate with rxvt 400 # now communicate with rxvt
387 my $slave = $pty->slave; 401 my $slave = $pty->slave;
388 while (<$slave>) { print $slave "got <$_>\n" } 402 while (<$slave>) { print $slave "got <$_>\n" }
403
404 -pe *string*
405 Comma-separated list of perl extension scripts to use in this
406 terminal instance. See resource perl-ext.
389 407
390RESOURCES (available also as long-options) 408RESOURCES (available also as long-options)
391 Note: `rxvt --help' gives a list of all resources (long options) 409 Note: `rxvt --help' gives a list of all resources (long options)
392 compiled into your version. 410 compiled into your version.
393 411
540 font: *fontlist* 558 font: *fontlist*
541 Select the fonts to be used. This is a comma separated list of font 559 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 560 names that are used in turn when trying to display Unicode
543 characters. The first font defines the cell size for characters; 561 characters. The first font defines the cell size for characters;
544 other fonts might be smaller, but not larger. A reasonable default 562 other fonts might be smaller, but not larger. A reasonable default
545 font list is always appended to it. option -fn. 563 font list is always appended to it; option -fn.
546 564
547 Each font can either be a standard X11 core font (XLFD) name, with 565 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 566 optional prefix "x:" or a Xft font (Compile *xft*), prefixed with
549 "xft:". 567 "xft:".
550 568
596 tried. 614 tried.
597 615
598 If set, but empty, then this specific style is disabled and the 616 If set, but empty, then this specific style is disabled and the
599 normal text font will being used for the given style. 617 normal text font will being used for the given style.
600 618
619 intensityStyles: *boolean*
620 When font styles are not enabled, or this option is enabled (True,
621 option -is, the default), bold and italic font styles imply high
622 intensity foreground/backround colours. Disabling this option
623 (False, option +is) disables this behaviour, the high intensity
624 colours are not reachable.
625
601 selectstyle: *mode* 626 selectstyle: *mode*
602 Set mouse selection style to old which is 2.20, oldword which is 627 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 628 xterm style with 2.20 old word selection, or anything else which
604 gives xterm style selection. 629 gives xterm style selection.
605 630
695 borderLess: *boolean* 720 borderLess: *boolean*
696 Set MWM hints to request a borderless window, i.e. if honoured by 721 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; 722 the WM, the rxvt-unicode window will not have window decorations;
698 option -bl. 723 option -bl.
699 724
725 skipBuiltinGlyphs: *boolean*
726 Compile *frills*: Disable the usage of the built-in block
727 graphics/line drawing characters and just rely on what the specified
728 fonts provide. Use this if you have a good font and want to use its
729 block graphic glyphs; option -sbg.
730
700 termName: *termname* 731 termName: *termname*
701 Specifies the terminal type name to be set in the TERM environment 732 Specifies the terminal type name to be set in the TERM environment
702 variable; option -tn. 733 variable; option -tn.
703 734
704 linespace: *number* 735 linespace: *number*
762 793
763 imLocale: *name* 794 imLocale: *name*
764 The locale to use for opening the IM. You can use an "LC_CTYPE" of 795 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 796 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 797 the input extension to be able to input japanese characters while
767 staying in another locale. option -imlocale. 798 staying in another locale; option -imlocale.
768 799
769 imFont: *fontset* 800 imFont: *fontset*
770 Specify the font-set used for XIM styles "OverTheSpot" or 801 Specify the font-set used for XIM styles "OverTheSpot" or
771 "OffTheSpot". It must be a standard X font set (XLFD patterns 802 "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 803 separated by commas), i.e. it's not in the same format as the other
775 to the base font. option -imfont. 806 to the base font. option -imfont.
776 807
777 tripleclickwords: *boolean* 808 tripleclickwords: *boolean*
778 Change the meaning of triple-click selection with the left mouse 809 Change the meaning of triple-click selection with the left mouse
779 button. Instead of selecting a full line it will extend the 810 button. Instead of selecting a full line it will extend the
780 selection to the end of the logical line only. option -tcw. 811 selection to the end of the logical line only; option -tcw.
781 812
782 insecure: *boolean* 813 insecure: *boolean*
783 Enables "insecure" mode. Rxvt-unicode offers some escape sequences 814 Enables "insecure" mode. Rxvt-unicode offers some escape sequences
784 that echo arbitrary strings like the icon name or the locale. This 815 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, 816 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 900 the following means "change the current locale to "zh_CN.GBK" when
870 Control-Meta-c is being pressed": 901 Control-Meta-c is being pressed":
871 902
872 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 903 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
873 904
905 If *string* takes the form "perl:STRING", then the specified STRING
906 is passed to the "on_keyboard_command" perl handler. See the
907 rxvtperl(3) manpage. For example, the selection extension (activated
908 via "rxvt -pe selection") listens for "selection:rot13" events:
909
910 URxvt.keysym.M-C-c: perl:selection:rot13
911
874 Due the the large number of modifier combinations, a defined key 912 Due the the large number of modifier combinations, a defined key
875 mapping will match if at *at least* the specified identifiers are 913 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 914 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 915 being defined. That means that defining a key map for "a" will
878 automatically provide definitions for "Meta-a", "Shift-a" and so on, 916 automatically provide definitions for "Meta-a", "Shift-a" and so on,
901 info): 939 info):
902 940
903 URxvt.keysym.M-C-3: command:\033[8;25;80t 941 URxvt.keysym.M-C-3: command:\033[8;25;80t
904 URxvt.keysym.M-C-4: command:\033[8;48;110t 942 URxvt.keysym.M-C-4: command:\033[8;48;110t
905 943
944 perl-ext-common: *string*
945 perl-ext: *string*
946 Comma-separated list(s) of perl extension scripts to use in this
947 terminal instance. Each extension is looked up in the library
948 directories, loaded if necessary, and bound to the current terminal
949 instance. If this resource is empty or missing, then the perl
950 interpreter will not be initialized. The idea behind two options is
951 that perl-ext-common will be used for extensions that should be
952 available to all instances, while perl-ext is used for specific
953 instances; option -pe.
954
955 perl-eval: *string*
956 Perl code to be evaluated when all extensions have been registered.
957 See the rxvtperl(3) manpage.
958
959 perl-lib: *path*
960 Colon-separated list of additional directories that hold extension
961 scripts. When looking for extensions specified by the "perl"
962 resource, rxvt will first look in these directories and then in
963 /opt/rxvt/lib/urxvt/perl/.
964
965 See the rxvtperl(3) manpage.
966
906THE SCROLLBAR 967THE SCROLLBAR
907 Lines of text that scroll off the top of the rxvt window (resource: 968 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 969 saveLines) and can be scrolled back using the scrollbar or by
909 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is 970 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is
910 fairly intuitive. The xterm-scrollbar is without arrows and its 971 fairly intuitive. The xterm-scrollbar is without arrows and its
936 entire logical line (which can span multiple screen lines), unless 997 entire logical line (which can span multiple screen lines), unless
937 modified by resource tripleclickwords. 998 modified by resource tripleclickwords.
938 999
939 Starting a selection while pressing the Meta key (or Meta+Ctrl keys) 1000 Starting a selection while pressing the Meta key (or Meta+Ctrl keys)
940 (Compile: *frills*) will create a rectangular selection instead of a 1001 (Compile: *frills*) will create a rectangular selection instead of a
941 normal one. 1002 normal one. In this mode, every selected row becomes its own line in
1003 the selection, and trailing whitespace is visually underlined and
1004 removed from the selection.
942 1005
943 Insertion: 1006 Insertion:
944 Pressing and releasing the Middle mouse button (or Shift-Insert) in 1007 Pressing and releasing the Middle mouse button (or Shift-Insert) in
945 an rxvt window causes the current text selection to be inserted as 1008 an rxvt window causes the current text selection to be inserted as
946 if it had been typed on the keyboard. 1009 if it had been typed on the keyboard.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines