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.35 by root, Wed Dec 15 00:53:23 2004 UTC vs.
Revision 1.107 by root, Sun Jan 29 20:51:27 2006 UTC

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
17=head1 FREQUENTLY ASKED QUESTIONS 17=head1 FREQUENTLY ASKED QUESTIONS
18 18
19See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of frequently 19See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of
20asked questions and answer to them and some common problems. 20frequently asked questions and answer to them and some common
21problems. That document is also accessible on the World-Wide-Web at
22L<http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>.
21 23
22=head1 RXVT-UNICODE VS. RXVT 24=head1 RXVT-UNICODE VS. RXVT
23 25
24Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode 26Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode
25internally. That means it can store and display most scripts in the 27internally. That means it can store and display most scripts in the
91 93
92Attempt to open a window on the named X display (B<-d> still 94Attempt to open a window on the named X display (B<-d> still
93respected). In the absence of this option, the display specified by the 95respected). In the absence of this option, the display specified by the
94B<DISPLAY> environment variable is used. 96B<DISPLAY> environment variable is used.
95 97
98=item B<-depth> I<bitdepth>
99
100Compile I<frills>: Attempt to find a visual with the given bit depth;
101resource B<depth>.
102
96=item B<-geometry> I<geom> 103=item B<-geometry> I<geom>
97 104
98Window geometry (B<-g> still respected); resource B<geometry>. 105Window geometry (B<-g> still respected); resource B<geometry>.
99 106
100=item B<-rv>|B<+rv> 107=item B<-rv>|B<+rv>
103 110
104=item B<-j>|B<+j> 111=item B<-j>|B<+j>
105 112
106Turn on/off jump scrolling; resource B<jumpScroll>. 113Turn on/off jump scrolling; resource B<jumpScroll>.
107 114
108=item B<-ip>|B<+ip> 115=item B<-ip>|B<+ip> | B<-tr>|B<+tr>
109 116
110Turn on/off inheriting parent window's pixmap. Alternative form is 117Turn on/off inheriting parent window's pixmap. Alternative form is
111B<-tr>; resource B<inheritPixmap>. 118B<-tr>; resource B<inheritPixmap>.
112 119
113=item B<-fade> I<number> 120=item B<-fade> I<number>
114 121
115Fade the text by the given percentage when focus is lost. 122Fade the text by the given percentage when focus is lost. Small values
123fade a little only, 100 completely replaces all colours by the fade
124colour; resource B<fading>.
125
126=item B<-fadecolor> I<colour>
127
128Fade to this colour when fading is used (see B<-fade>). The default colour
129is black. resource B<fadeColor>.
116 130
117=item B<-tint> I<colour> 131=item B<-tint> I<colour>
118 132
119Tint the transparent background pixmap with the given colour when 133Tint the transparent background pixmap with the given colour when
120transparency is enabled with B<-tr> or B<-ip>. See also the B<-sh> 134transparency is enabled with B<-tr> or B<-ip>. This only works for
121option that can be used to brighten or darken the image in addition to 135non-tiled backgrounds, currently. See also the B<-sh> option that can be
122tinting it. 136used to brighten or darken the image in addition to tinting it; resource
137I<tintColor>. Example:
138
139 @@RXVT_NAME@@ -tr -tint blue -sh 40
123 140
124=item B<-sh> 141=item B<-sh>
125 142
126I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent 143I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent
127background image in addition to tinting it (i.e. B<-tint> must be 144background image in addition to tinting it (i.e. B<-tint> must be
128specified, too). 145specified, too, e.g. C<-tint white>).
129 146
130=item B<-bg> I<colour> 147=item B<-bg> I<colour>
131 148
132Window background colour; resource B<background>. 149Window background colour; resource B<background>.
133 150
136Window foreground colour; resource B<foreground>. 153Window foreground colour; resource B<foreground>.
137 154
138=item B<-pixmap> I<file[;geom]> 155=item B<-pixmap> I<file[;geom]>
139 156
140Compile I<XPM>: Specify XPM file for the background and also optionally 157Compile I<XPM>: Specify XPM file for the background and also optionally
141specify its scaling with a geometry string. Note you may need to add 158specify its scaling with a geometry string. Note you may need to
142quotes to avoid special shell interpretation of the `;' in the 159add quotes to avoid special shell interpretation of the C<;> in the
143command-line; resource B<backgroundPixmap>. 160command-line; resource B<backgroundPixmap>.
144 161
145=item B<-cr> I<colour> 162=item B<-cr> I<colour>
146 163
147The cursor colour; resource B<cursorColor>. 164The cursor colour; resource B<cursorColor>.
160resource B<borderColor>. 177resource B<borderColor>.
161 178
162=item B<-fn> I<fontlist> 179=item B<-fn> I<fontlist>
163 180
164Select the fonts to be used. This is a comma separated list of font names 181Select the fonts to be used. This is a comma separated list of font names
165that are used in turn when trying to display Unicode characters. The 182that are checked in order when trying to find glyphs for characters. The
166first font defines the cell size for characters; other fonts might be 183first font defines the cell size for characters; other fonts might be
167smaller, but not (in general) larger. A (hopefully) reasonable default 184smaller, but not (in general) larger. A (hopefully) reasonable default
168font list is always appended to it. See resource B<font> for more details. 185font list is always appended to it. See resource B<font> for more details.
169 186
170In short, to specify an X11 core font, just specify it's name or prefix it 187In short, to specify an X11 core font, just specify it's name or prefix it
177See also the question "How does rxvt-unicode choose fonts?" in the FAQ 194See also the question "How does rxvt-unicode choose fonts?" in the FAQ
178section of @@RXVT_NAME@@(7). 195section of @@RXVT_NAME@@(7).
179 196
180=item B<-fb> I<fontlist> 197=item B<-fb> I<fontlist>
181 198
182Compile font-styles: The bold font list to use when bold characters are to 199Compile I<font-styles>: The bold font list to use when B<bold> characters
183be printed. See resource B<boldFont> for details. 200are to be printed. See resource B<boldFont> for details.
184 201
185=item B<-fi> I<fontlist> 202=item B<-fi> I<fontlist>
186 203
187Compile font-styles: The italic font list to use when bold characters are to 204Compile I<font-styles>: The italic font list to use when I<italic>
188be printed. See resource B<italicFont> for details. 205characters are to be printed. See resource B<italicFont> for details.
189 206
190=item B<-fbi> I<fontlist> 207=item B<-fbi> I<fontlist>
191 208
192Compile font-styles: The bold italic font list to use when bold characters are to 209Compile I<font-styles>: The bold italic font list to use when B<< I<bold
193be printed. See resource B<boldItalicFont> for details. 210italic> >> characters are to be printed. See resource B<boldItalicFont>
211for details.
212
213=item B<-is>|B<+is>
214
215Compile I<font-styles>: Bold/Italic font styles imply high intensity
216foreground/background (default). See resource B<intensityStyles> for
217details.
194 218
195=item B<-name> I<name> 219=item B<-name> I<name>
196 220
197Specify the application name under which resources are to be obtained, 221Specify the application name under which resources are to be obtained,
198rather than the default executable file name. Name should not contain 222rather than the default executable file name. Name should not contain
236 260
237Put scrollbar on right/left; resource B<scrollBar_right>. 261Put scrollbar on right/left; resource B<scrollBar_right>.
238 262
239=item B<-st>|B<+st> 263=item B<-st>|B<+st>
240 264
241Display normal (non XTerm/NeXT) scrollbar without/with a trough; 265Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
242resource B<scrollBar_floating>. 266resource B<scrollBar_floating>.
243 267
244=item B<-ptab>|B<+ptab> 268=item B<-ptab>|B<+ptab>
245 269
246If enabled (default), "Horizontal Tab" characters are being stored as 270If enabled (default), "Horizontal Tab" characters are being stored as
278 302
279Compile I<frills>: Set MWM hints to request a borderless window, i.e. 303Compile I<frills>: Set MWM hints to request a borderless window, i.e.
280if honoured by the WM, the rxvt-unicode window will not have window 304if honoured by the WM, the rxvt-unicode window will not have window
281decorations; resource B<borderLess>. 305decorations; resource B<borderLess>.
282 306
307=item B<-override-redirect>
308
309Compile I<frills>: Sets override-redirect on the window; resource
310B<override-redirect>.
311
312=item B<-sbg>
313
314Compile I<frills>: Disable the usage of the built-in block graphics/line
315drawing characters and just rely on what the specified fonts provide. Use
316this if you have a good font and want to use its block graphic glyphs;
317resource B<skipBuiltinGlyphs>.
318
283=item B<-lsp> I<number> 319=item B<-lsp> I<number>
284 320
285Compile I<linespace>: Lines (pixel height) to insert between each row 321Compile I<frills>: Lines (pixel height) to insert between each row of
286of the display; resource B<linespace>. 322the display. Useful to work around font rendering problems; resource
323B<linespace>.
287 324
288=item B<-tn> I<termname> 325=item B<-tn> I<termname>
289 326
290This option specifies the name of the terminal type to be set in the 327This option specifies the name of the terminal type to be set in the
291B<TERM> environment variable. This terminal type must exist in the 328B<TERM> environment variable. This terminal type must exist in the
300given on the command line. If this option is used, it must be the last 337given on the command line. If this option is used, it must be the last
301on the command-line. If there is no B<-e> option then the default is to 338on the command-line. If there is no B<-e> option then the default is to
302run the program specified by the B<SHELL> environment variable or, 339run the program specified by the B<SHELL> environment variable or,
303failing that, I<sh(1)>. 340failing that, I<sh(1)>.
304 341
342Please note that you must specify a program with arguments. If you want to
343run shell commands, you have to specify the shell, like this:
344
345 @@RXVT_NAME@@ -e sh -c "shell commands"
346
305=item B<-title> I<text> 347=item B<-title> I<text>
306 348
307Window title (B<-T> still respected); the default title is the basename 349Window title (B<-T> still respected); the default title is the basename
308of the program specified after the B<-e> option, if any, otherwise the 350of the program specified after the B<-e> option, if any, otherwise the
309application name; resource B<title>. 351application name; resource B<title>.
327 369
328Compile I<XIM>: input method name. resource B<inputMethod>. 370Compile I<XIM>: input method name. resource B<inputMethod>.
329 371
330=item B<-imlocale> I<string> 372=item B<-imlocale> I<string>
331 373
332The locale to use for opening the IM. You can use an LC_CTYPE of e.g. 374The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
333de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input 375C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
334extension to be able to input japanese characters while staying in 376input extension to be able to input japanese characters while staying in
335another locale. 377another locale. resource B<imLocale>.
378
379=item B<-imfont> I<fontset>
380
381Set the font set to use for the X Input Method, see resource B<imFont>
382for more info.
383
384=item B<-tcw>
385
386Change the meaning of triple-click selection with the left mouse
387button. Instead of selecting a full line it will extend the selection the
388end of the logical line only. resource B<tripleclickwords>.
336 389
337=item B<-insecure> 390=item B<-insecure>
338 391
339Enable "insecure" mode, which currently enables most of the escape 392Enable "insecure" mode, which currently enables most of the escape
340sequences that echo strings. See the resource B<insecure> for more 393sequences that echo strings. See the resource B<insecure> for more
354=item B<-ssr>|B<+ssr> 407=item B<-ssr>|B<+ssr>
355 408
356Turn on/off secondary screen scroll (default enabled); resource 409Turn on/off secondary screen scroll (default enabled); resource
357B<secondaryScroll>. 410B<secondaryScroll>.
358 411
412=item B<-hold>|B<+hold>
413
414Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
415will not immediately destroy its window when the program executed within
416it exits. Instead, it will wait till it is being killed or closed by the
417user; resource B<hold>.
418
419=item B<-keysym.>I<sym> I<string>
420
421Remap a key symbol. See resource B<keysym>.
422
423=item B<-embed> I<windowid>
424
425Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window,
426which enables applications to easily embed a terminal.
427
428Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
429shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
430quite a bit, so don't expect it to keep some specific state. It's best to
431create an extra subwindow for @@RXVT_NAME@@ and leave it alone.
432
433The window will not be destroyed when @@RXVT_NAME@@ exits.
434
435It might be useful to know that @@RXVT_NAME@@ will not close file
436descriptors passed to it (except for stdin/out/err, of course), so you
437can use file descriptors to communicate with the programs within the
438terminal. This works regardless of wether the C<-embed> option was used or
439not.
440
441Here is a short Gtk2-perl snippet that illustrates how this option can be
442used (a longer example is in F<doc/embed>):
443
444 my $rxvt = new Gtk2::Socket;
445 $rxvt->signal_connect_after (realize => sub {
446 my $xid = $_[0]->window->get_xid;
447 system "@@RXVT_NAME@@ -embed $xid &";
448 });
449
450=item B<-pty-fd> I<file descriptor>
451
452Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
453pair but instead use the given filehandle as the tty master. This is
454useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
455without having to run a program within it.
456
457If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
458entries and will not tinker with pty/tty permissions - you have to do that
459yourself if you want that.
460
461As an extremely special case, specifying C<-1> will completely suppress
462pty/tty operations.
463
464Here is a example in perl that illustrates how this option can be used (a
465longer example is in F<doc/pty-fd>):
466
467 use IO::Pty;
468 use Fcntl;
469
470 my $pty = new IO::Pty;
471 fcntl $pty, F_SETFD, 0; # clear close-on-exec
472 system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";
473 close $pty;
474
475 # now communicate with rxvt
476 my $slave = $pty->slave;
477 while (<$slave>) { print $slave "got <$_>\n" }
478
359=item B<-xrm> I<resourcestring> 479=item B<-pe> I<string>
360 480
361No effect on rxvt-unicode. Simply passes through an argument to be made 481Comma-separated list of perl extension scripts to use (or not to use) in
362available in the instance's argument list. Appears in I<WM_COMMAND> in 482this terminal instance. See resource B<perl-ext> for details.
363some window managers.
364 483
365=back 484=back
366 485
367=head1 RESOURCES (available also as long-options) 486=head1 RESOURCES (available also as long-options)
368 487
369Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long 488Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
370options) compiled into your version. 489options) compiled into your version.
371 490
372There are two different methods that @@RXVT_NAME@@ can use to get the 491You can set and change the resources using X11 tools like B<xrdb>. Many
373Xresource data: using the X libraries (Xrm*-functions) or internal 492distribution do also load settings from the B<~/.Xresources> file when X
374Xresources reader (B<~/.Xdefaults>). For the first method (ie. 493starts. @@RXVT_NAME@@ will consult the following files/resources in order,
375B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the 494with later settings overwriting earlier ones:
376resources using X11 tools like B<xset>. Many distribution do also load
377settings from the B<~/.Xresources> file when X starts.
378 495
379If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h> 496 1. system-wide app-defaults file, either locale-dependent OR global
380lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults 497 2. app-defaults file in $XAPPLRESDIR
381set in XAPPLOADDIR/URxvt (compile-time defined: usually 498 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
382B</usr/lib/X11/app-defaults/URxvt>) and resources set in 499 4. SCREEN_RESOURCES for the current screen
383B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist. 500 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
501
384Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two 502Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
385class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows 503names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
386resources common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be 504common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
387easily configured, while the class name B<URxvt> allows resources 505configured, while the class name B<URxvt> allows resources unique to
388unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be 506B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
389shared between different B<@@RXVT_NAME@@> configurations. If no 507configurations. If no resources are specified, suitable defaults will
390resources are specified, suitable defaults will be used. Command-line 508be used. Command-line arguments can be used to override resource
391arguments can be used to override resource settings. The following 509settings. The following resources are supported (you might want to
392resources are allowed: 510check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
511extensions not documented here):
393 512
394=over 4 513=over 4
514
515=item B<depth:> I<bitdepth>
516
517Compile I<frills>: Attempt to find a visual with the given bit depth;
518option B<-depth>.
395 519
396=item B<geometry:> I<geom> 520=item B<geometry:> I<geom>
397 521
398Create the window with the specified X window geometry [default 80x24]; 522Create the window with the specified X window geometry [default 80x24];
399option B<-geometry>. 523option B<-geometry>.
427 551
428=item B<colorIT:> I<colour> 552=item B<colorIT:> I<colour>
429 553
430Use the specified colour to display bold or italic characters when the 554Use the specified colour to display bold or italic characters when the
431foreground colour is the default. If font styles are not available 555foreground colour is the default. If font styles are not available
432(Compile styles) and this option is unset, reverse video is used instead. 556(Compile I<styles>) and this option is unset, reverse video is used instead.
433 557
434=item B<colorUL:> I<colour> 558=item B<colorUL:> I<colour>
435 559
436Use the specified colour to display underlined characters when the 560Use the specified colour to display underlined characters when the
437foreground colour is the default. 561foreground colour is the default.
475artificial transparency. B<False>: do not inherit the parent windows' 599artificial transparency. B<False>: do not inherit the parent windows'
476pixmap. 600pixmap.
477 601
478=item B<fading:> I<number> 602=item B<fading:> I<number>
479 603
480Fade the text by the given percentage when focus is lost. 604Fade the text by the given percentage when focus is lost; option B<-fade>.
605
606=item B<fadeColor:> I<colour>
607
608Fade to this colour, when fading is used (see B<fading:>). The default
609colour is black; option B<-fadecolor>.
481 610
482=item B<tintColor:> I<colour> 611=item B<tintColor:> I<colour>
483 612
484Tint the transparent background pixmap with the given colour. 613Tint the transparent background pixmap with the given colour; option
614B<-tint>.
485 615
486=item B<shading:> I<number> 616=item B<shading:> I<number>
487 617
488Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 618Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
489image in addition to tinting it. 619image in addition to tinting it.
493Use the specified colour for the scrollbar [default #B2B2B2]. 623Use the specified colour for the scrollbar [default #B2B2B2].
494 624
495=item B<troughColor:> I<colour> 625=item B<troughColor:> I<colour>
496 626
497Use the specified colour for the scrollbar's trough area [default 627Use the specified colour for the scrollbar's trough area [default
498#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 628#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
499 629
500=item B<borderColor:> I<colour> 630=item B<borderColor:> I<colour>
501 631
502The colour of the border around the text area and between the scrollbar 632The colour of the border around the text area and between the scrollbar
503and the text. 633and the text.
512of 1 displays the image without any scaling. A scale of 2 to 9 642of 1 displays the image without any scaling. A scale of 2 to 9
513specifies an integer number of images in that direction. No image will 643specifies an integer number of images in that direction. No image will
514be magnified beyond 10 times its original size. The maximum permitted 644be magnified beyond 10 times its original size. The maximum permitted
515scale is 1000. [default 0x0+50+50] 645scale is 1000. [default 0x0+50+50]
516 646
517=item B<menu:> I<file[;tag]>
518
519Read in the specified menu file (note the `.menu' extension is
520optional) and also optionally specify a starting tag to find. See the
521reference documentation for details on the syntax for the menuBar.
522
523=item B<path:> I<path> 647=item B<path:> I<path>
524 648
525Specify the colon-delimited search path for finding files (XPM and 649Specify the colon-delimited search path for finding XPM files.
526menus), in addition to the paths specified by the B<RXVTPATH> and
527B<PATH> environment variables.
528 650
529=item B<font:> I<fontlist> 651=item B<font:> I<fontlist>
530 652
531Select the fonts to be used. This is a comma separated list of font 653Select the fonts to be used. This is a comma separated list of font names
532names that are used in turn when trying to display Unicode characters. 654that are checked in order when trying to find glyphs for characters. The
533The first font defines the cell size for characters; other fonts might 655first font defines the cell size for characters; other fonts might be
534be smaller, but not larger. A reasonable default font list is always 656smaller, but not (in general) larger. A (hopefully) reasonable default
535appended to it. option B<-fn>. 657font list is always appended to it; option B<-fn>.
536 658
537Each font can either be a standard X11 core font (XLFD) name, with 659Each 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:>. 660optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
539 661
540In addition, each font can be prefixed with additional hints and 662In addition, each font can be prefixed with additional hints and
541specifications enclosed in square brackets (C<[]>). The only available 663specifications enclosed in square brackets (C<[]>). The only available
542hint currently is C<codeset=codeset-name>, and this is only used for Xft 664hint currently is C<codeset=codeset-name>, and this is only used for Xft
543fonts. 665fonts.
544 666
545For example, this font resource 667For example, this font resource
546 668
547 URxvt*font: 9x15bold,\ 669 URxvt.font: 9x15bold,\
548 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\ 670 -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, \ 671 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
550 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ 672 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
551 xft:Code2000:antialias=false 673 xft:Code2000:antialias=false
552 674
586not possible, replacement fonts of the desired shape will be tried. 708not possible, replacement fonts of the desired shape will be tried.
587 709
588If set, but empty, then this specific style is disabled and the normal 710If set, but empty, then this specific style is disabled and the normal
589text font will being used for the given style. 711text font will being used for the given style.
590 712
713=item B<intensityStyles:> I<boolean>
714
715When font styles are not enabled, or this option is enabled (B<True>,
716option B<-is>, the default), bold and italic font styles imply high
717intensity foreground/backround colours. Disabling this option (B<False>,
718option B<+is>) disables this behaviour, the high intensity colours are not
719reachable.
720
591=item B<selectstyle:> I<mode> 721=item B<selectstyle:> I<mode>
592 722
593Set mouse selection style to B<old> which is 2.20, B<oldword> which is 723Set mouse selection style to B<old> which is 2.20, B<oldword> which is
594xterm style with 2.20 old word selection, or anything else which gives 724xterm style with 2.20 old word selection, or anything else which gives
595xterm style selection. 725xterm style selection.
596 726
597=item B<scrollstyle:> I<mode> 727=item B<scrollstyle:> I<mode>
598 728
599Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is 729Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
600the author's favourite.. 730the author's favourite.
601 731
602=item B<title:> I<string> 732=item B<title:> I<string>
603 733
604Set window title string, the default title is the command-line 734Set window title string, the default title is the command-line
605specified after the B<-e> option, if any, otherwise the application 735specified after the B<-e> option, if any, otherwise the application
637 767
638Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use 768Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use
639B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or 769B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or
640B<Shift-Print> to include the scrollback as well. 770B<Shift-Print> to include the scrollback as well.
641 771
772The string will be interpreted as if typed into the shell as-is.
773
774Example:
775
776 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
777
778This creates a new file in your home directory with the screen contents
779everytime you hit C<Print>.
780
642=item B<scrollBar:> I<boolean> 781=item B<scrollBar:> I<boolean>
643 782
644B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 783B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
645disable the scrollbar; option B<+sb>. 784disable the scrollbar; option B<+sb>.
646 785
666B<+si>. 805B<+si>.
667 806
668=item B<scrollWithBuffer:> I<boolean> 807=item B<scrollWithBuffer:> I<boolean>
669 808
670B<True>: scroll with scrollback buffer when tty receives new lines (and 809B<True>: scroll with scrollback buffer when tty receives new lines (and
671B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll 810B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
672with scrollback buffer when tty recieves new lines; option B<-sw>. 811with scrollback buffer when tty recieves new lines; option B<+sw>.
673 812
674=item B<scrollTtyKeypress:> I<boolean> 813=item B<scrollTtyKeypress:> I<boolean>
675 814
676B<True>: scroll to bottom when a non-special key is pressed. Special keys 815B<True>: scroll to bottom when a non-special key is pressed. Special keys
677are those which are intercepted by rxvt-unicode for special handling and 816are those which are intercepted by rxvt-unicode for special handling and
696=item B<borderLess:> I<boolean> 835=item B<borderLess:> I<boolean>
697 836
698Set MWM hints to request a borderless window, i.e. if honoured by the 837Set MWM hints to request a borderless window, i.e. if honoured by the
699WM, the rxvt-unicode window will not have window decorations; option B<-bl>. 838WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
700 839
840=item B<skipBuiltinGlyphs:> I<boolean>
841
842Compile I<frills>: Disable the usage of the built-in block graphics/line
843drawing characters and just rely on what the specified fonts provide. Use
844this if you have a good font and want to use its block graphic glyphs;
845option B<-sbg>.
846
701=item B<termName:> I<termname> 847=item B<termName:> I<termname>
702 848
703Specifies the terminal type name to be set in the B<TERM> environment 849Specifies the terminal type name to be set in the B<TERM> environment
704variable; option B<-tn>. 850variable; option B<-tn>.
705 851
742 888
743Mouse pointer background colour. 889Mouse pointer background colour.
744 890
745=item B<pointerBlankDelay:> I<number> 891=item B<pointerBlankDelay:> I<number>
746 892
747Specifies number of seconds before blanking the pointer [default 2]. 893Specifies number of seconds before blanking the pointer [default 2]. Use a
894large number (e.g. C<987654321>) to effectively disable the timeout.
748 895
749=item B<backspacekey:> I<string> 896=item B<backspacekey:> I<string>
750 897
751The string to send when the backspace key is pressed. If set to B<DEC> 898The string to send when the backspace key is pressed. If set to B<DEC>
752or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace> 899or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>
759pressed. If unset it will send the sequence traditionally associated 906pressed. If unset it will send the sequence traditionally associated
760with the B<Execute> key. 907with the B<Execute> key.
761 908
762=item B<cutchars:> I<string> 909=item B<cutchars:> I<string>
763 910
764The characters used as delimiters for double-click word selection. The 911The characters used as delimiters for double-click word selection
765built-in default: 912(whitespace delimiting is added automatically if resource is given).
913
914When the selection extension is in use (the default if compiled in, see
915the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these characters
916will be created (if the resource exists, otherwise, no regex will be
917created). In this mode, characters outside ISO-8859-1 can be used.
918
919When the selection extension is not used, only ISO-8859-1 characters can
920be used. If not specified, the built-in default is used:
766 921
767B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 922B<< BACKSLASH `"'&()*,;<=>?@[]{|} >>
768 923
769=item B<preeditType:> I<style> 924=item B<preeditType:> I<style>
770 925
774 929
775I<name> of inputMethod to use; option B<-im>. 930I<name> of inputMethod to use; option B<-im>.
776 931
777=item B<imLocale:> I<name> 932=item B<imLocale:> I<name>
778 933
779The locale to use for opening the IM. You can use an LC_CTYPE of e.g. 934The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
780de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input 935C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
781extension to be able to input japanese characters while staying in 936input extension to be able to input japanese characters while staying in
782another locale. option B<-imlocale>. 937another locale; option B<-imlocale>.
938
939=item B<imFont:> I<fontset>
940
941Specify the font-set used for XIM styles C<OverTheSpot> or
942C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
943by commas), i.e. it's not in the same format as the other font lists used
944in @@RXVT_NAME@@. The default will be set-up to chose *any* suitable found
945found, preferably one or two pixels differing in size to the base font.
946option B<-imfont>.
947
948=item B<tripleclickwords:> I<boolean>
949
950Change the meaning of triple-click selection with the left mouse
951button. Instead of selecting a full line it will extend the selection to
952the end of the logical line only; option B<-tcw>.
783 953
784=item B<insecure:> I<boolean> 954=item B<insecure:> I<boolean>
785 955
786Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 956Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
787echo arbitrary strings like the icon name or the locale. This could be 957echo arbitrary strings like the icon name or the locale. This could be
788abused if somebody gets 8-bit-clean access to your display, whether 958abused if somebody gets 8-bit-clean access to your display, whether
789throuh a mail client displaying mail bodies unfiltered or though 959through a mail client displaying mail bodies unfiltered or through
790write(1). Therefore, these sequences are disabled by default. (Note 960write(1) or any other means. Therefore, these sequences are disabled by
791that other terminals, including xterm, have these sequences 961default. (Note that many other terminals, including xterm, have these
792enabled by default). You can enable them by setting this boolean 962sequences enabled by default, which doesn't make it safer, though).
793resource or specifying B<-insecure> as an option. At the moment, this 963
794enabled display-answer, locale, findfont, icon label and window title 964You can enable them by setting this boolean resource or specifying
795requests as well as dynamic menubar dispatch. 965B<-insecure> as an option. At the moment, this enables display-answer,
966locale, findfont, icon label and window title requests.
796 967
797=item B<modifier:> I<modifier> 968=item B<modifier:> I<modifier>
798 969
799Set the key to be interpreted as the Meta key to: B<alt>, B<meta>, 970Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
800B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option 971B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
804 975
805Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E) 976Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
806character is passed through. It may contain escape values as described 977character is passed through. It may contain escape values as described
807in the entry on B<keysym> following. 978in the entry on B<keysym> following.
808 979
809=item B<secondaryScreen:> I<bool> 980=item B<secondaryScreen:> I<boolean>
810 981
811Turn on/off secondary screen (default enabled). 982Turn on/off secondary screen (default enabled).
812 983
813=item B<secondaryScroll:> I<bool> 984=item B<secondaryScroll:> I<boolean>
814 985
815Turn on/off secondary screen scroll (default enabled). If the this 986Turn on/off secondary screen scroll (default enabled). If the this
816option is enabled, scrolls on the secondary screen will change the 987option is enabled, scrolls on the secondary screen will change the
817scrollback buffer and switching to/from the secondary screen will 988scrollback buffer and switching to/from the secondary screen will
818instead scroll the screen up. 989instead scroll the screen up.
819 990
991=item B<hold>: I<boolean>
992
993Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
994will not immediately destroy its window when the program executed within
995it exits. Instead, it will wait till it is being killed or closed by the
996user.
997
820=item B<keysym.>I<sym>: I<string> 998=item B<keysym.>I<sym>: I<string>
821 999
822Associate I<string> with keysym I<sym> (B<0xFF00 - 0xFFFF>). It may 1000Compile I<frills>: Associate I<string> with keysym I<sym>. The
823contain escape values (\a: bell, \b: backspace, \e, \E: escape, \n: 1001intervening resource name B<keysym.> cannot be omitted.
824newline, \r: return, \t: 1002
1003The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be
1004any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>,
1005B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>,
1006and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>,
1007B<2>, B<3>, B<4>, B<5>.
1008
1009The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
1010whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
1011keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
1012current application keymap mode state.
1013
1014The spellings of I<key> can be obtained by using B<xev>(1) command or
1015searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
1016omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1017keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1018performed in an exact manner; however, the closest match is assured.
1019
1020I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,
1021C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,
825tab, \000: octal number) or control characters (^?: delete, ^@: null, 1022C<\000>: octal number) or verbatim control characters (C<^?>: delete,
826^A ...) and may enclosed with double quotes so that it can start or end 1023C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
827with whitespace. The intervening resource name B<keysym.> cannot be 1024can start or end with whitespace.
828omitted. This resource is only available when compiled with 1025
829KEYSYM_RESOURCE. 1026Please note that you need to double the C<\> in resource files, as
1027Xlib itself does it's own de-escaping (you can use C<\033> instead of
1028C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1029processing).
1030
1031You can define a range of keysyms in one shot by providing a I<string>
1032with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'
1033should be a character not used by the strings.
1034
1035Its usage can be demonstrated by an example:
1036
1037 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
1038
1039The above line is equivalent to the following three lines:
1040
1041 URxvt.keysym.Meta-Control-0x61: \033<M-C-a>
1042 URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
1043 URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
1044
1045If I<string> takes the form of C<command:STRING>, the specified B<STRING>
1046is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1047example the following means "change the current locale to C<zh_CN.GBK>
1048when Control-Meta-c is being pressed":
1049
1050 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1051
1052If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1053is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)
1054manpage. For example, the F<selection> extension (activated via
1055C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1056
1057 URxvt.keysym.M-C-c: perl:selection:rot13
1058
1059Due the the large number of modifier combinations, a defined key mapping
1060will match if at I<at least> the specified identifiers are being set, and
1061no other key mappings with those and more bits are being defined. That
1062means that defining a key map for C<a> will automatically provide
1063definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1064mappings themselves.
1065
1066Unfortunately, this will override built-in key mappings. For example
1067if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s
1068C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the
1069user-defined keymap using the C<builtin:> replacement:
1070
1071 URxvt.keysym.Insert: <my insert key sequence>
1072 URxvt.keysym.S-Insert: builtin:
1073
1074The first line defines a mapping for C<Insert> and I<any> combination
1075of modifiers. The second line re-establishes the default mapping for
1076C<Shift-Insert>.
1077
1078The following example will map Control-Meta-1 and Control-Meta-2 to
1079the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1080font-switching at runtime:
1081
1082 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
1083 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1084
1085Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1086info):
1087
1088 URxvt.keysym.M-C-3: command:\033[8;25;80t
1089 URxvt.keysym.M-C-4: command:\033[8;48;110t
1090
1091=item B<perl-ext-common>: I<string>
1092
1093=item B<perl-ext>: I<string>
1094
1095Comma-separated list(s) of perl extension scripts (default: C<default>) to
1096use in this terminal instance; option B<-pe>.
1097
1098Extension names can be prefixed with a C<-> sign to prohibit using
1099them. This can be useful to selectively disable some extensions loaded
1100by default, or specified via the C<perl-ext-common> resource. For
1101example, C<default,-selection> will use all the default extension except
1102C<selection>.
1103
1104Extension names can also be followed by an argument in angle brackets
1105(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
1106searchable scorllback to Alt/Meta-s). Mentioning the same extension
1107multiple times with different arguments will pass multiple arguments to
1108the extension.
1109
1110Each extension is looked up in the library directories, loaded if
1111necessary, and bound to the current terminal instance.
1112
1113If both of these resources are the empty string, then the perl
1114interpreter will not be initialized. The idea behind two options is that
1115B<perl-ext-common> will be used for extensions that should be available to
1116all instances, while B<perl-ext> is used for specific instances.
1117
1118=item B<perl-eval>: I<string>
1119
1120Perl code to be evaluated when all extensions have been registered. See
1121the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource
1122will be ignored when running setuid/setgid.
1123
1124=item B<perl-lib>: I<path>
1125
1126Colon-separated list of additional directories that hold extension
1127scripts. When looking for extensions specified by the C<perl> resource,
1128@@RXVT_NAME@@ will first look in these directories and then in
1129F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
1130will be ignored when running setuid/setgid.
1131
1132See the @@RXVT_NAME@@perl(3) manpage.
1133
1134=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1135
1136Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
1137details.
1138
1139=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1140
1141Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1142for details.
1143
1144=item B<searchable-scrollback:> I<keysym>
1145
1146Sets the hotkey that starts the incremental scrollback buffer search
1147(default: C<M-s>).
1148
1149=item B<urlLauncher>: I<string>
1150
1151Specifies the program to be started with a URL argument. Used by the
1152C<selection-popup> and C<mark-urls> perl extensions.
1153
1154=item B<transient-for>: I<windowid>
1155
1156Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1157
1158=item B<override-redirect>: I<boolean>
1159
1160Compile I<frills>: Sets override-redirect for the terminal window, making
1161it almost invisible to window managers; option B<-override-redirect>.
830 1162
831=back 1163=back
832 1164
833=head1 THE SCROLLBAR 1165=head1 THE SCROLLBAR
834 1166
848the normal text selection/insertion, hold either the Shift or the Meta 1180the normal text selection/insertion, hold either the Shift or the Meta
849(Alt) key while performing the desired mouse action. 1181(Alt) key while performing the desired mouse action.
850 1182
851If mouse reporting mode is active, the normal scrollbar actions are 1183If mouse reporting mode is active, the normal scrollbar actions are
852disabled -- on the assumption that we are using a fullscreen 1184disabled -- on the assumption that we are using a fullscreen
853application. Instead, pressing Button1 and Button3 sends B<ESC[6~> 1185application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
854(Next) and B<ESC[5~> (Prior), respectively. Similarly, clicking on the 1186(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
855up and down arrows sends B<ESC[A> (Up) and B<ESC[B> (Down), 1187up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
856respectively. 1188respectively.
857 1189
858=head1 TEXT SELECTION AND INSERTION 1190=head1 TEXT SELECTION AND INSERTION
859 1191
860The behaviour of text selection and insertion mechanism is similar to 1192The behaviour of text selection and insertion mechanism is similar to
862 1194
863=over 4 1195=over 4
864 1196
865=item B<Selection>: 1197=item B<Selection>:
866 1198
867Left click at the beginning of the region, drag to the end of the 1199Left click at the beginning of the region, drag to the end of the region
868region and release; Right click to extend the marked region; Left 1200and release; Right click to extend the marked region; Left double-click
869double-click to select a word; Left triple-click to select the entire 1201to select a word; Left triple-click to select the entire logical line
870line. 1202(which can span multiple screen lines), unless modified by resource
1203B<tripleclickwords>.
871 1204
872Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys) 1205Starting 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 1206(Compile: I<frills>) will create a rectangular selection instead of a
874one. 1207normal one. In this mode, every selected row becomes its own line in the
1208selection, and trailing whitespace is visually underlined and removed from
1209the selection.
875 1210
876=item B<Insertion>: 1211=item B<Insertion>:
877 1212
878Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1213Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
879an B<@@RXVT_NAME@@> window causes the current text selection to be 1214window causes the value of the PRIMARY selection (or CLIPBOARD with the
880inserted as if it had been typed on the keyboard. 1215Meta modifier) to be inserted as if it had been typed on the keyboard.
1216
1217Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1218inserted too.
881 1219
882=back 1220=back
883 1221
884=head1 CHANGING FONTS 1222=head1 CHANGING FONTS
885 1223
886Changing fonts (or font sizes, respectively) via the keypad is not yet 1224Changing fonts (or font sizes, respectively) via the keypad is not yet
887supported in rxvt-unicode. Bug me if you need this. 1225supported in rxvt-unicode. Bug me if you need this.
888 1226
889You can, however, switch fonts at runtime using escape sequences (and 1227You can, however, switch fonts at runtime using escape sequences, e.g.:
890therefore using the menubar), e.g.:
891 1228
892 printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic" 1229 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1230
1231You can use keyboard shortcuts, too:
1232
1233 URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
1234 URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
893 1235
894rxvt-unicode will automatically re-apply these fonts to the output so far. 1236rxvt-unicode will automatically re-apply these fonts to the output so far.
895 1237
896=head1 ISO 14755 SUPPORT 1238=head1 ISO 14755 SUPPORT
897 1239
901C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1243C<--enable-frills>, the rest is available when rxvt-unicode was compiled
902with C<--enable-iso14755>. 1244with C<--enable-iso14755>.
903 1245
904=over 4 1246=over 4
905 1247
906=item 5.1: Basic method 1248=item * 5.1: Basic method
907 1249
908This allows you to enter unicode characters using their hexcode. 1250This allows you to enter unicode characters using their hexcode.
909 1251
910Start by pressing and holding both C<Control> and C<Shift>, then enter 1252Start 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 1253hex-digits (between one and six). Releasing C<Control> and C<Shift> will
918address, which you cannot type. Fortunately, the card has the e-mail 1260address, 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 1261address 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>, 1262by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>,
921followed by releasing the modifier keys. 1263followed by releasing the modifier keys.
922 1264
923=item 5.2: Keyboard symbols entry method 1265=item * 5.2: Keyboard symbols entry method
924 1266
925This mode lets you input characters representing the keycap symbols of 1267This mode lets you input characters representing the keycap symbols of
926your keyboard, if representable in the current locale encoding. 1268your keyboard, if representable in the current locale encoding.
927 1269
928Start by pressing C<Control> and C<Shift> together, then releasing 1270Start by pressing C<Control> and C<Shift> together, then releasing
931keycap symbol. The symbol will only be entered when the key has been 1273keycap symbol. The symbol will only be entered when the key has been
932released, otherwise pressing e.g. C<Shift> would enter the symbol for 1274released, 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 1275C<ISO Level 2 Switch>, although your intention might have been to enter a
934reverse tab (Shift-Tab). 1276reverse tab (Shift-Tab).
935 1277
936=item 5.3: Screen-selection entry method 1278=item * 5.3: Screen-selection entry method
937 1279
938While this is implemented already (it's basically the selection 1280While this is implemented already (it's basically the selection
939mechanism), it could be extended by displaying a unicode character map. 1281mechanism), it could be extended by displaying a unicode character map.
940 1282
941=item 5.4: Feedback method for identifying displayed characters for later input 1283=item * 5.4: Feedback method for identifying displayed characters for later input
942 1284
943This method lets you display the unicode character code associated with 1285This method lets you display the unicode character code associated with
944characters already displayed. 1286characters already displayed.
945 1287
946You enter this mode by holding down C<Control> and C<Shift> together, then 1288You enter this mode by holding down C<Control> and C<Shift> together, then
958With respect to conformance, rxvt-unicode is supposed to be compliant to 1300With respect to conformance, rxvt-unicode is supposed to be compliant to
959both scenario A and B of ISO 14755, including part 5.2. 1301both scenario A and B of ISO 14755, including part 5.2.
960 1302
961=head1 LOGIN STAMP 1303=head1 LOGIN STAMP
962 1304
963B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so 1305B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
964that it can be seen via the I<who(1)> command, and can accept messages. 1306it can be seen via the I<who(1)> command, and can accept messages. To
965To allow this feature, B<@@RXVT_NAME@@> must be installed setuid root on 1307allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
966some systems. 1308on some systems or setgid to root or to some other group on others.
967 1309
968=head1 COLORS AND GRAPHICS 1310=head1 COLORS AND GRAPHICS
969 1311
970In addition to the default foreground and background colours, 1312In addition to the default foreground and background colours,
971B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1313B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
972high-intensity bold/blink versions of the same). Here is a list of the 1314high-intensity bold/blink versions of the same). Here is a list of the
973colours with their B<rgb.txt> names. 1315colours with their names.
974 1316
975=begin table 1317=begin table
976 1318
977 B<color0> (black) = Black 1319 B<color0> (black) = Black
978 B<color1> (red) = Red3 1320 B<color1> (red) = Red3
998It is also possible to specify the colour values of B<foreground>, 1340It is also possible to specify the colour values of B<foreground>,
999B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1341B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1000a number 0-15, as a convenient shorthand to reference the colour name of 1342a number 0-15, as a convenient shorthand to reference the colour name of
1001color0-color15. 1343color0-color15.
1002 1344
1345If Xft support has been compiled in and as long as Xft/Xrender don't get
1346their act together, rxvt-unicode will support C<#ARGB>, C<#AARRGGBB>
1347and C<#AAAARRRRGGGGBBBB> colour specifications, in addition to the ones
1348provided by X, where the additional A component specifies alpha (opacity)
1349values (0 is completely transparent and the maximum is opaque). You
1350probably need to specify B<"-depth 32">, too, as X is far from just
1351supporting ARGB visuals out of the box.
1352
1003Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1353Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1004always swapping the foreground/background colours. This is in contrast to 1354always swapping the foreground/background colours. This is in contrast to
1005I<xterm>(1) where the colours are only swapped if they have not otherwise 1355I<xterm>(1) where the colours are only swapped if they have not otherwise
1006been specified. For example, 1356been specified. For example,
1007 1357
1014 1364
1015=back 1365=back
1016 1366
1017=head1 ENVIRONMENT 1367=head1 ENVIRONMENT
1018 1368
1019B<@@RXVT_NAME@@> sets the environment variables B<TERM>, B<COLORTERM> 1369B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1020and B<COLORFGBG>. The environment variable B<WINDOWID> is set to the X 1370
1021window id number of the B<@@RXVT_NAME@@> window and it also uses and 1371=over 4
1022sets the environment variable B<DISPLAY> to specify which display 1372
1023terminal to use. B<@@RXVT_NAME@@> uses the environment variables 1373=item B<TERM>
1024B<RXVTPATH> and B<PATH> to find XPM files. 1374
1375Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1376resources or on the commandline.
1377
1378=item B<COLORTERM>
1379
1380Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was
1381compiled with XPM support, and optionally with the added extension
1382C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.
1383
1384=item B<COLORFGBG>
1385
1386Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1387the colour code used as default foreground/text colour (or the string
1388C<default> to indicate that the default-colour escape sequence is to be
1389used), C<bg> is the colour code used as default background colour (or the
1390string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1391was compiled with XPM support. Libraries like C<ncurses> and C<slang> can
1392(and do) use this information to optimize screen output.
1393
1394=item B<WINDOWID>
1395
1396Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1397window, which usually has subwindows for the scrollbar, the terminal
1398window and so on).
1399
1400=item B<TERMINFO>
1401
1402Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
1403C<--with-terminfo=PATH>.
1404
1405=item B<DISPLAY>
1406
1407Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1408display in it's child processes.
1409
1410=item B<SHELL>
1411
1412The shell to be used for command execution, defaults to C</bin/sh>.
1413
1414=item B<RXVT_SOCKET>
1415
1416The unix domain socket path used by @@RXVT_NAME@@c(1) and
1417@@RXVT_NAME@@d(1).
1418
1419Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.
1420
1421=item B<HOME>
1422
1423Used to locate the default directory for the unix domain socket for
1424daemon communications and to locate various resource files (such as
1425C<.Xdefaults>)
1426
1427=item B<XAPPLRESDIR>
1428
1429Directory where various X resource files are being located.
1430
1431=item B<XENVIRONMENT>
1432
1433If set and accessible, gives the name of a X resource file to be loaded by
1434@@RXVT_NAME@@.
1435
1436=back
1025 1437
1026=head1 FILES 1438=head1 FILES
1027 1439
1028=over 4 1440=over 4
1029 1441
1030=item B</etc/utmp>
1031
1032System file for login records.
1033
1034=item B</usr/lib/X11/rgb.txt> 1442=item B</usr/lib/X11/rgb.txt>
1035 1443
1036Color names. 1444Color names.
1037 1445
1038=back 1446=back
1039 1447
1040=head1 SEE ALSO 1448=head1 SEE ALSO
1041 1449
1042@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) 1450@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1043
1044=head1 BUGS
1045
1046Check the BUGS file for an up-to-date list.
1047
1048Cursor change support is not yet implemented.
1049
1050Click-and-drag doesn't work with X11 mouse report overriding.
1051 1451
1052=head1 CURRENT PROJECT COORDINATOR 1452=head1 CURRENT PROJECT COORDINATOR
1053 1453
1054=over 4 1454=over 4
1055 1455
1056=item Project Coordinator 1456=item Project Coordinator
1057 1457
1058@@RXVT_MAINT@@ L<@@RXVT_MAINTEMAIL@@> 1458Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1059 1459
1060=item Web page maintainter 1460L<http://software.schmorp.de/#rxvt-unicode>
1061
1062@@RXVT_WEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@>
1063
1064L<@@RXVT_WEBPAGE@@>
1065 1461
1066=back 1462=back
1067 1463
1068=head1 AUTHORS 1464=head1 AUTHORS
1069 1465
1091 1487
1092Project Coordinator (changes.txt 2.21a to 2.4.5) 1488Project Coordinator (changes.txt 2.21a to 2.4.5)
1093 1489
1094=item Geoff Wing L<< <gcw@pobox.com> >> 1490=item Geoff Wing L<< <gcw@pobox.com> >>
1095 1491
1096Rewrote screen display and text selection routines. Project Coordinator 1492Rewrote screen display and text selection routines.
1493
1097(changes.txt 2.4.6 - rxvt-unicode) 1494Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1098 1495
1099=item Marc Alexander Lehmann L<< <rxvt@schmorp.de> >> 1496=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1100 1497
1101Forked rxvt-unicode, rewrote most of the display code and internal 1498Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1102character handling to store text in unicode, improve xterm 1499extension, random hacks, numerous bugfixes and extensions.
1103compatibility and apply numerous other bugfixes and extensions.
1104 1500
1105Project Coordinator (Changes 1.0 -) 1501Project Coordinator (Changes 1.0 -)
1106 1502
1503=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1504
1505Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
1506
1107=back 1507=back
1108 1508

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines