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.36 by root, Wed Dec 15 05:10:57 2004 UTC vs.
Revision 1.104 by root, Wed Jan 25 13:24:45 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
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 (hopefully) reasonable default 179smaller, but not (in general) larger. A (hopefully) reasonable default
168font list is always appended to it. See resource B<font> for more details. 180font list is always appended to it. See resource B<font> for more details.
169 181
170In short, to specify an X11 core font, just specify it's name or prefix it 182In short, to specify an X11 core font, just specify it's name or prefix it
177See also the question "How does rxvt-unicode choose fonts?" in the FAQ 189See also the question "How does rxvt-unicode choose fonts?" in the FAQ
178section of @@RXVT_NAME@@(7). 190section of @@RXVT_NAME@@(7).
179 191
180=item B<-fb> I<fontlist> 192=item B<-fb> I<fontlist>
181 193
182Compile 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
183be printed. See resource B<boldFont> for details. 195are to be printed. See resource B<boldFont> for details.
184 196
185=item B<-fi> I<fontlist> 197=item B<-fi> I<fontlist>
186 198
187Compile 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>
188be printed. See resource B<italicFont> for details. 200characters are to be printed. See resource B<italicFont> for details.
189 201
190=item B<-fbi> I<fontlist> 202=item B<-fbi> I<fontlist>
191 203
192Compile 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
193be 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.
194 213
195=item B<-name> I<name> 214=item B<-name> I<name>
196 215
197Specify the application name under which resources are to be obtained, 216Specify the application name under which resources are to be obtained,
198rather than the default executable file name. Name should not contain 217rather than the default executable file name. Name should not contain
236 255
237Put scrollbar on right/left; resource B<scrollBar_right>. 256Put scrollbar on right/left; resource B<scrollBar_right>.
238 257
239=item B<-st>|B<+st> 258=item B<-st>|B<+st>
240 259
241Display normal (non XTerm/NeXT) scrollbar without/with a trough; 260Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
242resource B<scrollBar_floating>. 261resource B<scrollBar_floating>.
243 262
244=item B<-ptab>|B<+ptab> 263=item B<-ptab>|B<+ptab>
245 264
246If enabled (default), "Horizontal Tab" characters are being stored as 265If enabled (default), "Horizontal Tab" characters are being stored as
278 297
279Compile 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.
280if 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
281decorations; resource B<borderLess>. 300decorations; resource B<borderLess>.
282 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
283=item B<-lsp> I<number> 314=item B<-lsp> I<number>
284 315
285Compile I<linespace>: Lines (pixel height) to insert between each row 316Compile I<frills>: Lines (pixel height) to insert between each row of
286of the display; resource B<linespace>. 317the display. Useful to work around font rendering problems; resource
318B<linespace>.
287 319
288=item B<-tn> I<termname> 320=item B<-tn> I<termname>
289 321
290This 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
291B<TERM> environment variable. This terminal type must exist in the 323B<TERM> environment variable. This terminal type must exist in the
300given on the command line. If this option is used, it must be the last 332given on the command line. If this option is used, it must be the last
301on the command-line. If there is no B<-e> option then the default is to 333on the command-line. If there is no B<-e> option then the default is to
302run the program specified by the B<SHELL> environment variable or, 334run the program specified by the B<SHELL> environment variable or,
303failing that, I<sh(1)>. 335failing that, I<sh(1)>.
304 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
305=item B<-title> I<text> 342=item B<-title> I<text>
306 343
307Window title (B<-T> still respected); the default title is the basename 344Window title (B<-T> still respected); the default title is the basename
308of 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
309application name; resource B<title>. 346application name; resource B<title>.
327 364
328Compile I<XIM>: input method name. resource B<inputMethod>. 365Compile I<XIM>: input method name. resource B<inputMethod>.
329 366
330=item B<-imlocale> I<string> 367=item B<-imlocale> I<string>
331 368
332The 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.
333de_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
334extension to be able to input japanese characters while staying in 371input extension to be able to input japanese characters while staying in
335another 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>.
336 384
337=item B<-insecure> 385=item B<-insecure>
338 386
339Enable "insecure" mode, which currently enables most of the escape 387Enable "insecure" mode, which currently enables most of the escape
340sequences that echo strings. See the resource B<insecure> for more 388sequences that echo strings. See the resource B<insecure> for more
354=item B<-ssr>|B<+ssr> 402=item B<-ssr>|B<+ssr>
355 403
356Turn on/off secondary screen scroll (default enabled); resource 404Turn on/off secondary screen scroll (default enabled); resource
357B<secondaryScroll>. 405B<secondaryScroll>.
358 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
359=item B<-xrm> I<resourcestring> 474=item B<-pe> I<string>
360 475
361No 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
362available in the instance's argument list. Appears in I<WM_COMMAND> in 477this terminal instance. See resource B<perl-ext> for details.
363some window managers.
364 478
365=back 479=back
366 480
367=head1 RESOURCES (available also as long-options) 481=head1 RESOURCES (available also as long-options)
368 482
369Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long 483Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
370options) compiled into your version. 484options) compiled into your version.
371 485
372There 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
373Xresource data: using the X libraries (Xrm*-functions) or internal 487distribution do also load settings from the B<~/.Xresources> file when X
374Xresources reader (B<~/.Xdefaults>). For the first method (ie. 488starts. @@RXVT_NAME@@ will consult the following files/resources in order,
375B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the 489with later settings overwriting earlier ones:
376resources using X11 tools like B<xset>. Many distribution do also load
377settings from the B<~/.Xresources> file when X starts.
378 490
379If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h> 491 1. system-wide app-defaults file, either locale-dependent OR global
380lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults 492 2. app-defaults file in $XAPPLRESDIR
381set in XAPPLOADDIR/URxvt (compile-time defined: usually 493 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
382B</usr/lib/X11/app-defaults/URxvt>) and resources set in 494 4. SCREEN_RESOURCES for the current screen
383B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist. 495 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
496
384Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two 497Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
385class 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
386resources 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
387easily configured, while the class name B<URxvt> allows resources 500configured, while the class name B<URxvt> allows resources unique to
388unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be 501B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
389shared between different B<@@RXVT_NAME@@> configurations. If no 502configurations. If no resources are specified, suitable defaults will
390resources are specified, suitable defaults will be used. Command-line 503be used. Command-line arguments can be used to override resource
391arguments can be used to override resource settings. The following 504settings. The following resources are supported (you might want to
392resources are allowed: 505check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
506extensions not documented here):
393 507
394=over 4 508=over 4
395 509
396=item B<geometry:> I<geom> 510=item B<geometry:> I<geom>
397 511
427 541
428=item B<colorIT:> I<colour> 542=item B<colorIT:> I<colour>
429 543
430Use the specified colour to display bold or italic characters when the 544Use the specified colour to display bold or italic characters when the
431foreground colour is the default. If font styles are not available 545foreground colour is the default. If font styles are not available
432(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.
433 547
434=item B<colorUL:> I<colour> 548=item B<colorUL:> I<colour>
435 549
436Use the specified colour to display underlined characters when the 550Use the specified colour to display underlined characters when the
437foreground colour is the default. 551foreground colour is the default.
475artificial transparency. B<False>: do not inherit the parent windows' 589artificial transparency. B<False>: do not inherit the parent windows'
476pixmap. 590pixmap.
477 591
478=item B<fading:> I<number> 592=item B<fading:> I<number>
479 593
480Fade 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>.
481 600
482=item B<tintColor:> I<colour> 601=item B<tintColor:> I<colour>
483 602
484Tint the transparent background pixmap with the given colour. 603Tint the transparent background pixmap with the given colour; option
604B<-tint>.
485 605
486=item B<shading:> I<number> 606=item B<shading:> I<number>
487 607
488Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 608Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
489image in addition to tinting it. 609image in addition to tinting it.
493Use the specified colour for the scrollbar [default #B2B2B2]. 613Use the specified colour for the scrollbar [default #B2B2B2].
494 614
495=item B<troughColor:> I<colour> 615=item B<troughColor:> I<colour>
496 616
497Use the specified colour for the scrollbar's trough area [default 617Use the specified colour for the scrollbar's trough area [default
498#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 618#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
499 619
500=item B<borderColor:> I<colour> 620=item B<borderColor:> I<colour>
501 621
502The 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
503and the text. 623and the text.
512of 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
513specifies an integer number of images in that direction. No image will 633specifies an integer number of images in that direction. No image will
514be magnified beyond 10 times its original size. The maximum permitted 634be magnified beyond 10 times its original size. The maximum permitted
515scale is 1000. [default 0x0+50+50] 635scale is 1000. [default 0x0+50+50]
516 636
517=item B<menu:> I<file[;tag]>
518
519Read in the specified menu file (note the `.menu' extension is
520optional) and also optionally specify a starting tag to find. See the
521reference documentation for details on the syntax for the menuBar.
522
523=item B<path:> I<path> 637=item B<path:> I<path>
524 638
525Specify the colon-delimited search path for finding files (XPM and 639Specify the colon-delimited search path for finding XPM files.
526menus), in addition to the paths specified by the B<RXVTPATH> and
527B<PATH> environment variables.
528 640
529=item B<font:> I<fontlist> 641=item B<font:> I<fontlist>
530 642
531Select 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
532names that are used in turn when trying to display Unicode characters. 644that are checked in order when trying to find glyphs for characters. The
533The first font defines the cell size for characters; other fonts might 645first font defines the cell size for characters; other fonts might be
534be smaller, but not larger. A reasonable default font list is always 646smaller, but not (in general) larger. A (hopefully) reasonable default
535appended to it. option B<-fn>. 647font list is always appended to it; option B<-fn>.
536 648
537Each 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
538optional 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:>.
539 651
540In addition, each font can be prefixed with additional hints and 652In addition, each font can be prefixed with additional hints and
541specifications enclosed in square brackets (C<[]>). The only available 653specifications enclosed in square brackets (C<[]>). The only available
542hint 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
543fonts. 655fonts.
544 656
545For example, this font resource 657For example, this font resource
546 658
547 URxvt*font: 9x15bold,\ 659 URxvt.font: 9x15bold,\
548 -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,\
549 -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, \
550 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ 662 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
551 xft:Code2000:antialias=false 663 xft:Code2000:antialias=false
552 664
586not possible, replacement fonts of the desired shape will be tried. 698not possible, replacement fonts of the desired shape will be tried.
587 699
588If 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
589text font will being used for the given style. 701text font will being used for the given style.
590 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
591=item B<selectstyle:> I<mode> 711=item B<selectstyle:> I<mode>
592 712
593Set 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
594xterm 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
595xterm style selection. 715xterm style selection.
596 716
597=item B<scrollstyle:> I<mode> 717=item B<scrollstyle:> I<mode>
598 718
599Set 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
600the author's favourite.. 720the author's favourite.
601 721
602=item B<title:> I<string> 722=item B<title:> I<string>
603 723
604Set window title string, the default title is the command-line 724Set window title string, the default title is the command-line
605specified after the B<-e> option, if any, otherwise the application 725specified after the B<-e> option, if any, otherwise the application
637 757
638Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use 758Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use
639B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or 759B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or
640B<Shift-Print> to include the scrollback as well. 760B<Shift-Print> to include the scrollback as well.
641 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
642=item B<scrollBar:> I<boolean> 771=item B<scrollBar:> I<boolean>
643 772
644B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 773B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
645disable the scrollbar; option B<+sb>. 774disable the scrollbar; option B<+sb>.
646 775
666B<+si>. 795B<+si>.
667 796
668=item B<scrollWithBuffer:> I<boolean> 797=item B<scrollWithBuffer:> I<boolean>
669 798
670B<True>: scroll with scrollback buffer when tty receives new lines (and 799B<True>: scroll with scrollback buffer when tty receives new lines (and
671B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll 800B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
672with scrollback buffer when tty recieves new lines; option B<-sw>. 801with scrollback buffer when tty recieves new lines; option B<+sw>.
673 802
674=item B<scrollTtyKeypress:> I<boolean> 803=item B<scrollTtyKeypress:> I<boolean>
675 804
676B<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
677are those which are intercepted by rxvt-unicode for special handling and 806are those which are intercepted by rxvt-unicode for special handling and
696=item B<borderLess:> I<boolean> 825=item B<borderLess:> I<boolean>
697 826
698Set 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
699WM, 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>.
700 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
701=item B<termName:> I<termname> 837=item B<termName:> I<termname>
702 838
703Specifies 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
704variable; option B<-tn>. 840variable; option B<-tn>.
705 841
742 878
743Mouse pointer background colour. 879Mouse pointer background colour.
744 880
745=item B<pointerBlankDelay:> I<number> 881=item B<pointerBlankDelay:> I<number>
746 882
747Specifies 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.
748 885
749=item B<backspacekey:> I<string> 886=item B<backspacekey:> I<string>
750 887
751The 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>
752or 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>
759pressed. If unset it will send the sequence traditionally associated 896pressed. If unset it will send the sequence traditionally associated
760with the B<Execute> key. 897with the B<Execute> key.
761 898
762=item B<cutchars:> I<string> 899=item B<cutchars:> I<string>
763 900
764The characters used as delimiters for double-click word selection. The 901The characters used as delimiters for double-click word selection.
765built-in default: 902
903When the selection extension is in use (the default if compiled in, see
904the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these characters
905will be created (if the resource exists, otherwise, no regex will be
906created). In this mode, characters outside ISO-8859-1 can be used.
907
908When the selection extension is not used, only ISO-8859-1 characters can
909be used. If not specified, the built-in default is used:
766 910
767B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 911B<< BACKSLASH `"'&()*,;<=>?@[]{|} >>
768 912
769=item B<preeditType:> I<style> 913=item B<preeditType:> I<style>
770 914
774 918
775I<name> of inputMethod to use; option B<-im>. 919I<name> of inputMethod to use; option B<-im>.
776 920
777=item B<imLocale:> I<name> 921=item B<imLocale:> I<name>
778 922
779The locale to use for opening the IM. You can use an LC_CTYPE of e.g. 923The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
780de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input 924C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
781extension to be able to input japanese characters while staying in 925input extension to be able to input japanese characters while staying in
782another locale. option B<-imlocale>. 926another locale; option B<-imlocale>.
927
928=item B<imFont:> I<fontset>
929
930Specify the font-set used for XIM styles C<OverTheSpot> or
931C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
932by commas), i.e. it's not in the same format as the other font lists used
933in @@RXVT_NAME@@. The default will be set-up to chose *any* suitable found
934found, preferably one or two pixels differing in size to the base font.
935option B<-imfont>.
936
937=item B<tripleclickwords:> I<boolean>
938
939Change the meaning of triple-click selection with the left mouse
940button. Instead of selecting a full line it will extend the selection to
941the end of the logical line only; option B<-tcw>.
783 942
784=item B<insecure:> I<boolean> 943=item B<insecure:> I<boolean>
785 944
786Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 945Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
787echo arbitrary strings like the icon name or the locale. This could be 946echo arbitrary strings like the icon name or the locale. This could be
788abused if somebody gets 8-bit-clean access to your display, whether 947abused if somebody gets 8-bit-clean access to your display, whether
789throuh a mail client displaying mail bodies unfiltered or though 948through a mail client displaying mail bodies unfiltered or through
790write(1). Therefore, these sequences are disabled by default. (Note 949write(1) or any other means. Therefore, these sequences are disabled by
791that other terminals, including xterm, have these sequences 950default. (Note that many other terminals, including xterm, have these
792enabled by default). You can enable them by setting this boolean 951sequences enabled by default, which doesn't make it safer, though).
793resource or specifying B<-insecure> as an option. At the moment, this 952
794enabled display-answer, locale, findfont, icon label and window title 953You can enable them by setting this boolean resource or specifying
795requests as well as dynamic menubar dispatch. 954B<-insecure> as an option. At the moment, this enables display-answer,
955locale, findfont, icon label and window title requests.
796 956
797=item B<modifier:> I<modifier> 957=item B<modifier:> I<modifier>
798 958
799Set the key to be interpreted as the Meta key to: B<alt>, B<meta>, 959Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
800B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option 960B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
804 964
805Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E) 965Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
806character is passed through. It may contain escape values as described 966character is passed through. It may contain escape values as described
807in the entry on B<keysym> following. 967in the entry on B<keysym> following.
808 968
809=item B<secondaryScreen:> I<bool> 969=item B<secondaryScreen:> I<boolean>
810 970
811Turn on/off secondary screen (default enabled). 971Turn on/off secondary screen (default enabled).
812 972
813=item B<secondaryScroll:> I<bool> 973=item B<secondaryScroll:> I<boolean>
814 974
815Turn on/off secondary screen scroll (default enabled). If the this 975Turn on/off secondary screen scroll (default enabled). If the this
816option is enabled, scrolls on the secondary screen will change the 976option is enabled, scrolls on the secondary screen will change the
817scrollback buffer and switching to/from the secondary screen will 977scrollback buffer and switching to/from the secondary screen will
818instead scroll the screen up. 978instead scroll the screen up.
819 979
980=item B<hold>: I<boolean>
981
982Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
983will not immediately destroy its window when the program executed within
984it exits. Instead, it will wait till it is being killed or closed by the
985user.
986
820=item B<keysym.>I<sym>: I<string> 987=item B<keysym.>I<sym>: I<string>
821 988
822Associate I<string> with keysym I<sym> (B<0xFF00 - 0xFFFF>). It may 989Compile I<frills>: Associate I<string> with keysym I<sym>. The
823contain escape values (\a: bell, \b: backspace, \e, \E: escape, \n: 990intervening resource name B<keysym.> cannot be omitted.
824newline, \r: return, \t: 991
992The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be
993any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>,
994B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>,
995and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>,
996B<2>, B<3>, B<4>, B<5>.
997
998The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
999whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
1000keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
1001current application keymap mode state.
1002
1003The spellings of I<key> can be obtained by using B<xev>(1) command or
1004searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
1005omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1006keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1007performed in an exact manner; however, the closest match is assured.
1008
1009I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,
1010C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,
825tab, \000: octal number) or control characters (^?: delete, ^@: null, 1011C<\000>: octal number) or verbatim control characters (C<^?>: delete,
826^A ...) and may enclosed with double quotes so that it can start or end 1012C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
827with whitespace. The intervening resource name B<keysym.> cannot be 1013can start or end with whitespace.
828omitted. This resource is only available when compiled with 1014
829KEYSYM_RESOURCE. 1015Please note that you need to double the C<\> in resource files, as
1016Xlib itself does it's own de-escaping (you can use C<\033> instead of
1017C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1018processing).
1019
1020You can define a range of keysyms in one shot by providing a I<string>
1021with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'
1022should be a character not used by the strings.
1023
1024Its usage can be demonstrated by an example:
1025
1026 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
1027
1028The above line is equivalent to the following three lines:
1029
1030 URxvt.keysym.Meta-Control-0x61: \033<M-C-a>
1031 URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
1032 URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
1033
1034If I<string> takes the form of C<command:STRING>, the specified B<STRING>
1035is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1036example the following means "change the current locale to C<zh_CN.GBK>
1037when Control-Meta-c is being pressed":
1038
1039 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1040
1041If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1042is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)
1043manpage. For example, the F<selection> extension (activated via
1044C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1045
1046 URxvt.keysym.M-C-c: perl:selection:rot13
1047
1048Due the the large number of modifier combinations, a defined key mapping
1049will match if at I<at least> the specified identifiers are being set, and
1050no other key mappings with those and more bits are being defined. That
1051means that defining a key map for C<a> will automatically provide
1052definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1053mappings themselves.
1054
1055Unfortunately, this will override built-in key mappings. For example
1056if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s
1057C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the
1058user-defined keymap using the C<builtin:> replacement:
1059
1060 URxvt.keysym.Insert: <my insert key sequence>
1061 URxvt.keysym.S-Insert: builtin:
1062
1063The first line defines a mapping for C<Insert> and I<any> combination
1064of modifiers. The second line re-establishes the default mapping for
1065C<Shift-Insert>.
1066
1067The following example will map Control-Meta-1 and Control-Meta-2 to
1068the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1069font-switching at runtime:
1070
1071 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
1072 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1073
1074Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1075info):
1076
1077 URxvt.keysym.M-C-3: command:\033[8;25;80t
1078 URxvt.keysym.M-C-4: command:\033[8;48;110t
1079
1080=item B<perl-ext-common>: I<string>
1081
1082=item B<perl-ext>: I<string>
1083
1084Comma-separated list(s) of perl extension scripts (default: C<default>) to
1085use in this terminal instance; option B<-pe>.
1086
1087Extension names can be prefixed with a C<-> sign to prohibit using
1088them. This can be useful to selectively disable some extensions loaded
1089by default, or specified via the C<perl-ext-common> resource. For
1090example, C<default,-selection> will use all the default extension except
1091C<selection>.
1092
1093Extension names can also be followed by an argument in angle brackets
1094(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
1095searchable scorllback to Alt/Meta-s). Mentioning the same extension
1096multiple times with different arguments will pass multiple arguments to
1097the extension.
1098
1099Each extension is looked up in the library directories, loaded if
1100necessary, and bound to the current terminal instance.
1101
1102If both of these resources are the empty string, then the perl
1103interpreter will not be initialized. The idea behind two options is that
1104B<perl-ext-common> will be used for extensions that should be available to
1105all instances, while B<perl-ext> is used for specific instances.
1106
1107=item B<perl-eval>: I<string>
1108
1109Perl code to be evaluated when all extensions have been registered. See
1110the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource
1111will be ignored when running setuid/setgid.
1112
1113=item B<perl-lib>: I<path>
1114
1115Colon-separated list of additional directories that hold extension
1116scripts. When looking for extensions specified by the C<perl> resource,
1117@@RXVT_NAME@@ will first look in these directories and then in
1118F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
1119will be ignored when running setuid/setgid.
1120
1121See the @@RXVT_NAME@@perl(3) manpage.
1122
1123=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1124
1125Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
1126details.
1127
1128=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1129
1130Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1131for details.
1132
1133=item B<searchable-scrollback:> I<keysym>
1134
1135Sets the hotkey that starts the incremental scrollback buffer search
1136(default: C<M-s>).
1137
1138=item B<urlLauncher>: I<string>
1139
1140Specifies the program to be started with a URL argument. Used by the
1141C<selection-popup> and C<mark-urls> perl extensions.
1142
1143=item B<transient-for>: I<windowid>
1144
1145Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1146
1147=item B<override-redirect>: I<boolean>
1148
1149Compile I<frills>: Sets override-redirect for the terminal window, making
1150it almost invisible to window managers; option B<-override-redirect>.
830 1151
831=back 1152=back
832 1153
833=head1 THE SCROLLBAR 1154=head1 THE SCROLLBAR
834 1155
848the normal text selection/insertion, hold either the Shift or the Meta 1169the normal text selection/insertion, hold either the Shift or the Meta
849(Alt) key while performing the desired mouse action. 1170(Alt) key while performing the desired mouse action.
850 1171
851If mouse reporting mode is active, the normal scrollbar actions are 1172If mouse reporting mode is active, the normal scrollbar actions are
852disabled -- on the assumption that we are using a fullscreen 1173disabled -- on the assumption that we are using a fullscreen
853application. Instead, pressing Button1 and Button3 sends B<ESC[6~> 1174application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
854(Next) and B<ESC[5~> (Prior), respectively. Similarly, clicking on the 1175(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
855up and down arrows sends B<ESC[A> (Up) and B<ESC[B> (Down), 1176up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
856respectively. 1177respectively.
857 1178
858=head1 TEXT SELECTION AND INSERTION 1179=head1 TEXT SELECTION AND INSERTION
859 1180
860The behaviour of text selection and insertion mechanism is similar to 1181The behaviour of text selection and insertion mechanism is similar to
862 1183
863=over 4 1184=over 4
864 1185
865=item B<Selection>: 1186=item B<Selection>:
866 1187
867Left click at the beginning of the region, drag to the end of the 1188Left click at the beginning of the region, drag to the end of the region
868region and release; Right click to extend the marked region; Left 1189and release; Right click to extend the marked region; Left double-click
869double-click to select a word; Left triple-click to select the entire 1190to select a word; Left triple-click to select the entire logical line
870line. 1191(which can span multiple screen lines), unless modified by resource
1192B<tripleclickwords>.
871 1193
872Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys) 1194Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
873(Compile: frills) will create a rectangular selection instead of a normal 1195(Compile: I<frills>) will create a rectangular selection instead of a
874one. 1196normal one. In this mode, every selected row becomes its own line in the
1197selection, and trailing whitespace is visually underlined and removed from
1198the selection.
875 1199
876=item B<Insertion>: 1200=item B<Insertion>:
877 1201
878Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1202Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
879an B<@@RXVT_NAME@@> window causes the current text selection to be 1203window causes the value of the PRIMARY selection (or CLIPBOARD with the
880inserted as if it had been typed on the keyboard. 1204Meta modifier) to be inserted as if it had been typed on the keyboard.
1205
1206Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1207inserted too.
881 1208
882=back 1209=back
883 1210
884=head1 CHANGING FONTS 1211=head1 CHANGING FONTS
885 1212
886Changing fonts (or font sizes, respectively) via the keypad is not yet 1213Changing fonts (or font sizes, respectively) via the keypad is not yet
887supported in rxvt-unicode. Bug me if you need this. 1214supported in rxvt-unicode. Bug me if you need this.
888 1215
889You can, however, switch fonts at runtime using escape sequences (and 1216You can, however, switch fonts at runtime using escape sequences, e.g.:
890therefore using the menubar), e.g.:
891 1217
892 printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic" 1218 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1219
1220You can use keyboard shortcuts, too:
1221
1222 URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
1223 URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
893 1224
894rxvt-unicode will automatically re-apply these fonts to the output so far. 1225rxvt-unicode will automatically re-apply these fonts to the output so far.
895 1226
896=head1 ISO 14755 SUPPORT 1227=head1 ISO 14755 SUPPORT
897 1228
901C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1232C<--enable-frills>, the rest is available when rxvt-unicode was compiled
902with C<--enable-iso14755>. 1233with C<--enable-iso14755>.
903 1234
904=over 4 1235=over 4
905 1236
906=item 5.1: Basic method 1237=item * 5.1: Basic method
907 1238
908This allows you to enter unicode characters using their hexcode. 1239This allows you to enter unicode characters using their hexcode.
909 1240
910Start by pressing and holding both C<Control> and C<Shift>, then enter 1241Start by pressing and holding both C<Control> and C<Shift>, then enter
911hex-digits (between one and six). Releasing C<Control> and C<Shift> will 1242hex-digits (between one and six). Releasing C<Control> and C<Shift> will
918address, which you cannot type. Fortunately, the card has the e-mail 1249address, which you cannot type. Fortunately, the card has the e-mail
919address printed as hexcodes, e.g. C<671d 65e5>. You can enter this easily 1250address printed as hexcodes, e.g. C<671d 65e5>. You can enter this easily
920by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>, 1251by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>,
921followed by releasing the modifier keys. 1252followed by releasing the modifier keys.
922 1253
923=item 5.2: Keyboard symbols entry method 1254=item * 5.2: Keyboard symbols entry method
924 1255
925This mode lets you input characters representing the keycap symbols of 1256This mode lets you input characters representing the keycap symbols of
926your keyboard, if representable in the current locale encoding. 1257your keyboard, if representable in the current locale encoding.
927 1258
928Start by pressing C<Control> and C<Shift> together, then releasing 1259Start by pressing C<Control> and C<Shift> together, then releasing
931keycap symbol. The symbol will only be entered when the key has been 1262keycap symbol. The symbol will only be entered when the key has been
932released, otherwise pressing e.g. C<Shift> would enter the symbol for 1263released, otherwise pressing e.g. C<Shift> would enter the symbol for
933C<ISO Level 2 Switch>, although your intention might have been to enter a 1264C<ISO Level 2 Switch>, although your intention might have been to enter a
934reverse tab (Shift-Tab). 1265reverse tab (Shift-Tab).
935 1266
936=item 5.3: Screen-selection entry method 1267=item * 5.3: Screen-selection entry method
937 1268
938While this is implemented already (it's basically the selection 1269While this is implemented already (it's basically the selection
939mechanism), it could be extended by displaying a unicode character map. 1270mechanism), it could be extended by displaying a unicode character map.
940 1271
941=item 5.4: Feedback method for identifying displayed characters for later input 1272=item * 5.4: Feedback method for identifying displayed characters for later input
942 1273
943This method lets you display the unicode character code associated with 1274This method lets you display the unicode character code associated with
944characters already displayed. 1275characters already displayed.
945 1276
946You enter this mode by holding down C<Control> and C<Shift> together, then 1277You enter this mode by holding down C<Control> and C<Shift> together, then
958With respect to conformance, rxvt-unicode is supposed to be compliant to 1289With respect to conformance, rxvt-unicode is supposed to be compliant to
959both scenario A and B of ISO 14755, including part 5.2. 1290both scenario A and B of ISO 14755, including part 5.2.
960 1291
961=head1 LOGIN STAMP 1292=head1 LOGIN STAMP
962 1293
963B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so 1294B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
964that it can be seen via the I<who(1)> command, and can accept messages. 1295it can be seen via the I<who(1)> command, and can accept messages. To
965To allow this feature, B<@@RXVT_NAME@@> must be installed setuid root on 1296allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
966some systems. 1297on some systems or setgid to root or to some other group on others.
967 1298
968=head1 COLORS AND GRAPHICS 1299=head1 COLORS AND GRAPHICS
969 1300
970In addition to the default foreground and background colours, 1301In addition to the default foreground and background colours,
971B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1302B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
1014 1345
1015=back 1346=back
1016 1347
1017=head1 ENVIRONMENT 1348=head1 ENVIRONMENT
1018 1349
1019B<@@RXVT_NAME@@> sets the environment variables B<TERM>, B<COLORTERM> 1350B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1020and B<COLORFGBG>. The environment variable B<WINDOWID> is set to the X 1351
1021window id number of the B<@@RXVT_NAME@@> window and it also uses and 1352=over 4
1022sets the environment variable B<DISPLAY> to specify which display 1353
1023terminal to use. B<@@RXVT_NAME@@> uses the environment variables 1354=item B<TERM>
1024B<RXVTPATH> and B<PATH> to find XPM files. 1355
1356Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1357resources or on the commandline.
1358
1359=item B<COLORTERM>
1360
1361Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was
1362compiled with XPM support, and optionally with the added extension
1363C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.
1364
1365=item B<COLORFGBG>
1366
1367Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1368the colour code used as default foreground/text colour (or the string
1369C<default> to indicate that the default-colour escape sequence is to be
1370used), C<bg> is the colour code used as default background colour (or the
1371string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1372was compiled with XPM support. Libraries like C<ncurses> and C<slang> can
1373(and do) use this information to optimize screen output.
1374
1375=item B<WINDOWID>
1376
1377Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1378window, which usually has subwindows for the scrollbar, the terminal
1379window and so on).
1380
1381=item B<TERMINFO>
1382
1383Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
1384C<--with-terminfo=PATH>.
1385
1386=item B<DISPLAY>
1387
1388Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1389display in it's child processes.
1390
1391=item B<SHELL>
1392
1393The shell to be used for command execution, defaults to C</bin/sh>.
1394
1395=item B<RXVT_SOCKET>
1396
1397The unix domain socket path used by @@RXVT_NAME@@c(1) and
1398@@RXVT_NAME@@d(1).
1399
1400Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.
1401
1402=item B<HOME>
1403
1404Used to locate the default directory for the unix domain socket for
1405daemon communications and to locate various resource files (such as
1406C<.Xdefaults>)
1407
1408=item B<XAPPLRESDIR>
1409
1410Directory where various X resource files are being located.
1411
1412=item B<XENVIRONMENT>
1413
1414If set and accessible, gives the name of a X resource file to be loaded by
1415@@RXVT_NAME@@.
1416
1417=back
1025 1418
1026=head1 FILES 1419=head1 FILES
1027 1420
1028=over 4 1421=over 4
1029 1422
1030=item B</etc/utmp>
1031
1032System file for login records.
1033
1034=item B</usr/lib/X11/rgb.txt> 1423=item B</usr/lib/X11/rgb.txt>
1035 1424
1036Color names. 1425Color names.
1037 1426
1038=back 1427=back
1039 1428
1040=head1 SEE ALSO 1429=head1 SEE ALSO
1041 1430
1042@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) 1431@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1043
1044=head1 BUGS
1045
1046Check the BUGS file for an up-to-date list.
1047
1048Cursor change support is not yet implemented.
1049
1050Click-and-drag doesn't work with X11 mouse report overriding.
1051 1432
1052=head1 CURRENT PROJECT COORDINATOR 1433=head1 CURRENT PROJECT COORDINATOR
1053 1434
1054=over 4 1435=over 4
1055 1436
1056=item Project Coordinator 1437=item Project Coordinator
1057 1438
1058@@RXVT_MAINT@@ L<@@RXVT_MAINTEMAIL@@> 1439Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1059 1440
1060=item Web page maintainter 1441L<http://software.schmorp.de/#rxvt-unicode>
1061
1062@@RXVT_WEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@>
1063
1064L<@@RXVT_WEBPAGE@@>
1065 1442
1066=back 1443=back
1067 1444
1068=head1 AUTHORS 1445=head1 AUTHORS
1069 1446
1091 1468
1092Project Coordinator (changes.txt 2.21a to 2.4.5) 1469Project Coordinator (changes.txt 2.21a to 2.4.5)
1093 1470
1094=item Geoff Wing L<< <gcw@pobox.com> >> 1471=item Geoff Wing L<< <gcw@pobox.com> >>
1095 1472
1096Rewrote screen display and text selection routines. Project Coordinator 1473Rewrote screen display and text selection routines.
1474
1097(changes.txt 2.4.6 - rxvt-unicode) 1475Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1098 1476
1099=item Marc Alexander Lehmann L<< <rxvt@schmorp.de> >> 1477=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1100 1478
1101Forked rxvt-unicode, rewrote most of the display code and internal 1479Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1102character handling to store text in unicode, improve xterm 1480extension, random hacks, numerous bugfixes and extensions.
1103compatibility and apply numerous other bugfixes and extensions.
1104 1481
1105Project Coordinator (Changes 1.0 -) 1482Project Coordinator (Changes 1.0 -)
1106 1483
1484=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1485
1486Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
1487
1107=back 1488=back
1108 1489

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines