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.56 by root, Mon Feb 14 18:47:54 2005 UTC vs.
Revision 1.121 by root, Sun Aug 20 02:47:26 2006 UTC

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 19See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of
20frequently asked questions and answer to them and some common 20frequently asked questions and answer to them and some common
21problems. That document is also accessible on the World-Wide-Web at 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>. 22L<http://cvs.schmorp.de/browse/rxvt-unicode/doc/rxvt.7.html>.
23 23
24=head1 RXVT-UNICODE VS. RXVT 24=head1 RXVT-UNICODE VS. RXVT
25 25
26Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode 26Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode
27internally. That means it can store and display most scripts in the 27internally. That means it can store and display most scripts in the
28world. Being a terminal emulator, however, some things are very difficult, 28world. Being a terminal emulator, however, some things are very difficult,
29especially cursive scripts such as arabic, vertically written scripts 29especially cursive scripts such as arabic, vertically written scripts
30like mongolian or scripts requiring extremely complex combining rules, 30like mongolian or scripts requiring extremely complex combining rules,
31like tibetan or devenagari. Don't expect pretty output when using these 31like tibetan or devenagari. Don't expect pretty output when using these
32scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work 32scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
33fine, though. A somewhat difficult case are left-to-right scripts, such 33fine, though. A somewhat difficult case are right-to-left scripts, such
34as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms 34as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms
35belong into the application, not the terminal emulator (too many things -- 35belong into the application, not the terminal emulator (too many things --
36such as cursor-movement while editing -- break otherwise), but that might 36such as cursor-movement while editing -- break otherwise), but that might
37change. 37change.
38 38
39If you are looking for a terminal that supports more exotic scripts, let 39If you are looking for a terminal that supports more exotic scripts, let
40me recommend C<mlterm>, which is a very userfriendly, lean and clean 40me recommend C<mlterm>, which is a very user friendly, lean and clean
41terminal emulator. In fact, the reason rxvt-unicode was born was solely 41terminal emulator. In fact, the reason rxvt-unicode was born was solely
42because the author couldn't get C<mlterm> to use one font for latin1 and 42because the author couldn't get C<mlterm> to use one font for latin1 and
43another for japanese. 43another for japanese.
44 44
45Therefore another design rationale was the use of multiple fonts to 45Therefore another design rationale was the use of multiple fonts to
46display characters: The idea of a single unicode font which many other 46display characters: The idea of a single unicode font which many other
47programs force onto it's users never made sense to me: You should be able 47programs force onto its users never made sense to me: You should be able
48to choose any font for any script freely. 48to choose any font for any script freely.
49 49
50Apart from that, rxvt-unicode is also much better internationalised than 50Apart from that, rxvt-unicode is also much better internationalised than
51it's predecessor, supports things such as XFT and ISO 14755 that are handy 51its predecessor, supports things such as XFT and ISO 14755 that are handy
52in i18n-environments, is faster, and has a lot less bugs than the original 52in i18n-environments, is faster, and has a lot bugs less than the original
53rxvt. This all in addition to dozens of other small improvements. 53rxvt. This all in addition to dozens of other small improvements.
54 54
55It is still faithfully following the original rxvt idea of being lean 55It is still faithfully following the original rxvt idea of being lean
56and nice on resources: for example, you can still configure rxvt-unicode 56and nice on resources: for example, you can still configure rxvt-unicode
57without most of it's features to get a lean binary. It also comes with 57without most of its features to get a lean binary. It also comes with
58a client/daemon pair that lets you open any number of terminal windows 58a client/daemon pair that lets you open any number of terminal windows
59from within a single process, which makes startup time very fast and 59from within a single process, which makes startup time very fast and
60drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and 60drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and
61@@RXVT_NAME@@c(1) (client). 61@@RXVT_NAME@@c(1) (client).
62 62
63It also makes technical information about escape sequences (which have 63It also makes technical information about escape sequences (which have
64been extended) easier accessible: see @@RXVT_NAME@@(7) for technical 64been extended) more accessible: see @@RXVT_NAME@@(7) for technical
65reference documentation (escape sequences etc.). 65reference documentation (escape sequences etc.).
66 66
67=head1 OPTIONS 67=head1 OPTIONS
68 68
69The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed 69The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed
93 93
94Attempt to open a window on the named X display (B<-d> still 94Attempt to open a window on the named X display (B<-d> still
95respected). In the absence of this option, the display specified by the 95respected). In the absence of this option, the display specified by the
96B<DISPLAY> environment variable is used. 96B<DISPLAY> environment variable is used.
97 97
98=item B<-depth> I<bitdepth>
99
100Compile I<xft>: Attempt to find a visual with the given bit depth;
101resource B<depth>.
102
98=item B<-geometry> I<geom> 103=item B<-geometry> I<geom>
99 104
100Window geometry (B<-g> still respected); resource B<geometry>. 105Window geometry (B<-g> still respected); resource B<geometry>.
101 106
102=item B<-rv>|B<+rv> 107=item B<-rv>|B<+rv>
105 110
106=item B<-j>|B<+j> 111=item B<-j>|B<+j>
107 112
108Turn on/off jump scrolling; resource B<jumpScroll>. 113Turn on/off jump scrolling; resource B<jumpScroll>.
109 114
110=item B<-ip>|B<+ip> 115=item B<-ip>|B<+ip> | B<-tr>|B<+tr>
111 116
112Turn on/off inheriting parent window's pixmap. Alternative form is 117Turn on/off inheriting parent window's pixmap. Alternative form is
113B<-tr>; resource B<inheritPixmap>. 118B<-tr>; resource B<inheritPixmap>.
114 119
120I<Please note that transparency of any kind if completely unsupported by
121the author. Don't bug him with installation questions! Read the FAQ (man 7
122@@RXVT_NAME@@)!>
123
115=item B<-fade> I<number> 124=item B<-fade> I<number>
116 125
117Fade the text by the given percentage when focus is lost. resource B<fading>. 126Fade the text by the given percentage when focus is lost. Small values
127fade a little only, 100 completely replaces all colours by the fade
128colour; resource B<fading>.
129
130=item B<-fadecolor> I<colour>
131
132Fade to this colour when fading is used (see B<-fade>). The default colour
133is opaque black. resource B<fadeColor>.
118 134
119=item B<-tint> I<colour> 135=item B<-tint> I<colour>
120 136
121Tint the transparent background pixmap with the given colour when 137Tint the transparent background pixmap with the given colour when
122transparency is enabled with B<-tr> or B<-ip>. See also the B<-sh> 138transparency is enabled with B<-tr> or B<-ip>. This only works for
123option that can be used to brighten or darken the image in addition to 139non-tiled backgrounds, currently. See also the B<-sh> option that can be
124tinting it. 140used to brighten or darken the image in addition to tinting it; resource
141I<tintColor>. Example:
142
143 @@RXVT_NAME@@ -tr -tint blue -sh 40
125 144
126=item B<-sh> 145=item B<-sh>
127 146
128I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent 147I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent
129background image in addition to tinting it (i.e. B<-tint> must be 148background image in addition to tinting it (i.e. B<-tint> must be
162resource B<borderColor>. 181resource B<borderColor>.
163 182
164=item B<-fn> I<fontlist> 183=item B<-fn> I<fontlist>
165 184
166Select the fonts to be used. This is a comma separated list of font names 185Select the fonts to be used. This is a comma separated list of font names
167that are used in turn when trying to display Unicode characters. The 186that are checked in order when trying to find glyphs for characters. The
168first font defines the cell size for characters; other fonts might be 187first font defines the cell size for characters; other fonts might be
169smaller, but not (in general) larger. A (hopefully) reasonable default 188smaller, but not (in general) larger. A (hopefully) reasonable default
170font list is always appended to it. See resource B<font> for more details. 189font list is always appended to it. See resource B<font> for more details.
171 190
172In short, to specify an X11 core font, just specify it's name or prefix it 191In short, to specify an X11 core font, just specify its name or prefix it
173with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>, 192with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
174e.g.: 193e.g.:
175 194
176 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" 195 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
177 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono" 196 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
179See also the question "How does rxvt-unicode choose fonts?" in the FAQ 198See also the question "How does rxvt-unicode choose fonts?" in the FAQ
180section of @@RXVT_NAME@@(7). 199section of @@RXVT_NAME@@(7).
181 200
182=item B<-fb> I<fontlist> 201=item B<-fb> I<fontlist>
183 202
184Compile font-styles: The bold font list to use when bold characters are to 203Compile I<font-styles>: The bold font list to use when B<bold> characters
185be printed. See resource B<boldFont> for details. 204are to be printed. See resource B<boldFont> for details.
186 205
187=item B<-fi> I<fontlist> 206=item B<-fi> I<fontlist>
188 207
189Compile font-styles: The italic font list to use when bold characters are to 208Compile I<font-styles>: The italic font list to use when I<italic>
190be printed. See resource B<italicFont> for details. 209characters are to be printed. See resource B<italicFont> for details.
191 210
192=item B<-fbi> I<fontlist> 211=item B<-fbi> I<fontlist>
193 212
194Compile font-styles: The bold italic font list to use when bold characters are to 213Compile I<font-styles>: The bold italic font list to use when B<< I<bold
195be printed. See resource B<boldItalicFont> for details. 214italic> >> characters are to be printed. See resource B<boldItalicFont>
215for details.
216
217=item B<-is>|B<+is>
218
219Compile I<font-styles>: Bold/Italic font styles imply high intensity
220foreground/background (default). See resource B<intensityStyles> for
221details.
196 222
197=item B<-name> I<name> 223=item B<-name> I<name>
198 224
199Specify the application name under which resources are to be obtained, 225Specify the application name under which resources are to be obtained,
200rather than the default executable file name. Name should not contain 226rather than the default executable file name. Name should not contain
238 264
239Put scrollbar on right/left; resource B<scrollBar_right>. 265Put scrollbar on right/left; resource B<scrollBar_right>.
240 266
241=item B<-st>|B<+st> 267=item B<-st>|B<+st>
242 268
243Display normal (non XTerm/NeXT) scrollbar without/with a trough; 269Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
244resource B<scrollBar_floating>. 270resource B<scrollBar_floating>.
245 271
246=item B<-ptab>|B<+ptab> 272=item B<-ptab>|B<+ptab>
247 273
248If enabled (default), "Horizontal Tab" characters are being stored as 274If enabled (default), "Horizontal Tab" characters are being stored as
279=item B<-bl> 305=item B<-bl>
280 306
281Compile I<frills>: Set MWM hints to request a borderless window, i.e. 307Compile I<frills>: Set MWM hints to request a borderless window, i.e.
282if honoured by the WM, the rxvt-unicode window will not have window 308if honoured by the WM, the rxvt-unicode window will not have window
283decorations; resource B<borderLess>. 309decorations; resource B<borderLess>.
310
311=item B<-override-redirect>
312
313Compile I<frills>: Sets override-redirect on the window; resource
314B<override-redirect>.
315
316=item B<-sbg>
317
318Compile I<frills>: Disable the usage of the built-in block graphics/line
319drawing characters and just rely on what the specified fonts provide. Use
320this if you have a good font and want to use its block graphic glyphs;
321resource B<skipBuiltinGlyphs>.
284 322
285=item B<-lsp> I<number> 323=item B<-lsp> I<number>
286 324
287Compile I<frills>: Lines (pixel height) to insert between each row of 325Compile I<frills>: Lines (pixel height) to insert between each row of
288the display. Useful to work around font rendering problems; resource 326the display. Useful to work around font rendering problems; resource
303given on the command line. If this option is used, it must be the last 341given on the command line. If this option is used, it must be the last
304on the command-line. If there is no B<-e> option then the default is to 342on the command-line. If there is no B<-e> option then the default is to
305run the program specified by the B<SHELL> environment variable or, 343run the program specified by the B<SHELL> environment variable or,
306failing that, I<sh(1)>. 344failing that, I<sh(1)>.
307 345
346Please note that you must specify a program with arguments. If you want to
347run shell commands, you have to specify the shell, like this:
348
349 @@RXVT_NAME@@ -e sh -c "shell commands"
350
308=item B<-title> I<text> 351=item B<-title> I<text>
309 352
310Window title (B<-T> still respected); the default title is the basename 353Window title (B<-T> still respected); the default title is the basename
311of the program specified after the B<-e> option, if any, otherwise the 354of the program specified after the B<-e> option, if any, otherwise the
312application name; resource B<title>. 355application name; resource B<title>.
368=item B<-ssr>|B<+ssr> 411=item B<-ssr>|B<+ssr>
369 412
370Turn on/off secondary screen scroll (default enabled); resource 413Turn on/off secondary screen scroll (default enabled); resource
371B<secondaryScroll>. 414B<secondaryScroll>.
372 415
416=item B<-hold>|B<+hold>
417
418Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
419will not immediately destroy its window when the program executed within
420it exits. Instead, it will wait till it is being killed or closed by the
421user; resource B<hold>.
422
373=item B<-keysym.>I<sym>: I<string> 423=item B<-keysym.>I<sym> I<string>
374 424
375Remap a key symbol. See resource B<keysym>. 425Remap a key symbol. See resource B<keysym>.
376 426
377=item B<-embed>: I<windowid> 427=item B<-embed> I<windowid>
378 428
379Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window, 429Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
380which enables applications to easily embed a terminal. 430which enables applications to easily embed a terminal.
381 431
382Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it 432Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
383shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it 433shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
384quite a bit, so don't expect it to keep some specific state. It's best to 434quite a bit, so don't expect it to keep some specific state. It's best to
385create an extra subwindow for @@RXVT_NAME@@ and leave it alone. 435create an extra subwindow for @@RXVT_NAME@@ and leave it alone.
386 436
437The window will not be destroyed when @@RXVT_NAME@@ exits.
438
387It might be useful to know that @@RXVT_NAME@@ will not close file 439It might be useful to know that @@RXVT_NAME@@ will not close file
388descriptors passed to it (except for stdin/out/err, of course), so you 440descriptors passed to it (except for stdin/out/err, of course), so you
389can use file descriptors to communicate with the programs within the 441can use file descriptors to communicate with the programs within the
390terminal. This works regardless of wether the C<-embed> option was used or 442terminal. This works regardless of whether the C<-embed> option was used or
391not. 443not.
444
445Here is a short Gtk2-perl snippet that illustrates how this option can be
446used (a longer example is in F<doc/embed>):
447
448 my $rxvt = new Gtk2::Socket;
449 $rxvt->signal_connect_after (realize => sub {
450 my $xid = $_[0]->window->get_xid;
451 system "@@RXVT_NAME@@ -embed $xid &";
452 });
453
454=item B<-pty-fd> I<file descriptor>
455
456Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
457pair but instead use the given file descriptor as the tty master. This is
458useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
459without having to run a program within it.
460
461If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
462entries and will not tinker with pty/tty permissions - you have to do that
463yourself if you want that.
464
465As an extremely special case, specifying C<-1> will completely suppress
466pty/tty operations.
467
468Here is a example in perl that illustrates how this option can be used (a
469longer example is in F<doc/pty-fd>):
470
471 use IO::Pty;
472 use Fcntl;
473
474 my $pty = new IO::Pty;
475 fcntl $pty, F_SETFD, 0; # clear close-on-exec
476 system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";
477 close $pty;
478
479 # now communicate with rxvt
480 my $slave = $pty->slave;
481 while (<$slave>) { print $slave "got <$_>\n" }
482
483=item B<-pe> I<string>
484
485Comma-separated list of perl extension scripts to use (or not to use) in
486this terminal instance. See resource B<perl-ext> for details.
392 487
393=back 488=back
394 489
395=head1 RESOURCES (available also as long-options) 490=head1 RESOURCES (available also as long-options)
396 491
397Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long 492Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
398options) compiled into your version. 493options) compiled into your version.
399 494
400There are two different methods that @@RXVT_NAME@@ can use to get the 495You can set and change the resources using X11 tools like B<xrdb>. Many
401Xresource data: using the X libraries (Xrm*-functions) or internal 496distribution do also load settings from the B<~/.Xresources> file when X
402Xresources reader (B<~/.Xdefaults>). For the first method (ie. 497starts. @@RXVT_NAME@@ will consult the following files/resources in order,
403B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the 498with later settings overwriting earlier ones:
404resources using X11 tools like B<xrdb>. Many distribution do also load
405settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
406will consult the following files/resources in order, with later settings
407overwriting earlier ones:
408 499
409 1. system-wide app-defaults file, either locale-dependent OR global 500 1. system-wide app-defaults file, either locale-dependent OR global
410 2. app-defaults file in $XAPPLRESDIR 501 2. app-defaults file in $XAPPLRESDIR
411 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 502 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
412 4. SCREEN_RESOURCES for the current screen 503 4. SCREEN_RESOURCES for the current screen
413 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 504 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
414 505
415If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
416lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
417set in XAPPLOADDIR/URxvt (compile-time defined: usually
418B</usr/lib/X11/app-defaults/URxvt>) and resources set in
419B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.
420Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two 506Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
421class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows 507names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
422resources common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be 508common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
423easily configured, while the class name B<URxvt> allows resources 509configured, while the class name B<URxvt> allows resources unique to
424unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be 510B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
425shared between different B<@@RXVT_NAME@@> configurations. If no 511configurations. If no resources are specified, suitable defaults will
426resources are specified, suitable defaults will be used. Command-line 512be used. Command-line arguments can be used to override resource
427arguments can be used to override resource settings. The following 513settings. The following resources are supported (you might want to
428resources are allowed: 514check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
515extensions not documented here):
429 516
430=over 4 517=over 4
518
519=item B<depth:> I<bitdepth>
520
521Compile I<xft>: Attempt to find a visual with the given bit depth;
522option B<-depth>.
431 523
432=item B<geometry:> I<geom> 524=item B<geometry:> I<geom>
433 525
434Create the window with the specified X window geometry [default 80x24]; 526Create the window with the specified X window geometry [default 80x24];
435option B<-geometry>. 527option B<-geometry>.
509 601
510B<True>: make the background inherit the parent windows' pixmap, giving 602B<True>: make the background inherit the parent windows' pixmap, giving
511artificial transparency. B<False>: do not inherit the parent windows' 603artificial transparency. B<False>: do not inherit the parent windows'
512pixmap. 604pixmap.
513 605
606I<Please note that transparency of any kind if completely unsupported by
607the author. Don't bug him with installation questions!>
608
514=item B<fading:> I<number> 609=item B<fading:> I<number>
515 610
516Fade the text by the given percentage when focus is lost. 611Fade the text by the given percentage when focus is lost; option B<-fade>.
612
613=item B<fadeColor:> I<colour>
614
615Fade to this colour, when fading is used (see B<fading:>). The default
616colour is black; option B<-fadecolor>.
517 617
518=item B<tintColor:> I<colour> 618=item B<tintColor:> I<colour>
519 619
520Tint the transparent background pixmap with the given colour. 620Tint the transparent background pixmap with the given colour; option
621B<-tint>.
521 622
522=item B<shading:> I<number> 623=item B<shading:> I<number>
523 624
524Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 625Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
525image in addition to tinting it. 626image in addition to tinting it.
529Use the specified colour for the scrollbar [default #B2B2B2]. 630Use the specified colour for the scrollbar [default #B2B2B2].
530 631
531=item B<troughColor:> I<colour> 632=item B<troughColor:> I<colour>
532 633
533Use the specified colour for the scrollbar's trough area [default 634Use the specified colour for the scrollbar's trough area [default
534#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 635#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
535 636
536=item B<borderColor:> I<colour> 637=item B<borderColor:> I<colour>
537 638
538The colour of the border around the text area and between the scrollbar 639The colour of the border around the text area and between the scrollbar
539and the text. 640and the text.
548of 1 displays the image without any scaling. A scale of 2 to 9 649of 1 displays the image without any scaling. A scale of 2 to 9
549specifies an integer number of images in that direction. No image will 650specifies an integer number of images in that direction. No image will
550be magnified beyond 10 times its original size. The maximum permitted 651be magnified beyond 10 times its original size. The maximum permitted
551scale is 1000. [default 0x0+50+50] 652scale is 1000. [default 0x0+50+50]
552 653
553=item B<menu:> I<file[;tag]>
554
555Read in the specified menu file (note the `.menu' extension is
556optional) and also optionally specify a starting tag to find. See the
557reference documentation for details on the syntax for the menuBar.
558
559=item B<path:> I<path> 654=item B<path:> I<path>
560 655
561Specify the colon-delimited search path for finding files (XPM and 656Specify the colon-delimited search path for finding XPM files.
562menus), in addition to the paths specified by the B<RXVTPATH> and
563B<PATH> environment variables.
564 657
565=item B<font:> I<fontlist> 658=item B<font:> I<fontlist>
566 659
567Select the fonts to be used. This is a comma separated list of font 660Select the fonts to be used. This is a comma separated list of font names
568names that are used in turn when trying to display Unicode characters. 661that are checked in order when trying to find glyphs for characters. The
569The first font defines the cell size for characters; other fonts might 662first font defines the cell size for characters; other fonts might be
570be smaller, but not larger. A reasonable default font list is always 663smaller, but not (in general) larger. A (hopefully) reasonable default
571appended to it. option B<-fn>. 664font list is always appended to it; option B<-fn>.
572 665
573Each font can either be a standard X11 core font (XLFD) name, with 666Each font can either be a standard X11 core font (XLFD) name, with
574optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>. 667optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
575 668
576In addition, each font can be prefixed with additional hints and 669In addition, each font can be prefixed with additional hints and
578hint currently is C<codeset=codeset-name>, and this is only used for Xft 671hint currently is C<codeset=codeset-name>, and this is only used for Xft
579fonts. 672fonts.
580 673
581For example, this font resource 674For example, this font resource
582 675
583 URxvt*font: 9x15bold,\ 676 URxvt.font: 9x15bold,\
584 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\ 677 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
585 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \ 678 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
586 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ 679 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
587 xft:Code2000:antialias=false 680 xft:Code2000:antialias=false
588 681
622not possible, replacement fonts of the desired shape will be tried. 715not possible, replacement fonts of the desired shape will be tried.
623 716
624If set, but empty, then this specific style is disabled and the normal 717If set, but empty, then this specific style is disabled and the normal
625text font will being used for the given style. 718text font will being used for the given style.
626 719
720=item B<intensityStyles:> I<boolean>
721
722When font styles are not enabled, or this option is enabled (B<True>,
723option B<-is>, the default), bold and italic font styles imply high
724intensity foreground/background colours. Disabling this option (B<False>,
725option B<+is>) disables this behaviour, the high intensity colours are not
726reachable.
727
627=item B<selectstyle:> I<mode> 728=item B<selectstyle:> I<mode>
628 729
629Set mouse selection style to B<old> which is 2.20, B<oldword> which is 730Set mouse selection style to B<old> which is 2.20, B<oldword> which is
630xterm style with 2.20 old word selection, or anything else which gives 731xterm style with 2.20 old word selection, or anything else which gives
631xterm style selection. 732xterm style selection.
632 733
633=item B<scrollstyle:> I<mode> 734=item B<scrollstyle:> I<mode>
634 735
635Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is 736Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
636the author's favourite.. 737the author's favourite.
637 738
638=item B<title:> I<string> 739=item B<title:> I<string>
639 740
640Set window title string, the default title is the command-line 741Set window title string, the default title is the command-line
641specified after the B<-e> option, if any, otherwise the application 742specified after the B<-e> option, if any, otherwise the application
673 774
674Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use 775Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use
675B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or 776B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or
676B<Shift-Print> to include the scrollback as well. 777B<Shift-Print> to include the scrollback as well.
677 778
779The string will be interpreted as if typed into the shell as-is.
780
781Example:
782
783 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
784
785This creates a new file in your home directory with the screen contents
786every time you hit C<Print>.
787
678=item B<scrollBar:> I<boolean> 788=item B<scrollBar:> I<boolean>
679 789
680B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 790B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
681disable the scrollbar; option B<+sb>. 791disable the scrollbar; option B<+sb>.
682 792
702B<+si>. 812B<+si>.
703 813
704=item B<scrollWithBuffer:> I<boolean> 814=item B<scrollWithBuffer:> I<boolean>
705 815
706B<True>: scroll with scrollback buffer when tty receives new lines (and 816B<True>: scroll with scrollback buffer when tty receives new lines (and
707B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll 817B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
708with scrollback buffer when tty recieves new lines; option B<-sw>. 818with scrollback buffer when tty receives new lines; option B<+sw>.
709 819
710=item B<scrollTtyKeypress:> I<boolean> 820=item B<scrollTtyKeypress:> I<boolean>
711 821
712B<True>: scroll to bottom when a non-special key is pressed. Special keys 822B<True>: scroll to bottom when a non-special key is pressed. Special keys
713are those which are intercepted by rxvt-unicode for special handling and 823are those which are intercepted by rxvt-unicode for special handling and
732=item B<borderLess:> I<boolean> 842=item B<borderLess:> I<boolean>
733 843
734Set MWM hints to request a borderless window, i.e. if honoured by the 844Set MWM hints to request a borderless window, i.e. if honoured by the
735WM, the rxvt-unicode window will not have window decorations; option B<-bl>. 845WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
736 846
847=item B<skipBuiltinGlyphs:> I<boolean>
848
849Compile I<frills>: Disable the usage of the built-in block graphics/line
850drawing characters and just rely on what the specified fonts provide. Use
851this if you have a good font and want to use its block graphic glyphs;
852option B<-sbg>.
853
737=item B<termName:> I<termname> 854=item B<termName:> I<termname>
738 855
739Specifies the terminal type name to be set in the B<TERM> environment 856Specifies the terminal type name to be set in the B<TERM> environment
740variable; option B<-tn>. 857variable; option B<-tn>.
741 858
778 895
779Mouse pointer background colour. 896Mouse pointer background colour.
780 897
781=item B<pointerBlankDelay:> I<number> 898=item B<pointerBlankDelay:> I<number>
782 899
783Specifies number of seconds before blanking the pointer [default 2]. 900Specifies number of seconds before blanking the pointer [default 2]. Use a
901large number (e.g. C<987654321>) to effectively disable the timeout.
784 902
785=item B<backspacekey:> I<string> 903=item B<backspacekey:> I<string>
786 904
787The string to send when the backspace key is pressed. If set to B<DEC> 905The string to send when the backspace key is pressed. If set to B<DEC>
788or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace> 906or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>
795pressed. If unset it will send the sequence traditionally associated 913pressed. If unset it will send the sequence traditionally associated
796with the B<Execute> key. 914with the B<Execute> key.
797 915
798=item B<cutchars:> I<string> 916=item B<cutchars:> I<string>
799 917
800The characters used as delimiters for double-click word selection. The 918The characters used as delimiters for double-click word selection
801built-in default: 919(whitespace delimiting is added automatically if resource is given).
920
921When the selection extension is in use (the default if compiled in, see
922the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these characters
923will be created (if the resource exists, otherwise, no regex will be
924created). In this mode, characters outside ISO-8859-1 can be used.
925
926When the selection extension is not used, only ISO-8859-1 characters can
927be used. If not specified, the built-in default is used:
802 928
803B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 929B<< BACKSLASH `"'&()*,;<=>?@[]{|} >>
804 930
805=item B<preeditType:> I<style> 931=item B<preeditType:> I<style>
806 932
813=item B<imLocale:> I<name> 939=item B<imLocale:> I<name>
814 940
815The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g. 941The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
816C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the 942C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
817input extension to be able to input japanese characters while staying in 943input extension to be able to input japanese characters while staying in
818another locale. option B<-imlocale>. 944another locale; option B<-imlocale>.
819 945
820=item B<imFont:> I<fontset> 946=item B<imFont:> I<fontset>
821 947
822Specify the font-set used for XIM styles C<OverTheSpot> or 948Specify the font-set used for XIM styles C<OverTheSpot> or
823C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated 949C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
828 954
829=item B<tripleclickwords:> I<boolean> 955=item B<tripleclickwords:> I<boolean>
830 956
831Change the meaning of triple-click selection with the left mouse 957Change the meaning of triple-click selection with the left mouse
832button. Instead of selecting a full line it will extend the selection to 958button. Instead of selecting a full line it will extend the selection to
833the end of the logical line only. option B<-tcw>. 959the end of the logical line only; option B<-tcw>.
834 960
835=item B<insecure:> I<boolean> 961=item B<insecure:> I<boolean>
836 962
837Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 963Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
838echo arbitrary strings like the icon name or the locale. This could be 964echo arbitrary strings like the icon name or the locale. This could be
839abused if somebody gets 8-bit-clean access to your display, whether 965abused if somebody gets 8-bit-clean access to your display, whether
840throuh a mail client displaying mail bodies unfiltered or though 966through a mail client displaying mail bodies unfiltered or through
841write(1). Therefore, these sequences are disabled by default. (Note 967write(1) or any other means. Therefore, these sequences are disabled by
842that other terminals, including xterm, have these sequences 968default. (Note that many other terminals, including xterm, have these
843enabled by default). You can enable them by setting this boolean 969sequences enabled by default, which doesn't make it safer, though).
844resource or specifying B<-insecure> as an option. At the moment, this 970
845enabled display-answer, locale, findfont, icon label and window title 971You can enable them by setting this boolean resource or specifying
846requests as well as dynamic menubar dispatch. 972B<-insecure> as an option. At the moment, this enables display-answer,
973locale, findfont, icon label and window title requests.
847 974
848=item B<modifier:> I<modifier> 975=item B<modifier:> I<modifier>
849 976
850Set the key to be interpreted as the Meta key to: B<alt>, B<meta>, 977Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
851B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option 978B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
855 982
856Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E) 983Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
857character is passed through. It may contain escape values as described 984character is passed through. It may contain escape values as described
858in the entry on B<keysym> following. 985in the entry on B<keysym> following.
859 986
860=item B<secondaryScreen:> I<bool> 987=item B<secondaryScreen:> I<boolean>
861 988
862Turn on/off secondary screen (default enabled). 989Turn on/off secondary screen (default enabled).
863 990
864=item B<secondaryScroll:> I<bool> 991=item B<secondaryScroll:> I<boolean>
865 992
866Turn on/off secondary screen scroll (default enabled). If the this 993Turn on/off secondary screen scroll (default enabled). If the this
867option is enabled, scrolls on the secondary screen will change the 994option is enabled, scrolls on the secondary screen will change the
868scrollback buffer and switching to/from the secondary screen will 995scrollback buffer and switching to/from the secondary screen will
869instead scroll the screen up. 996instead scroll the screen up.
997
998=item B<hold>: I<boolean>
999
1000Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1001will not immediately destroy its window when the program executed within
1002it exits. Instead, it will wait till it is being killed or closed by the
1003user.
870 1004
871=item B<keysym.>I<sym>: I<string> 1005=item B<keysym.>I<sym>: I<string>
872 1006
873Compile I<frills>: Associate I<string> with keysym I<sym>. The 1007Compile I<frills>: Associate I<string> with keysym I<sym>. The
874intervening resource name B<keysym.> cannot be omitted. 1008intervening resource name B<keysym.> cannot be omitted.
892 1026
893I<string> may contain escape values (C<\a>: bell, C<\b>: backspace, 1027I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,
894C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, 1028C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,
895C<\000>: octal number) or verbatim control characters (C<^?>: delete, 1029C<\000>: octal number) or verbatim control characters (C<^?>: delete,
896C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it 1030C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
897can start or end with whitespace. 1031can start or end with whitespace. B<This feature is deprecated and will
1032be removed>.
898 1033
899Please note that you need to double the C<\> when using 1034Please note that you need to double the C<\> in resource files, as
900C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can 1035Xlib itself does its own de-escaping (you can use C<\033> instead of
901use C<\033> instead of C<\e> (and so on), which will work with both Xt and 1036C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
902@@RXVT_NAME@@'s own processing). 1037processing).
903 1038
904You can define a range of keysyms in one shot by providing a I<string> 1039You can define a range of keysyms in one shot by providing a I<string>
905with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' 1040with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
906should be a character not used by the strings. 1041should be a character not used by the strings.
907 1042
908Its usage can be demonstrated by an example: 1043Its usage can be demonstrated by an example:
909 1044
910 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1045 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
920example the following means "change the current locale to C<zh_CN.GBK> 1055example the following means "change the current locale to C<zh_CN.GBK>
921when Control-Meta-c is being pressed": 1056when Control-Meta-c is being pressed":
922 1057
923 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1058 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
924 1059
1060If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1061is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)
1062manpage. For example, the F<selection> extension (activated via
1063C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1064
1065 URxvt.keysym.M-C-c: perl:selection:rot13
1066
1067Due the the large number of modifier combinations, a defined key mapping
1068will match if at I<at least> the specified identifiers are being set, and
1069no other key mappings with those and more bits are being defined. That
1070means that defining a key map for C<a> will automatically provide
1071definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1072mappings themselves.
1073
1074Unfortunately, this will override built-in key mappings. For example
1075if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s
1076C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the
1077user-defined keymap using the C<builtin:> replacement:
1078
1079 URxvt.keysym.Insert: <my insert key sequence>
1080 URxvt.keysym.S-Insert: builtin:
1081
1082The first line defines a mapping for C<Insert> and I<any> combination
1083of modifiers. The second line re-establishes the default mapping for
1084C<Shift-Insert>.
1085
925The following example will map Control-Meta-1 and Control-Meta-2 to 1086The following example will map Control-Meta-1 and Control-Meta-2 to
926the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited 1087the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
927font-switching at runtime: 1088font-switching at runtime:
928 1089
929 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 1090 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
932Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more 1093Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
933info): 1094info):
934 1095
935 URxvt.keysym.M-C-3: command:\033[8;25;80t 1096 URxvt.keysym.M-C-3: command:\033[8;25;80t
936 URxvt.keysym.M-C-4: command:\033[8;48;110t 1097 URxvt.keysym.M-C-4: command:\033[8;48;110t
1098
1099=item B<perl-ext-common>: I<string>
1100
1101=item B<perl-ext>: I<string>
1102
1103Comma-separated list(s) of perl extension scripts (default: C<default>) to
1104use in this terminal instance; option B<-pe>.
1105
1106Extension names can be prefixed with a C<-> sign to prohibit using
1107them. This can be useful to selectively disable some extensions loaded
1108by default, or specified via the C<perl-ext-common> resource. For
1109example, C<default,-selection> will use all the default extension except
1110C<selection>.
1111
1112Extension names can also be followed by an argument in angle brackets
1113(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
1114searchable scrollback to Alt/Meta-s). Mentioning the same extension
1115multiple times with different arguments will pass multiple arguments to
1116the extension.
1117
1118Each extension is looked up in the library directories, loaded if
1119necessary, and bound to the current terminal instance.
1120
1121If both of these resources are the empty string, then the perl
1122interpreter will not be initialized. The idea behind two options is that
1123B<perl-ext-common> will be used for extensions that should be available to
1124all instances, while B<perl-ext> is used for specific instances.
1125
1126=item B<perl-eval>: I<string>
1127
1128Perl code to be evaluated when all extensions have been registered. See
1129the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource
1130will be ignored when running setuid/setgid.
1131
1132=item B<perl-lib>: I<path>
1133
1134Colon-separated list of additional directories that hold extension
1135scripts. When looking for extensions specified by the C<perl> resource,
1136@@RXVT_NAME@@ will first look in these directories and then in
1137F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
1138will be ignored when running setuid/setgid.
1139
1140See the @@RXVT_NAME@@perl(3) manpage.
1141
1142=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1143
1144Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
1145details.
1146
1147=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1148
1149Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1150for details.
1151
1152=item B<searchable-scrollback:> I<keysym>
1153
1154Sets the hotkey that starts the incremental scrollback buffer search
1155(default: C<M-s>).
1156
1157=item B<urlLauncher>: I<string>
1158
1159Specifies the program to be started with a URL argument. Used by the
1160C<selection-popup> and C<mark-urls> perl extensions.
1161
1162=item B<transient-for>: I<windowid>
1163
1164Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1165
1166=item B<override-redirect>: I<boolean>
1167
1168Compile I<frills>: Sets override-redirect for the terminal window, making
1169it almost invisible to window managers; option B<-override-redirect>.
937 1170
938=back 1171=back
939 1172
940=head1 THE SCROLLBAR 1173=head1 THE SCROLLBAR
941 1174
976to select a word; Left triple-click to select the entire logical line 1209to select a word; Left triple-click to select the entire logical line
977(which can span multiple screen lines), unless modified by resource 1210(which can span multiple screen lines), unless modified by resource
978B<tripleclickwords>. 1211B<tripleclickwords>.
979 1212
980Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys) 1213Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
981(Compile: I<frills>) will create a rectangular selection instead of a normal 1214(Compile: I<frills>) will create a rectangular selection instead of a
982one. 1215normal one. In this mode, every selected row becomes its own line in the
1216selection, and trailing whitespace is visually underlined and removed from
1217the selection.
983 1218
984=item B<Insertion>: 1219=item B<Insertion>:
985 1220
986Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1221Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
987an B<@@RXVT_NAME@@> window causes the current text selection to be 1222window causes the value of the PRIMARY selection (or CLIPBOARD with the
988inserted as if it had been typed on the keyboard. 1223Meta modifier) to be inserted as if it had been typed on the keyboard.
1224
1225Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1226inserted too.
989 1227
990=back 1228=back
991 1229
992=head1 CHANGING FONTS 1230=head1 CHANGING FONTS
993 1231
994Changing fonts (or font sizes, respectively) via the keypad is not yet 1232Changing fonts (or font sizes, respectively) via the keypad is not yet
995supported in rxvt-unicode. Bug me if you need this. 1233supported in rxvt-unicode. Bug me if you need this.
996 1234
997You can, however, switch fonts at runtime using escape sequences (and 1235You can, however, switch fonts at runtime using escape sequences, e.g.:
998therefore using the menubar), e.g.:
999 1236
1000 printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic" 1237 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1238
1239You can use keyboard shortcuts, too:
1240
1241 URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
1242 URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1001 1243
1002rxvt-unicode will automatically re-apply these fonts to the output so far. 1244rxvt-unicode will automatically re-apply these fonts to the output so far.
1003 1245
1004=head1 ISO 14755 SUPPORT 1246=head1 ISO 14755 SUPPORT
1005 1247
1033This mode lets you input characters representing the keycap symbols of 1275This mode lets you input characters representing the keycap symbols of
1034your keyboard, if representable in the current locale encoding. 1276your keyboard, if representable in the current locale encoding.
1035 1277
1036Start by pressing C<Control> and C<Shift> together, then releasing 1278Start by pressing C<Control> and C<Shift> together, then releasing
1037them. The next special key (cursor keys, home etc.) you enter will not 1279them. The next special key (cursor keys, home etc.) you enter will not
1038invoke it's usual function but instead will insert the corresponding 1280invoke its usual function but instead will insert the corresponding
1039keycap symbol. The symbol will only be entered when the key has been 1281keycap symbol. The symbol will only be entered when the key has been
1040released, otherwise pressing e.g. C<Shift> would enter the symbol for 1282released, otherwise pressing e.g. C<Shift> would enter the symbol for
1041C<ISO Level 2 Switch>, although your intention might have been to enter a 1283C<ISO Level 2 Switch>, although your intention might have been to enter a
1042reverse tab (Shift-Tab). 1284reverse tab (Shift-Tab).
1043 1285
1076=head1 COLORS AND GRAPHICS 1318=head1 COLORS AND GRAPHICS
1077 1319
1078In addition to the default foreground and background colours, 1320In addition to the default foreground and background colours,
1079B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1321B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
1080high-intensity bold/blink versions of the same). Here is a list of the 1322high-intensity bold/blink versions of the same). Here is a list of the
1081colours with their B<rgb.txt> names. 1323colours with their names.
1082 1324
1083=begin table 1325=begin table
1084 1326
1085 B<color0> (black) = Black 1327 B<color0> (black) = Black
1086 B<color1> (red) = Red3 1328 B<color1> (red) = Red3
1106It is also possible to specify the colour values of B<foreground>, 1348It is also possible to specify the colour values of B<foreground>,
1107B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1349B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1108a number 0-15, as a convenient shorthand to reference the colour name of 1350a number 0-15, as a convenient shorthand to reference the colour name of
1109color0-color15. 1351color0-color15.
1110 1352
1353In addition to the colours defined above, @@RXVT_NAME@@ offers an
1354additional 72 colours. The first 64 of those (with indices 16 to 79)
1355consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
135616>), followed by 8 additional shades of gray (with indices 80 to 87).
1357
1358Together, all those colours implement the 88 colour xterm colours. Only
1359the first 16 can be changed using resources currently, the rest can only
1360be changed via command sequences ("escape codes").
1361
1111Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1362Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1112always swapping the foreground/background colours. This is in contrast to 1363always swapping the foreground/background colours. This is in contrast to
1113I<xterm>(1) where the colours are only swapped if they have not otherwise 1364I<xterm>(1) where the colours are only swapped if they have not otherwise
1114been specified. For example, 1365been specified. For example,
1115 1366
1120would yield White on Black, while on I<xterm>(1) it would yield Black 1371would yield White on Black, while on I<xterm>(1) it would yield Black
1121on White. 1372on White.
1122 1373
1123=back 1374=back
1124 1375
1376=head2 ALPHA CHANNEL SUPPORT
1377
1378If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1379their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>
1380(recommended, but B<MUST> have 4 digits/component) colour specifications,
1381in addition to the ones provided by X, where the additional A component
1382specifies opacity (alpha) values. The minimum value of C<0> is completely
1383transparent). You can also prefix any color with C<[a]>, where C<a> is on
1384to four hex digits specifiying the opacity value.
1385
1386You probably need to specify B<"-depth 32">, too, and have the luck that
1387your X-server uses ARGB pixel layout, as X is far from just supporting
1388ARGB visuals out of the box, and rxvt-unicode just fudges around.
1389
1390For example, the following selects an almost completely transparent red
1391background, and an almost opaque pink foreground:
1392
1393 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/2222 -fg "[e]pink"
1394
1395I<Please note that transparency of any kind if completely unsupported by
1396the author. Don't bug him with installation questions!>
1397
1125=head1 ENVIRONMENT 1398=head1 ENVIRONMENT
1126 1399
1127B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1400B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1128 1401
1129=over 4 1402=over 4
1130 1403
1131=item B<TERM> 1404=item B<TERM>
1132 1405
1133Normally set to C<rxvt-unicode>, unless overwritten at configure time, via 1406Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1134resources or on the commandline. 1407resources or on the command line.
1135 1408
1136=item B<COLORTERM> 1409=item B<COLORTERM>
1137 1410
1138Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was 1411Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1139compiled with XPM support, and optionally with the added extension 1412compiled with XPM support, and optionally with the added extension
1140C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. 1413C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.
1141 1414
1142=item B<COLORFGBG> 1415=item B<COLORFGBG>
1143 1416
1161C<--with-terminfo=PATH>. 1434C<--with-terminfo=PATH>.
1162 1435
1163=item B<DISPLAY> 1436=item B<DISPLAY>
1164 1437
1165Used by @@RXVT_NAME@@ to connect to the display and set to the correct 1438Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1166display in it's child processes. 1439display in its child processes.
1167 1440
1168=item B<SHELL> 1441=item B<SHELL>
1169 1442
1170The shell to be used for command execution, defaults to C</bin/sh>. 1443The shell to be used for command execution, defaults to C</bin/sh>.
1171
1172=item B<RXVTPATH>
1173
1174The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1175files.
1176
1177=item B<PATH>
1178
1179Used in the same way as C<RXVTPATH>.
1180 1444
1181=item B<RXVT_SOCKET> 1445=item B<RXVT_SOCKET>
1182 1446
1183The unix domain socket path used by @@RXVT_NAME@@c(1) and 1447The unix domain socket path used by @@RXVT_NAME@@c(1) and
1184@@RXVT_NAME@@d(1). 1448@@RXVT_NAME@@d(1).
1185 1449
1186Default C<< $HOME/.rxvt-unicode-<nodename >>. 1450Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.
1187 1451
1188=item B<HOME> 1452=item B<HOME>
1189 1453
1190Used to locate the default directory for the unix domain socket for 1454Used to locate the default directory for the unix domain socket for
1191daemon communications and to locate various resource files (such as 1455daemon communications and to locate various resource files (such as
1212 1476
1213=back 1477=back
1214 1478
1215=head1 SEE ALSO 1479=head1 SEE ALSO
1216 1480
1217@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) 1481@@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)
1218
1219=head1 BUGS
1220
1221Check the BUGS file for an up-to-date list.
1222
1223Cursor change support is not yet implemented.
1224
1225Click-and-drag doesn't work with X11 mouse report overriding.
1226 1482
1227=head1 CURRENT PROJECT COORDINATOR 1483=head1 CURRENT PROJECT COORDINATOR
1228 1484
1229=over 4 1485=over 4
1230 1486
1231=item Project Coordinator 1487=item Project Coordinator
1232 1488
1233Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1489Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1234 1490
1235L<http://software.schmorp.de/#rxvt-unicode> 1491L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1236 1492
1237=back 1493=back
1238 1494
1239=head1 AUTHORS 1495=head1 AUTHORS
1240 1496
1262 1518
1263Project Coordinator (changes.txt 2.21a to 2.4.5) 1519Project Coordinator (changes.txt 2.21a to 2.4.5)
1264 1520
1265=item Geoff Wing L<< <gcw@pobox.com> >> 1521=item Geoff Wing L<< <gcw@pobox.com> >>
1266 1522
1267Rewrote screen display and text selection routines. Project Coordinator 1523Rewrote screen display and text selection routines.
1524
1268(changes.txt 2.4.6 - rxvt-unicode) 1525Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1269 1526
1270=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1527=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1271 1528
1272Forked rxvt-unicode, rewrote most of the display code and internal 1529Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1273character handling to store text in unicode, improve xterm 1530extension, random hacks, numerous bugfixes and extensions.
1274compatibility and apply numerous other bugfixes and extensions.
1275 1531
1276Project Coordinator (Changes 1.0 -) 1532Project Coordinator (Changes 1.0 -)
1277 1533
1534=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1535
1536Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
1537
1278=back 1538=back
1279 1539

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines