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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.2 by root, Thu Aug 12 21:30:14 2004 UTC vs.
Revision 1.36 by root, Wed Dec 15 05:10:57 2004 UTC

6 6
7B<@@RXVT_NAME@@> [options] [-e command [ args ]] 7B<@@RXVT_NAME@@> [options] [-e command [ args ]]
8 8
9=head1 DESCRIPTION 9=head1 DESCRIPTION
10 10
11B<rxvt-unicode>, version B<@@RXVTVERSION@@>, is a colour vt102 terminal 11B<rxvt-unicode>, version B<@@RXVT_VERSION@@>, is a colour vt102 terminal
12emulator intended as an I<xterm>(1) replacement for users who do not 12emulator intended as an I<xterm>(1) replacement for users who do not
13require features such as Tektronix 4014 emulation and toolkit-style 13require features such as Tektronix 4014 emulation and toolkit-style
14configurability. As a result, B<rxvt-unicode> uses much less swap space -- 14configurability. As a result, B<rxvt-unicode> uses much less swap space --
15a significant advantage on a machine serving many X sessions. 15a significant advantage on a machine serving many X sessions.
16 16
17See also @@RXVT_NAME@@(7) for technical reference documentation (escape 17=head1 FREQUENTLY ASKED QUESTIONS
18sequences etc.). 18
19See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of frequently
20asked questions and answer to them and some common problems.
21
22=head1 RXVT-UNICODE VS. RXVT
23
24Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode
25internally. That means it can store and display most scripts in the
26world. Being a terminal emulator, however, some things are very difficult,
27especially cursive scripts such as arabic, vertically written scripts
28like mongolian or scripts requiring extremely complex combining rules,
29like tibetan or devenagari. Don't expect pretty output when using these
30scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
31fine, though. A somewhat difficult case are left-to-right scripts, such
32as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms
33belong into the application, not the terminal emulator (too many things --
34such as cursor-movement while editing -- break otherwise), but that might
35change.
36
37If you are looking for a terminal that supports more exotic scripts, let
38me recommend C<mlterm>, which is a very userfriendly, lean and clean
39terminal emulator. In fact, the reason rxvt-unicode was born was solely
40because the author couldn't get C<mlterm> to use one font for latin1 and
41another for japanese.
42
43Therefore another design rationale was the use of multiple fonts to
44display characters: The idea of a single unicode font which many other
45programs force onto it's users never made sense to me: You should be able
46to choose any font for any script freely.
47
48Apart from that, rxvt-unicode is also much better internationalised than
49it's predecessor, supports things such as XFT and ISO 14755 that are handy
50in i18n-environments, is faster, and has a lot less bugs than the original
51rxvt. This all in addition to dozens of other small improvements.
52
53It is still faithfully following the original rxvt idea of being lean
54and nice on resources: for example, you can still configure rxvt-unicode
55without most of it's features to get a lean binary. It also comes with
56a client/daemon pair that lets you open any number of terminal windows
57from within a single process, which makes startup time very fast and
58drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and
59@@RXVT_NAME@@c(1) (client).
60
61It also makes technical information about escape sequences (which have
62been extended) easier accessible: see @@RXVT_NAME@@(7) for technical
63reference documentation (escape sequences etc.).
19 64
20=head1 OPTIONS 65=head1 OPTIONS
21 66
22The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed 67The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed
23below. In keeping with the smaller-is-better philosophy, options may be 68below. In keeping with the smaller-is-better philosophy, options may be
24eliminated or default values chosen at compile-time, so options and 69eliminated or default values chosen at compile-time, so options and
25defaults listed may not accurately reflect the version installed on 70defaults listed may not accurately reflect the version installed on
26your system. `rxvt -h' gives a list of major compile-time options on 71your system. `@@RXVT_NAME@@ -h' gives a list of major compile-time options on
27the I<Options> line. Option descriptions may be prefixed with which 72the I<Options> line. Option descriptions may be prefixed with which
28compile option each is dependent upon. e.g. `Compile I<XIM>:' requires 73compile option each is dependent upon. e.g. `Compile I<XIM>:' requires
29I<XIM> on the I<Options> line. Note: `rxvt -help' gives a list of all 74I<XIM> on the I<Options> line. Note: `@@RXVT_NAME@@ -help' gives a list of all
30command-line options compiled into your version. 75command-line options compiled into your version.
31 76
32Note that B<@@RXVT_NAME@@> permits the resource name to be used as a 77Note that B<@@RXVT_NAME@@> permits the resource name to be used as a
33long-option (--/++ option) so the potential command-line options are 78long-option (--/++ option) so the potential command-line options are
34far greater than those listed. For example: `rxvt --loginShell --color1 79far greater than those listed. For example: `@@RXVT_NAME@@ --loginShell --color1
35Orange'. 80Orange'.
36 81
37The following options are available: 82The following options are available:
38 83
39=over 4 84=over 4
78 123
79=item B<-sh> 124=item B<-sh>
80 125
81I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent 126I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent
82background image in addition to tinting it (i.e. B<-tint> must be 127background image in addition to tinting it (i.e. B<-tint> must be
83specified, too). 128specified, too, e.g. C<-tint white>).
84 129
85=item B<-bg> I<colour> 130=item B<-bg> I<colour>
86 131
87Window background colour; resource B<background>. 132Window background colour; resource B<background>.
88 133
109 154
110The mouse pointer background colour; resource B<pointerColor2>. 155The mouse pointer background colour; resource B<pointerColor2>.
111 156
112=item B<-bd> I<colour> 157=item B<-bd> I<colour>
113 158
114The colour of the border between the xterm scrollbar and the text; 159The colour of the border around the text area and between the scrollbar and the text;
115resource B<borderColor>. 160resource B<borderColor>.
116 161
117=item B<-fn> I<fontname> 162=item B<-fn> I<fontlist>
118 163
119Select the fonts to be used. This is a comma seperated list of font 164Select the fonts to be used. This is a comma separated list of font names
120names that are used in turn when trying to display Unicode characters. 165that are used in turn when trying to display Unicode characters. The
121The first font defines the cell size for characters; other fonts might 166first font defines the cell size for characters; other fonts might be
122be smaller, but not larger. A reasonable default font list is always 167smaller, but not (in general) larger. A (hopefully) reasonable default
123appended to it. resource B<font>. 168font list is always appended to it. See resource B<font> for more details.
124 169
125=item B<-rb>|B<+rb> 170In short, to specify an X11 core font, just specify it's name or prefix it
171with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
172e.g.:
126 173
127Enable "real bold" support. When this option is on, bold text will be 174 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
128displayed using the first available bold font in the font list. Bold 175 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
129fonts should thus be specified in the font list after their 176
130corresponding regular fonts. If no bold font can be found, a regular 177See also the question "How does rxvt-unicode choose fonts?" in the FAQ
131font will be used. resource B<realBold>. 178section of @@RXVT_NAME@@(7).
179
180=item B<-fb> I<fontlist>
181
182Compile font-styles: The bold font list to use when bold characters are to
183be printed. See resource B<boldFont> for details.
184
185=item B<-fi> I<fontlist>
186
187Compile font-styles: The italic font list to use when bold characters are to
188be printed. See resource B<italicFont> for details.
189
190=item B<-fbi> I<fontlist>
191
192Compile font-styles: The bold italic font list to use when bold characters are to
193be printed. See resource B<boldItalicFont> for details.
132 194
133=item B<-name> I<name> 195=item B<-name> I<name>
134 196
135Specify the application name under which resources are to be obtained, 197Specify the application name under which resources are to be obtained,
136rather than the default executable file name. Name should not contain 198rather than the default executable file name. Name should not contain
177=item B<-st>|B<+st> 239=item B<-st>|B<+st>
178 240
179Display normal (non XTerm/NeXT) scrollbar without/with a trough; 241Display normal (non XTerm/NeXT) scrollbar without/with a trough;
180resource B<scrollBar_floating>. 242resource B<scrollBar_floating>.
181 243
244=item B<-ptab>|B<+ptab>
245
246If enabled (default), "Horizontal Tab" characters are being stored as
247actual wide characters in the screen buffer, which makes it possible to
248select and paste them. Since a horizontal tab is a cursor movement and
249not an actual glyph, this can sometimes be visually annoying as the cursor
250on a tab character is displayed as a wide cursor; resource B<pastableTabs>.
251
182=item B<-bc>|B<+bc> 252=item B<-bc>|B<+bc>
183 253
184Blink the cursor; resource B<cursorBlink>. 254Blink the cursor; resource B<cursorBlink>.
185 255
186=item B<-iconic> 256=item B<-iconic>
205B<externalBorder>. 275B<externalBorder>.
206 276
207=item B<-bl> 277=item B<-bl>
208 278
209Compile I<frills>: Set MWM hints to request a borderless window, i.e. 279Compile I<frills>: Set MWM hints to request a borderless window, i.e.
210if honoured by the WM, the rxvt window will not have window 280if honoured by the WM, the rxvt-unicode window will not have window
211decorations; resource B<borderLess>. 281decorations; resource B<borderLess>.
212 282
213=item B<-lsp> I<number> 283=item B<-lsp> I<number>
214 284
215Compile I<linespace>: Lines (pixel height) to insert between each row 285Compile I<linespace>: Lines (pixel height) to insert between each row
286Turn on/off secondary screen scroll (default enabled); resource 356Turn on/off secondary screen scroll (default enabled); resource
287B<secondaryScroll>. 357B<secondaryScroll>.
288 358
289=item B<-xrm> I<resourcestring> 359=item B<-xrm> I<resourcestring>
290 360
291No effect on rxvt. Simply passes through an argument to be made 361No effect on rxvt-unicode. Simply passes through an argument to be made
292available in the instance's argument list. Appears in I<WM_COMMAND> in 362available in the instance's argument list. Appears in I<WM_COMMAND> in
293some window managers. 363some window managers.
294 364
295=back 365=back
296 366
345high-intensity (bold = bright foreground, blink = bright background) 415high-intensity (bold = bright foreground, blink = bright background)
346colours. The canonical names are as follows: 0=black, 1=red, 2=green, 416colours. The canonical names are as follows: 0=black, 1=red, 2=green,
3473=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour 4173=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
348names used are listed in the B<COLORS AND GRAPHICS> section. 418names used are listed in the B<COLORS AND GRAPHICS> section.
349 419
420Colours higher than 15 cannot be set using resources (yet), but can be
421changed using an escape command (see @@RXVT_NAME@@(7)).
422
423Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
42488 colour support). Colours 80-87 are evenly spaces grey steps.
425
350=item B<colorBD:> I<colour> 426=item B<colorBD:> I<colour>
351 427
428=item B<colorIT:> I<colour>
429
352Use the specified colour to display bold characters when the foreground 430Use the specified colour to display bold or italic characters when the
353colour is the default. This option will be ignored if B<realBold> is 431foreground colour is the default. If font styles are not available
354enabled. 432(Compile styles) and this option is unset, reverse video is used instead.
355 433
356=item B<colorUL:> I<colour> 434=item B<colorUL:> I<colour>
357 435
358Use the specified colour to display underlined characters when the 436Use the specified colour to display underlined characters when the
359foreground colour is the default. 437foreground colour is the default.
360 438
361=item B<colorRV:> I<colour> 439=item B<colorRV:> I<colour>
362 440
363Use the specified colour as the background for reverse video 441Use the specified colour as the background for reverse video
364characters. 442characters.
443
444=item B<underlineColor:> I<colour>
445
446If set, use the specified colour as the colour for the underline
447itself. If unset, use the foreground colour.
365 448
366=item B<cursorColor:> I<colour> 449=item B<cursorColor:> I<colour>
367 450
368Use the specified colour for the cursor. The default is to use the 451Use the specified colour for the cursor. The default is to use the
369foreground colour; option B<-cr>. 452foreground colour; option B<-cr>.
403=item B<shading:> I<number> 486=item B<shading:> I<number>
404 487
405Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 488Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
406image in addition to tinting it. 489image in addition to tinting it.
407 490
408=item B<fading:> I<number>
409
410Scale the tint colour by the given percentage.
411
412=item B<scrollColor:> I<colour> 491=item B<scrollColor:> I<colour>
413 492
414Use the specified colour for the scrollbar [default #B2B2B2]. 493Use the specified colour for the scrollbar [default #B2B2B2].
415 494
416=item B<troughColor:> I<colour> 495=item B<troughColor:> I<colour>
417 496
418Use the specified colour for the scrollbar's trough area [default 497Use the specified colour for the scrollbar's trough area [default
419#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 498#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar.
499
500=item B<borderColor:> I<colour>
501
502The colour of the border around the text area and between the scrollbar
503and the text.
420 504
421=item B<backgroundPixmap:> I<file[;geom]> 505=item B<backgroundPixmap:> I<file[;geom]>
422 506
423Use the specified XPM file (note the `.xpm' extension is optional) for 507Use the specified XPM file (note the `.xpm' extension is optional) for
424the background and also optionally specify its scaling with a geometry 508the background and also optionally specify its scaling with a geometry
440 524
441Specify the colon-delimited search path for finding files (XPM and 525Specify the colon-delimited search path for finding files (XPM and
442menus), in addition to the paths specified by the B<RXVTPATH> and 526menus), in addition to the paths specified by the B<RXVTPATH> and
443B<PATH> environment variables. 527B<PATH> environment variables.
444 528
445=item B<font:> I<fontname> 529=item B<font:> I<fontlist>
446 530
447Select the fonts to be used. This is a comma seperated list of font 531Select the fonts to be used. This is a comma separated list of font
448names that are used in turn when trying to display Unicode characters. 532names that are used in turn when trying to display Unicode characters.
449The first font defines the cell size for characters; other fonts might 533The first font defines the cell size for characters; other fonts might
450be smaller, but not larger. A reasonable default font list is always 534be smaller, but not larger. A reasonable default font list is always
451appended to it. option B<-fn>. 535appended to it. option B<-fn>.
452 536
453=item B<realBold:> I<boolean> 537Each font can either be a standard X11 core font (XLFD) name, with
538optional prefix C<x:> or a Xft font (Compile xft), prefixed with C<xft:>.
454 539
455B<True>: Enable "real bold" support. When this option is on, bold text 540In addition, each font can be prefixed with additional hints and
456will be displayed using the first available bold font in the font list. 541specifications enclosed in square brackets (C<[]>). The only available
457Bold fonts should thus be specified in the font list after their 542hint currently is C<codeset=codeset-name>, and this is only used for Xft
458corresponding regular fonts. If no bold font can be found, a regular 543fonts.
459font will be used. option B<-rb>. B<False>: Display bold text in a 544
460regular font, using the color specified with B<colorBD>; option B<+rb>. 545For example, this font resource
546
547 URxvt*font: 9x15bold,\
548 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
549 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
550 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
551 xft:Code2000:antialias=false
552
553specifies five fonts to be used. The first one is C<9x15bold> (actually
554the iso8859-1 version of the second font), which is the base font (because
555it is named first) and thus defines the character cell grid to be 9 pixels
556wide and 15 pixels high.
557
558The second font is just used to add additional unicode characters not in
559the base font, likewise the third, which is unfortunately non-bold, but
560the bold version of the font does contain less characters, so this is a
561useful supplement.
562
563The third font is an Xft font with aliasing turned off, and the characters
564are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
565contains other characters, but we are not interested in them.
566
567The last font is a useful catch-all font that supplies most of the
568remaining unicode characters.
569
570=item B<boldFont:> I<fontlist>
571
572=item B<italicFont:> I<fontlist>
573
574=item B<boldItalicFont:> I<fontlist>
575
576The font list to use for displaying B<bold>, I<italic> or B<< I<bold
577italic> >> characters, respectively.
578
579If specified and non-empty, then the syntax is the same as for the
580B<font>-resource, and the given font list will be used as is, which makes
581it possible to substitute completely different font styles for bold and
582italic.
583
584If unset (the default), a suitable font list will be synthesized by
585"morphing" the normal text font list into the desired shape. If that is
586not possible, replacement fonts of the desired shape will be tried.
587
588If set, but empty, then this specific style is disabled and the normal
589text font will being used for the given style.
461 590
462=item B<selectstyle:> I<mode> 591=item B<selectstyle:> I<mode>
463 592
464Set mouse selection style to B<old> which is 2.20, B<oldword> which is 593Set mouse selection style to B<old> which is 2.20, B<oldword> which is
465xterm style with 2.20 old word selection, or anything else which gives 594xterm style with 2.20 old word selection, or anything else which gives
466xterm style selection. 595xterm style selection.
467 596
468=item B<scrollstyle:> I<mode> 597=item B<scrollstyle:> I<mode>
469 598
470Set scrollbar style to B<@@RXVT_NAME@@>, B<rxvt>, B<plain>, B<next> or 599Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
471B<xterm> 600the author's favourite..
472 601
473=item B<title:> I<string> 602=item B<title:> I<string>
474 603
475Set window title string, the default title is the command-line 604Set window title string, the default title is the command-line
476specified after the B<-e> option, if any, otherwise the application 605specified after the B<-e> option, if any, otherwise the application
530Align the B<top>, B<bottom> or B<centre> [default] of the scrollbar 659Align the B<top>, B<bottom> or B<centre> [default] of the scrollbar
531thumb with the pointer on middle button press/drag. 660thumb with the pointer on middle button press/drag.
532 661
533=item B<scrollTtyOutput:> I<boolean> 662=item B<scrollTtyOutput:> I<boolean>
534 663
535B<True>: scroll to bottom when tty receives output; option B<+si>. 664B<True>: scroll to bottom when tty receives output; option B<-si>.
536B<False>: do not scroll to bottom when tty receives output; option 665B<False>: do not scroll to bottom when tty receives output; option
537B<-si>. 666B<+si>.
538 667
539=item B<scrollWithBuffer:> I<boolean> 668=item B<scrollWithBuffer:> I<boolean>
540 669
541B<True>: scroll with scrollback buffer when tty recieves new lines (and 670B<True>: scroll with scrollback buffer when tty receives new lines (and
542B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll 671B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll
543with scrollback buffer when tty recieves new lines; option B<-sw>. 672with scrollback buffer when tty recieves new lines; option B<-sw>.
544 673
545=item B<scrollTtyKeypress:> I<boolean> 674=item B<scrollTtyKeypress:> I<boolean>
546 675
547B<True>: scroll to bottom when a non-special key is pressed. Special 676B<True>: scroll to bottom when a non-special key is pressed. Special keys
548keys are those which are intercepted by rxvt for special handling and 677are those which are intercepted by rxvt-unicode for special handling and
549are not passed onto the shell; option B<-sk>. B<False>: do not scroll 678are not passed onto the shell; option B<-sk>. B<False>: do not scroll to
550to bottom when a non-special key is pressed; option B<+sk>. 679bottom when a non-special key is pressed; option B<+sk>.
551
552=item B<smallfont_key:> I<keysym>
553
554If enabled, use B<@@HOTKEY@@->I<keysym> to toggle to a smaller font
555[default B<@@HOTKEY@@-@@SMALLFONT@@>]
556
557=item B<bigfont_key:> I<keysym>
558
559If enabled, use B<@@HOTKEY@@->I<keysym> to toggle to a bigger font
560[default B<@@HOTKEY@@-@@BIGFONT@@>]
561 680
562=item B<saveLines:> I<number> 681=item B<saveLines:> I<number>
563 682
564Save I<number> lines in the scrollback buffer [default 64]. This 683Save I<number> lines in the scrollback buffer [default 64]. This
565resource is limited on most machines to 65535; option B<-sl>. 684resource is limited on most machines to 65535; option B<-sl>.
575option B<-w>, B<-bw>, B<-borderwidth>. 694option B<-w>, B<-bw>, B<-borderwidth>.
576 695
577=item B<borderLess:> I<boolean> 696=item B<borderLess:> I<boolean>
578 697
579Set MWM hints to request a borderless window, i.e. if honoured by the 698Set MWM hints to request a borderless window, i.e. if honoured by the
580WM, the rxvt window will not have window decorations; option B<-bl>. 699WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
581 700
582=item B<termName:> I<termname> 701=item B<termName:> I<termname>
583 702
584Specifies the terminal type name to be set in the B<TERM> environment 703Specifies the terminal type name to be set in the B<TERM> environment
585variable; option B<-tn>. 704variable; option B<-tn>.
596 715
597=item B<mouseWheelScrollPage:> I<boolean> 716=item B<mouseWheelScrollPage:> I<boolean>
598 717
599B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel 718B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel
600scrolls five lines [default]. 719scrolls five lines [default].
720
721=item B<pastableTabs:> I<boolean>
722
723B<True>: store tabs as wide characters. B<False>: interpret tabs as cursor
724movement only; option C<-ptab>.
601 725
602=item B<cursorBlink:> I<boolean> 726=item B<cursorBlink:> I<boolean>
603 727
604B<True>: blink the cursor. B<False>: do not blink the cursor [default]; 728B<True>: blink the cursor. B<False>: do not blink the cursor [default];
605option B<-bc>. 729option B<-bc>.
655The locale to use for opening the IM. You can use an LC_CTYPE of e.g. 779The locale to use for opening the IM. You can use an LC_CTYPE of e.g.
656de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input 780de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input
657extension to be able to input japanese characters while staying in 781extension to be able to input japanese characters while staying in
658another locale. option B<-imlocale>. 782another locale. option B<-imlocale>.
659 783
660=item B<insecure> 784=item B<insecure:> I<boolean>
661 785
662Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 786Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
663echo arbitrary strings like the icon name or the locale. This could be 787echo arbitrary strings like the icon name or the locale. This could be
664abused if somebody gets 8-bit-clean access to your display, wether 788abused if somebody gets 8-bit-clean access to your display, whether
665throuh a mail client displaying mail bodies unfiltered or though 789throuh a mail client displaying mail bodies unfiltered or though
666write(1). Therefore, these sequences are disabled by default. (Note 790write(1). Therefore, these sequences are disabled by default. (Note
667that other terminals, including xterm, have these sequences 791that other terminals, including xterm, have these sequences
668enabled by default). You can enable them by setting this boolean 792enabled by default). You can enable them by setting this boolean
669resource or specifying B<-insecure> as an option. At the moment, this 793resource or specifying B<-insecure> as an option. At the moment, this
676B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option 800B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
677B<-mod>. 801B<-mod>.
678 802
679=item B<answerbackString:> I<string> 803=item B<answerbackString:> I<string>
680 804
681Specify the reply rxvt sends to the shell when an ENQ (control-E) 805Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
682character is passed through. It may contain escape values as described 806character is passed through. It may contain escape values as described
683in the entry on B<keysym> following. 807in the entry on B<keysym> following.
684 808
685=item B<secondaryScreen:> I<bool> 809=item B<secondaryScreen:> I<bool>
686 810
743Left click at the beginning of the region, drag to the end of the 867Left click at the beginning of the region, drag to the end of the
744region and release; Right click to extend the marked region; Left 868region and release; Right click to extend the marked region; Left
745double-click to select a word; Left triple-click to select the entire 869double-click to select a word; Left triple-click to select the entire
746line. 870line.
747 871
872Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
873(Compile: frills) will create a rectangular selection instead of a normal
874one.
875
748=item B<Insertion>: 876=item B<Insertion>:
749 877
750Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 878Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in
751an B<@@RXVT_NAME@@> window causes the current text selection to be 879an B<@@RXVT_NAME@@> window causes the current text selection to be
752inserted as if it had been typed on the keyboard. 880inserted as if it had been typed on the keyboard.
753 881
754=back 882=back
755 883
756=head1 CHANGING FONTS 884=head1 CHANGING FONTS
757 885
758You can change fonts on-the-fly, which is to say cycle through the 886Changing fonts (or font sizes, respectively) via the keypad is not yet
759default font and others of various sizes, by using B<Shift-KP_Add> and 887supported in rxvt-unicode. Bug me if you need this.
760B<Shift-KP_Subtract>. Or, alternatively (if enabled) with 888
761B<@@HOTKEY@@-@@BIGFONT@@> and B<@@HOTKEY@@-@@SMALLFONT@@>, where the 889You can, however, switch fonts at runtime using escape sequences (and
762actual key can be selected using resources 890therefore using the menubar), e.g.:
763B<smallfont_key>/B<bigfont_key>. 891
892 printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic"
893
894rxvt-unicode will automatically re-apply these fonts to the output so far.
764 895
765=head1 ISO 14755 SUPPORT 896=head1 ISO 14755 SUPPORT
766 897
767Partial ISO 14755-support is implemented. that means that pressing 898ISO 14755 is a standard for entering and viewing unicode characters
899and character codes using the keyboard. It consists of 4 parts. The
900first part is available rxvt-unicode has been compiled with
901C<--enable-frills>, the rest is available when rxvt-unicode was compiled
902with C<--enable-iso14755>.
768 903
769Section 5.1: Control and Shift together enters unicode input 904=over 4
770mode. Entering hex digits composes a Unicode character, pressing space or
771releasing the modifiers commits the keycode and every other key cancels
772the current input character.
773 905
774Section 5.2: Pressing and immediately releasing Control and Shift together 906=item 5.1: Basic method
775enters keycap entry mode for the next key: pressing a function key (tab, 907
776return etc..) will enter the unicode character corresponding to the given 908This allows you to enter unicode characters using their hexcode.
777key. 909
910Start by pressing and holding both C<Control> and C<Shift>, then enter
911hex-digits (between one and six). Releasing C<Control> and C<Shift> will
912commit the character as if it were typed directly. While holding down
913C<Control> and C<Shift> you can also enter multiple characters by pressing
914C<Space>, which will commit the current character and lets you start a new
915one.
916
917As an example of use, imagine a business card with a japanese e-mail
918address, which you cannot type. Fortunately, the card has the e-mail
919address printed as hexcodes, e.g. C<671d 65e5>. You can enter this easily
920by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>,
921followed by releasing the modifier keys.
922
923=item 5.2: Keyboard symbols entry method
924
925This mode lets you input characters representing the keycap symbols of
926your keyboard, if representable in the current locale encoding.
927
928Start by pressing C<Control> and C<Shift> together, then releasing
929them. The next special key (cursor keys, home etc.) you enter will not
930invoke it's usual function but instead will insert the corresponding
931keycap symbol. The symbol will only be entered when the key has been
932released, otherwise pressing e.g. C<Shift> would enter the symbol for
933C<ISO Level 2 Switch>, although your intention might have been to enter a
934reverse tab (Shift-Tab).
935
936=item 5.3: Screen-selection entry method
937
938While this is implemented already (it's basically the selection
939mechanism), it could be extended by displaying a unicode character map.
940
941=item 5.4: Feedback method for identifying displayed characters for later input
942
943This method lets you display the unicode character code associated with
944characters already displayed.
945
946You enter this mode by holding down C<Control> and C<Shift> together, then
947pressing and holding the left mouse button and moving around. The unicode
948hex code(s) (it might be a combining character) of the character under the
949pointer is displayed until you release C<Control> and C<Shift>.
950
951In addition to the hex codes it will display the font used to draw this
952character - due to implementation reasons, characters combined with
953combining characters, line drawing characters and unknown characters will
954always be drawn using the built-in support font.
955
956=back
957
958With respect to conformance, rxvt-unicode is supposed to be compliant to
959both scenario A and B of ISO 14755, including part 5.2.
778 960
779=head1 LOGIN STAMP 961=head1 LOGIN STAMP
780 962
781B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so 963B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so
782that it can be seen via the I<who(1)> command, and can accept messages. 964that it can be seen via the I<who(1)> command, and can accept messages.
823I<xterm>(1) where the colours are only swapped if they have not otherwise 1005I<xterm>(1) where the colours are only swapped if they have not otherwise
824been specified. For example, 1006been specified. For example,
825 1007
826=over 4 1008=over 4
827 1009
828=item B<rxvt -fg Black -bg White -rv> 1010=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>
829 1011
830would yield White on Black, while on I<xterm>(1) it would yield Black 1012would yield White on Black, while on I<xterm>(1) it would yield Black
831on White. 1013on White.
832 1014
833=back 1015=back
853 1035
854Color names. 1036Color names.
855 1037
856=back 1038=back
857 1039
858=head1 SEEALSO 1040=head1 SEE ALSO
859 1041
860I<xterm>(1), I<sh>(1), I<resize>(1), I<X>(1), I<pty>(4), I<tty>(4), I<utmp>(5) 1042@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
861
862See rxvtRef.html rxvtRef.txt for detailed information on recognized escape sequences and menuBar syntax, etc.
863 1043
864=head1 BUGS 1044=head1 BUGS
865 1045
866Check the BUGS file for an up-to-date list. 1046Check the BUGS file for an up-to-date list.
867 1047
873 1053
874=over 4 1054=over 4
875 1055
876=item Project Coordinator 1056=item Project Coordinator
877 1057
878@@RXVTMAINT@@ L<@@RXVT_MAINTEMAIL@@> 1058@@RXVT_MAINT@@ L<@@RXVT_MAINTEMAIL@@>
879 1059
880=item Web page maintainter 1060=item Web page maintainter
881 1061
882@@RXVTWEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@> 1062@@RXVT_WEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@>
883 1063
884L<@@RXVT_WEBPAGE@@> 1064L<@@RXVT_WEBPAGE@@>
885 1065
886=back 1066=back
887 1067

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines