ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.1.man.in
(Generate patch)

Comparing rxvt-unicode/doc/rxvt.1.man.in (file contents):
Revision 1.3 by root, Mon Jan 17 01:44:51 2005 UTC vs.
Revision 1.59 by root, Tue Feb 21 01:00:40 2006 UTC

… …
36. ds PI pi 36. ds PI pi
37. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch 37. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
38. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch 38. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
39. ds L" "" 39. ds L" ""
40. ds R" "" 40. ds R" ""
41. ds C` 41. ds C` ""
42. ds C' 42. ds C' ""
43'br\} 43'br\}
44.el\{\ 44.el\{\
45. ds -- \|\(em\| 45. ds -- \|\(em\|
46. ds PI \(*p 46. ds PI \(*p
47. ds L" `` 47. ds L" ``
… …
127.\} 127.\}
128.rm #[ #] #H #V #F C 128.rm #[ #] #H #V #F C
129.\" ======================================================================== 129.\" ========================================================================
130.\" 130.\"
131.IX Title "rxvt 1" 131.IX Title "rxvt 1"
132.TH rxvt 1 "2005-01-17" "4.8" "RXVT-UNICODE" 132.TH rxvt 1 "2006-02-21" "7.6" "RXVT-UNICODE"
133.SH "NAME" 133.SH "NAME"
134rxvt\-unicode (ouR XVT, unicode) \- (a VT102 emulator for the X window system) 134rxvt\-unicode (ouR XVT, unicode) \- (a VT102 emulator for the X window system)
135.SH "SYNOPSIS" 135.SH "SYNOPSIS"
136.IX Header "SYNOPSIS" 136.IX Header "SYNOPSIS"
137\&\fB@@RXVT_NAME@@\fR [options] [\-e command [ args ]] 137\&\fB@@RXVT_NAME@@\fR [options] [\-e command [ args ]]
… …
142require features such as Tektronix 4014 emulation and toolkit-style 142require features such as Tektronix 4014 emulation and toolkit-style
143configurability. As a result, \fBrxvt-unicode\fR uses much less swap space \*(-- 143configurability. As a result, \fBrxvt-unicode\fR uses much less swap space \*(--
144a significant advantage on a machine serving many X sessions. 144a significant advantage on a machine serving many X sessions.
145.SH "FREQUENTLY ASKED QUESTIONS" 145.SH "FREQUENTLY ASKED QUESTIONS"
146.IX Header "FREQUENTLY ASKED QUESTIONS" 146.IX Header "FREQUENTLY ASKED QUESTIONS"
147See @@RXVT_NAME@@(7) (try \f(CW\*(C`man 7 @@RXVT_NAME@@\*(C'\fR) for a list of frequently 147See @@RXVT_NAME@@(7) (try \f(CW\*(C`man 7 @@RXVT_NAME@@\*(C'\fR) for a list of
148asked questions and answer to them and some common problems. 148frequently asked questions and answer to them and some common
149problems. That document is also accessible on the World-Wide-Web at
150<http://cvs.schmorp.de/browse/*checkout*/rxvt\-unicode/doc/rxvt.7.html>.
149.SH "RXVT-UNICODE VS. RXVT" 151.SH "RXVT-UNICODE VS. RXVT"
150.IX Header "RXVT-UNICODE VS. RXVT" 152.IX Header "RXVT-UNICODE VS. RXVT"
151Unlike the original rxvt, \fBrxvt-unicode\fR stores all text in Unicode 153Unlike the original rxvt, \fBrxvt-unicode\fR stores all text in Unicode
152internally. That means it can store and display most scripts in the 154internally. That means it can store and display most scripts in the
153world. Being a terminal emulator, however, some things are very difficult, 155world. Being a terminal emulator, however, some things are very difficult,
… …
212.IP "\fB\-display\fR \fIdisplayname\fR" 4 214.IP "\fB\-display\fR \fIdisplayname\fR" 4
213.IX Item "-display displayname" 215.IX Item "-display displayname"
214Attempt to open a window on the named X display (\fB\-d\fR still 216Attempt to open a window on the named X display (\fB\-d\fR still
215respected). In the absence of this option, the display specified by the 217respected). In the absence of this option, the display specified by the
216\&\fB\s-1DISPLAY\s0\fR environment variable is used. 218\&\fB\s-1DISPLAY\s0\fR environment variable is used.
219.IP "\fB\-depth\fR \fIbitdepth\fR" 4
220.IX Item "-depth bitdepth"
221Compile \fIxft\fR: Attempt to find a visual with the given bit depth;
222resource \fBdepth\fR.
217.IP "\fB\-geometry\fR \fIgeom\fR" 4 223.IP "\fB\-geometry\fR \fIgeom\fR" 4
218.IX Item "-geometry geom" 224.IX Item "-geometry geom"
219Window geometry (\fB\-g\fR still respected); resource \fBgeometry\fR. 225Window geometry (\fB\-g\fR still respected); resource \fBgeometry\fR.
220.IP "\fB\-rv\fR|\fB+rv\fR" 4 226.IP "\fB\-rv\fR|\fB+rv\fR" 4
221.IX Item "-rv|+rv" 227.IX Item "-rv|+rv"
222Turn on/off simulated reverse video; resource \fBreverseVideo\fR. 228Turn on/off simulated reverse video; resource \fBreverseVideo\fR.
223.IP "\fB\-j\fR|\fB+j\fR" 4 229.IP "\fB\-j\fR|\fB+j\fR" 4
224.IX Item "-j|+j" 230.IX Item "-j|+j"
225Turn on/off jump scrolling; resource \fBjumpScroll\fR. 231Turn on/off jump scrolling; resource \fBjumpScroll\fR.
226.IP "\fB\-ip\fR|\fB+ip\fR" 4 232.IP "\fB\-ip\fR|\fB+ip\fR | \fB\-tr\fR|\fB+tr\fR" 4
227.IX Item "-ip|+ip" 233.IX Item "-ip|+ip | -tr|+tr"
228Turn on/off inheriting parent window's pixmap. Alternative form is 234Turn on/off inheriting parent window's pixmap. Alternative form is
229\&\fB\-tr\fR; resource \fBinheritPixmap\fR. 235\&\fB\-tr\fR; resource \fBinheritPixmap\fR.
236.Sp
237\&\fIPlease note that transparency of any kind if completely unsupported by
238the author. Don't bug him with installation questions!\fR
230.IP "\fB\-fade\fR \fInumber\fR" 4 239.IP "\fB\-fade\fR \fInumber\fR" 4
231.IX Item "-fade number" 240.IX Item "-fade number"
232Fade the text by the given percentage when focus is lost. resource \fBfading\fR. 241Fade the text by the given percentage when focus is lost. Small values
242fade a little only, 100 completely replaces all colours by the fade
243colour; resource \fBfading\fR.
244.IP "\fB\-fadecolor\fR \fIcolour\fR" 4
245.IX Item "-fadecolor colour"
246Fade to this colour when fading is used (see \fB\-fade\fR). The default colour
247is opaque black. resource \fBfadeColor\fR.
233.IP "\fB\-tint\fR \fIcolour\fR" 4 248.IP "\fB\-tint\fR \fIcolour\fR" 4
234.IX Item "-tint colour" 249.IX Item "-tint colour"
235Tint the transparent background pixmap with the given colour when 250Tint the transparent background pixmap with the given colour when
236transparency is enabled with \fB\-tr\fR or \fB\-ip\fR. See also the \fB\-sh\fR 251transparency is enabled with \fB\-tr\fR or \fB\-ip\fR. This only works for
237option that can be used to brighten or darken the image in addition to 252non-tiled backgrounds, currently. See also the \fB\-sh\fR option that can be
238tinting it. 253used to brighten or darken the image in addition to tinting it; resource
254\&\fItintColor\fR. Example:
255.Sp
256.Vb 1
257\& @@RXVT_NAME@@ -tr -tint blue -sh 40
258.Ve
239.IP "\fB\-sh\fR" 4 259.IP "\fB\-sh\fR" 4
240.IX Item "-sh" 260.IX Item "-sh"
241\&\fInumber\fR Darken (0 .. 100) or lighten (\-1 .. \-100) the transparent 261\&\fInumber\fR Darken (0 .. 100) or lighten (\-1 .. \-100) the transparent
242background image in addition to tinting it (i.e. \fB\-tint\fR must be 262background image in addition to tinting it (i.e. \fB\-tint\fR must be
243specified, too, e.g. \f(CW\*(C`\-tint white\*(C'\fR). 263specified, too, e.g. \f(CW\*(C`\-tint white\*(C'\fR).
… …
267The colour of the border around the text area and between the scrollbar and the text; 287The colour of the border around the text area and between the scrollbar and the text;
268resource \fBborderColor\fR. 288resource \fBborderColor\fR.
269.IP "\fB\-fn\fR \fIfontlist\fR" 4 289.IP "\fB\-fn\fR \fIfontlist\fR" 4
270.IX Item "-fn fontlist" 290.IX Item "-fn fontlist"
271Select the fonts to be used. This is a comma separated list of font names 291Select the fonts to be used. This is a comma separated list of font names
272that are used in turn when trying to display Unicode characters. The 292that are checked in order when trying to find glyphs for characters. The
273first font defines the cell size for characters; other fonts might be 293first font defines the cell size for characters; other fonts might be
274smaller, but not (in general) larger. A (hopefully) reasonable default 294smaller, but not (in general) larger. A (hopefully) reasonable default
275font list is always appended to it. See resource \fBfont\fR for more details. 295font list is always appended to it. See resource \fBfont\fR for more details.
276.Sp 296.Sp
277In short, to specify an X11 core font, just specify it's name or prefix it 297In short, to specify an X11 core font, just specify it's name or prefix it
… …
285.Sp 305.Sp
286See also the question \*(L"How does rxvt-unicode choose fonts?\*(R" in the \s-1FAQ\s0 306See also the question \*(L"How does rxvt-unicode choose fonts?\*(R" in the \s-1FAQ\s0
287section of @@RXVT_NAME@@(7). 307section of @@RXVT_NAME@@(7).
288.IP "\fB\-fb\fR \fIfontlist\fR" 4 308.IP "\fB\-fb\fR \fIfontlist\fR" 4
289.IX Item "-fb fontlist" 309.IX Item "-fb fontlist"
290Compile font\-styles: The bold font list to use when bold characters are to 310Compile \fIfont-styles\fR: The bold font list to use when \fBbold\fR characters
291be printed. See resource \fBboldFont\fR for details. 311are to be printed. See resource \fBboldFont\fR for details.
292.IP "\fB\-fi\fR \fIfontlist\fR" 4 312.IP "\fB\-fi\fR \fIfontlist\fR" 4
293.IX Item "-fi fontlist" 313.IX Item "-fi fontlist"
294Compile font\-styles: The italic font list to use when bold characters are to 314Compile \fIfont-styles\fR: The italic font list to use when \fIitalic\fR
295be printed. See resource \fBitalicFont\fR for details. 315characters are to be printed. See resource \fBitalicFont\fR for details.
296.IP "\fB\-fbi\fR \fIfontlist\fR" 4 316.IP "\fB\-fbi\fR \fIfontlist\fR" 4
297.IX Item "-fbi fontlist" 317.IX Item "-fbi fontlist"
298Compile font\-styles: The bold italic font list to use when bold characters are to 318Compile \fIfont-styles\fR: The bold italic font list to use when \fB\f(BIbold
299be printed. See resource \fBboldItalicFont\fR for details. 319italic\fB\fR characters are to be printed. See resource \fBboldItalicFont\fR
320for details.
321.IP "\fB\-is\fR|\fB+is\fR" 4
322.IX Item "-is|+is"
323Compile \fIfont-styles\fR: Bold/Italic font styles imply high intensity
324foreground/background (default). See resource \fBintensityStyles\fR for
325details.
300.IP "\fB\-name\fR \fIname\fR" 4 326.IP "\fB\-name\fR \fIname\fR" 4
301.IX Item "-name name" 327.IX Item "-name name"
302Specify the application name under which resources are to be obtained, 328Specify the application name under which resources are to be obtained,
303rather than the default executable file name. Name should not contain 329rather than the default executable file name. Name should not contain
304`.' or `*' characters. Also sets the icon and title name. 330`.' or `*' characters. Also sets the icon and title name.
… …
332.IP "\fB\-sr\fR|\fB+sr\fR" 4 358.IP "\fB\-sr\fR|\fB+sr\fR" 4
333.IX Item "-sr|+sr" 359.IX Item "-sr|+sr"
334Put scrollbar on right/left; resource \fBscrollBar_right\fR. 360Put scrollbar on right/left; resource \fBscrollBar_right\fR.
335.IP "\fB\-st\fR|\fB+st\fR" 4 361.IP "\fB\-st\fR|\fB+st\fR" 4
336.IX Item "-st|+st" 362.IX Item "-st|+st"
337Display normal (non XTerm/NeXT) scrollbar without/with a trough; 363Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
338resource \fBscrollBar_floating\fR. 364resource \fBscrollBar_floating\fR.
339.IP "\fB\-ptab\fR|\fB+ptab\fR" 4 365.IP "\fB\-ptab\fR|\fB+ptab\fR" 4
340.IX Item "-ptab|+ptab" 366.IX Item "-ptab|+ptab"
341If enabled (default), \*(L"Horizontal Tab\*(R" characters are being stored as 367If enabled (default), \*(L"Horizontal Tab\*(R" characters are being stored as
342actual wide characters in the screen buffer, which makes it possible to 368actual wide characters in the screen buffer, which makes it possible to
… …
366.IP "\fB\-bl\fR" 4 392.IP "\fB\-bl\fR" 4
367.IX Item "-bl" 393.IX Item "-bl"
368Compile \fIfrills\fR: Set \s-1MWM\s0 hints to request a borderless window, i.e. 394Compile \fIfrills\fR: Set \s-1MWM\s0 hints to request a borderless window, i.e.
369if honoured by the \s-1WM\s0, the rxvt-unicode window will not have window 395if honoured by the \s-1WM\s0, the rxvt-unicode window will not have window
370decorations; resource \fBborderLess\fR. 396decorations; resource \fBborderLess\fR.
397.IP "\fB\-override\-redirect\fR" 4
398.IX Item "-override-redirect"
399Compile \fIfrills\fR: Sets override-redirect on the window; resource
400\&\fBoverride-redirect\fR.
401.IP "\fB\-sbg\fR" 4
402.IX Item "-sbg"
403Compile \fIfrills\fR: Disable the usage of the built-in block graphics/line
404drawing characters and just rely on what the specified fonts provide. Use
405this if you have a good font and want to use its block graphic glyphs;
406resource \fBskipBuiltinGlyphs\fR.
371.IP "\fB\-lsp\fR \fInumber\fR" 4 407.IP "\fB\-lsp\fR \fInumber\fR" 4
372.IX Item "-lsp number" 408.IX Item "-lsp number"
373Compile \fIfrills\fR: Lines (pixel height) to insert between each row of 409Compile \fIfrills\fR: Lines (pixel height) to insert between each row of
374the display. Useful to work around font rendering problems; resource 410the display. Useful to work around font rendering problems; resource
375\&\fBlinespace\fR. 411\&\fBlinespace\fR.
… …
386the program being executed if neither \fI\-title\fR (\fI\-T\fR) nor \fI\-n\fR are 422the program being executed if neither \fI\-title\fR (\fI\-T\fR) nor \fI\-n\fR are
387given on the command line. If this option is used, it must be the last 423given on the command line. If this option is used, it must be the last
388on the command\-line. If there is no \fB\-e\fR option then the default is to 424on the command\-line. If there is no \fB\-e\fR option then the default is to
389run the program specified by the \fB\s-1SHELL\s0\fR environment variable or, 425run the program specified by the \fB\s-1SHELL\s0\fR environment variable or,
390failing that, \fI\fIsh\fI\|(1)\fR. 426failing that, \fI\fIsh\fI\|(1)\fR.
427.Sp
428Please note that you must specify a program with arguments. If you want to
429run shell commands, you have to specify the shell, like this:
430.Sp
431.Vb 1
432\& @@RXVT_NAME@@ -e sh -c "shell commands"
433.Ve
391.IP "\fB\-title\fR \fItext\fR" 4 434.IP "\fB\-title\fR \fItext\fR" 4
392.IX Item "-title text" 435.IX Item "-title text"
393Window title (\fB\-T\fR still respected); the default title is the basename 436Window title (\fB\-T\fR still respected); the default title is the basename
394of the program specified after the \fB\-e\fR option, if any, otherwise the 437of the program specified after the \fB\-e\fR option, if any, otherwise the
395application name; resource \fBtitle\fR. 438application name; resource \fBtitle\fR.
… …
408.IP "\fB\-im\fR \fItext\fR" 4 451.IP "\fB\-im\fR \fItext\fR" 4
409.IX Item "-im text" 452.IX Item "-im text"
410Compile \fI\s-1XIM\s0\fR: input method name. resource \fBinputMethod\fR. 453Compile \fI\s-1XIM\s0\fR: input method name. resource \fBinputMethod\fR.
411.IP "\fB\-imlocale\fR \fIstring\fR" 4 454.IP "\fB\-imlocale\fR \fIstring\fR" 4
412.IX Item "-imlocale string" 455.IX Item "-imlocale string"
413The locale to use for opening the \s-1IM\s0. You can use an \s-1LC_CTYPE\s0 of e.g. 456The locale to use for opening the \s-1IM\s0. You can use an \f(CW\*(C`LC_CTYPE\*(C'\fR of e.g.
414de_DE.UTF\-8 for normal text processing but ja_JP.EUC\-JP for the input 457\&\f(CW\*(C`de_DE.UTF\-8\*(C'\fR for normal text processing but \f(CW\*(C`ja_JP.EUC\-JP\*(C'\fR for the
415extension to be able to input japanese characters while staying in 458input extension to be able to input japanese characters while staying in
416another locale. 459another locale. resource \fBimLocale\fR.
460.IP "\fB\-imfont\fR \fIfontset\fR" 4
461.IX Item "-imfont fontset"
462Set the font set to use for the X Input Method, see resource \fBimFont\fR
463for more info.
464.IP "\fB\-tcw\fR" 4
465.IX Item "-tcw"
466Change the meaning of triple-click selection with the left mouse
467button. Instead of selecting a full line it will extend the selection the
468end of the logical line only. resource \fBtripleclickwords\fR.
417.IP "\fB\-insecure\fR" 4 469.IP "\fB\-insecure\fR" 4
418.IX Item "-insecure" 470.IX Item "-insecure"
419Enable \*(L"insecure\*(R" mode, which currently enables most of the escape 471Enable \*(L"insecure\*(R" mode, which currently enables most of the escape
420sequences that echo strings. See the resource \fBinsecure\fR for more 472sequences that echo strings. See the resource \fBinsecure\fR for more
421info. 473info.
… …
430\&\fBsecondaryScreen\fR. 482\&\fBsecondaryScreen\fR.
431.IP "\fB\-ssr\fR|\fB+ssr\fR" 4 483.IP "\fB\-ssr\fR|\fB+ssr\fR" 4
432.IX Item "-ssr|+ssr" 484.IX Item "-ssr|+ssr"
433Turn on/off secondary screen scroll (default enabled); resource 485Turn on/off secondary screen scroll (default enabled); resource
434\&\fBsecondaryScroll\fR. 486\&\fBsecondaryScroll\fR.
487.IP "\fB\-hold\fR|\fB+hold\fR" 4
488.IX Item "-hold|+hold"
489Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
490will not immediately destroy its window when the program executed within
491it exits. Instead, it will wait till it is being killed or closed by the
492user; resource \fBhold\fR.
493.IP "\fB\-keysym.\fR\fIsym\fR \fIstring\fR" 4
494.IX Item "-keysym.sym string"
495Remap a key symbol. See resource \fBkeysym\fR.
496.IP "\fB\-embed\fR \fIwindowid\fR" 4
497.IX Item "-embed windowid"
498Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window,
499which enables applications to easily embed a terminal.
500.Sp
501Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
502shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
503quite a bit, so don't expect it to keep some specific state. It's best to
504create an extra subwindow for @@RXVT_NAME@@ and leave it alone.
505.Sp
506The window will not be destroyed when @@RXVT_NAME@@ exits.
507.Sp
508It might be useful to know that @@RXVT_NAME@@ will not close file
509descriptors passed to it (except for stdin/out/err, of course), so you
510can use file descriptors to communicate with the programs within the
511terminal. This works regardless of wether the \f(CW\*(C`\-embed\*(C'\fR option was used or
512not.
513.Sp
514Here is a short Gtk2\-perl snippet that illustrates how this option can be
515used (a longer example is in \fIdoc/embed\fR):
516.Sp
517.Vb 5
518\& my $rxvt = new Gtk2::Socket;
519\& $rxvt->signal_connect_after (realize => sub {
520\& my $xid = $_[0]->window->get_xid;
521\& system "@@RXVT_NAME@@ -embed $xid &";
522\& });
523.Ve
524.IP "\fB\-pty\-fd\fR \fIfile descriptor\fR" 4
525.IX Item "-pty-fd file descriptor"
526Tells @@RXVT_NAME@@ \s-1NOT\s0 to execute any commands or create a new pty/tty
527pair but instead use the given filehandle as the tty master. This is
528useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
529without having to run a program within it.
530.Sp
531If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
532entries and will not tinker with pty/tty permissions \- you have to do that
533yourself if you want that.
534.Sp
535As an extremely special case, specifying \f(CW\*(C`\-1\*(C'\fR will completely suppress
536pty/tty operations.
537.Sp
538Here is a example in perl that illustrates how this option can be used (a
539longer example is in \fIdoc/pty\-fd\fR):
540.Sp
541.Vb 2
542\& use IO::Pty;
543\& use Fcntl;
544.Ve
545.Sp
546.Vb 4
547\& my $pty = new IO::Pty;
548\& fcntl $pty, F_SETFD, 0; # clear close-on-exec
549\& system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";
550\& close $pty;
551.Ve
552.Sp
553.Vb 3
554\& # now communicate with rxvt
555\& my $slave = $pty->slave;
556\& while (<$slave>) { print $slave "got <$_>\en" }
557.Ve
435.IP "\fB\-xrm\fR \fIresourcestring\fR" 4 558.IP "\fB\-pe\fR \fIstring\fR" 4
436.IX Item "-xrm resourcestring" 559.IX Item "-pe string"
437No effect on rxvt\-unicode. Simply passes through an argument to be made 560Comma-separated list of perl extension scripts to use (or not to use) in
438available in the instance's argument list. Appears in \fI\s-1WM_COMMAND\s0\fR in 561this terminal instance. See resource \fBperl-ext\fR for details.
439some window managers.
440.SH "RESOURCES (available also as long\-options)" 562.SH "RESOURCES (available also as long\-options)"
441.IX Header "RESOURCES (available also as long-options)" 563.IX Header "RESOURCES (available also as long-options)"
442Note: `@@RXVT_NAME@@ \-\-help' gives a list of all resources (long 564Note: `@@RXVT_NAME@@ \-\-help' gives a list of all resources (long
443options) compiled into your version. 565options) compiled into your version.
444.PP 566.PP
445There are two different methods that @@RXVT_NAME@@ can use to get the 567You can set and change the resources using X11 tools like \fBxrdb\fR. Many
446Xresource data: using the X libraries (Xrm*\-functions) or internal 568distribution do also load settings from the \fB~/.Xresources\fR file when X
447Xresources reader (\fB~/.Xdefaults\fR). For the first method (ie. 569starts. @@RXVT_NAME@@ will consult the following files/resources in order,
448\&\fB@@RXVT_NAME@@ \-h\fR lists \fBXGetDefaults\fR), you can set and change the 570with later settings overwriting earlier ones:
449resources using X11 tools like \fBxset\fR. Many distribution do also load
450settings from the \fB~/.Xresources\fR file when X starts.
451.PP 571.PP
452If compiled with internal Xresources support (i.e. \fB@@RXVT_NAME@@ \-h\fR 572.Vb 5
453lists \fB.Xdefaults\fR) then \fB@@RXVT_NAME@@\fR accepts application defaults 573\& 1. system-wide app-defaults file, either locale-dependent OR global
454set in XAPPLOADDIR/URxvt (compile\-time defined: usually 574\& 2. app-defaults file in $XAPPLRESDIR
455\&\fB/usr/lib/X11/app\-defaults/URxvt\fR) and resources set in 575\& 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
456\&\fB~/.Xdefaults\fR, or \fB~/.Xresources\fR if \fB~/.Xdefaults\fR does not exist. 576\& 4. SCREEN_RESOURCES for the current screen
577\& 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
578.Ve
579.PP
457Note that when reading X resources, \fB@@RXVT_NAME@@\fR recognizes two 580Note that when reading X resources, \fB@@RXVT_NAME@@\fR recognizes two class
458class names: \fBXTerm\fR and \fBURxvt\fR. The class name \fBRxvt\fR allows 581names: \fBRxvt\fR and \fBURxvt\fR. The class name \fBRxvt\fR allows resources
459resources common to both \fB@@RXVT_NAME@@\fR and the original \fIrxvt\fR to be 582common to both \fB@@RXVT_NAME@@\fR and the original \fIrxvt\fR to be easily
460easily configured, while the class name \fBURxvt\fR allows resources 583configured, while the class name \fBURxvt\fR allows resources unique to
461unique to \fB@@RXVT_NAME@@\fR, notably colours and key\-handling, to be 584\&\fB@@RXVT_NAME@@\fR, to be shared between different \fB@@RXVT_NAME@@\fR
462shared between different \fB@@RXVT_NAME@@\fR configurations. If no 585configurations. If no resources are specified, suitable defaults will
463resources are specified, suitable defaults will be used. Command-line 586be used. Command-line arguments can be used to override resource
464arguments can be used to override resource settings. The following 587settings. The following resources are supported (you might want to
465resources are allowed: 588check the @@RXVT_NAME@@\fIperl\fR\|(3) manpage for additional settings by perl
589extensions not documented here):
590.IP "\fBdepth:\fR \fIbitdepth\fR" 4
591.IX Item "depth: bitdepth"
592Compile \fIxft\fR: Attempt to find a visual with the given bit depth;
593option \fB\-depth\fR.
466.IP "\fBgeometry:\fR \fIgeom\fR" 4 594.IP "\fBgeometry:\fR \fIgeom\fR" 4
467.IX Item "geometry: geom" 595.IX Item "geometry: geom"
468Create the window with the specified X window geometry [default 80x24]; 596Create the window with the specified X window geometry [default 80x24];
469option \fB\-geometry\fR. 597option \fB\-geometry\fR.
470.IP "\fBbackground:\fR \fIcolour\fR" 4 598.IP "\fBbackground:\fR \fIcolour\fR" 4
… …
532.IP "\fBinheritPixmap:\fR \fIboolean\fR" 4 660.IP "\fBinheritPixmap:\fR \fIboolean\fR" 4
533.IX Item "inheritPixmap: boolean" 661.IX Item "inheritPixmap: boolean"
534\&\fBTrue\fR: make the background inherit the parent windows' pixmap, giving 662\&\fBTrue\fR: make the background inherit the parent windows' pixmap, giving
535artificial transparency. \fBFalse\fR: do not inherit the parent windows' 663artificial transparency. \fBFalse\fR: do not inherit the parent windows'
536pixmap. 664pixmap.
665.Sp
666\&\fIPlease note that transparency of any kind if completely unsupported by
667the author. Don't bug him with installation questions!\fR
537.IP "\fBfading:\fR \fInumber\fR" 4 668.IP "\fBfading:\fR \fInumber\fR" 4
538.IX Item "fading: number" 669.IX Item "fading: number"
539Fade the text by the given percentage when focus is lost. 670Fade the text by the given percentage when focus is lost; option \fB\-fade\fR.
671.IP "\fBfadeColor:\fR \fIcolour\fR" 4
672.IX Item "fadeColor: colour"
673Fade to this colour, when fading is used (see \fBfading:\fR). The default
674colour is black; option \fB\-fadecolor\fR.
540.IP "\fBtintColor:\fR \fIcolour\fR" 4 675.IP "\fBtintColor:\fR \fIcolour\fR" 4
541.IX Item "tintColor: colour" 676.IX Item "tintColor: colour"
542Tint the transparent background pixmap with the given colour. 677Tint the transparent background pixmap with the given colour; option
678\&\fB\-tint\fR.
543.IP "\fBshading:\fR \fInumber\fR" 4 679.IP "\fBshading:\fR \fInumber\fR" 4
544.IX Item "shading: number" 680.IX Item "shading: number"
545Darken (0 .. 100) or lighten (\-1 .. \-100) the transparent background 681Darken (0 .. 100) or lighten (\-1 .. \-100) the transparent background
546image in addition to tinting it. 682image in addition to tinting it.
547.IP "\fBscrollColor:\fR \fIcolour\fR" 4 683.IP "\fBscrollColor:\fR \fIcolour\fR" 4
548.IX Item "scrollColor: colour" 684.IX Item "scrollColor: colour"
549Use the specified colour for the scrollbar [default #B2B2B2]. 685Use the specified colour for the scrollbar [default #B2B2B2].
550.IP "\fBtroughColor:\fR \fIcolour\fR" 4 686.IP "\fBtroughColor:\fR \fIcolour\fR" 4
551.IX Item "troughColor: colour" 687.IX Item "troughColor: colour"
552Use the specified colour for the scrollbar's trough area [default 688Use the specified colour for the scrollbar's trough area [default
553#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 689#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
554.IP "\fBborderColor:\fR \fIcolour\fR" 4 690.IP "\fBborderColor:\fR \fIcolour\fR" 4
555.IX Item "borderColor: colour" 691.IX Item "borderColor: colour"
556The colour of the border around the text area and between the scrollbar 692The colour of the border around the text area and between the scrollbar
557and the text. 693and the text.
558.IP "\fBbackgroundPixmap:\fR \fIfile[;geom]\fR" 4 694.IP "\fBbackgroundPixmap:\fR \fIfile[;geom]\fR" 4
… …
564centre (percent). A scale of 0 displays the image with tiling. A scale 700centre (percent). A scale of 0 displays the image with tiling. A scale
565of 1 displays the image without any scaling. A scale of 2 to 9 701of 1 displays the image without any scaling. A scale of 2 to 9
566specifies an integer number of images in that direction. No image will 702specifies an integer number of images in that direction. No image will
567be magnified beyond 10 times its original size. The maximum permitted 703be magnified beyond 10 times its original size. The maximum permitted
568scale is 1000. [default 0x0+50+50] 704scale is 1000. [default 0x0+50+50]
569.IP "\fBmenu:\fR \fIfile[;tag]\fR" 4
570.IX Item "menu: file[;tag]"
571Read in the specified menu file (note the `.menu' extension is
572optional) and also optionally specify a starting tag to find. See the
573reference documentation for details on the syntax for the menuBar.
574.IP "\fBpath:\fR \fIpath\fR" 4 705.IP "\fBpath:\fR \fIpath\fR" 4
575.IX Item "path: path" 706.IX Item "path: path"
576Specify the colon-delimited search path for finding files (\s-1XPM\s0 and 707Specify the colon-delimited search path for finding \s-1XPM\s0 files.
577menus), in addition to the paths specified by the \fB\s-1RXVTPATH\s0\fR and
578\&\fB\s-1PATH\s0\fR environment variables.
579.IP "\fBfont:\fR \fIfontlist\fR" 4 708.IP "\fBfont:\fR \fIfontlist\fR" 4
580.IX Item "font: fontlist" 709.IX Item "font: fontlist"
581Select the fonts to be used. This is a comma separated list of font 710Select the fonts to be used. This is a comma separated list of font names
582names that are used in turn when trying to display Unicode characters. 711that are checked in order when trying to find glyphs for characters. The
583The first font defines the cell size for characters; other fonts might 712first font defines the cell size for characters; other fonts might be
584be smaller, but not larger. A reasonable default font list is always 713smaller, but not (in general) larger. A (hopefully) reasonable default
585appended to it. option \fB\-fn\fR. 714font list is always appended to it; option \fB\-fn\fR.
586.Sp 715.Sp
587Each font can either be a standard X11 core font (\s-1XLFD\s0) name, with 716Each font can either be a standard X11 core font (\s-1XLFD\s0) name, with
588optional prefix \f(CW\*(C`x:\*(C'\fR or a Xft font (Compile \fIxft\fR), prefixed with \f(CW\*(C`xft:\*(C'\fR. 717optional prefix \f(CW\*(C`x:\*(C'\fR or a Xft font (Compile \fIxft\fR), prefixed with \f(CW\*(C`xft:\*(C'\fR.
589.Sp 718.Sp
590In addition, each font can be prefixed with additional hints and 719In addition, each font can be prefixed with additional hints and
… …
593fonts. 722fonts.
594.Sp 723.Sp
595For example, this font resource 724For example, this font resource
596.Sp 725.Sp
597.Vb 5 726.Vb 5
598\& URxvt*font: 9x15bold,\e 727\& URxvt.font: 9x15bold,\e
599\& -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\e 728\& -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\e
600\& -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \e 729\& -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \e
601\& [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \e 730\& [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \e
602\& xft:Code2000:antialias=false 731\& xft:Code2000:antialias=false
603.Ve 732.Ve
… …
638\&\*(L"morphing\*(R" the normal text font list into the desired shape. If that is 767\&\*(L"morphing\*(R" the normal text font list into the desired shape. If that is
639not possible, replacement fonts of the desired shape will be tried. 768not possible, replacement fonts of the desired shape will be tried.
640.Sp 769.Sp
641If set, but empty, then this specific style is disabled and the normal 770If set, but empty, then this specific style is disabled and the normal
642text font will being used for the given style. 771text font will being used for the given style.
772.IP "\fBintensityStyles:\fR \fIboolean\fR" 4
773.IX Item "intensityStyles: boolean"
774When font styles are not enabled, or this option is enabled (\fBTrue\fR,
775option \fB\-is\fR, the default), bold and italic font styles imply high
776intensity foreground/backround colours. Disabling this option (\fBFalse\fR,
777option \fB+is\fR) disables this behaviour, the high intensity colours are not
778reachable.
643.IP "\fBselectstyle:\fR \fImode\fR" 4 779.IP "\fBselectstyle:\fR \fImode\fR" 4
644.IX Item "selectstyle: mode" 780.IX Item "selectstyle: mode"
645Set mouse selection style to \fBold\fR which is 2.20, \fBoldword\fR which is 781Set mouse selection style to \fBold\fR which is 2.20, \fBoldword\fR which is
646xterm style with 2.20 old word selection, or anything else which gives 782xterm style with 2.20 old word selection, or anything else which gives
647xterm style selection. 783xterm style selection.
648.IP "\fBscrollstyle:\fR \fImode\fR" 4 784.IP "\fBscrollstyle:\fR \fImode\fR" 4
649.IX Item "scrollstyle: mode" 785.IX Item "scrollstyle: mode"
650Set scrollbar style to \fBrxvt\fR, \fBplain\fR, \fBnext\fR or \fBxterm\fR. \fBplain\fR is 786Set scrollbar style to \fBrxvt\fR, \fBplain\fR, \fBnext\fR or \fBxterm\fR. \fBplain\fR is
651the author's favourite.. 787the author's favourite.
652.IP "\fBtitle:\fR \fIstring\fR" 4 788.IP "\fBtitle:\fR \fIstring\fR" 4
653.IX Item "title: string" 789.IX Item "title: string"
654Set window title string, the default title is the command-line 790Set window title string, the default title is the command-line
655specified after the \fB\-e\fR option, if any, otherwise the application 791specified after the \fB\-e\fR option, if any, otherwise the application
656name; option \fB\-title\fR. 792name; option \fB\-title\fR.
… …
680.IP "\fBprint\-pipe:\fR \fIstring\fR" 4 816.IP "\fBprint\-pipe:\fR \fIstring\fR" 4
681.IX Item "print-pipe: string" 817.IX Item "print-pipe: string"
682Specify a command pipe for vt100 printer [default \fI\fIlpr\fI\|(1)\fR]. Use 818Specify a command pipe for vt100 printer [default \fI\fIlpr\fI\|(1)\fR]. Use
683\&\fBPrint\fR to initiate a screen dump to the printer and \fBCtrl-Print\fR or 819\&\fBPrint\fR to initiate a screen dump to the printer and \fBCtrl-Print\fR or
684\&\fBShift-Print\fR to include the scrollback as well. 820\&\fBShift-Print\fR to include the scrollback as well.
821.Sp
822The string will be interpreted as if typed into the shell as\-is.
823.Sp
824Example:
825.Sp
826.Vb 1
827\& URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
828.Ve
829.Sp
830This creates a new file in your home directory with the screen contents
831everytime you hit \f(CW\*(C`Print\*(C'\fR.
685.IP "\fBscrollBar:\fR \fIboolean\fR" 4 832.IP "\fBscrollBar:\fR \fIboolean\fR" 4
686.IX Item "scrollBar: boolean" 833.IX Item "scrollBar: boolean"
687\&\fBTrue\fR: enable the scrollbar [default]; option \fB\-sb\fR. \fBFalse\fR: 834\&\fBTrue\fR: enable the scrollbar [default]; option \fB\-sb\fR. \fBFalse\fR:
688disable the scrollbar; option \fB+sb\fR. 835disable the scrollbar; option \fB+sb\fR.
689.IP "\fBscrollBar_right:\fR \fIboolean\fR" 4 836.IP "\fBscrollBar_right:\fR \fIboolean\fR" 4
… …
704\&\fBFalse\fR: do not scroll to bottom when tty receives output; option 851\&\fBFalse\fR: do not scroll to bottom when tty receives output; option
705\&\fB+si\fR. 852\&\fB+si\fR.
706.IP "\fBscrollWithBuffer:\fR \fIboolean\fR" 4 853.IP "\fBscrollWithBuffer:\fR \fIboolean\fR" 4
707.IX Item "scrollWithBuffer: boolean" 854.IX Item "scrollWithBuffer: boolean"
708\&\fBTrue\fR: scroll with scrollback buffer when tty receives new lines (and 855\&\fBTrue\fR: scroll with scrollback buffer when tty receives new lines (and
709\&\fBscrollTtyOutput\fR is False); option \fB+sw\fR. \fBFalse\fR: do not scroll 856\&\fBscrollTtyOutput\fR is False); option \fB\-sw\fR. \fBFalse\fR: do not scroll
710with scrollback buffer when tty recieves new lines; option \fB\-sw\fR. 857with scrollback buffer when tty recieves new lines; option \fB+sw\fR.
711.IP "\fBscrollTtyKeypress:\fR \fIboolean\fR" 4 858.IP "\fBscrollTtyKeypress:\fR \fIboolean\fR" 4
712.IX Item "scrollTtyKeypress: boolean" 859.IX Item "scrollTtyKeypress: boolean"
713\&\fBTrue\fR: scroll to bottom when a non-special key is pressed. Special keys 860\&\fBTrue\fR: scroll to bottom when a non-special key is pressed. Special keys
714are those which are intercepted by rxvt-unicode for special handling and 861are those which are intercepted by rxvt-unicode for special handling and
715are not passed onto the shell; option \fB\-sk\fR. \fBFalse\fR: do not scroll to 862are not passed onto the shell; option \fB\-sk\fR. \fBFalse\fR: do not scroll to
… …
728option \fB\-w\fR, \fB\-bw\fR, \fB\-borderwidth\fR. 875option \fB\-w\fR, \fB\-bw\fR, \fB\-borderwidth\fR.
729.IP "\fBborderLess:\fR \fIboolean\fR" 4 876.IP "\fBborderLess:\fR \fIboolean\fR" 4
730.IX Item "borderLess: boolean" 877.IX Item "borderLess: boolean"
731Set \s-1MWM\s0 hints to request a borderless window, i.e. if honoured by the 878Set \s-1MWM\s0 hints to request a borderless window, i.e. if honoured by the
732\&\s-1WM\s0, the rxvt-unicode window will not have window decorations; option \fB\-bl\fR. 879\&\s-1WM\s0, the rxvt-unicode window will not have window decorations; option \fB\-bl\fR.
880.IP "\fBskipBuiltinGlyphs:\fR \fIboolean\fR" 4
881.IX Item "skipBuiltinGlyphs: boolean"
882Compile \fIfrills\fR: Disable the usage of the built-in block graphics/line
883drawing characters and just rely on what the specified fonts provide. Use
884this if you have a good font and want to use its block graphic glyphs;
885option \fB\-sbg\fR.
733.IP "\fBtermName:\fR \fItermname\fR" 4 886.IP "\fBtermName:\fR \fItermname\fR" 4
734.IX Item "termName: termname" 887.IX Item "termName: termname"
735Specifies the terminal type name to be set in the \fB\s-1TERM\s0\fR environment 888Specifies the terminal type name to be set in the \fB\s-1TERM\s0\fR environment
736variable; option \fB\-tn\fR. 889variable; option \fB\-tn\fR.
737.IP "\fBlinespace:\fR \fInumber\fR" 4 890.IP "\fBlinespace:\fR \fInumber\fR" 4
… …
765.IP "\fBpointerColor2:\fR \fIcolour\fR" 4 918.IP "\fBpointerColor2:\fR \fIcolour\fR" 4
766.IX Item "pointerColor2: colour" 919.IX Item "pointerColor2: colour"
767Mouse pointer background colour. 920Mouse pointer background colour.
768.IP "\fBpointerBlankDelay:\fR \fInumber\fR" 4 921.IP "\fBpointerBlankDelay:\fR \fInumber\fR" 4
769.IX Item "pointerBlankDelay: number" 922.IX Item "pointerBlankDelay: number"
770Specifies number of seconds before blanking the pointer [default 2]. 923Specifies number of seconds before blanking the pointer [default 2]. Use a
924large number (e.g. \f(CW987654321\fR) to effectively disable the timeout.
771.IP "\fBbackspacekey:\fR \fIstring\fR" 4 925.IP "\fBbackspacekey:\fR \fIstring\fR" 4
772.IX Item "backspacekey: string" 926.IX Item "backspacekey: string"
773The string to send when the backspace key is pressed. If set to \fB\s-1DEC\s0\fR 927The string to send when the backspace key is pressed. If set to \fB\s-1DEC\s0\fR
774or unset it will send \fBDelete\fR (code 127) or, if shifted, \fBBackspace\fR 928or unset it will send \fBDelete\fR (code 127) or, if shifted, \fBBackspace\fR
775(code 8) \- which can be reversed with the appropriate \s-1DEC\s0 private mode 929(code 8) \- which can be reversed with the appropriate \s-1DEC\s0 private mode
… …
779The string to send when the delete key (not the keypad delete key) is 933The string to send when the delete key (not the keypad delete key) is
780pressed. If unset it will send the sequence traditionally associated 934pressed. If unset it will send the sequence traditionally associated
781with the \fBExecute\fR key. 935with the \fBExecute\fR key.
782.IP "\fBcutchars:\fR \fIstring\fR" 4 936.IP "\fBcutchars:\fR \fIstring\fR" 4
783.IX Item "cutchars: string" 937.IX Item "cutchars: string"
784The characters used as delimiters for double-click word selection. The 938The characters used as delimiters for double-click word selection
785built-in default: 939(whitespace delimiting is added automatically if resource is given).
940.Sp
941When the selection extension is in use (the default if compiled in, see
942the @@RXVT_NAME@@\fIperl\fR\|(3) manpage), a suitable regex using these characters
943will be created (if the resource exists, otherwise, no regex will be
944created). In this mode, characters outside \s-1ISO\-8859\-1\s0 can be used.
945.Sp
946When the selection extension is not used, only \s-1ISO\-8859\-1\s0 characters can
947be used. If not specified, the built-in default is used:
786.Sp 948.Sp
787\&\fB\s-1BACKSLASH\s0 `"'&()*,;<=>?@[]{|}\fR 949\&\fB\s-1BACKSLASH\s0 `"'&()*,;<=>?@[]{|}\fR
788.IP "\fBpreeditType:\fR \fIstyle\fR" 4 950.IP "\fBpreeditType:\fR \fIstyle\fR" 4
789.IX Item "preeditType: style" 951.IX Item "preeditType: style"
790\&\fBOverTheSpot\fR, \fBOffTheSpot\fR, \fBRoot\fR; option \fB\-pt\fR. 952\&\fBOverTheSpot\fR, \fBOffTheSpot\fR, \fBRoot\fR; option \fB\-pt\fR.
791.IP "\fBinputMethod:\fR \fIname\fR" 4 953.IP "\fBinputMethod:\fR \fIname\fR" 4
792.IX Item "inputMethod: name" 954.IX Item "inputMethod: name"
793\&\fIname\fR of inputMethod to use; option \fB\-im\fR. 955\&\fIname\fR of inputMethod to use; option \fB\-im\fR.
794.IP "\fBimLocale:\fR \fIname\fR" 4 956.IP "\fBimLocale:\fR \fIname\fR" 4
795.IX Item "imLocale: name" 957.IX Item "imLocale: name"
796The locale to use for opening the \s-1IM\s0. You can use an \s-1LC_CTYPE\s0 of e.g. 958The locale to use for opening the \s-1IM\s0. You can use an \f(CW\*(C`LC_CTYPE\*(C'\fR of e.g.
797de_DE.UTF\-8 for normal text processing but ja_JP.EUC\-JP for the input 959\&\f(CW\*(C`de_DE.UTF\-8\*(C'\fR for normal text processing but \f(CW\*(C`ja_JP.EUC\-JP\*(C'\fR for the
798extension to be able to input japanese characters while staying in 960input extension to be able to input japanese characters while staying in
799another locale. option \fB\-imlocale\fR. 961another locale; option \fB\-imlocale\fR.
962.IP "\fBimFont:\fR \fIfontset\fR" 4
963.IX Item "imFont: fontset"
964Specify the font-set used for \s-1XIM\s0 styles \f(CW\*(C`OverTheSpot\*(C'\fR or
965\&\f(CW\*(C`OffTheSpot\*(C'\fR. It must be a standard X font set (\s-1XLFD\s0 patterns separated
966by commas), i.e. it's not in the same format as the other font lists used
967in @@RXVT_NAME@@. The default will be set-up to chose *any* suitable found
968found, preferably one or two pixels differing in size to the base font.
969option \fB\-imfont\fR.
970.IP "\fBtripleclickwords:\fR \fIboolean\fR" 4
971.IX Item "tripleclickwords: boolean"
972Change the meaning of triple-click selection with the left mouse
973button. Instead of selecting a full line it will extend the selection to
974the end of the logical line only; option \fB\-tcw\fR.
800.IP "\fBinsecure:\fR \fIboolean\fR" 4 975.IP "\fBinsecure:\fR \fIboolean\fR" 4
801.IX Item "insecure: boolean" 976.IX Item "insecure: boolean"
802Enables \*(L"insecure\*(R" mode. Rxvt-unicode offers some escape sequences that 977Enables \*(L"insecure\*(R" mode. Rxvt-unicode offers some escape sequences that
803echo arbitrary strings like the icon name or the locale. This could be 978echo arbitrary strings like the icon name or the locale. This could be
804abused if somebody gets 8\-bit\-clean access to your display, whether 979abused if somebody gets 8\-bit\-clean access to your display, whether
805throuh a mail client displaying mail bodies unfiltered or though 980through a mail client displaying mail bodies unfiltered or through
806\&\fIwrite\fR\|(1). Therefore, these sequences are disabled by default. (Note 981\&\fIwrite\fR\|(1) or any other means. Therefore, these sequences are disabled by
807that other terminals, including xterm, have these sequences 982default. (Note that many other terminals, including xterm, have these
808enabled by default). You can enable them by setting this boolean 983sequences enabled by default, which doesn't make it safer, though).
809resource or specifying \fB\-insecure\fR as an option. At the moment, this 984.Sp
810enabled display\-answer, locale, findfont, icon label and window title 985You can enable them by setting this boolean resource or specifying
811requests as well as dynamic menubar dispatch. 986\&\fB\-insecure\fR as an option. At the moment, this enables display\-answer,
987locale, findfont, icon label and window title requests.
812.IP "\fBmodifier:\fR \fImodifier\fR" 4 988.IP "\fBmodifier:\fR \fImodifier\fR" 4
813.IX Item "modifier: modifier" 989.IX Item "modifier: modifier"
814Set the key to be interpreted as the Meta key to: \fBalt\fR, \fBmeta\fR, 990Set the key to be interpreted as the Meta key to: \fBalt\fR, \fBmeta\fR,
815\&\fBhyper\fR, \fBsuper\fR, \fBmod1\fR, \fBmod2\fR, \fBmod3\fR, \fBmod4\fR, \fBmod5\fR; option 991\&\fBhyper\fR, \fBsuper\fR, \fBmod1\fR, \fBmod2\fR, \fBmod3\fR, \fBmod4\fR, \fBmod5\fR; option
816\&\fB\-mod\fR. 992\&\fB\-mod\fR.
817.IP "\fBanswerbackString:\fR \fIstring\fR" 4 993.IP "\fBanswerbackString:\fR \fIstring\fR" 4
818.IX Item "answerbackString: string" 994.IX Item "answerbackString: string"
819Specify the reply rxvt-unicode sends to the shell when an \s-1ENQ\s0 (control\-E) 995Specify the reply rxvt-unicode sends to the shell when an \s-1ENQ\s0 (control\-E)
820character is passed through. It may contain escape values as described 996character is passed through. It may contain escape values as described
821in the entry on \fBkeysym\fR following. 997in the entry on \fBkeysym\fR following.
822.IP "\fBsecondaryScreen:\fR \fIbool\fR" 4 998.IP "\fBsecondaryScreen:\fR \fIboolean\fR" 4
823.IX Item "secondaryScreen: bool" 999.IX Item "secondaryScreen: boolean"
824Turn on/off secondary screen (default enabled). 1000Turn on/off secondary screen (default enabled).
825.IP "\fBsecondaryScroll:\fR \fIbool\fR" 4 1001.IP "\fBsecondaryScroll:\fR \fIboolean\fR" 4
826.IX Item "secondaryScroll: bool" 1002.IX Item "secondaryScroll: boolean"
827Turn on/off secondary screen scroll (default enabled). If the this 1003Turn on/off secondary screen scroll (default enabled). If the this
828option is enabled, scrolls on the secondary screen will change the 1004option is enabled, scrolls on the secondary screen will change the
829scrollback buffer and switching to/from the secondary screen will 1005scrollback buffer and switching to/from the secondary screen will
830instead scroll the screen up. 1006instead scroll the screen up.
1007.IP "\fBhold\fR: \fIboolean\fR" 4
1008.IX Item "hold: boolean"
1009Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1010will not immediately destroy its window when the program executed within
1011it exits. Instead, it will wait till it is being killed or closed by the
1012user.
831.IP "\fBkeysym.\fR\fIsym\fR: \fIstring\fR" 4 1013.IP "\fBkeysym.\fR\fIsym\fR: \fIstring\fR" 4
832.IX Item "keysym.sym: string" 1014.IX Item "keysym.sym: string"
833Compile \fIfrills\fR: Associate \fIstring\fR with keysym \fIsym\fR. The 1015Compile \fIfrills\fR: Associate \fIstring\fR with keysym \fIsym\fR. The
834intervening resource name \fBkeysym.\fR cannot be omitted. 1016intervening resource name \fBkeysym.\fR cannot be omitted.
835.Sp 1017.Sp
… …
839and the abbreviated \fBI\fR, \fBK\fR, \fBC\fR, \fBN\fR, \fBS\fR, \fBM\fR, \fBA\fR, \fBL\fR, \fB1\fR, 1021and the abbreviated \fBI\fR, \fBK\fR, \fBC\fR, \fBN\fR, \fBS\fR, \fBM\fR, \fBA\fR, \fBL\fR, \fB1\fR,
840\&\fB2\fR, \fB3\fR, \fB4\fR, \fB5\fR. 1022\&\fB2\fR, \fB3\fR, \fB4\fR, \fB5\fR.
841.Sp 1023.Sp
842The \fBNumLock\fR, \fBMeta\fR and \fBISOLevel3\fR modifiers are usually aliased to 1024The \fBNumLock\fR, \fBMeta\fR and \fBISOLevel3\fR modifiers are usually aliased to
843whatever modifier the NumLock key, Meta/Alt keys or \s-1ISO\s0 Level3 Shift/AltGr 1025whatever modifier the NumLock key, Meta/Alt keys or \s-1ISO\s0 Level3 Shift/AltGr
844keys are being mapped. \fBAppKeypad\fR is a artificial modifier mapped to the 1026keys are being mapped. \fBAppKeypad\fR is a synthetic modifier mapped to the
845current application keymap mode state. 1027current application keymap mode state.
846.Sp 1028.Sp
847The spellings of \fIkey\fR can be obtained by using \fBxev\fR(1) command or 1029The spellings of \fIkey\fR can be obtained by using \fBxev\fR(1) command or
848searching keysym macros from \fB/usr/X11R6/include/X11/keysymdef.h\fR and 1030searching keysym macros from \fB/usr/X11R6/include/X11/keysymdef.h\fR and
849omitting the prefix \fB\s-1XK_\s0\fR. Alternatively you can specify \fIkey\fR by its hex 1031omitting the prefix \fB\s-1XK_\s0\fR. Alternatively you can specify \fIkey\fR by its hex
… …
854\&\f(CW\*(C`\ee\*(C'\fR, \f(CW\*(C`\eE\*(C'\fR: escape, \f(CW\*(C`\en\*(C'\fR: newline, \f(CW\*(C`\er\*(C'\fR: carriage return, \f(CW\*(C`\et\*(C'\fR: tab, 1036\&\f(CW\*(C`\ee\*(C'\fR, \f(CW\*(C`\eE\*(C'\fR: escape, \f(CW\*(C`\en\*(C'\fR: newline, \f(CW\*(C`\er\*(C'\fR: carriage return, \f(CW\*(C`\et\*(C'\fR: tab,
855\&\f(CW\*(C`\e000\*(C'\fR: octal number) or verbatim control characters (\f(CW\*(C`^?\*(C'\fR: delete, 1037\&\f(CW\*(C`\e000\*(C'\fR: octal number) or verbatim control characters (\f(CW\*(C`^?\*(C'\fR: delete,
856\&\f(CW\*(C`^@\*(C'\fR: null, \f(CW\*(C`^A\*(C'\fR ...) and may be enclosed with double quotes so that it 1038\&\f(CW\*(C`^@\*(C'\fR: null, \f(CW\*(C`^A\*(C'\fR ...) and may be enclosed with double quotes so that it
857can start or end with whitespace. 1039can start or end with whitespace.
858.Sp 1040.Sp
1041Please note that you need to double the \f(CW\*(C`\e\*(C'\fR in resource files, as
1042Xlib itself does it's own de-escaping (you can use \f(CW\*(C`\e033\*(C'\fR instead of
1043\&\f(CW\*(C`\ee\*(C'\fR (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1044processing).
1045.Sp
859You can define a range of keysyms in one shot by providing a \fIstring\fR 1046You can define a range of keysyms in one shot by providing a \fIstring\fR
860with pattern \fBlist/PREFIX/MIDDLE/SUFFIX\fR, where the delimeter `/' 1047with pattern \fBlist/PREFIX/MIDDLE/SUFFIX\fR, where the delimeter `/'
861should be a character not used by the strings. 1048should be a character not used by the strings.
862.Sp 1049.Sp
863Its usage can be demonstrated by an example: 1050Its usage can be demonstrated by an example:
864.Sp 1051.Sp
865.Vb 1 1052.Vb 1
866\& URxvt.keysym.M-C-0x61: list|\ee<M-C-|abc|> 1053\& URxvt.keysym.M-C-0x61: list|\e033<M-C-|abc|>
867.Ve 1054.Ve
868.Sp 1055.Sp
869The above line is equivalent to the following three lines: 1056The above line is equivalent to the following three lines:
870.Sp 1057.Sp
871.Vb 3 1058.Vb 3
872\& URxvt.keysym.Meta-Control-0x61: \ee<M-C-a> 1059\& URxvt.keysym.Meta-Control-0x61: \e033<M-C-a>
873\& URxvt.keysym.Meta-Control-0x62: \ee<M-C-b> 1060\& URxvt.keysym.Meta-Control-0x62: \e033<M-C-b>
874\& URxvt.keysym.Meta-Control-0x63: \ee<M-C-c> 1061\& URxvt.keysym.Meta-Control-0x63: \e033<M-C-c>
875.Ve 1062.Ve
876.Sp 1063.Sp
877If \fIstring\fR takes the form of \f(CW\*(C`proto:STRING\*(C'\fR, the specified \fB\s-1STRING\s0\fR is 1064If \fIstring\fR takes the form of \f(CW\*(C`command:STRING\*(C'\fR, the specified \fB\s-1STRING\s0\fR
878interpreted and executed as @@RXVT_NAME@@'s control sequence. For example, 1065is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
879\&\f(CW\*(C`proto:\e033]701;zh_CN.GBK\e007\*(C'\fR means: change the current locale to 1066example the following means "change the current locale to \f(CW\*(C`zh_CN.GBK\*(C'\fR
880\&\f(CW\*(C`zh_CN.GBK\*(C'\fR. 1067when Control-Meta-c is being pressed":
1068.Sp
1069.Vb 1
1070\& URxvt.keysym.M-C-c: command:\e033]701;zh_CN.GBK\e007
1071.Ve
1072.Sp
1073If \fIstring\fR takes the form \f(CW\*(C`perl:STRING\*(C'\fR, then the specified \fB\s-1STRING\s0\fR
1074is passed to the \f(CW\*(C`on_keyboard_command\*(C'\fR perl handler. See the @@RXVT_NAME@@\fIperl\fR\|(3)
1075manpage. For example, the \fIselection\fR extension (activated via
1076\&\f(CW\*(C`@@RXVT_NAME@@ \-pe selection\*(C'\fR) listens for \f(CW\*(C`selection:rot13\*(C'\fR events:
1077.Sp
1078.Vb 1
1079\& URxvt.keysym.M-C-c: perl:selection:rot13
1080.Ve
1081.Sp
1082Due the the large number of modifier combinations, a defined key mapping
1083will match if at \fIat least\fR the specified identifiers are being set, and
1084no other key mappings with those and more bits are being defined. That
1085means that defining a key map for \f(CW\*(C`a\*(C'\fR will automatically provide
1086definitions for \f(CW\*(C`Meta\-a\*(C'\fR, \f(CW\*(C`Shift\-a\*(C'\fR and so on, unless some of those are defined
1087mappings themselves.
1088.Sp
1089Unfortunately, this will override built-in key mappings. For example
1090if you overwrite the \f(CW\*(C`Insert\*(C'\fR key you will disable @@RXVT_NAME@@'s
1091\&\f(CW\*(C`Shift\-Insert\*(C'\fR mapping. To re-enable that, you can poke \*(L"holes\*(R" into the
1092user-defined keymap using the \f(CW\*(C`builtin:\*(C'\fR replacement:
1093.Sp
1094.Vb 2
1095\& URxvt.keysym.Insert: <my insert key sequence>
1096\& URxvt.keysym.S-Insert: builtin:
1097.Ve
1098.Sp
1099The first line defines a mapping for \f(CW\*(C`Insert\*(C'\fR and \fIany\fR combination
1100of modifiers. The second line re-establishes the default mapping for
1101\&\f(CW\*(C`Shift\-Insert\*(C'\fR.
1102.Sp
1103The following example will map Control\-Meta\-1 and Control\-Meta\-2 to
1104the fonts \f(CW\*(C`suxuseuro\*(C'\fR and \f(CW\*(C`9x15bold\*(C'\fR, so you can have some limited
1105font-switching at runtime:
1106.Sp
1107.Vb 2
1108\& URxvt.keysym.M-C-1: command:\e033]50;suxuseuro\e007
1109\& URxvt.keysym.M-C-2: command:\e033]50;9x15bold\e007
1110.Ve
1111.Sp
1112Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1113info):
1114.Sp
1115.Vb 2
1116\& URxvt.keysym.M-C-3: command:\e033[8;25;80t
1117\& URxvt.keysym.M-C-4: command:\e033[8;48;110t
1118.Ve
1119.IP "\fBperl-ext-common\fR: \fIstring\fR" 4
1120.IX Item "perl-ext-common: string"
1121.PD 0
1122.IP "\fBperl-ext\fR: \fIstring\fR" 4
1123.IX Item "perl-ext: string"
1124.PD
1125Comma-separated list(s) of perl extension scripts (default: \f(CW\*(C`default\*(C'\fR) to
1126use in this terminal instance; option \fB\-pe\fR.
1127.Sp
1128Extension names can be prefixed with a \f(CW\*(C`\-\*(C'\fR sign to prohibit using
1129them. This can be useful to selectively disable some extensions loaded
1130by default, or specified via the \f(CW\*(C`perl\-ext\-common\*(C'\fR resource. For
1131example, \f(CW\*(C`default,\-selection\*(C'\fR will use all the default extension except
1132\&\f(CW\*(C`selection\*(C'\fR.
1133.Sp
1134Extension names can also be followed by an argument in angle brackets
1135(e.g. \f(CW\*(C`searchable\-scrollback<M\-s>\*(C'\fR, which binds the hotkey for
1136searchable scorllback to Alt/Meta\-s). Mentioning the same extension
1137multiple times with different arguments will pass multiple arguments to
1138the extension.
1139.Sp
1140Each extension is looked up in the library directories, loaded if
1141necessary, and bound to the current terminal instance.
1142.Sp
1143If both of these resources are the empty string, then the perl
1144interpreter will not be initialized. The idea behind two options is that
1145\&\fBperl-ext-common\fR will be used for extensions that should be available to
1146all instances, while \fBperl-ext\fR is used for specific instances.
1147.IP "\fBperl-eval\fR: \fIstring\fR" 4
1148.IX Item "perl-eval: string"
1149Perl code to be evaluated when all extensions have been registered. See
1150the @@RXVT_NAME@@\fIperl\fR\|(3) manpage. Due to security reasons, this resource
1151will be ignored when running setuid/setgid.
1152.IP "\fBperl-lib\fR: \fIpath\fR" 4
1153.IX Item "perl-lib: path"
1154Colon-separated list of additional directories that hold extension
1155scripts. When looking for extensions specified by the \f(CW\*(C`perl\*(C'\fR resource,
1156@@RXVT_NAME@@ will first look in these directories and then in
1157\&\fI@@RXVT_LIBDIR@@/urxvt/perl/\fR. Due to security reasons, this resource
1158will be ignored when running setuid/setgid.
1159.Sp
1160See the @@RXVT_NAME@@\fIperl\fR\|(3) manpage.
1161.IP "\fBselection.pattern\-\f(BIidx\fB\fR: \fIperl-regex\fR" 4
1162.IX Item "selection.pattern-idx: perl-regex"
1163Additional selection patterns, see the @@RXVT_NAME@@\fIperl\fR\|(3) manpage for
1164details.
1165.IP "\fBselection\-autotransform.\f(BIidx\fB\fR: \fIperl-transform\fR" 4
1166.IX Item "selection-autotransform.idx: perl-transform"
1167Selection auto-transform patterns, see the @@RXVT_NAME@@\fIperl\fR\|(3) manpage
1168for details.
1169.IP "\fBsearchable\-scrollback:\fR \fIkeysym\fR" 4
1170.IX Item "searchable-scrollback: keysym"
1171Sets the hotkey that starts the incremental scrollback buffer search
1172(default: \f(CW\*(C`M\-s\*(C'\fR).
1173.IP "\fBurlLauncher\fR: \fIstring\fR" 4
1174.IX Item "urlLauncher: string"
1175Specifies the program to be started with a \s-1URL\s0 argument. Used by the
1176\&\f(CW\*(C`selection\-popup\*(C'\fR and \f(CW\*(C`mark\-urls\*(C'\fR perl extensions.
1177.IP "\fBtransient-for\fR: \fIwindowid\fR" 4
1178.IX Item "transient-for: windowid"
1179Compile \fIfrills\fR: Sets the \s-1WM_TRANSIENT_FOR\s0 property to the given window id.
1180.IP "\fBoverride-redirect\fR: \fIboolean\fR" 4
1181.IX Item "override-redirect: boolean"
1182Compile \fIfrills\fR: Sets override-redirect for the terminal window, making
1183it almost invisible to window managers; option \fB\-override\-redirect\fR.
881.SH "THE SCROLLBAR" 1184.SH "THE SCROLLBAR"
882.IX Header "THE SCROLLBAR" 1185.IX Header "THE SCROLLBAR"
883Lines of text that scroll off the top of the \fB@@RXVT_NAME@@\fR window 1186Lines of text that scroll off the top of the \fB@@RXVT_NAME@@\fR window
884(resource: \fBsaveLines\fR) and can be scrolled back using the scrollbar 1187(resource: \fBsaveLines\fR) and can be scrolled back using the scrollbar
885or by keystrokes. The normal \fB@@RXVT_NAME@@\fR scrollbar has arrows and 1188or by keystrokes. The normal \fB@@RXVT_NAME@@\fR scrollbar has arrows and
… …
895the normal text selection/insertion, hold either the Shift or the Meta 1198the normal text selection/insertion, hold either the Shift or the Meta
896(Alt) key while performing the desired mouse action. 1199(Alt) key while performing the desired mouse action.
897.PP 1200.PP
898If mouse reporting mode is active, the normal scrollbar actions are 1201If mouse reporting mode is active, the normal scrollbar actions are
899disabled \*(-- on the assumption that we are using a fullscreen 1202disabled \*(-- on the assumption that we are using a fullscreen
900application. Instead, pressing Button1 and Button3 sends \fBESC[6~\fR 1203application. Instead, pressing Button1 and Button3 sends \fB\s-1ESC\s0 [ 6 ~\fR
901(Next) and \fBESC[5~\fR (Prior), respectively. Similarly, clicking on the 1204(Next) and \fB\s-1ESC\s0 [ 5 ~\fR (Prior), respectively. Similarly, clicking on the
902up and down arrows sends \fBESC[A\fR (Up) and \fBESC[B\fR (Down), 1205up and down arrows sends \fB\s-1ESC\s0 [ A\fR (Up) and \fB\s-1ESC\s0 [ B\fR (Down),
903respectively. 1206respectively.
904.SH "TEXT SELECTION AND INSERTION" 1207.SH "TEXT SELECTION AND INSERTION"
905.IX Header "TEXT SELECTION AND INSERTION" 1208.IX Header "TEXT SELECTION AND INSERTION"
906The behaviour of text selection and insertion mechanism is similar to 1209The behaviour of text selection and insertion mechanism is similar to
907\&\fIxterm\fR(1). 1210\&\fIxterm\fR(1).
908.IP "\fBSelection\fR:" 4 1211.IP "\fBSelection\fR:" 4
909.IX Item "Selection:" 1212.IX Item "Selection:"
910Left click at the beginning of the region, drag to the end of the 1213Left click at the beginning of the region, drag to the end of the region
911region and release; Right click to extend the marked region; Left 1214and release; Right click to extend the marked region; Left double-click
912double-click to select a word; Left triple-click to select the entire 1215to select a word; Left triple-click to select the entire logical line
913line. 1216(which can span multiple screen lines), unless modified by resource
1217\&\fBtripleclickwords\fR.
914.Sp 1218.Sp
915Starting a selection while pressing the \fBMeta\fR key (or \fBMeta+Ctrl\fR keys) 1219Starting a selection while pressing the \fBMeta\fR key (or \fBMeta+Ctrl\fR keys)
916(Compile: \fIfrills\fR) will create a rectangular selection instead of a normal 1220(Compile: \fIfrills\fR) will create a rectangular selection instead of a
917one. 1221normal one. In this mode, every selected row becomes its own line in the
1222selection, and trailing whitespace is visually underlined and removed from
1223the selection.
918.IP "\fBInsertion\fR:" 4 1224.IP "\fBInsertion\fR:" 4
919.IX Item "Insertion:" 1225.IX Item "Insertion:"
920Pressing and releasing the Middle mouse button (or \fBShift-Insert\fR) in 1226Pressing and releasing the Middle mouse button in an \fB@@RXVT_NAME@@\fR
921an \fB@@RXVT_NAME@@\fR window causes the current text selection to be 1227window causes the value of the \s-1PRIMARY\s0 selection (or \s-1CLIPBOARD\s0 with the
922inserted as if it had been typed on the keyboard. 1228Meta modifier) to be inserted as if it had been typed on the keyboard.
1229.Sp
1230Pressing \fBShift-Insert\fR causes the value of the \s-1PRIMARY\s0 selection to be
1231inserted too.
923.SH "CHANGING FONTS" 1232.SH "CHANGING FONTS"
924.IX Header "CHANGING FONTS" 1233.IX Header "CHANGING FONTS"
925Changing fonts (or font sizes, respectively) via the keypad is not yet 1234Changing fonts (or font sizes, respectively) via the keypad is not yet
926supported in rxvt\-unicode. Bug me if you need this. 1235supported in rxvt\-unicode. Bug me if you need this.
927.PP 1236.PP
928You can, however, switch fonts at runtime using escape sequences (and 1237You can, however, switch fonts at runtime using escape sequences, e.g.:
929therefore using the menubar), e.g.:
930.PP 1238.PP
931.Vb 1 1239.Vb 1
932\& printf '\ee]701;%s\e007' "9x15bold,xft:Kochi Gothic" 1240\& printf '\ee]710;%s\e007' "9x15bold,xft:Kochi Gothic"
1241.Ve
1242.PP
1243You can use keyboard shortcuts, too:
1244.PP
1245.Vb 2
1246\& URxvt.keysym.M-C-1: command:\e033]710;suxuseuro\e007\e033]711;suxuseuro\e007
1247\& URxvt.keysym.M-C-2: command:\e033]710;9x15bold\e007\e033]711;9x15bold\e007
933.Ve 1248.Ve
934.PP 1249.PP
935rxvt-unicode will automatically re-apply these fonts to the output so far. 1250rxvt-unicode will automatically re-apply these fonts to the output so far.
936.SH "ISO 14755 SUPPORT" 1251.SH "ISO 14755 SUPPORT"
937.IX Header "ISO 14755 SUPPORT" 1252.IX Header "ISO 14755 SUPPORT"
938\&\s-1ISO\s0 14755 is a standard for entering and viewing unicode characters 1253\&\s-1ISO\s0 14755 is a standard for entering and viewing unicode characters
939and character codes using the keyboard. It consists of 4 parts. The 1254and character codes using the keyboard. It consists of 4 parts. The
940first part is available rxvt-unicode has been compiled with 1255first part is available rxvt-unicode has been compiled with
941\&\f(CW\*(C`\-\-enable\-frills\*(C'\fR, the rest is available when rxvt-unicode was compiled 1256\&\f(CW\*(C`\-\-enable\-frills\*(C'\fR, the rest is available when rxvt-unicode was compiled
942with \f(CW\*(C`\-\-enable\-iso14755\*(C'\fR. 1257with \f(CW\*(C`\-\-enable\-iso14755\*(C'\fR.
943.IP "5.1: Basic method" 4 1258.IP "* 5.1: Basic method" 4
944.IX Item "5.1: Basic method" 1259.IX Item "5.1: Basic method"
945This allows you to enter unicode characters using their hexcode. 1260This allows you to enter unicode characters using their hexcode.
946.Sp 1261.Sp
947Start by pressing and holding both \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR, then enter 1262Start by pressing and holding both \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR, then enter
948hex-digits (between one and six). Releasing \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR will 1263hex-digits (between one and six). Releasing \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR will
… …
954As an example of use, imagine a business card with a japanese e\-mail 1269As an example of use, imagine a business card with a japanese e\-mail
955address, which you cannot type. Fortunately, the card has the e\-mail 1270address, which you cannot type. Fortunately, the card has the e\-mail
956address printed as hexcodes, e.g. \f(CW\*(C`671d 65e5\*(C'\fR. You can enter this easily 1271address printed as hexcodes, e.g. \f(CW\*(C`671d 65e5\*(C'\fR. You can enter this easily
957by pressing \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR, followed by \f(CW\*(C`6\-7\-1\-D\-SPACE\-6\-5\-E\-5\*(C'\fR, 1272by pressing \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR, followed by \f(CW\*(C`6\-7\-1\-D\-SPACE\-6\-5\-E\-5\*(C'\fR,
958followed by releasing the modifier keys. 1273followed by releasing the modifier keys.
959.IP "5.2: Keyboard symbols entry method" 4 1274.IP "* 5.2: Keyboard symbols entry method" 4
960.IX Item "5.2: Keyboard symbols entry method" 1275.IX Item "5.2: Keyboard symbols entry method"
961This mode lets you input characters representing the keycap symbols of 1276This mode lets you input characters representing the keycap symbols of
962your keyboard, if representable in the current locale encoding. 1277your keyboard, if representable in the current locale encoding.
963.Sp 1278.Sp
964Start by pressing \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR together, then releasing 1279Start by pressing \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR together, then releasing
… …
966invoke it's usual function but instead will insert the corresponding 1281invoke it's usual function but instead will insert the corresponding
967keycap symbol. The symbol will only be entered when the key has been 1282keycap symbol. The symbol will only be entered when the key has been
968released, otherwise pressing e.g. \f(CW\*(C`Shift\*(C'\fR would enter the symbol for 1283released, otherwise pressing e.g. \f(CW\*(C`Shift\*(C'\fR would enter the symbol for
969\&\f(CW\*(C`ISO Level 2 Switch\*(C'\fR, although your intention might have been to enter a 1284\&\f(CW\*(C`ISO Level 2 Switch\*(C'\fR, although your intention might have been to enter a
970reverse tab (Shift\-Tab). 1285reverse tab (Shift\-Tab).
971.IP "5.3: Screen-selection entry method" 4 1286.IP "* 5.3: Screen-selection entry method" 4
972.IX Item "5.3: Screen-selection entry method" 1287.IX Item "5.3: Screen-selection entry method"
973While this is implemented already (it's basically the selection 1288While this is implemented already (it's basically the selection
974mechanism), it could be extended by displaying a unicode character map. 1289mechanism), it could be extended by displaying a unicode character map.
975.IP "5.4: Feedback method for identifying displayed characters for later input" 4 1290.IP "* 5.4: Feedback method for identifying displayed characters for later input" 4
976.IX Item "5.4: Feedback method for identifying displayed characters for later input" 1291.IX Item "5.4: Feedback method for identifying displayed characters for later input"
977This method lets you display the unicode character code associated with 1292This method lets you display the unicode character code associated with
978characters already displayed. 1293characters already displayed.
979.Sp 1294.Sp
980You enter this mode by holding down \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR together, then 1295You enter this mode by holding down \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR together, then
… …
989.PP 1304.PP
990With respect to conformance, rxvt-unicode is supposed to be compliant to 1305With respect to conformance, rxvt-unicode is supposed to be compliant to
991both scenario A and B of \s-1ISO\s0 14755, including part 5.2. 1306both scenario A and B of \s-1ISO\s0 14755, including part 5.2.
992.SH "LOGIN STAMP" 1307.SH "LOGIN STAMP"
993.IX Header "LOGIN STAMP" 1308.IX Header "LOGIN STAMP"
994\&\fB@@RXVT_NAME@@\fR tries to write an entry into the \fIutmp\fR(5) file so 1309\&\fB@@RXVT_NAME@@\fR tries to write an entry into the \fIutmp\fR(5) file so that
995that it can be seen via the \fI\fIwho\fI\|(1)\fR command, and can accept messages. 1310it can be seen via the \fI\fIwho\fI\|(1)\fR command, and can accept messages. To
996To allow this feature, \fB@@RXVT_NAME@@\fR must be installed setuid root on 1311allow this feature, \fB@@RXVT_NAME@@\fR may need to be installed setuid root
997some systems. 1312on some systems or setgid to root or to some other group on others.
998.SH "COLORS AND GRAPHICS" 1313.SH "COLORS AND GRAPHICS"
999.IX Header "COLORS AND GRAPHICS" 1314.IX Header "COLORS AND GRAPHICS"
1000In addition to the default foreground and background colours, 1315In addition to the default foreground and background colours,
1001\&\fB@@RXVT_NAME@@\fR can display up to 16 colours (8 \s-1ANSI\s0 colours plus 1316\&\fB@@RXVT_NAME@@\fR can display up to 16 colours (8 \s-1ANSI\s0 colours plus
1002high-intensity bold/blink versions of the same). Here is a list of the 1317high-intensity bold/blink versions of the same). Here is a list of the
1003colours with their \fBrgb.txt\fR names. 1318colours with their names.
1004.TS 1319.TS
1005l l l . 1320l l l .
1006color0 (black) = Black 1321color0 (black) = Black
1007color1 (red) = Red3 1322color1 (red) = Red3
1008color2 (green) = Green3 1323color2 (green) = Green3
… …
1027It is also possible to specify the colour values of \fBforeground\fR, 1342It is also possible to specify the colour values of \fBforeground\fR,
1028\&\fBbackground\fR, \fBcursorColor\fR, \fBcursorColor2\fR, \fBcolorBD\fR, \fBcolorUL\fR as 1343\&\fBbackground\fR, \fBcursorColor\fR, \fBcursorColor2\fR, \fBcolorBD\fR, \fBcolorUL\fR as
1029a number 0\-15, as a convenient shorthand to reference the colour name of 1344a number 0\-15, as a convenient shorthand to reference the colour name of
1030color0\-color15. 1345color0\-color15.
1031.PP 1346.PP
1347In addition to the colours defined above, @@RXVT_NAME@@ offers an
1348additional 72 colours. The first 64 of those (with indices 16 to 79)
1349consist of a 4*4*4 \s-1RGB\s0 colour cube (i.e. \fIindex = r * 16 + g * 4 + b +
135016\fR), followed by 8 additional shades of gray (with indices 80 to 87).
1351.PP
1352Together, all those colours implement the 88 colour xterm colours. Only
1353the first 16 can be changed using resources currently, the rest can only
1354be changed via command sequences (\*(L"escape codes\*(R").
1355.PP
1032Note that \fB\-rv\fR (\fB\*(L"reverseVideo: True\*(R"\fR) simulates reverse video by 1356Note that \fB\-rv\fR (\fB\*(L"reverseVideo: True\*(R"\fR) simulates reverse video by
1033always swapping the foreground/background colours. This is in contrast to 1357always swapping the foreground/background colours. This is in contrast to
1034\&\fIxterm\fR(1) where the colours are only swapped if they have not otherwise 1358\&\fIxterm\fR(1) where the colours are only swapped if they have not otherwise
1035been specified. For example, 1359been specified. For example,
1036.IP "\fB@@RXVT_NAME@@ \-fg Black \-bg White \-rv\fR" 4 1360.IP "\fB@@RXVT_NAME@@ \-fg Black \-bg White \-rv\fR" 4
1037.IX Item "@@RXVT_NAME@@ -fg Black -bg White -rv" 1361.IX Item "@@RXVT_NAME@@ -fg Black -bg White -rv"
1038would yield White on Black, while on \fIxterm\fR(1) it would yield Black 1362would yield White on Black, while on \fIxterm\fR(1) it would yield Black
1039on White. 1363on White.
1364.Sh "\s-1ALPHA\s0 \s-1CHANNEL\s0 \s-1SUPPORT\s0"
1365.IX Subsection "ALPHA CHANNEL SUPPORT"
1366If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1367their act together, rxvt-unicode will support \f(CW\*(C`rgba:rrrr/gggg/bbbb/aaaa\*(C'\fR
1368(recommended, but \fB\s-1MUST\s0\fR have 4 digits/component) colour specifications,
1369in addition to the ones provided by X, where the additional A component
1370specifies opacity (alpha) values. The minimum value of \f(CW0\fR is completely
1371transparent). You can also prefix any color with \f(CW\*(C`[a]\*(C'\fR, where \f(CW\*(C`a\*(C'\fR is on
1372to four hex digits specifiying the opacity value.
1373.PP
1374You probably need to specify \fB\*(L"\-depth 32\*(R"\fR, too, and have the luck that
1375your X\-server uses \s-1ARGB\s0 pixel layout, as X is far from just supporting
1376\&\s-1ARGB\s0 visuals out of the box, and rxvt-unicode just fudges around.
1377.PP
1378For example, the following selects an almost completely transparent red
1379background, and an almost opaque pink foreground:
1380.PP
1381.Vb 1
1382\& @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/2222 -fg "[e]pink"
1383.Ve
1384.PP
1385\&\fIPlease note that transparency of any kind if completely unsupported by
1386the author. Don't bug him with installation questions!\fR
1040.SH "ENVIRONMENT" 1387.SH "ENVIRONMENT"
1041.IX Header "ENVIRONMENT" 1388.IX Header "ENVIRONMENT"
1042\&\fB@@RXVT_NAME@@\fR sets the environment variables \fB\s-1TERM\s0\fR, \fB\s-1COLORTERM\s0\fR 1389\&\fB@@RXVT_NAME@@\fR sets and/or uses the following environment variables:
1043and \fB\s-1COLORFGBG\s0\fR. The environment variable \fB\s-1WINDOWID\s0\fR is set to the X 1390.IP "\fB\s-1TERM\s0\fR" 4
1044window id number of the \fB@@RXVT_NAME@@\fR window and it also uses and 1391.IX Item "TERM"
1045sets the environment variable \fB\s-1DISPLAY\s0\fR to specify which display 1392Normally set to \f(CW\*(C`rxvt\-unicode\*(C'\fR, unless overwritten at configure time, via
1046terminal to use. \fB@@RXVT_NAME@@\fR uses the environment variables 1393resources or on the commandline.
1047\&\fB\s-1RXVTPATH\s0\fR and \fB\s-1PATH\s0\fR to find \s-1XPM\s0 files. 1394.IP "\fB\s-1COLORTERM\s0\fR" 4
1395.IX Item "COLORTERM"
1396Either \f(CW\*(C`rxvt\*(C'\fR, \f(CW\*(C`rxvt\-xpm\*(C'\fR, depending on wether @@RXVT_NAME@@ was
1397compiled with \s-1XPM\s0 support, and optionally with the added extension
1398\&\f(CW\*(C`\-mono\*(C'\fR to indicate that rxvt-unicode runs on a monochrome screen.
1399.IP "\fB\s-1COLORFGBG\s0\fR" 4
1400.IX Item "COLORFGBG"
1401Set to a string of the form \f(CW\*(C`fg;bg\*(C'\fR or \f(CW\*(C`fg;xpm;bg\*(C'\fR, where \f(CW\*(C`fg\*(C'\fR is
1402the colour code used as default foreground/text colour (or the string
1403\&\f(CW\*(C`default\*(C'\fR to indicate that the default-colour escape sequence is to be
1404used), \f(CW\*(C`bg\*(C'\fR is the colour code used as default background colour (or the
1405string \f(CW\*(C`default\*(C'\fR), and \f(CW\*(C`xpm\*(C'\fR is the string \f(CW\*(C`default\*(C'\fR if @@RXVT_NAME@@
1406was compiled with \s-1XPM\s0 support. Libraries like \f(CW\*(C`ncurses\*(C'\fR and \f(CW\*(C`slang\*(C'\fR can
1407(and do) use this information to optimize screen output.
1408.IP "\fB\s-1WINDOWID\s0\fR" 4
1409.IX Item "WINDOWID"
1410Set to the (decimal) X Window \s-1ID\s0 of the @@RXVT_NAME@@ window (the toplevel
1411window, which usually has subwindows for the scrollbar, the terminal
1412window and so on).
1413.IP "\fB\s-1TERMINFO\s0\fR" 4
1414.IX Item "TERMINFO"
1415Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
1416\&\f(CW\*(C`\-\-with\-terminfo=PATH\*(C'\fR.
1417.IP "\fB\s-1DISPLAY\s0\fR" 4
1418.IX Item "DISPLAY"
1419Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1420display in it's child processes.
1421.IP "\fB\s-1SHELL\s0\fR" 4
1422.IX Item "SHELL"
1423The shell to be used for command execution, defaults to \f(CW\*(C`/bin/sh\*(C'\fR.
1424.IP "\fB\s-1RXVT_SOCKET\s0\fR" 4
1425.IX Item "RXVT_SOCKET"
1426The unix domain socket path used by @@RXVT_NAME@@c(1) and
1427@@RXVT_NAME@@d(1).
1428.Sp
1429Default \fI$HOME/.rxvt\-unicode\-\fI<nodename\fI\fR.
1430.IP "\fB\s-1HOME\s0\fR" 4
1431.IX Item "HOME"
1432Used to locate the default directory for the unix domain socket for
1433daemon communications and to locate various resource files (such as
1434\&\f(CW\*(C`.Xdefaults\*(C'\fR)
1435.IP "\fB\s-1XAPPLRESDIR\s0\fR" 4
1436.IX Item "XAPPLRESDIR"
1437Directory where various X resource files are being located.
1438.IP "\fB\s-1XENVIRONMENT\s0\fR" 4
1439.IX Item "XENVIRONMENT"
1440If set and accessible, gives the name of a X resource file to be loaded by
1441@@RXVT_NAME@@.
1048.SH "FILES" 1442.SH "FILES"
1049.IX Header "FILES" 1443.IX Header "FILES"
1050.IP "\fB/etc/utmp\fR" 4
1051.IX Item "/etc/utmp"
1052System file for login records.
1053.IP "\fB/usr/lib/X11/rgb.txt\fR" 4 1444.IP "\fB/usr/lib/X11/rgb.txt\fR" 4
1054.IX Item "/usr/lib/X11/rgb.txt" 1445.IX Item "/usr/lib/X11/rgb.txt"
1055Color names. 1446Color names.
1056.SH "SEE ALSO" 1447.SH "SEE ALSO"
1057.IX Header "SEE ALSO" 1448.IX Header "SEE ALSO"
1058@@RXVT_NAME@@(7), \fIxterm\fR\|(1), \fIsh\fR\|(1), \fIresize\fR\|(1), X(1), \fIpty\fR\|(4), \fItty\fR\|(4), \fIutmp\fR\|(5) 1449@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), \fIxterm\fR\|(1), \fIsh\fR\|(1), \fIresize\fR\|(1), X(1), \fIpty\fR\|(4), \fItty\fR\|(4), \fIutmp\fR\|(5)
1059.SH "BUGS"
1060.IX Header "BUGS"
1061Check the \s-1BUGS\s0 file for an up-to-date list.
1062.PP
1063Cursor change support is not yet implemented.
1064.PP
1065Click-and-drag doesn't work with X11 mouse report overriding.
1066.SH "CURRENT PROJECT COORDINATOR" 1450.SH "CURRENT PROJECT COORDINATOR"
1067.IX Header "CURRENT PROJECT COORDINATOR" 1451.IX Header "CURRENT PROJECT COORDINATOR"
1068.IP "Project Coordinator" 4 1452.IP "Project Coordinator" 4
1069.IX Item "Project Coordinator" 1453.IX Item "Project Coordinator"
1070@@RXVT_MAINT@@ @@RXVT_MAINTEMAIL@@ 1454Marc A. Lehmann <rxvt\-unicode@schmorp.de>
1071.IP "Web page maintainter" 4
1072.IX Item "Web page maintainter"
1073@@RXVT_WEBMAINT@@ @@RXVT_WEBMAINTEMAIL@@
1074.Sp 1455.Sp
1075@@RXVT_WEBPAGE@@ 1456<http://software.schmorp.de/#rxvt\-unicode>
1076.SH "AUTHORS" 1457.SH "AUTHORS"
1077.IX Header "AUTHORS" 1458.IX Header "AUTHORS"
1078.IP "John Bovey" 4 1459.IP "John Bovey" 4
1079.IX Item "John Bovey" 1460.IX Item "John Bovey"
1080University of Kent, 1992, wrote the original Xvt. 1461University of Kent, 1992, wrote the original Xvt.
… …
1092.IP "Oezguer Kesim <kesim@math.fu\-berlin.de>" 4 1473.IP "Oezguer Kesim <kesim@math.fu\-berlin.de>" 4
1093.IX Item "Oezguer Kesim <kesim@math.fu-berlin.de>" 1474.IX Item "Oezguer Kesim <kesim@math.fu-berlin.de>"
1094Project Coordinator (changes.txt 2.21a to 2.4.5) 1475Project Coordinator (changes.txt 2.21a to 2.4.5)
1095.IP "Geoff Wing <gcw@pobox.com>" 4 1476.IP "Geoff Wing <gcw@pobox.com>" 4
1096.IX Item "Geoff Wing <gcw@pobox.com>" 1477.IX Item "Geoff Wing <gcw@pobox.com>"
1097Rewrote screen display and text selection routines. Project Coordinator 1478Rewrote screen display and text selection routines.
1479.Sp
1098(changes.txt 2.4.6 \- rxvt\-unicode) 1480Project Coordinator (changes.txt 2.4.6 \- rxvt\-unicode)
1099.IP "Marc Alexander Lehmann <rxvt@schmorp.de>" 4 1481.IP "Marc Alexander Lehmann <rxvt\-unicode@schmorp.de>" 4
1100.IX Item "Marc Alexander Lehmann <rxvt@schmorp.de>" 1482.IX Item "Marc Alexander Lehmann <rxvt-unicode@schmorp.de>"
1101Forked rxvt\-unicode, rewrote most of the display code and internal 1483Forked rxvt\-unicode, unicode support, rewrote almost all the code, perl
1102character handling to store text in unicode, improve xterm 1484extension, random hacks, numerous bugfixes and extensions.
1103compatibility and apply numerous other bugfixes and extensions.
1104.Sp 1485.Sp
1105Project Coordinator (Changes 1.0 \-) 1486Project Coordinator (Changes 1.0 \-)
1487.IP "Emanuele Giaquinta <e.giaquinta@glauco.it>" 4
1488.IX Item "Emanuele Giaquinta <e.giaquinta@glauco.it>"
1489Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines