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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines