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.26 by root, Sat Dec 17 20:55:45 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 5.9, 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.
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,
372 close $pty; 395 close $pty;
373 396
374 # now communicate with rxvt 397 # now communicate with rxvt
375 my $slave = $pty->slave; 398 my $slave = $pty->slave;
376 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.
377 404
378RESOURCES (available also as long-options) 405RESOURCES (available also as long-options)
379 Note: `rxvt --help' gives a list of all resources (long options) 406 Note: `rxvt --help' gives a list of all resources (long options)
380 compiled into your version. 407 compiled into your version.
381 408
528 font: *fontlist* 555 font: *fontlist*
529 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
530 names that are used in turn when trying to display Unicode 557 names that are used in turn when trying to display Unicode
531 characters. The first font defines the cell size for characters; 558 characters. The first font defines the cell size for characters;
532 other fonts might be smaller, but not larger. A reasonable default 559 other fonts might be smaller, but not larger. A reasonable default
533 font list is always appended to it. option -fn. 560 font list is always appended to it; option -fn.
534 561
535 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
536 optional prefix "x:" or a Xft font (Compile *xft*), prefixed with 563 optional prefix "x:" or a Xft font (Compile *xft*), prefixed with
537 "xft:". 564 "xft:".
538 565
584 tried. 611 tried.
585 612
586 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
587 normal text font will being used for the given style. 614 normal text font will being used for the given style.
588 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
589 selectstyle: *mode* 623 selectstyle: *mode*
590 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
591 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
592 gives xterm style selection. 626 gives xterm style selection.
593 627
683 borderLess: *boolean* 717 borderLess: *boolean*
684 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
685 the WM, the rxvt-unicode window will not have window decorations; 719 the WM, the rxvt-unicode window will not have window decorations;
686 option -bl. 720 option -bl.
687 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
688 termName: *termname* 728 termName: *termname*
689 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
690 variable; option -tn. 730 variable; option -tn.
691 731
692 linespace: *number* 732 linespace: *number*
750 790
751 imLocale: *name* 791 imLocale: *name*
752 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
753 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
754 the input extension to be able to input japanese characters while 794 the input extension to be able to input japanese characters while
755 staying in another locale. option -imlocale. 795 staying in another locale; option -imlocale.
756 796
757 imFont: *fontset* 797 imFont: *fontset*
758 Specify the font-set used for XIM styles "OverTheSpot" or 798 Specify the font-set used for XIM styles "OverTheSpot" or
759 "OffTheSpot". It must be a standard X font set (XLFD patterns 799 "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 800 separated by commas), i.e. it's not in the same format as the other
763 to the base font. option -imfont. 803 to the base font. option -imfont.
764 804
765 tripleclickwords: *boolean* 805 tripleclickwords: *boolean*
766 Change the meaning of triple-click selection with the left mouse 806 Change the meaning of triple-click selection with the left mouse
767 button. Instead of selecting a full line it will extend the 807 button. Instead of selecting a full line it will extend the
768 selection to the end of the logical line only. option -tcw. 808 selection to the end of the logical line only; option -tcw.
769 809
770 insecure: *boolean* 810 insecure: *boolean*
771 Enables "insecure" mode. Rxvt-unicode offers some escape sequences 811 Enables "insecure" mode. Rxvt-unicode offers some escape sequences
772 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
773 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,
798 Turn on/off secondary screen scroll (default enabled). If the this 838 Turn on/off secondary screen scroll (default enabled). If the this
799 option is enabled, scrolls on the secondary screen will change the 839 option is enabled, scrolls on the secondary screen will change the
800 scrollback buffer and switching to/from the secondary screen will 840 scrollback buffer and switching to/from the secondary screen will
801 instead scroll the screen up. 841 instead scroll the screen up.
802 842
843 hold: *bool*
844 Turn on/off hold window after exit support. If enabled, rxvt will
845 not immediately destroy its window when the program executed within
846 it exits. Instead, it will wait till it is being killed or closed by
847 the user.
848
803 keysym.*sym*: *string* 849 keysym.*sym*: *string*
804 Compile *frills*: Associate *string* with keysym *sym*. The 850 Compile *frills*: Associate *string* with keysym *sym*. The
805 intervening resource name keysym. cannot be omitted. 851 intervening resource name keysym. cannot be omitted.
806 852
807 The format of *sym* is "*(modifiers-)key*", where *modifiers* can be 853 The format of *sym* is "*(modifiers-)key*", where *modifiers* can be
851 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
852 Control-Meta-c is being pressed": 898 Control-Meta-c is being pressed":
853 899
854 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
855 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
856 Due the the large number of modifier combinations, a defined key 909 Due the the large number of modifier combinations, a defined key
857 mapping will match if at *at least* the specified identifiers are 910 mapping will match if at *at least* the specified identifiers are
858 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
859 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
860 automatically provide definitions for "Meta-a", "Shift-a" and so on, 913 automatically provide definitions for "Meta-a", "Shift-a" and so on,
883 info): 936 info):
884 937
885 URxvt.keysym.M-C-3: command:\033[8;25;80t 938 URxvt.keysym.M-C-3: command:\033[8;25;80t
886 URxvt.keysym.M-C-4: command:\033[8;48;110t 939 URxvt.keysym.M-C-4: command:\033[8;48;110t
887 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.
963
888THE SCROLLBAR 964THE SCROLLBAR
889 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:
890 saveLines) and can be scrolled back using the scrollbar or by 966 saveLines) and can be scrolled back using the scrollbar or by
891 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is 967 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is
892 fairly intuitive. The xterm-scrollbar is without arrows and its 968 fairly intuitive. The xterm-scrollbar is without arrows and its
918 entire logical line (which can span multiple screen lines), unless 994 entire logical line (which can span multiple screen lines), unless
919 modified by resource tripleclickwords. 995 modified by resource tripleclickwords.
920 996
921 Starting a selection while pressing the Meta key (or Meta+Ctrl keys) 997 Starting a selection while pressing the Meta key (or Meta+Ctrl keys)
922 (Compile: *frills*) will create a rectangular selection instead of a 998 (Compile: *frills*) will create a rectangular selection instead of a
923 normal one. 999 normal one. In this mode, every selected row becomes its own line in
1000 the selection, and trailing whitespace is visually underlined and
1001 removed from the selection.
924 1002
925 Insertion: 1003 Insertion:
926 Pressing and releasing the Middle mouse button (or Shift-Insert) in 1004 Pressing and releasing the Middle mouse button (or Shift-Insert) in
927 an rxvt window causes the current text selection to be inserted as 1005 an rxvt window causes the current text selection to be inserted as
928 if it had been typed on the keyboard. 1006 if it had been typed on the keyboard.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines