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.38 by root, Sun Jan 8 00:20:12 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.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,
… …
348 $rxvt->signal_connect_after (realize => sub { 371 $rxvt->signal_connect_after (realize => sub {
349 my $xid = $_[0]->window->get_xid; 372 my $xid = $_[0]->window->get_xid;
350 system "rxvt -embed $xid &"; 373 system "rxvt -embed $xid &";
351 }); 374 });
352 375
353 -pty-fd *fileno* 376 -pty-fd *file descriptor*
354 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
355 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
356 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
357 without having to run a program within it. 380 without having to run a program within it.
358 381
359 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
360 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
361 yourself if you want that. 384 yourself if you want that.
362 385
386 As an extremely special case, specifying -1 will completely suppress
387 pty/tty operations.
388
363 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
364 used (a longer example is in doc/pty-fd): 390 used (a longer example is in doc/pty-fd):
365 391
366 use IO::Pty; 392 use IO::Pty;
367 use Fcntl; 393 use Fcntl;
… …
372 close $pty; 398 close $pty;
373 399
374 # now communicate with rxvt 400 # now communicate with rxvt
375 my $slave = $pty->slave; 401 my $slave = $pty->slave;
376 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 (or not to
406 use) in this terminal instance. See resource perl-ext for details.
377 407
378RESOURCES (available also as long-options) 408RESOURCES (available also as long-options)
379 Note: `rxvt --help' gives a list of all resources (long options) 409 Note: `rxvt --help' gives a list of all resources (long options)
380 compiled into your version. 410 compiled into your version.
381 411
… …
528 font: *fontlist* 558 font: *fontlist*
529 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
530 names that are used in turn when trying to display Unicode 560 names that are used in turn when trying to display Unicode
531 characters. The first font defines the cell size for characters; 561 characters. The first font defines the cell size for characters;
532 other fonts might be smaller, but not larger. A reasonable default 562 other fonts might be smaller, but not larger. A reasonable default
533 font list is always appended to it. option -fn. 563 font list is always appended to it; option -fn.
534 564
535 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
536 optional prefix "x:" or a Xft font (Compile *xft*), prefixed with 566 optional prefix "x:" or a Xft font (Compile *xft*), prefixed with
537 "xft:". 567 "xft:".
538 568
… …
584 tried. 614 tried.
585 615
586 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
587 normal text font will being used for the given style. 617 normal text font will being used for the given style.
588 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
589 selectstyle: *mode* 626 selectstyle: *mode*
590 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
591 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
592 gives xterm style selection. 629 gives xterm style selection.
593 630
… …
683 borderLess: *boolean* 720 borderLess: *boolean*
684 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
685 the WM, the rxvt-unicode window will not have window decorations; 722 the WM, the rxvt-unicode window will not have window decorations;
686 option -bl. 723 option -bl.
687 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
688 termName: *termname* 731 termName: *termname*
689 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
690 variable; option -tn. 733 variable; option -tn.
691 734
692 linespace: *number* 735 linespace: *number*
… …
750 793
751 imLocale: *name* 794 imLocale: *name*
752 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
753 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
754 the input extension to be able to input japanese characters while 797 the input extension to be able to input japanese characters while
755 staying in another locale. option -imlocale. 798 staying in another locale; option -imlocale.
756 799
757 imFont: *fontset* 800 imFont: *fontset*
758 Specify the font-set used for XIM styles "OverTheSpot" or 801 Specify the font-set used for XIM styles "OverTheSpot" or
759 "OffTheSpot". It must be a standard X font set (XLFD patterns 802 "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 803 separated by commas), i.e. it's not in the same format as the other
… …
763 to the base font. option -imfont. 806 to the base font. option -imfont.
764 807
765 tripleclickwords: *boolean* 808 tripleclickwords: *boolean*
766 Change the meaning of triple-click selection with the left mouse 809 Change the meaning of triple-click selection with the left mouse
767 button. Instead of selecting a full line it will extend the 810 button. Instead of selecting a full line it will extend the
768 selection to the end of the logical line only. option -tcw. 811 selection to the end of the logical line only; option -tcw.
769 812
770 insecure: *boolean* 813 insecure: *boolean*
771 Enables "insecure" mode. Rxvt-unicode offers some escape sequences 814 Enables "insecure" mode. Rxvt-unicode offers some escape sequences
772 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
773 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,
774 whether throuh a mail client displaying mail bodies unfiltered or 817 whether through a mail client displaying mail bodies unfiltered or
775 though write(1). Therefore, these sequences are disabled by default. 818 through write(1) or any other means. Therefore, these sequences are
776 (Note that other terminals, including xterm, have these sequences 819 disabled by default. (Note that many other terminals, including
777 enabled by default). You can enable them by setting this boolean 820 xterm, have these sequences enabled by default, which doesn't make
778 resource or specifying -insecure as an option. At the moment, this 821 it safer, though).
779 enabled display-answer, locale, findfont, icon label and window 822
780 title requests as well as dynamic menubar dispatch. 823 You can enable them by setting this boolean resource or specifying
824 -insecure as an option. At the moment, this enables display-answer,
825 locale, findfont, icon label and window title requests as well as
826 dynamic menubar dispatch.
781 827
782 modifier: *modifier* 828 modifier: *modifier*
783 Set the key to be interpreted as the Meta key to: alt, meta, hyper, 829 Set the key to be interpreted as the Meta key to: alt, meta, hyper,
784 super, mod1, mod2, mod3, mod4, mod5; option -mod. 830 super, mod1, mod2, mod3, mod4, mod5; option -mod.
785 831
… …
794 secondaryScroll: *bool* 840 secondaryScroll: *bool*
795 Turn on/off secondary screen scroll (default enabled). If the this 841 Turn on/off secondary screen scroll (default enabled). If the this
796 option is enabled, scrolls on the secondary screen will change the 842 option is enabled, scrolls on the secondary screen will change the
797 scrollback buffer and switching to/from the secondary screen will 843 scrollback buffer and switching to/from the secondary screen will
798 instead scroll the screen up. 844 instead scroll the screen up.
845
846 hold: *bool*
847 Turn on/off hold window after exit support. If enabled, rxvt will
848 not immediately destroy its window when the program executed within
849 it exits. Instead, it will wait till it is being killed or closed by
850 the user.
799 851
800 keysym.*sym*: *string* 852 keysym.*sym*: *string*
801 Compile *frills*: Associate *string* with keysym *sym*. The 853 Compile *frills*: Associate *string* with keysym *sym*. The
802 intervening resource name keysym. cannot be omitted. 854 intervening resource name keysym. cannot be omitted.
803 855
… …
848 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
849 Control-Meta-c is being pressed": 901 Control-Meta-c is being pressed":
850 902
851 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
852 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
853 Due the the large number of modifier combinations, a defined key 912 Due the the large number of modifier combinations, a defined key
854 mapping will match if at *at least* the specified identifiers are 913 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 914 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 915 being defined. That means that defining a key map for "a" will
857 automatically provide definitions for "Meta-a", "Shift-a" and so on, 916 automatically provide definitions for "Meta-a", "Shift-a" and so on,
… …
880 info): 939 info):
881 940
882 URxvt.keysym.M-C-3: command:\033[8;25;80t 941 URxvt.keysym.M-C-3: command:\033[8;25;80t
883 URxvt.keysym.M-C-4: command:\033[8;48;110t 942 URxvt.keysym.M-C-4: command:\033[8;48;110t
884 943
944 perl-ext-common: *string*
945 perl-ext: *string*
946 Comma-separated list(s) of perl extension scripts (default:
947 "default") to use in this terminal instance; option -pe.
948
949 Extension names can be prefixed with a "-" sign to prohibit using
950 it. This can be useful to selectively disable some extensions loaded
951 by default, or specified via the "perl-ext-common" resource. For
952 example, "default,-selection" will use all the default extension
953 except "selection".
954
955 Each extension is looked up in the library directories, loaded if
956 necessary, and bound to the current terminal instance.
957
958 If both of these resources are the empty string, then the perl
959 interpreter will not be initialized. The idea behind two options is
960 that perl-ext-common will be used for extensions that should be
961 available to all instances, while perl-ext is used for specific
962 instances.
963
964 perl-eval: *string*
965 Perl code to be evaluated when all extensions have been registered.
966 See the rxvtperl(3) manpage.
967
968 perl-lib: *path*
969 Colon-separated list of additional directories that hold extension
970 scripts. When looking for extensions specified by the "perl"
971 resource, rxvt will first look in these directories and then in
972 /opt/rxvt/lib/urxvt/perl/.
973
974 See the rxvtperl(3) manpage.
975
885THE SCROLLBAR 976THE SCROLLBAR
886 Lines of text that scroll off the top of the rxvt window (resource: 977 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 978 saveLines) and can be scrolled back using the scrollbar or by
888 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is 979 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is
889 fairly intuitive. The xterm-scrollbar is without arrows and its 980 fairly intuitive. The xterm-scrollbar is without arrows and its
… …
915 entire logical line (which can span multiple screen lines), unless 1006 entire logical line (which can span multiple screen lines), unless
916 modified by resource tripleclickwords. 1007 modified by resource tripleclickwords.
917 1008
918 Starting a selection while pressing the Meta key (or Meta+Ctrl keys) 1009 Starting a selection while pressing the Meta key (or Meta+Ctrl keys)
919 (Compile: *frills*) will create a rectangular selection instead of a 1010 (Compile: *frills*) will create a rectangular selection instead of a
920 normal one. 1011 normal one. In this mode, every selected row becomes its own line in
1012 the selection, and trailing whitespace is visually underlined and
1013 removed from the selection.
921 1014
922 Insertion: 1015 Insertion:
923 Pressing and releasing the Middle mouse button (or Shift-Insert) in 1016 Pressing and releasing the Middle mouse button (or Shift-Insert) in
924 an rxvt window causes the current text selection to be inserted as 1017 an rxvt window causes the current text selection to be inserted as
925 if it had been typed on the keyboard. 1018 if it had been typed on the keyboard.
… …
929 supported in rxvt-unicode. Bug me if you need this. 1022 supported in rxvt-unicode. Bug me if you need this.
930 1023
931 You can, however, switch fonts at runtime using escape sequences (and 1024 You can, however, switch fonts at runtime using escape sequences (and
932 therefore using the menubar), e.g.: 1025 therefore using the menubar), e.g.:
933 1026
934 printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic" 1027 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
935 1028
936 rxvt-unicode will automatically re-apply these fonts to the output so 1029 rxvt-unicode will automatically re-apply these fonts to the output so
937 far. 1030 far.
938 1031
939ISO 14755 SUPPORT 1032ISO 14755 SUPPORT

Diff Legend

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