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.93 by root, Wed Jan 11 23:08:54 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>.
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 used in turn when trying to display Unicode 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<-sbg>
303
304Compile I<frills>: Disable the usage of the built-in block graphics/line
305drawing characters and just rely on what the specified fonts provide. Use
306this if you have a good font and want to use its block graphic glyphs;
307resource B<skipBuiltinGlyphs>.
308
268=item B<-lsp> I<number> 309=item B<-lsp> I<number>
269 310
270Compile I<linespace>: Lines (pixel height) to insert between each row 311Compile I<frills>: Lines (pixel height) to insert between each row of
271of the display; resource B<linespace>. 312the display. Useful to work around font rendering problems; resource
313B<linespace>.
272 314
273=item B<-tn> I<termname> 315=item B<-tn> I<termname>
274 316
275This option specifies the name of the terminal type to be set in the 317This option specifies the name of the terminal type to be set in the
276B<TERM> environment variable. This terminal type must exist in the 318B<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 327given 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 328on 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, 329run the program specified by the B<SHELL> environment variable or,
288failing that, I<sh(1)>. 330failing that, I<sh(1)>.
289 331
332Please note that you must specify a program with arguments. If you want to
333run shell commands, you have to specify the shell, like this:
334
335 @@RXVT_NAME@@ -e sh -c "shell commands"
336
290=item B<-title> I<text> 337=item B<-title> I<text>
291 338
292Window title (B<-T> still respected); the default title is the basename 339Window title (B<-T> still respected); the default title is the basename
293of the program specified after the B<-e> option, if any, otherwise the 340of the program specified after the B<-e> option, if any, otherwise the
294application name; resource B<title>. 341application name; resource B<title>.
312 359
313Compile I<XIM>: input method name. resource B<inputMethod>. 360Compile I<XIM>: input method name. resource B<inputMethod>.
314 361
315=item B<-imlocale> I<string> 362=item B<-imlocale> I<string>
316 363
317The locale to use for opening the IM. You can use an LC_CTYPE of e.g. 364The 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 365C<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 366input extension to be able to input japanese characters while staying in
320another locale. 367another locale. resource B<imLocale>.
368
369=item B<-imfont> I<fontset>
370
371Set the font set to use for the X Input Method, see resource B<imFont>
372for more info.
373
374=item B<-tcw>
375
376Change the meaning of triple-click selection with the left mouse
377button. Instead of selecting a full line it will extend the selection the
378end of the logical line only. resource B<tripleclickwords>.
321 379
322=item B<-insecure> 380=item B<-insecure>
323 381
324Enable "insecure" mode, which currently enables most of the escape 382Enable "insecure" mode, which currently enables most of the escape
325sequences that echo strings. See the resource B<insecure> for more 383sequences that echo strings. See the resource B<insecure> for more
339=item B<-ssr>|B<+ssr> 397=item B<-ssr>|B<+ssr>
340 398
341Turn on/off secondary screen scroll (default enabled); resource 399Turn on/off secondary screen scroll (default enabled); resource
342B<secondaryScroll>. 400B<secondaryScroll>.
343 401
402=item B<-hold>|B<+hold>
403
404Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
405will not immediately destroy its window when the program executed within
406it exits. Instead, it will wait till it is being killed or closed by the
407user; resource B<hold>.
408
409=item B<-keysym.>I<sym> I<string>
410
411Remap a key symbol. See resource B<keysym>.
412
413=item B<-embed> I<windowid>
414
415Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window,
416which enables applications to easily embed a terminal.
417
418Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
419shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
420quite a bit, so don't expect it to keep some specific state. It's best to
421create an extra subwindow for @@RXVT_NAME@@ and leave it alone.
422
423The window will not be destroyed when @@RXVT_NAME@@ exits.
424
425It might be useful to know that @@RXVT_NAME@@ will not close file
426descriptors passed to it (except for stdin/out/err, of course), so you
427can use file descriptors to communicate with the programs within the
428terminal. This works regardless of wether the C<-embed> option was used or
429not.
430
431Here is a short Gtk2-perl snippet that illustrates how this option can be
432used (a longer example is in F<doc/embed>):
433
434 my $rxvt = new Gtk2::Socket;
435 $rxvt->signal_connect_after (realize => sub {
436 my $xid = $_[0]->window->get_xid;
437 system "@@RXVT_NAME@@ -embed $xid &";
438 });
439
440=item B<-pty-fd> I<file descriptor>
441
442Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
443pair but instead use the given filehandle as the tty master. This is
444useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
445without having to run a program within it.
446
447If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
448entries and will not tinker with pty/tty permissions - you have to do that
449yourself if you want that.
450
451As an extremely special case, specifying C<-1> will completely suppress
452pty/tty operations.
453
454Here is a example in perl that illustrates how this option can be used (a
455longer example is in F<doc/pty-fd>):
456
457 use IO::Pty;
458 use Fcntl;
459
460 my $pty = new IO::Pty;
461 fcntl $pty, F_SETFD, 0; # clear close-on-exec
462 system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";
463 close $pty;
464
465 # now communicate with rxvt
466 my $slave = $pty->slave;
467 while (<$slave>) { print $slave "got <$_>\n" }
468
344=item B<-xrm> I<resourcestring> 469=item B<-pe> I<string>
345 470
346No effect on rxvt-unicode. Simply passes through an argument to be made 471Comma-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 472this terminal instance. See resource B<perl-ext> for details.
348some window managers.
349 473
350=back 474=back
351 475
352=head1 RESOURCES (available also as long-options) 476=head1 RESOURCES (available also as long-options)
353 477
354Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long 478Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
355options) compiled into your version. 479options) compiled into your version.
356 480
357There are two different methods that @@RXVT_NAME@@ can use to get the 481You can set and change the resources using X11 tools like B<xrdb>. Many
358Xresource data: using the X libraries (Xrm*-functions) or internal 482distribution do also load settings from the B<~/.Xresources> file when X
359Xresources reader (B<~/.Xdefaults>). For the first method (ie. 483starts. @@RXVT_NAME@@ will consult the following files/resources in order,
360B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the 484with 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 485
364If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h> 486 1. system-wide app-defaults file, either locale-dependent OR global
365lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults 487 2. app-defaults file in $XAPPLRESDIR
366set in XAPPLOADDIR/URxvt (compile-time defined: usually 488 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
367B</usr/lib/X11/app-defaults/URxvt>) and resources set in 489 4. SCREEN_RESOURCES for the current screen
368B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist. 490 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
491
369Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two 492Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
370class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows 493names: 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 494common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
372easily configured, while the class name B<URxvt> allows resources 495configured, while the class name B<URxvt> allows resources unique to
373unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be 496B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
374shared between different B<@@RXVT_NAME@@> configurations. If no 497configurations. If no resources are specified, suitable defaults will
375resources are specified, suitable defaults will be used. Command-line 498be used. Command-line arguments can be used to override resource
376arguments can be used to override resource settings. The following 499settings. The following resources are supported (you might want to
377resources are allowed: 500check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
501extensions not documented here):
378 502
379=over 4 503=over 4
380 504
381=item B<geometry:> I<geom> 505=item B<geometry:> I<geom>
382 506
412 536
413=item B<colorIT:> I<colour> 537=item B<colorIT:> I<colour>
414 538
415Use the specified colour to display bold or italic characters when the 539Use the specified colour to display bold or italic characters when the
416foreground colour is the default. If font styles are not available 540foreground colour is the default. If font styles are not available
417(Compile styles) and this option is unset, reverse video is used instead. 541(Compile I<styles>) and this option is unset, reverse video is used instead.
418 542
419=item B<colorUL:> I<colour> 543=item B<colorUL:> I<colour>
420 544
421Use the specified colour to display underlined characters when the 545Use the specified colour to display underlined characters when the
422foreground colour is the default. 546foreground colour is the default.
423 547
424=item B<colorRV:> I<colour> 548=item B<colorRV:> I<colour>
425 549
426Use the specified colour as the background for reverse video 550Use the specified colour as the background for reverse video
427characters. 551characters.
552
553=item B<underlineColor:> I<colour>
554
555If set, use the specified colour as the colour for the underline
556itself. If unset, use the foreground colour.
428 557
429=item B<cursorColor:> I<colour> 558=item B<cursorColor:> I<colour>
430 559
431Use the specified colour for the cursor. The default is to use the 560Use the specified colour for the cursor. The default is to use the
432foreground colour; option B<-cr>. 561foreground colour; option B<-cr>.
455artificial transparency. B<False>: do not inherit the parent windows' 584artificial transparency. B<False>: do not inherit the parent windows'
456pixmap. 585pixmap.
457 586
458=item B<fading:> I<number> 587=item B<fading:> I<number>
459 588
460Fade the text by the given percentage when focus is lost. 589Fade the text by the given percentage when focus is lost; option B<-fade>.
590
591=item B<fadeColor:> I<colour>
592
593Fade to this colour, when fading is used (see B<fading:>). The default
594colour is black; option B<-fadecolor>.
461 595
462=item B<tintColor:> I<colour> 596=item B<tintColor:> I<colour>
463 597
464Tint the transparent background pixmap with the given colour. 598Tint the transparent background pixmap with the given colour; option
599B<-tint>.
465 600
466=item B<shading:> I<number> 601=item B<shading:> I<number>
467 602
468Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 603Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
469image in addition to tinting it. 604image in addition to tinting it.
470 605
471=item B<fading:> I<number>
472
473Scale the tint colour by the given percentage.
474
475=item B<scrollColor:> I<colour> 606=item B<scrollColor:> I<colour>
476 607
477Use the specified colour for the scrollbar [default #B2B2B2]. 608Use the specified colour for the scrollbar [default #B2B2B2].
478 609
479=item B<troughColor:> I<colour> 610=item B<troughColor:> I<colour>
480 611
481Use the specified colour for the scrollbar's trough area [default 612Use the specified colour for the scrollbar's trough area [default
482#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 613#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
483 614
484=item B<borderColor:> I<colour> 615=item B<borderColor:> I<colour>
485 616
486The colour of the border around the text area and between the scrollbar 617The colour of the border around the text area and between the scrollbar
487and the text. 618and the text.
514 645
515Select the fonts to be used. This is a comma separated list of font 646Select the fonts to be used. This is a comma separated list of font
516names that are used in turn when trying to display Unicode characters. 647names that are used in turn when trying to display Unicode characters.
517The first font defines the cell size for characters; other fonts might 648The first font defines the cell size for characters; other fonts might
518be smaller, but not larger. A reasonable default font list is always 649be smaller, but not larger. A reasonable default font list is always
519appended to it. option B<-fn>. 650appended to it; option B<-fn>.
520 651
521Each font can either be a standard X11 core font (XLFD) name, with 652Each 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:>. 653optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
523 654
524In addition, each font can be prefixed with additional hints and 655In addition, each font can be prefixed with additional hints and
525specifications enclosed in square brackets (C<[]>). The only available 656specifications enclosed in square brackets (C<[]>). The only available
526hint currently is C<codeset=codeset-name>, and this is only used for Xft 657hint currently is C<codeset=codeset-name>, and this is only used for Xft
527fonts. 658fonts.
537specifies five fonts to be used. The first one is C<9x15bold> (actually 668specifies 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 669the 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 670it is named first) and thus defines the character cell grid to be 9 pixels
540wide and 15 pixels high. 671wide and 15 pixels high.
541 672
542the second font is just used to add additional unicode characters not in 673The second font is just used to add additional unicode characters not in
543the base font, likewise the third, which is unfortunately non-bold, but 674the 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 675the bold version of the font does contain less characters, so this is a
545useful supplement. 676useful supplement.
546 677
547The third font is an Xft font with aliasing turned off, and the characters 678The third font is an Xft font with aliasing turned off, and the characters
570not possible, replacement fonts of the desired shape will be tried. 701not possible, replacement fonts of the desired shape will be tried.
571 702
572If set, but empty, then this specific style is disabled and the normal 703If set, but empty, then this specific style is disabled and the normal
573text font will being used for the given style. 704text font will being used for the given style.
574 705
706=item B<intensityStyles:> I<boolean>
707
708When font styles are not enabled, or this option is enabled (B<True>,
709option B<-is>, the default), bold and italic font styles imply high
710intensity foreground/backround colours. Disabling this option (B<False>,
711option B<+is>) disables this behaviour, the high intensity colours are not
712reachable.
713
575=item B<selectstyle:> I<mode> 714=item B<selectstyle:> I<mode>
576 715
577Set mouse selection style to B<old> which is 2.20, B<oldword> which is 716Set 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 717xterm style with 2.20 old word selection, or anything else which gives
579xterm style selection. 718xterm style selection.
580 719
581=item B<scrollstyle:> I<mode> 720=item B<scrollstyle:> I<mode>
582 721
583Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is 722Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
584the author's favourite.. 723the author's favourite.
585 724
586=item B<title:> I<string> 725=item B<title:> I<string>
587 726
588Set window title string, the default title is the command-line 727Set window title string, the default title is the command-line
589specified after the B<-e> option, if any, otherwise the application 728specified after the B<-e> option, if any, otherwise the application
621 760
622Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use 761Specify 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 762B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or
624B<Shift-Print> to include the scrollback as well. 763B<Shift-Print> to include the scrollback as well.
625 764
765The string will be interpreted as if typed into the shell as-is.
766
767Example:
768
769 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
770
771This creates a new file in your home directory with the screen contents
772everytime you hit C<Print>.
773
626=item B<scrollBar:> I<boolean> 774=item B<scrollBar:> I<boolean>
627 775
628B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 776B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
629disable the scrollbar; option B<+sb>. 777disable the scrollbar; option B<+sb>.
630 778
650B<+si>. 798B<+si>.
651 799
652=item B<scrollWithBuffer:> I<boolean> 800=item B<scrollWithBuffer:> I<boolean>
653 801
654B<True>: scroll with scrollback buffer when tty receives new lines (and 802B<True>: scroll with scrollback buffer when tty receives new lines (and
655B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll 803B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
656with scrollback buffer when tty recieves new lines; option B<-sw>. 804with scrollback buffer when tty recieves new lines; option B<+sw>.
657 805
658=item B<scrollTtyKeypress:> I<boolean> 806=item B<scrollTtyKeypress:> I<boolean>
659 807
660B<True>: scroll to bottom when a non-special key is pressed. Special keys 808B<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 809are those which are intercepted by rxvt-unicode for special handling and
680=item B<borderLess:> I<boolean> 828=item B<borderLess:> I<boolean>
681 829
682Set MWM hints to request a borderless window, i.e. if honoured by the 830Set 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>. 831WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
684 832
833=item B<skipBuiltinGlyphs:> I<boolean>
834
835Compile I<frills>: Disable the usage of the built-in block graphics/line
836drawing characters and just rely on what the specified fonts provide. Use
837this if you have a good font and want to use its block graphic glyphs;
838option B<-sbg>.
839
685=item B<termName:> I<termname> 840=item B<termName:> I<termname>
686 841
687Specifies the terminal type name to be set in the B<TERM> environment 842Specifies the terminal type name to be set in the B<TERM> environment
688variable; option B<-tn>. 843variable; option B<-tn>.
689 844
699 854
700=item B<mouseWheelScrollPage:> I<boolean> 855=item B<mouseWheelScrollPage:> I<boolean>
701 856
702B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel 857B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel
703scrolls five lines [default]. 858scrolls five lines [default].
859
860=item B<pastableTabs:> I<boolean>
861
862B<True>: store tabs as wide characters. B<False>: interpret tabs as cursor
863movement only; option C<-ptab>.
704 864
705=item B<cursorBlink:> I<boolean> 865=item B<cursorBlink:> I<boolean>
706 866
707B<True>: blink the cursor. B<False>: do not blink the cursor [default]; 867B<True>: blink the cursor. B<False>: do not blink the cursor [default];
708option B<-bc>. 868option B<-bc>.
721 881
722Mouse pointer background colour. 882Mouse pointer background colour.
723 883
724=item B<pointerBlankDelay:> I<number> 884=item B<pointerBlankDelay:> I<number>
725 885
726Specifies number of seconds before blanking the pointer [default 2]. 886Specifies number of seconds before blanking the pointer [default 2]. Use a
887large number (e.g. C<987654321>) to effectively disable the timeout.
727 888
728=item B<backspacekey:> I<string> 889=item B<backspacekey:> I<string>
729 890
730The string to send when the backspace key is pressed. If set to B<DEC> 891The 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> 892or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>
753 914
754I<name> of inputMethod to use; option B<-im>. 915I<name> of inputMethod to use; option B<-im>.
755 916
756=item B<imLocale:> I<name> 917=item B<imLocale:> I<name>
757 918
758The locale to use for opening the IM. You can use an LC_CTYPE of e.g. 919The 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 920C<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 921input extension to be able to input japanese characters while staying in
761another locale. option B<-imlocale>. 922another locale; option B<-imlocale>.
923
924=item B<imFont:> I<fontset>
925
926Specify the font-set used for XIM styles C<OverTheSpot> or
927C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
928by commas), i.e. it's not in the same format as the other font lists used
929in @@RXVT_NAME@@. The default will be set-up to chose *any* suitable found
930found, preferably one or two pixels differing in size to the base font.
931option B<-imfont>.
932
933=item B<tripleclickwords:> I<boolean>
934
935Change the meaning of triple-click selection with the left mouse
936button. Instead of selecting a full line it will extend the selection to
937the end of the logical line only; option B<-tcw>.
762 938
763=item B<insecure:> I<boolean> 939=item B<insecure:> I<boolean>
764 940
765Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 941Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
766echo arbitrary strings like the icon name or the locale. This could be 942echo arbitrary strings like the icon name or the locale. This could be
767abused if somebody gets 8-bit-clean access to your display, whether 943abused if somebody gets 8-bit-clean access to your display, whether
768throuh a mail client displaying mail bodies unfiltered or though 944through a mail client displaying mail bodies unfiltered or through
769write(1). Therefore, these sequences are disabled by default. (Note 945write(1) or any other means. Therefore, these sequences are disabled by
770that other terminals, including xterm, have these sequences 946default. (Note that many other terminals, including xterm, have these
771enabled by default). You can enable them by setting this boolean 947sequences enabled by default, which doesn't make it safer, though).
772resource or specifying B<-insecure> as an option. At the moment, this 948
773enabled display-answer, locale, findfont, icon label and window title 949You can enable them by setting this boolean resource or specifying
774requests as well as dynamic menubar dispatch. 950B<-insecure> as an option. At the moment, this enables display-answer,
951locale, findfont, icon label and window title requests as well as dynamic
952menubar dispatch.
775 953
776=item B<modifier:> I<modifier> 954=item B<modifier:> I<modifier>
777 955
778Set the key to be interpreted as the Meta key to: B<alt>, B<meta>, 956Set 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 957B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
794Turn on/off secondary screen scroll (default enabled). If the this 972Turn on/off secondary screen scroll (default enabled). If the this
795option is enabled, scrolls on the secondary screen will change the 973option is enabled, scrolls on the secondary screen will change the
796scrollback buffer and switching to/from the secondary screen will 974scrollback buffer and switching to/from the secondary screen will
797instead scroll the screen up. 975instead scroll the screen up.
798 976
977=item B<hold>: I<bool>
978
979Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
980will not immediately destroy its window when the program executed within
981it exits. Instead, it will wait till it is being killed or closed by the
982user.
983
799=item B<keysym.>I<sym>: I<string> 984=item B<keysym.>I<sym>: I<string>
800 985
801Associate I<string> with keysym I<sym> (B<0xFF00 - 0xFFFF>). It may 986Compile I<frills>: Associate I<string> with keysym I<sym>. The
802contain escape values (\a: bell, \b: backspace, \e, \E: escape, \n: 987intervening resource name B<keysym.> cannot be omitted.
803newline, \r: return, \t: 988
989The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be
990any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>,
991B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>,
992and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>,
993B<2>, B<3>, B<4>, B<5>.
994
995The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
996whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
997keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
998current application keymap mode state.
999
1000The spellings of I<key> can be obtained by using B<xev>(1) command or
1001searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
1002omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1003keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1004performed in an exact manner; however, the closest match is assured.
1005
1006I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,
1007C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,
804tab, \000: octal number) or control characters (^?: delete, ^@: null, 1008C<\000>: octal number) or verbatim control characters (C<^?>: delete,
805^A ...) and may enclosed with double quotes so that it can start or end 1009C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
806with whitespace. The intervening resource name B<keysym.> cannot be 1010can start or end with whitespace.
807omitted. This resource is only available when compiled with 1011
808KEYSYM_RESOURCE. 1012Please note that you need to double the C<\> in resource files, as
1013Xlib itself does it's own de-escaping (you can use C<\033> instead of
1014C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1015processing).
1016
1017You can define a range of keysyms in one shot by providing a I<string>
1018with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'
1019should be a character not used by the strings.
1020
1021Its usage can be demonstrated by an example:
1022
1023 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
1024
1025The above line is equivalent to the following three lines:
1026
1027 URxvt.keysym.Meta-Control-0x61: \033<M-C-a>
1028 URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
1029 URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
1030
1031If I<string> takes the form of C<command:STRING>, the specified B<STRING>
1032is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1033example the following means "change the current locale to C<zh_CN.GBK>
1034when Control-Meta-c is being pressed":
1035
1036 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1037
1038If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1039is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)
1040manpage. For example, the F<selection> extension (activated via
1041C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1042
1043 URxvt.keysym.M-C-c: perl:selection:rot13
1044
1045Due the the large number of modifier combinations, a defined key mapping
1046will match if at I<at least> the specified identifiers are being set, and
1047no other key mappings with those and more bits are being defined. That
1048means that defining a key map for C<a> will automatically provide
1049definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1050mappings themselves.
1051
1052Unfortunately, this will override built-in key mappings. For example
1053if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s
1054C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the
1055user-defined keymap using the C<builtin:> replacement:
1056
1057 URxvt.keysym.Insert: <my insert key sequence>
1058 URxvt.keysym.S-Insert: builtin:
1059
1060The first line defines a mapping for C<Insert> and I<any> combination
1061of modifiers. The second line re-establishes the default mapping for
1062C<Shift-Insert>.
1063
1064The following example will map Control-Meta-1 and Control-Meta-2 to
1065the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1066font-switching at runtime:
1067
1068 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
1069 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1070
1071Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1072info):
1073
1074 URxvt.keysym.M-C-3: command:\033[8;25;80t
1075 URxvt.keysym.M-C-4: command:\033[8;48;110t
1076
1077=item B<perl-ext-common>: I<string>
1078
1079=item B<perl-ext>: I<string>
1080
1081Comma-separated list(s) of perl extension scripts (default: C<default>) to
1082use in this terminal instance; option B<-pe>.
1083
1084Extension names can be prefixed with a C<-> sign to prohibit using
1085them. This can be useful to selectively disable some extensions loaded
1086by default, or specified via the C<perl-ext-common> resource. For
1087example, C<default,-selection> will use all the default extension except
1088C<selection>.
1089
1090Extension names can also be followed by an argument in angle brackets
1091(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
1092searchable scorllback to Alt/Meta-s). Mentioning the same extension
1093multiple times with different arguments will pass multiple arguments to
1094the extension.
1095
1096Each extension is looked up in the library directories, loaded if
1097necessary, and bound to the current terminal instance.
1098
1099If both of these resources are the empty string, then the perl
1100interpreter will not be initialized. The idea behind two options is that
1101B<perl-ext-common> will be used for extensions that should be available to
1102all instances, while B<perl-ext> is used for specific instances.
1103
1104=item B<perl-eval>: I<string>
1105
1106Perl code to be evaluated when all extensions have been registered. See
1107the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource
1108will be ignored when running setuid/setgid.
1109
1110=item B<perl-lib>: I<path>
1111
1112Colon-separated list of additional directories that hold extension
1113scripts. When looking for extensions specified by the C<perl> resource,
1114@@RXVT_NAME@@ will first look in these directories and then in
1115F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
1116will be ignored when running setuid/setgid.
1117
1118See the @@RXVT_NAME@@perl(3) manpage.
1119
1120=item B<urlLauncher>: I<string>
1121
1122Specifies the program to be started with a URL argument. Used by the
1123C<selection-popup> and C<mark-urls> perl extensions.
1124
1125=item B<transient-for>: I<windowid>
1126
1127Sets the WM_TRANSIENT_FOR property to the given window iw.
809 1128
810=back 1129=back
811 1130
812=head1 THE SCROLLBAR 1131=head1 THE SCROLLBAR
813 1132
827the normal text selection/insertion, hold either the Shift or the Meta 1146the normal text selection/insertion, hold either the Shift or the Meta
828(Alt) key while performing the desired mouse action. 1147(Alt) key while performing the desired mouse action.
829 1148
830If mouse reporting mode is active, the normal scrollbar actions are 1149If mouse reporting mode is active, the normal scrollbar actions are
831disabled -- on the assumption that we are using a fullscreen 1150disabled -- on the assumption that we are using a fullscreen
832application. Instead, pressing Button1 and Button3 sends B<ESC[6~> 1151application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
833(Next) and B<ESC[5~> (Prior), respectively. Similarly, clicking on the 1152(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), 1153up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
835respectively. 1154respectively.
836 1155
837=head1 TEXT SELECTION AND INSERTION 1156=head1 TEXT SELECTION AND INSERTION
838 1157
839The behaviour of text selection and insertion mechanism is similar to 1158The behaviour of text selection and insertion mechanism is similar to
841 1160
842=over 4 1161=over 4
843 1162
844=item B<Selection>: 1163=item B<Selection>:
845 1164
846Left click at the beginning of the region, drag to the end of the 1165Left 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 1166and release; Right click to extend the marked region; Left double-click
848double-click to select a word; Left triple-click to select the entire 1167to select a word; Left triple-click to select the entire logical line
849line. 1168(which can span multiple screen lines), unless modified by resource
1169B<tripleclickwords>.
850 1170
851Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys) 1171Starting 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 1172(Compile: I<frills>) will create a rectangular selection instead of a
853one. 1173normal one. In this mode, every selected row becomes its own line in the
1174selection, and trailing whitespace is visually underlined and removed from
1175the selection.
854 1176
855=item B<Insertion>: 1177=item B<Insertion>:
856 1178
857Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1179Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in
858an B<@@RXVT_NAME@@> window causes the current text selection to be 1180an B<@@RXVT_NAME@@> window causes the current text selection to be
866supported in rxvt-unicode. Bug me if you need this. 1188supported in rxvt-unicode. Bug me if you need this.
867 1189
868You can, however, switch fonts at runtime using escape sequences (and 1190You can, however, switch fonts at runtime using escape sequences (and
869therefore using the menubar), e.g.: 1191therefore using the menubar), e.g.:
870 1192
871 printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic" 1193 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
872 1194
873rxvt-unicode will automatically re-apply these fonts to the output so far. 1195rxvt-unicode will automatically re-apply these fonts to the output so far.
874 1196
875=head1 ISO 14755 SUPPORT 1197=head1 ISO 14755 SUPPORT
876 1198
880C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1202C<--enable-frills>, the rest is available when rxvt-unicode was compiled
881with C<--enable-iso14755>. 1203with C<--enable-iso14755>.
882 1204
883=over 4 1205=over 4
884 1206
885=item 5.1: Basic method 1207=item * 5.1: Basic method
886 1208
887This allows you to enter unicode characters using their hexcode. 1209This allows you to enter unicode characters using their hexcode.
888 1210
889Start by pressing and holding both C<Control> and C<Shift>, then enter 1211Start 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 1212hex-digits (between one and six). Releasing C<Control> and C<Shift> will
897address, which you cannot type. Fortunately, the card has the e-mail 1219address, 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 1220address 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>, 1221by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>,
900followed by releasing the modifier keys. 1222followed by releasing the modifier keys.
901 1223
902=item 5.2: Keyboard symbols entry method 1224=item * 5.2: Keyboard symbols entry method
903 1225
904This mode lets you input characters representing the keycap symbols of 1226This mode lets you input characters representing the keycap symbols of
905your keyboard, if representable in the current locale encoding. 1227your keyboard, if representable in the current locale encoding.
906 1228
907Start by pressing C<Control> and C<Shift> together, then releasing 1229Start by pressing C<Control> and C<Shift> together, then releasing
910keycap symbol. The symbol will only be entered when the key has been 1232keycap symbol. The symbol will only be entered when the key has been
911released, otherwise pressing e.g. C<Shift> would enter the symbol for 1233released, 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 1234C<ISO Level 2 Switch>, although your intention might have been to enter a
913reverse tab (Shift-Tab). 1235reverse tab (Shift-Tab).
914 1236
915=item 5.3: Screen-selection entry method 1237=item * 5.3: Screen-selection entry method
916 1238
917While this is implemented already (it's basically the selection 1239While this is implemented already (it's basically the selection
918mechanism), it could be extended by displaying a unicode character map. 1240mechanism), it could be extended by displaying a unicode character map.
919 1241
920=item 5.4: Feedback method for identifying displayed characters for later input 1242=item * 5.4: Feedback method for identifying displayed characters for later input
921 1243
922This method lets you display the unicode character code associated with 1244This method lets you display the unicode character code associated with
923characters already displayed. 1245characters already displayed.
924 1246
925You enter this mode by holding down C<Control> and C<Shift> together, then 1247You 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 1259With respect to conformance, rxvt-unicode is supposed to be compliant to
938both scenario A and B of ISO 14755, including part 5.2. 1260both scenario A and B of ISO 14755, including part 5.2.
939 1261
940=head1 LOGIN STAMP 1262=head1 LOGIN STAMP
941 1263
942B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so 1264B<@@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. 1265it 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 1266allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
945some systems. 1267on some systems or setgid to root or to some other group on others.
946 1268
947=head1 COLORS AND GRAPHICS 1269=head1 COLORS AND GRAPHICS
948 1270
949In addition to the default foreground and background colours, 1271In addition to the default foreground and background colours,
950B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1272B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
993 1315
994=back 1316=back
995 1317
996=head1 ENVIRONMENT 1318=head1 ENVIRONMENT
997 1319
998B<@@RXVT_NAME@@> sets the environment variables B<TERM>, B<COLORTERM> 1320B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
999and B<COLORFGBG>. The environment variable B<WINDOWID> is set to the X 1321
1000window id number of the B<@@RXVT_NAME@@> window and it also uses and 1322=over 4
1001sets the environment variable B<DISPLAY> to specify which display 1323
1002terminal to use. B<@@RXVT_NAME@@> uses the environment variables 1324=item B<TERM>
1003B<RXVTPATH> and B<PATH> to find XPM files. 1325
1326Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1327resources or on the commandline.
1328
1329=item B<COLORTERM>
1330
1331Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was
1332compiled with XPM support, and optionally with the added extension
1333C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.
1334
1335=item B<COLORFGBG>
1336
1337Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1338the colour code used as default foreground/text colour (or the string
1339C<default> to indicate that the default-colour escape sequence is to be
1340used), C<bg> is the colour code used as default background colour (or the
1341string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1342was compiled with XPM support. Libraries like C<ncurses> and C<slang> can
1343(and do) use this information to optimize screen output.
1344
1345=item B<WINDOWID>
1346
1347Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1348window, which usually has subwindows for the scrollbar, the terminal
1349window and so on).
1350
1351=item B<TERMINFO>
1352
1353Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
1354C<--with-terminfo=PATH>.
1355
1356=item B<DISPLAY>
1357
1358Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1359display in it's child processes.
1360
1361=item B<SHELL>
1362
1363The shell to be used for command execution, defaults to C</bin/sh>.
1364
1365=item B<RXVTPATH>
1366
1367The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1368files.
1369
1370=item B<PATH>
1371
1372Used in the same way as C<RXVTPATH>.
1373
1374=item B<RXVT_SOCKET>
1375
1376The unix domain socket path used by @@RXVT_NAME@@c(1) and
1377@@RXVT_NAME@@d(1).
1378
1379Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.
1380
1381=item B<HOME>
1382
1383Used to locate the default directory for the unix domain socket for
1384daemon communications and to locate various resource files (such as
1385C<.Xdefaults>)
1386
1387=item B<XAPPLRESDIR>
1388
1389Directory where various X resource files are being located.
1390
1391=item B<XENVIRONMENT>
1392
1393If set and accessible, gives the name of a X resource file to be loaded by
1394@@RXVT_NAME@@.
1395
1396=back
1004 1397
1005=head1 FILES 1398=head1 FILES
1006 1399
1007=over 4 1400=over 4
1008 1401
1009=item B</etc/utmp>
1010
1011System file for login records.
1012
1013=item B</usr/lib/X11/rgb.txt> 1402=item B</usr/lib/X11/rgb.txt>
1014 1403
1015Color names. 1404Color names.
1016 1405
1017=back 1406=back
1018 1407
1019=head1 SEE ALSO 1408=head1 SEE ALSO
1020 1409
1021@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) 1410@@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 1411
1031=head1 CURRENT PROJECT COORDINATOR 1412=head1 CURRENT PROJECT COORDINATOR
1032 1413
1033=over 4 1414=over 4
1034 1415
1035=item Project Coordinator 1416=item Project Coordinator
1036 1417
1037@@RXVT_MAINT@@ L<@@RXVT_MAINTEMAIL@@> 1418Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1038 1419
1039=item Web page maintainter 1420L<http://software.schmorp.de/#rxvt-unicode>
1040
1041@@RXVT_WEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@>
1042
1043L<@@RXVT_WEBPAGE@@>
1044 1421
1045=back 1422=back
1046 1423
1047=head1 AUTHORS 1424=head1 AUTHORS
1048 1425
1073=item Geoff Wing L<< <gcw@pobox.com> >> 1450=item Geoff Wing L<< <gcw@pobox.com> >>
1074 1451
1075Rewrote screen display and text selection routines. Project Coordinator 1452Rewrote screen display and text selection routines. Project Coordinator
1076(changes.txt 2.4.6 - rxvt-unicode) 1453(changes.txt 2.4.6 - rxvt-unicode)
1077 1454
1078=item Marc Alexander Lehmann L<< <rxvt@schmorp.de> >> 1455=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1079 1456
1080Forked rxvt-unicode, rewrote most of the display code and internal 1457Forked rxvt-unicode, rewrote most of the display code and internal
1081character handling to store text in unicode, improve xterm 1458character handling to store text in unicode, improve xterm
1082compatibility and apply numerous other bugfixes and extensions. 1459compatibility and apply numerous other bugfixes and extensions.
1083 1460

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines