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.4 by root, Tue Jan 18 01:27:09 2005 UTC vs.
Revision 1.50 by root, Fri Jan 20 16:02:20 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-18" "4.8" "RXVT-UNICODE" 132.TH rxvt 1 "2006-01-20" "7.1" "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,
221.IX Item "-rv|+rv" 223.IX Item "-rv|+rv"
222Turn on/off simulated reverse video; resource \fBreverseVideo\fR. 224Turn on/off simulated reverse video; resource \fBreverseVideo\fR.
223.IP "\fB\-j\fR|\fB+j\fR" 4 225.IP "\fB\-j\fR|\fB+j\fR" 4
224.IX Item "-j|+j" 226.IX Item "-j|+j"
225Turn on/off jump scrolling; resource \fBjumpScroll\fR. 227Turn on/off jump scrolling; resource \fBjumpScroll\fR.
226.IP "\fB\-ip\fR|\fB+ip\fR" 4 228.IP "\fB\-ip\fR|\fB+ip\fR | \fB\-tr\fR|\fB+tr\fR" 4
227.IX Item "-ip|+ip" 229.IX Item "-ip|+ip | -tr|+tr"
228Turn on/off inheriting parent window's pixmap. Alternative form is 230Turn on/off inheriting parent window's pixmap. Alternative form is
229\&\fB\-tr\fR; resource \fBinheritPixmap\fR. 231\&\fB\-tr\fR; resource \fBinheritPixmap\fR.
230.IP "\fB\-fade\fR \fInumber\fR" 4 232.IP "\fB\-fade\fR \fInumber\fR" 4
231.IX Item "-fade number" 233.IX Item "-fade number"
232Fade the text by the given percentage when focus is lost. resource \fBfading\fR. 234Fade the text by the given percentage when focus is lost. Small values
235fade a little only, 100 completely replaces all colours by the fade
236colour; resource \fBfading\fR.
237.IP "\fB\-fadecolor\fR \fIcolour\fR" 4
238.IX Item "-fadecolor colour"
239Fade to this colour when fading is used (see \fB\-fade\fR). The default colour
240is black. resource \fBfadeColor\fR.
233.IP "\fB\-tint\fR \fIcolour\fR" 4 241.IP "\fB\-tint\fR \fIcolour\fR" 4
234.IX Item "-tint colour" 242.IX Item "-tint colour"
235Tint the transparent background pixmap with the given colour when 243Tint 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 244transparency 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 245non-tiled backgrounds, currently. See also the \fB\-sh\fR option that can be
238tinting it. 246used to brighten or darken the image in addition to tinting it; resource
247\&\fItintColor\fR. Example:
248.Sp
249.Vb 1
250\& @@RXVT_NAME@@ -tr -tint blue -sh 40
251.Ve
239.IP "\fB\-sh\fR" 4 252.IP "\fB\-sh\fR" 4
240.IX Item "-sh" 253.IX Item "-sh"
241\&\fInumber\fR Darken (0 .. 100) or lighten (\-1 .. \-100) the transparent 254\&\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 255background image in addition to tinting it (i.e. \fB\-tint\fR must be
243specified, too, e.g. \f(CW\*(C`\-tint white\*(C'\fR). 256specified, 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; 280The colour of the border around the text area and between the scrollbar and the text;
268resource \fBborderColor\fR. 281resource \fBborderColor\fR.
269.IP "\fB\-fn\fR \fIfontlist\fR" 4 282.IP "\fB\-fn\fR \fIfontlist\fR" 4
270.IX Item "-fn fontlist" 283.IX Item "-fn fontlist"
271Select the fonts to be used. This is a comma separated list of font names 284Select 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 285that are checked in order when trying to find glyphs for characters. The
273first font defines the cell size for characters; other fonts might be 286first font defines the cell size for characters; other fonts might be
274smaller, but not (in general) larger. A (hopefully) reasonable default 287smaller, but not (in general) larger. A (hopefully) reasonable default
275font list is always appended to it. See resource \fBfont\fR for more details. 288font list is always appended to it. See resource \fBfont\fR for more details.
276.Sp 289.Sp
277In short, to specify an X11 core font, just specify it's name or prefix it 290In short, to specify an X11 core font, just specify it's name or prefix it
285.Sp 298.Sp
286See also the question \*(L"How does rxvt-unicode choose fonts?\*(R" in the \s-1FAQ\s0 299See also the question \*(L"How does rxvt-unicode choose fonts?\*(R" in the \s-1FAQ\s0
287section of @@RXVT_NAME@@(7). 300section of @@RXVT_NAME@@(7).
288.IP "\fB\-fb\fR \fIfontlist\fR" 4 301.IP "\fB\-fb\fR \fIfontlist\fR" 4
289.IX Item "-fb fontlist" 302.IX Item "-fb fontlist"
290Compile font\-styles: The bold font list to use when bold characters are to 303Compile \fIfont-styles\fR: The bold font list to use when \fBbold\fR characters
291be printed. See resource \fBboldFont\fR for details. 304are to be printed. See resource \fBboldFont\fR for details.
292.IP "\fB\-fi\fR \fIfontlist\fR" 4 305.IP "\fB\-fi\fR \fIfontlist\fR" 4
293.IX Item "-fi fontlist" 306.IX Item "-fi fontlist"
294Compile font\-styles: The italic font list to use when bold characters are to 307Compile \fIfont-styles\fR: The italic font list to use when \fIitalic\fR
295be printed. See resource \fBitalicFont\fR for details. 308characters are to be printed. See resource \fBitalicFont\fR for details.
296.IP "\fB\-fbi\fR \fIfontlist\fR" 4 309.IP "\fB\-fbi\fR \fIfontlist\fR" 4
297.IX Item "-fbi fontlist" 310.IX Item "-fbi fontlist"
298Compile font\-styles: The bold italic font list to use when bold characters are to 311Compile \fIfont-styles\fR: The bold italic font list to use when \fB\f(BIbold
299be printed. See resource \fBboldItalicFont\fR for details. 312italic\fB\fR characters are to be printed. See resource \fBboldItalicFont\fR
313for details.
314.IP "\fB\-is\fR|\fB+is\fR" 4
315.IX Item "-is|+is"
316Compile \fIfont-styles\fR: Bold/Italic font styles imply high intensity
317foreground/background (default). See resource \fBintensityStyles\fR for
318details.
300.IP "\fB\-name\fR \fIname\fR" 4 319.IP "\fB\-name\fR \fIname\fR" 4
301.IX Item "-name name" 320.IX Item "-name name"
302Specify the application name under which resources are to be obtained, 321Specify the application name under which resources are to be obtained,
303rather than the default executable file name. Name should not contain 322rather than the default executable file name. Name should not contain
304`.' or `*' characters. Also sets the icon and title name. 323`.' or `*' characters. Also sets the icon and title name.
332.IP "\fB\-sr\fR|\fB+sr\fR" 4 351.IP "\fB\-sr\fR|\fB+sr\fR" 4
333.IX Item "-sr|+sr" 352.IX Item "-sr|+sr"
334Put scrollbar on right/left; resource \fBscrollBar_right\fR. 353Put scrollbar on right/left; resource \fBscrollBar_right\fR.
335.IP "\fB\-st\fR|\fB+st\fR" 4 354.IP "\fB\-st\fR|\fB+st\fR" 4
336.IX Item "-st|+st" 355.IX Item "-st|+st"
337Display normal (non XTerm/NeXT) scrollbar without/with a trough; 356Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
338resource \fBscrollBar_floating\fR. 357resource \fBscrollBar_floating\fR.
339.IP "\fB\-ptab\fR|\fB+ptab\fR" 4 358.IP "\fB\-ptab\fR|\fB+ptab\fR" 4
340.IX Item "-ptab|+ptab" 359.IX Item "-ptab|+ptab"
341If enabled (default), \*(L"Horizontal Tab\*(R" characters are being stored as 360If enabled (default), \*(L"Horizontal Tab\*(R" characters are being stored as
342actual wide characters in the screen buffer, which makes it possible to 361actual wide characters in the screen buffer, which makes it possible to
366.IP "\fB\-bl\fR" 4 385.IP "\fB\-bl\fR" 4
367.IX Item "-bl" 386.IX Item "-bl"
368Compile \fIfrills\fR: Set \s-1MWM\s0 hints to request a borderless window, i.e. 387Compile \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 388if honoured by the \s-1WM\s0, the rxvt-unicode window will not have window
370decorations; resource \fBborderLess\fR. 389decorations; resource \fBborderLess\fR.
390.IP "\fB\-override\-redirect\fR" 4
391.IX Item "-override-redirect"
392Compile \fIfrills\fR: Sets override-redirect on the window; resource
393\&\fBoverride-redirect\fR.
394.IP "\fB\-sbg\fR" 4
395.IX Item "-sbg"
396Compile \fIfrills\fR: Disable the usage of the built-in block graphics/line
397drawing characters and just rely on what the specified fonts provide. Use
398this if you have a good font and want to use its block graphic glyphs;
399resource \fBskipBuiltinGlyphs\fR.
371.IP "\fB\-lsp\fR \fInumber\fR" 4 400.IP "\fB\-lsp\fR \fInumber\fR" 4
372.IX Item "-lsp number" 401.IX Item "-lsp number"
373Compile \fIfrills\fR: Lines (pixel height) to insert between each row of 402Compile \fIfrills\fR: Lines (pixel height) to insert between each row of
374the display. Useful to work around font rendering problems; resource 403the display. Useful to work around font rendering problems; resource
375\&\fBlinespace\fR. 404\&\fBlinespace\fR.
386the program being executed if neither \fI\-title\fR (\fI\-T\fR) nor \fI\-n\fR are 415the 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 416given 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 417on 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, 418run the program specified by the \fB\s-1SHELL\s0\fR environment variable or,
390failing that, \fI\fIsh\fI\|(1)\fR. 419failing that, \fI\fIsh\fI\|(1)\fR.
420.Sp
421Please note that you must specify a program with arguments. If you want to
422run shell commands, you have to specify the shell, like this:
423.Sp
424.Vb 1
425\& @@RXVT_NAME@@ -e sh -c "shell commands"
426.Ve
391.IP "\fB\-title\fR \fItext\fR" 4 427.IP "\fB\-title\fR \fItext\fR" 4
392.IX Item "-title text" 428.IX Item "-title text"
393Window title (\fB\-T\fR still respected); the default title is the basename 429Window 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 430of the program specified after the \fB\-e\fR option, if any, otherwise the
395application name; resource \fBtitle\fR. 431application name; resource \fBtitle\fR.
408.IP "\fB\-im\fR \fItext\fR" 4 444.IP "\fB\-im\fR \fItext\fR" 4
409.IX Item "-im text" 445.IX Item "-im text"
410Compile \fI\s-1XIM\s0\fR: input method name. resource \fBinputMethod\fR. 446Compile \fI\s-1XIM\s0\fR: input method name. resource \fBinputMethod\fR.
411.IP "\fB\-imlocale\fR \fIstring\fR" 4 447.IP "\fB\-imlocale\fR \fIstring\fR" 4
412.IX Item "-imlocale string" 448.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. 449The 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 450\&\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 451input extension to be able to input japanese characters while staying in
416another locale. 452another locale. resource \fBimLocale\fR.
453.IP "\fB\-imfont\fR \fIfontset\fR" 4
454.IX Item "-imfont fontset"
455Set the font set to use for the X Input Method, see resource \fBimFont\fR
456for more info.
457.IP "\fB\-tcw\fR" 4
458.IX Item "-tcw"
459Change the meaning of triple-click selection with the left mouse
460button. Instead of selecting a full line it will extend the selection the
461end of the logical line only. resource \fBtripleclickwords\fR.
417.IP "\fB\-insecure\fR" 4 462.IP "\fB\-insecure\fR" 4
418.IX Item "-insecure" 463.IX Item "-insecure"
419Enable \*(L"insecure\*(R" mode, which currently enables most of the escape 464Enable \*(L"insecure\*(R" mode, which currently enables most of the escape
420sequences that echo strings. See the resource \fBinsecure\fR for more 465sequences that echo strings. See the resource \fBinsecure\fR for more
421info. 466info.
430\&\fBsecondaryScreen\fR. 475\&\fBsecondaryScreen\fR.
431.IP "\fB\-ssr\fR|\fB+ssr\fR" 4 476.IP "\fB\-ssr\fR|\fB+ssr\fR" 4
432.IX Item "-ssr|+ssr" 477.IX Item "-ssr|+ssr"
433Turn on/off secondary screen scroll (default enabled); resource 478Turn on/off secondary screen scroll (default enabled); resource
434\&\fBsecondaryScroll\fR. 479\&\fBsecondaryScroll\fR.
480.IP "\fB\-hold\fR|\fB+hold\fR" 4
481.IX Item "-hold|+hold"
482Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
483will not immediately destroy its window when the program executed within
484it exits. Instead, it will wait till it is being killed or closed by the
485user; resource \fBhold\fR.
486.IP "\fB\-keysym.\fR\fIsym\fR \fIstring\fR" 4
487.IX Item "-keysym.sym string"
488Remap a key symbol. See resource \fBkeysym\fR.
489.IP "\fB\-embed\fR \fIwindowid\fR" 4
490.IX Item "-embed windowid"
491Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window,
492which enables applications to easily embed a terminal.
493.Sp
494Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
495shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
496quite a bit, so don't expect it to keep some specific state. It's best to
497create an extra subwindow for @@RXVT_NAME@@ and leave it alone.
498.Sp
499The window will not be destroyed when @@RXVT_NAME@@ exits.
500.Sp
501It might be useful to know that @@RXVT_NAME@@ will not close file
502descriptors passed to it (except for stdin/out/err, of course), so you
503can use file descriptors to communicate with the programs within the
504terminal. This works regardless of wether the \f(CW\*(C`\-embed\*(C'\fR option was used or
505not.
506.Sp
507Here is a short Gtk2\-perl snippet that illustrates how this option can be
508used (a longer example is in \fIdoc/embed\fR):
509.Sp
510.Vb 5
511\& my $rxvt = new Gtk2::Socket;
512\& $rxvt->signal_connect_after (realize => sub {
513\& my $xid = $_[0]->window->get_xid;
514\& system "@@RXVT_NAME@@ -embed $xid &";
515\& });
516.Ve
517.IP "\fB\-pty\-fd\fR \fIfile descriptor\fR" 4
518.IX Item "-pty-fd file descriptor"
519Tells @@RXVT_NAME@@ \s-1NOT\s0 to execute any commands or create a new pty/tty
520pair but instead use the given filehandle as the tty master. This is
521useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
522without having to run a program within it.
523.Sp
524If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
525entries and will not tinker with pty/tty permissions \- you have to do that
526yourself if you want that.
527.Sp
528As an extremely special case, specifying \f(CW\*(C`\-1\*(C'\fR will completely suppress
529pty/tty operations.
530.Sp
531Here is a example in perl that illustrates how this option can be used (a
532longer example is in \fIdoc/pty\-fd\fR):
533.Sp
534.Vb 2
535\& use IO::Pty;
536\& use Fcntl;
537.Ve
538.Sp
539.Vb 4
540\& my $pty = new IO::Pty;
541\& fcntl $pty, F_SETFD, 0; # clear close-on-exec
542\& system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";
543\& close $pty;
544.Ve
545.Sp
546.Vb 3
547\& # now communicate with rxvt
548\& my $slave = $pty->slave;
549\& while (<$slave>) { print $slave "got <$_>\en" }
550.Ve
435.IP "\fB\-xrm\fR \fIresourcestring\fR" 4 551.IP "\fB\-pe\fR \fIstring\fR" 4
436.IX Item "-xrm resourcestring" 552.IX Item "-pe string"
437No effect on rxvt\-unicode. Simply passes through an argument to be made 553Comma-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 554this terminal instance. See resource \fBperl-ext\fR for details.
439some window managers.
440.SH "RESOURCES (available also as long\-options)" 555.SH "RESOURCES (available also as long\-options)"
441.IX Header "RESOURCES (available also as long-options)" 556.IX Header "RESOURCES (available also as long-options)"
442Note: `@@RXVT_NAME@@ \-\-help' gives a list of all resources (long 557Note: `@@RXVT_NAME@@ \-\-help' gives a list of all resources (long
443options) compiled into your version. 558options) compiled into your version.
444.PP 559.PP
445There are two different methods that @@RXVT_NAME@@ can use to get the 560You can set and change the resources using X11 tools like \fBxrdb\fR. Many
446Xresource data: using the X libraries (Xrm*\-functions) or internal 561distribution do also load settings from the \fB~/.Xresources\fR file when X
447Xresources reader (\fB~/.Xdefaults\fR). For the first method (ie. 562starts. @@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 563with 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 564.PP
452If compiled with internal Xresources support (i.e. \fB@@RXVT_NAME@@ \-h\fR 565.Vb 5
453lists \fB.Xdefaults\fR) then \fB@@RXVT_NAME@@\fR accepts application defaults 566\& 1. system-wide app-defaults file, either locale-dependent OR global
454set in XAPPLOADDIR/URxvt (compile\-time defined: usually 567\& 2. app-defaults file in $XAPPLRESDIR
455\&\fB/usr/lib/X11/app\-defaults/URxvt\fR) and resources set in 568\& 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. 569\& 4. SCREEN_RESOURCES for the current screen
570\& 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
571.Ve
572.PP
457Note that when reading X resources, \fB@@RXVT_NAME@@\fR recognizes two 573Note 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 574names: \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 575common to both \fB@@RXVT_NAME@@\fR and the original \fIrxvt\fR to be easily
460easily configured, while the class name \fBURxvt\fR allows resources 576configured, while the class name \fBURxvt\fR allows resources unique to
461unique to \fB@@RXVT_NAME@@\fR, notably colours and key\-handling, to be 577\&\fB@@RXVT_NAME@@\fR, to be shared between different \fB@@RXVT_NAME@@\fR
462shared between different \fB@@RXVT_NAME@@\fR configurations. If no 578configurations. If no resources are specified, suitable defaults will
463resources are specified, suitable defaults will be used. Command-line 579be used. Command-line arguments can be used to override resource
464arguments can be used to override resource settings. The following 580settings. The following resources are supported (you might want to
465resources are allowed: 581check the @@RXVT_NAME@@\fIperl\fR\|(3) manpage for additional settings by perl
582extensions not documented here):
466.IP "\fBgeometry:\fR \fIgeom\fR" 4 583.IP "\fBgeometry:\fR \fIgeom\fR" 4
467.IX Item "geometry: geom" 584.IX Item "geometry: geom"
468Create the window with the specified X window geometry [default 80x24]; 585Create the window with the specified X window geometry [default 80x24];
469option \fB\-geometry\fR. 586option \fB\-geometry\fR.
470.IP "\fBbackground:\fR \fIcolour\fR" 4 587.IP "\fBbackground:\fR \fIcolour\fR" 4
534\&\fBTrue\fR: make the background inherit the parent windows' pixmap, giving 651\&\fBTrue\fR: make the background inherit the parent windows' pixmap, giving
535artificial transparency. \fBFalse\fR: do not inherit the parent windows' 652artificial transparency. \fBFalse\fR: do not inherit the parent windows'
536pixmap. 653pixmap.
537.IP "\fBfading:\fR \fInumber\fR" 4 654.IP "\fBfading:\fR \fInumber\fR" 4
538.IX Item "fading: number" 655.IX Item "fading: number"
539Fade the text by the given percentage when focus is lost. 656Fade the text by the given percentage when focus is lost; option \fB\-fade\fR.
657.IP "\fBfadeColor:\fR \fIcolour\fR" 4
658.IX Item "fadeColor: colour"
659Fade to this colour, when fading is used (see \fBfading:\fR). The default
660colour is black; option \fB\-fadecolor\fR.
540.IP "\fBtintColor:\fR \fIcolour\fR" 4 661.IP "\fBtintColor:\fR \fIcolour\fR" 4
541.IX Item "tintColor: colour" 662.IX Item "tintColor: colour"
542Tint the transparent background pixmap with the given colour. 663Tint the transparent background pixmap with the given colour; option
664\&\fB\-tint\fR.
543.IP "\fBshading:\fR \fInumber\fR" 4 665.IP "\fBshading:\fR \fInumber\fR" 4
544.IX Item "shading: number" 666.IX Item "shading: number"
545Darken (0 .. 100) or lighten (\-1 .. \-100) the transparent background 667Darken (0 .. 100) or lighten (\-1 .. \-100) the transparent background
546image in addition to tinting it. 668image in addition to tinting it.
547.IP "\fBscrollColor:\fR \fIcolour\fR" 4 669.IP "\fBscrollColor:\fR \fIcolour\fR" 4
548.IX Item "scrollColor: colour" 670.IX Item "scrollColor: colour"
549Use the specified colour for the scrollbar [default #B2B2B2]. 671Use the specified colour for the scrollbar [default #B2B2B2].
550.IP "\fBtroughColor:\fR \fIcolour\fR" 4 672.IP "\fBtroughColor:\fR \fIcolour\fR" 4
551.IX Item "troughColor: colour" 673.IX Item "troughColor: colour"
552Use the specified colour for the scrollbar's trough area [default 674Use the specified colour for the scrollbar's trough area [default
553#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 675#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
554.IP "\fBborderColor:\fR \fIcolour\fR" 4 676.IP "\fBborderColor:\fR \fIcolour\fR" 4
555.IX Item "borderColor: colour" 677.IX Item "borderColor: colour"
556The colour of the border around the text area and between the scrollbar 678The colour of the border around the text area and between the scrollbar
557and the text. 679and the text.
558.IP "\fBbackgroundPixmap:\fR \fIfile[;geom]\fR" 4 680.IP "\fBbackgroundPixmap:\fR \fIfile[;geom]\fR" 4
564centre (percent). A scale of 0 displays the image with tiling. A scale 686centre (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 687of 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 688specifies an integer number of images in that direction. No image will
567be magnified beyond 10 times its original size. The maximum permitted 689be magnified beyond 10 times its original size. The maximum permitted
568scale is 1000. [default 0x0+50+50] 690scale 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 691.IP "\fBpath:\fR \fIpath\fR" 4
575.IX Item "path: path" 692.IX Item "path: path"
576Specify the colon-delimited search path for finding files (\s-1XPM\s0 and 693Specify 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 694.IP "\fBfont:\fR \fIfontlist\fR" 4
580.IX Item "font: fontlist" 695.IX Item "font: fontlist"
581Select the fonts to be used. This is a comma separated list of font 696Select 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. 697that are checked in order when trying to find glyphs for characters. The
583The first font defines the cell size for characters; other fonts might 698first font defines the cell size for characters; other fonts might be
584be smaller, but not larger. A reasonable default font list is always 699smaller, but not (in general) larger. A (hopefully) reasonable default
585appended to it. option \fB\-fn\fR. 700font list is always appended to it; option \fB\-fn\fR.
586.Sp 701.Sp
587Each font can either be a standard X11 core font (\s-1XLFD\s0) name, with 702Each 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. 703optional prefix \f(CW\*(C`x:\*(C'\fR or a Xft font (Compile \fIxft\fR), prefixed with \f(CW\*(C`xft:\*(C'\fR.
589.Sp 704.Sp
590In addition, each font can be prefixed with additional hints and 705In addition, each font can be prefixed with additional hints and
593fonts. 708fonts.
594.Sp 709.Sp
595For example, this font resource 710For example, this font resource
596.Sp 711.Sp
597.Vb 5 712.Vb 5
598\& URxvt*font: 9x15bold,\e 713\& URxvt.font: 9x15bold,\e
599\& -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\e 714\& -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 715\& -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \e
601\& [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \e 716\& [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \e
602\& xft:Code2000:antialias=false 717\& xft:Code2000:antialias=false
603.Ve 718.Ve
638\&\*(L"morphing\*(R" the normal text font list into the desired shape. If that is 753\&\*(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. 754not possible, replacement fonts of the desired shape will be tried.
640.Sp 755.Sp
641If set, but empty, then this specific style is disabled and the normal 756If set, but empty, then this specific style is disabled and the normal
642text font will being used for the given style. 757text font will being used for the given style.
758.IP "\fBintensityStyles:\fR \fIboolean\fR" 4
759.IX Item "intensityStyles: boolean"
760When font styles are not enabled, or this option is enabled (\fBTrue\fR,
761option \fB\-is\fR, the default), bold and italic font styles imply high
762intensity foreground/backround colours. Disabling this option (\fBFalse\fR,
763option \fB+is\fR) disables this behaviour, the high intensity colours are not
764reachable.
643.IP "\fBselectstyle:\fR \fImode\fR" 4 765.IP "\fBselectstyle:\fR \fImode\fR" 4
644.IX Item "selectstyle: mode" 766.IX Item "selectstyle: mode"
645Set mouse selection style to \fBold\fR which is 2.20, \fBoldword\fR which is 767Set 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 768xterm style with 2.20 old word selection, or anything else which gives
647xterm style selection. 769xterm style selection.
648.IP "\fBscrollstyle:\fR \fImode\fR" 4 770.IP "\fBscrollstyle:\fR \fImode\fR" 4
649.IX Item "scrollstyle: mode" 771.IX Item "scrollstyle: mode"
650Set scrollbar style to \fBrxvt\fR, \fBplain\fR, \fBnext\fR or \fBxterm\fR. \fBplain\fR is 772Set scrollbar style to \fBrxvt\fR, \fBplain\fR, \fBnext\fR or \fBxterm\fR. \fBplain\fR is
651the author's favourite.. 773the author's favourite.
652.IP "\fBtitle:\fR \fIstring\fR" 4 774.IP "\fBtitle:\fR \fIstring\fR" 4
653.IX Item "title: string" 775.IX Item "title: string"
654Set window title string, the default title is the command-line 776Set window title string, the default title is the command-line
655specified after the \fB\-e\fR option, if any, otherwise the application 777specified after the \fB\-e\fR option, if any, otherwise the application
656name; option \fB\-title\fR. 778name; option \fB\-title\fR.
680.IP "\fBprint\-pipe:\fR \fIstring\fR" 4 802.IP "\fBprint\-pipe:\fR \fIstring\fR" 4
681.IX Item "print-pipe: string" 803.IX Item "print-pipe: string"
682Specify a command pipe for vt100 printer [default \fI\fIlpr\fI\|(1)\fR]. Use 804Specify 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 805\&\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. 806\&\fBShift-Print\fR to include the scrollback as well.
807.Sp
808The string will be interpreted as if typed into the shell as\-is.
809.Sp
810Example:
811.Sp
812.Vb 1
813\& URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
814.Ve
815.Sp
816This creates a new file in your home directory with the screen contents
817everytime you hit \f(CW\*(C`Print\*(C'\fR.
685.IP "\fBscrollBar:\fR \fIboolean\fR" 4 818.IP "\fBscrollBar:\fR \fIboolean\fR" 4
686.IX Item "scrollBar: boolean" 819.IX Item "scrollBar: boolean"
687\&\fBTrue\fR: enable the scrollbar [default]; option \fB\-sb\fR. \fBFalse\fR: 820\&\fBTrue\fR: enable the scrollbar [default]; option \fB\-sb\fR. \fBFalse\fR:
688disable the scrollbar; option \fB+sb\fR. 821disable the scrollbar; option \fB+sb\fR.
689.IP "\fBscrollBar_right:\fR \fIboolean\fR" 4 822.IP "\fBscrollBar_right:\fR \fIboolean\fR" 4
704\&\fBFalse\fR: do not scroll to bottom when tty receives output; option 837\&\fBFalse\fR: do not scroll to bottom when tty receives output; option
705\&\fB+si\fR. 838\&\fB+si\fR.
706.IP "\fBscrollWithBuffer:\fR \fIboolean\fR" 4 839.IP "\fBscrollWithBuffer:\fR \fIboolean\fR" 4
707.IX Item "scrollWithBuffer: boolean" 840.IX Item "scrollWithBuffer: boolean"
708\&\fBTrue\fR: scroll with scrollback buffer when tty receives new lines (and 841\&\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 842\&\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. 843with scrollback buffer when tty recieves new lines; option \fB+sw\fR.
711.IP "\fBscrollTtyKeypress:\fR \fIboolean\fR" 4 844.IP "\fBscrollTtyKeypress:\fR \fIboolean\fR" 4
712.IX Item "scrollTtyKeypress: boolean" 845.IX Item "scrollTtyKeypress: boolean"
713\&\fBTrue\fR: scroll to bottom when a non-special key is pressed. Special keys 846\&\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 847are 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 848are 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. 861option \fB\-w\fR, \fB\-bw\fR, \fB\-borderwidth\fR.
729.IP "\fBborderLess:\fR \fIboolean\fR" 4 862.IP "\fBborderLess:\fR \fIboolean\fR" 4
730.IX Item "borderLess: boolean" 863.IX Item "borderLess: boolean"
731Set \s-1MWM\s0 hints to request a borderless window, i.e. if honoured by the 864Set \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. 865\&\s-1WM\s0, the rxvt-unicode window will not have window decorations; option \fB\-bl\fR.
866.IP "\fBskipBuiltinGlyphs:\fR \fIboolean\fR" 4
867.IX Item "skipBuiltinGlyphs: boolean"
868Compile \fIfrills\fR: Disable the usage of the built-in block graphics/line
869drawing characters and just rely on what the specified fonts provide. Use
870this if you have a good font and want to use its block graphic glyphs;
871option \fB\-sbg\fR.
733.IP "\fBtermName:\fR \fItermname\fR" 4 872.IP "\fBtermName:\fR \fItermname\fR" 4
734.IX Item "termName: termname" 873.IX Item "termName: termname"
735Specifies the terminal type name to be set in the \fB\s-1TERM\s0\fR environment 874Specifies the terminal type name to be set in the \fB\s-1TERM\s0\fR environment
736variable; option \fB\-tn\fR. 875variable; option \fB\-tn\fR.
737.IP "\fBlinespace:\fR \fInumber\fR" 4 876.IP "\fBlinespace:\fR \fInumber\fR" 4
765.IP "\fBpointerColor2:\fR \fIcolour\fR" 4 904.IP "\fBpointerColor2:\fR \fIcolour\fR" 4
766.IX Item "pointerColor2: colour" 905.IX Item "pointerColor2: colour"
767Mouse pointer background colour. 906Mouse pointer background colour.
768.IP "\fBpointerBlankDelay:\fR \fInumber\fR" 4 907.IP "\fBpointerBlankDelay:\fR \fInumber\fR" 4
769.IX Item "pointerBlankDelay: number" 908.IX Item "pointerBlankDelay: number"
770Specifies number of seconds before blanking the pointer [default 2]. 909Specifies number of seconds before blanking the pointer [default 2]. Use a
910large number (e.g. \f(CW987654321\fR) to effectively disable the timeout.
771.IP "\fBbackspacekey:\fR \fIstring\fR" 4 911.IP "\fBbackspacekey:\fR \fIstring\fR" 4
772.IX Item "backspacekey: string" 912.IX Item "backspacekey: string"
773The string to send when the backspace key is pressed. If set to \fB\s-1DEC\s0\fR 913The 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 914or 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 915(code 8) \- which can be reversed with the appropriate \s-1DEC\s0 private mode
791.IP "\fBinputMethod:\fR \fIname\fR" 4 931.IP "\fBinputMethod:\fR \fIname\fR" 4
792.IX Item "inputMethod: name" 932.IX Item "inputMethod: name"
793\&\fIname\fR of inputMethod to use; option \fB\-im\fR. 933\&\fIname\fR of inputMethod to use; option \fB\-im\fR.
794.IP "\fBimLocale:\fR \fIname\fR" 4 934.IP "\fBimLocale:\fR \fIname\fR" 4
795.IX Item "imLocale: name" 935.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. 936The 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 937\&\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 938input extension to be able to input japanese characters while staying in
799another locale. option \fB\-imlocale\fR. 939another locale; option \fB\-imlocale\fR.
940.IP "\fBimFont:\fR \fIfontset\fR" 4
941.IX Item "imFont: fontset"
942Specify the font-set used for \s-1XIM\s0 styles \f(CW\*(C`OverTheSpot\*(C'\fR or
943\&\f(CW\*(C`OffTheSpot\*(C'\fR. It must be a standard X font set (\s-1XLFD\s0 patterns separated
944by commas), i.e. it's not in the same format as the other font lists used
945in @@RXVT_NAME@@. The default will be set-up to chose *any* suitable found
946found, preferably one or two pixels differing in size to the base font.
947option \fB\-imfont\fR.
948.IP "\fBtripleclickwords:\fR \fIboolean\fR" 4
949.IX Item "tripleclickwords: boolean"
950Change the meaning of triple-click selection with the left mouse
951button. Instead of selecting a full line it will extend the selection to
952the end of the logical line only; option \fB\-tcw\fR.
800.IP "\fBinsecure:\fR \fIboolean\fR" 4 953.IP "\fBinsecure:\fR \fIboolean\fR" 4
801.IX Item "insecure: boolean" 954.IX Item "insecure: boolean"
802Enables \*(L"insecure\*(R" mode. Rxvt-unicode offers some escape sequences that 955Enables \*(L"insecure\*(R" mode. Rxvt-unicode offers some escape sequences that
803echo arbitrary strings like the icon name or the locale. This could be 956echo arbitrary strings like the icon name or the locale. This could be
804abused if somebody gets 8\-bit\-clean access to your display, whether 957abused if somebody gets 8\-bit\-clean access to your display, whether
805throuh a mail client displaying mail bodies unfiltered or though 958through a mail client displaying mail bodies unfiltered or through
806\&\fIwrite\fR\|(1). Therefore, these sequences are disabled by default. (Note 959\&\fIwrite\fR\|(1) or any other means. Therefore, these sequences are disabled by
807that other terminals, including xterm, have these sequences 960default. (Note that many other terminals, including xterm, have these
808enabled by default). You can enable them by setting this boolean 961sequences enabled by default, which doesn't make it safer, though).
809resource or specifying \fB\-insecure\fR as an option. At the moment, this 962.Sp
810enabled display\-answer, locale, findfont, icon label and window title 963You can enable them by setting this boolean resource or specifying
811requests as well as dynamic menubar dispatch. 964\&\fB\-insecure\fR as an option. At the moment, this enables display\-answer,
965locale, findfont, icon label and window title requests.
812.IP "\fBmodifier:\fR \fImodifier\fR" 4 966.IP "\fBmodifier:\fR \fImodifier\fR" 4
813.IX Item "modifier: modifier" 967.IX Item "modifier: modifier"
814Set the key to be interpreted as the Meta key to: \fBalt\fR, \fBmeta\fR, 968Set 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 969\&\fBhyper\fR, \fBsuper\fR, \fBmod1\fR, \fBmod2\fR, \fBmod3\fR, \fBmod4\fR, \fBmod5\fR; option
816\&\fB\-mod\fR. 970\&\fB\-mod\fR.
817.IP "\fBanswerbackString:\fR \fIstring\fR" 4 971.IP "\fBanswerbackString:\fR \fIstring\fR" 4
818.IX Item "answerbackString: string" 972.IX Item "answerbackString: string"
819Specify the reply rxvt-unicode sends to the shell when an \s-1ENQ\s0 (control\-E) 973Specify 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 974character is passed through. It may contain escape values as described
821in the entry on \fBkeysym\fR following. 975in the entry on \fBkeysym\fR following.
822.IP "\fBsecondaryScreen:\fR \fIbool\fR" 4 976.IP "\fBsecondaryScreen:\fR \fIboolean\fR" 4
823.IX Item "secondaryScreen: bool" 977.IX Item "secondaryScreen: boolean"
824Turn on/off secondary screen (default enabled). 978Turn on/off secondary screen (default enabled).
825.IP "\fBsecondaryScroll:\fR \fIbool\fR" 4 979.IP "\fBsecondaryScroll:\fR \fIboolean\fR" 4
826.IX Item "secondaryScroll: bool" 980.IX Item "secondaryScroll: boolean"
827Turn on/off secondary screen scroll (default enabled). If the this 981Turn on/off secondary screen scroll (default enabled). If the this
828option is enabled, scrolls on the secondary screen will change the 982option is enabled, scrolls on the secondary screen will change the
829scrollback buffer and switching to/from the secondary screen will 983scrollback buffer and switching to/from the secondary screen will
830instead scroll the screen up. 984instead scroll the screen up.
985.IP "\fBhold\fR: \fIboolean\fR" 4
986.IX Item "hold: boolean"
987Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
988will not immediately destroy its window when the program executed within
989it exits. Instead, it will wait till it is being killed or closed by the
990user.
831.IP "\fBkeysym.\fR\fIsym\fR: \fIstring\fR" 4 991.IP "\fBkeysym.\fR\fIsym\fR: \fIstring\fR" 4
832.IX Item "keysym.sym: string" 992.IX Item "keysym.sym: string"
833Compile \fIfrills\fR: Associate \fIstring\fR with keysym \fIsym\fR. The 993Compile \fIfrills\fR: Associate \fIstring\fR with keysym \fIsym\fR. The
834intervening resource name \fBkeysym.\fR cannot be omitted. 994intervening resource name \fBkeysym.\fR cannot be omitted.
835.Sp 995.Sp
839and the abbreviated \fBI\fR, \fBK\fR, \fBC\fR, \fBN\fR, \fBS\fR, \fBM\fR, \fBA\fR, \fBL\fR, \fB1\fR, 999and 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. 1000\&\fB2\fR, \fB3\fR, \fB4\fR, \fB5\fR.
841.Sp 1001.Sp
842The \fBNumLock\fR, \fBMeta\fR and \fBISOLevel3\fR modifiers are usually aliased to 1002The \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 1003whatever 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 1004keys are being mapped. \fBAppKeypad\fR is a synthetic modifier mapped to the
845current application keymap mode state. 1005current application keymap mode state.
846.Sp 1006.Sp
847The spellings of \fIkey\fR can be obtained by using \fBxev\fR(1) command or 1007The 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 1008searching 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 1009omitting 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, 1014\&\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, 1015\&\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 1016\&\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. 1017can start or end with whitespace.
858.Sp 1018.Sp
1019Please note that you need to double the \f(CW\*(C`\e\*(C'\fR in resource files, as
1020Xlib itself does it's own de-escaping (you can use \f(CW\*(C`\e033\*(C'\fR instead of
1021\&\f(CW\*(C`\ee\*(C'\fR (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1022processing).
1023.Sp
859You can define a range of keysyms in one shot by providing a \fIstring\fR 1024You can define a range of keysyms in one shot by providing a \fIstring\fR
860with pattern \fBlist/PREFIX/MIDDLE/SUFFIX\fR, where the delimeter `/' 1025with pattern \fBlist/PREFIX/MIDDLE/SUFFIX\fR, where the delimeter `/'
861should be a character not used by the strings. 1026should be a character not used by the strings.
862.Sp 1027.Sp
863Its usage can be demonstrated by an example: 1028Its usage can be demonstrated by an example:
864.Sp 1029.Sp
865.Vb 1 1030.Vb 1
866\& URxvt.keysym.M-C-0x61: list|\ee<M-C-|abc|> 1031\& URxvt.keysym.M-C-0x61: list|\e033<M-C-|abc|>
867.Ve 1032.Ve
868.Sp 1033.Sp
869The above line is equivalent to the following three lines: 1034The above line is equivalent to the following three lines:
870.Sp 1035.Sp
871.Vb 3 1036.Vb 3
872\& URxvt.keysym.Meta-Control-0x61: \ee<M-C-a> 1037\& URxvt.keysym.Meta-Control-0x61: \e033<M-C-a>
873\& URxvt.keysym.Meta-Control-0x62: \ee<M-C-b> 1038\& URxvt.keysym.Meta-Control-0x62: \e033<M-C-b>
874\& URxvt.keysym.Meta-Control-0x63: \ee<M-C-c> 1039\& URxvt.keysym.Meta-Control-0x63: \e033<M-C-c>
875.Ve 1040.Ve
876.Sp 1041.Sp
877If \fIstring\fR takes the form of \f(CW\*(C`proto:STRING\*(C'\fR, the specified \fB\s-1STRING\s0\fR is 1042If \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, 1043is 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 1044example 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. 1045when Control-Meta-c is being pressed":
1046.Sp
1047.Vb 1
1048\& URxvt.keysym.M-C-c: command:\e033]701;zh_CN.GBK\e007
1049.Ve
1050.Sp
1051If \fIstring\fR takes the form \f(CW\*(C`perl:STRING\*(C'\fR, then the specified \fB\s-1STRING\s0\fR
1052is passed to the \f(CW\*(C`on_keyboard_command\*(C'\fR perl handler. See the @@RXVT_NAME@@\fIperl\fR\|(3)
1053manpage. For example, the \fIselection\fR extension (activated via
1054\&\f(CW\*(C`@@RXVT_NAME@@ \-pe selection\*(C'\fR) listens for \f(CW\*(C`selection:rot13\*(C'\fR events:
1055.Sp
1056.Vb 1
1057\& URxvt.keysym.M-C-c: perl:selection:rot13
1058.Ve
1059.Sp
1060Due the the large number of modifier combinations, a defined key mapping
1061will match if at \fIat least\fR the specified identifiers are being set, and
1062no other key mappings with those and more bits are being defined. That
1063means that defining a key map for \f(CW\*(C`a\*(C'\fR will automatically provide
1064definitions for \f(CW\*(C`Meta\-a\*(C'\fR, \f(CW\*(C`Shift\-a\*(C'\fR and so on, unless some of those are defined
1065mappings themselves.
1066.Sp
1067Unfortunately, this will override built-in key mappings. For example
1068if you overwrite the \f(CW\*(C`Insert\*(C'\fR key you will disable @@RXVT_NAME@@'s
1069\&\f(CW\*(C`Shift\-Insert\*(C'\fR mapping. To re-enable that, you can poke \*(L"holes\*(R" into the
1070user-defined keymap using the \f(CW\*(C`builtin:\*(C'\fR replacement:
1071.Sp
1072.Vb 2
1073\& URxvt.keysym.Insert: <my insert key sequence>
1074\& URxvt.keysym.S-Insert: builtin:
1075.Ve
1076.Sp
1077The first line defines a mapping for \f(CW\*(C`Insert\*(C'\fR and \fIany\fR combination
1078of modifiers. The second line re-establishes the default mapping for
1079\&\f(CW\*(C`Shift\-Insert\*(C'\fR.
1080.Sp
1081The following example will map Control\-Meta\-1 and Control\-Meta\-2 to
1082the fonts \f(CW\*(C`suxuseuro\*(C'\fR and \f(CW\*(C`9x15bold\*(C'\fR, so you can have some limited
1083font-switching at runtime:
1084.Sp
1085.Vb 2
1086\& URxvt.keysym.M-C-1: command:\e033]50;suxuseuro\e007
1087\& URxvt.keysym.M-C-2: command:\e033]50;9x15bold\e007
1088.Ve
1089.Sp
1090Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1091info):
1092.Sp
1093.Vb 2
1094\& URxvt.keysym.M-C-3: command:\e033[8;25;80t
1095\& URxvt.keysym.M-C-4: command:\e033[8;48;110t
1096.Ve
1097.IP "\fBperl-ext-common\fR: \fIstring\fR" 4
1098.IX Item "perl-ext-common: string"
1099.PD 0
1100.IP "\fBperl-ext\fR: \fIstring\fR" 4
1101.IX Item "perl-ext: string"
1102.PD
1103Comma-separated list(s) of perl extension scripts (default: \f(CW\*(C`default\*(C'\fR) to
1104use in this terminal instance; option \fB\-pe\fR.
1105.Sp
1106Extension names can be prefixed with a \f(CW\*(C`\-\*(C'\fR sign to prohibit using
1107them. This can be useful to selectively disable some extensions loaded
1108by default, or specified via the \f(CW\*(C`perl\-ext\-common\*(C'\fR resource. For
1109example, \f(CW\*(C`default,\-selection\*(C'\fR will use all the default extension except
1110\&\f(CW\*(C`selection\*(C'\fR.
1111.Sp
1112Extension names can also be followed by an argument in angle brackets
1113(e.g. \f(CW\*(C`searchable\-scrollback<M\-s>\*(C'\fR, which binds the hotkey for
1114searchable scorllback to Alt/Meta\-s). Mentioning the same extension
1115multiple times with different arguments will pass multiple arguments to
1116the extension.
1117.Sp
1118Each extension is looked up in the library directories, loaded if
1119necessary, and bound to the current terminal instance.
1120.Sp
1121If both of these resources are the empty string, then the perl
1122interpreter will not be initialized. The idea behind two options is that
1123\&\fBperl-ext-common\fR will be used for extensions that should be available to
1124all instances, while \fBperl-ext\fR is used for specific instances.
1125.IP "\fBperl-eval\fR: \fIstring\fR" 4
1126.IX Item "perl-eval: string"
1127Perl code to be evaluated when all extensions have been registered. See
1128the @@RXVT_NAME@@\fIperl\fR\|(3) manpage. Due to security reasons, this resource
1129will be ignored when running setuid/setgid.
1130.IP "\fBperl-lib\fR: \fIpath\fR" 4
1131.IX Item "perl-lib: path"
1132Colon-separated list of additional directories that hold extension
1133scripts. When looking for extensions specified by the \f(CW\*(C`perl\*(C'\fR resource,
1134@@RXVT_NAME@@ will first look in these directories and then in
1135\&\fI@@RXVT_LIBDIR@@/urxvt/perl/\fR. Due to security reasons, this resource
1136will be ignored when running setuid/setgid.
1137.Sp
1138See the @@RXVT_NAME@@\fIperl\fR\|(3) manpage.
1139.IP "\fBselection.pattern\-\f(BIidx\fB\fR: \fIperl-regex\fR" 4
1140.IX Item "selection.pattern-idx: perl-regex"
1141Additional selection patterns, see the @@RXVT_NAME@@\fIperl\fR\|(3) manpage for
1142details.
1143.IP "\fBselection\-autotransform.\f(BIidx\fB\fR: \fIperl-transform\fR" 4
1144.IX Item "selection-autotransform.idx: perl-transform"
1145Selection auto-transform patterns, see the @@RXVT_NAME@@\fIperl\fR\|(3) manpage
1146for details.
1147.IP "\fBsearchable\-scrollback:\fR \fIkeysym\fR" 4
1148.IX Item "searchable-scrollback: keysym"
1149Sets the hotkey that starts the incremental scrollback buffer search
1150(default: \f(CW\*(C`M\-s\*(C'\fR).
1151.IP "\fBurlLauncher\fR: \fIstring\fR" 4
1152.IX Item "urlLauncher: string"
1153Specifies the program to be started with a \s-1URL\s0 argument. Used by the
1154\&\f(CW\*(C`selection\-popup\*(C'\fR and \f(CW\*(C`mark\-urls\*(C'\fR perl extensions.
1155.IP "\fBtransient-for\fR: \fIwindowid\fR" 4
1156.IX Item "transient-for: windowid"
1157Compile \fIfrills\fR: Sets the \s-1WM_TRANSIENT_FOR\s0 property to the given window id.
1158.IP "\fBoverride-redirect\fR: \fIboolean\fR" 4
1159.IX Item "override-redirect: boolean"
1160Compile \fIfrills\fR: Sets override-redirect for the terminal window, making
1161it almost invisible to window managers; option \fB\-override\-redirect\fR.
881.SH "THE SCROLLBAR" 1162.SH "THE SCROLLBAR"
882.IX Header "THE SCROLLBAR" 1163.IX Header "THE SCROLLBAR"
883Lines of text that scroll off the top of the \fB@@RXVT_NAME@@\fR window 1164Lines 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 1165(resource: \fBsaveLines\fR) and can be scrolled back using the scrollbar
885or by keystrokes. The normal \fB@@RXVT_NAME@@\fR scrollbar has arrows and 1166or by keystrokes. The normal \fB@@RXVT_NAME@@\fR scrollbar has arrows and
895the normal text selection/insertion, hold either the Shift or the Meta 1176the normal text selection/insertion, hold either the Shift or the Meta
896(Alt) key while performing the desired mouse action. 1177(Alt) key while performing the desired mouse action.
897.PP 1178.PP
898If mouse reporting mode is active, the normal scrollbar actions are 1179If mouse reporting mode is active, the normal scrollbar actions are
899disabled \*(-- on the assumption that we are using a fullscreen 1180disabled \*(-- on the assumption that we are using a fullscreen
900application. Instead, pressing Button1 and Button3 sends \fBESC[6~\fR 1181application. Instead, pressing Button1 and Button3 sends \fB\s-1ESC\s0 [ 6 ~\fR
901(Next) and \fBESC[5~\fR (Prior), respectively. Similarly, clicking on the 1182(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), 1183up and down arrows sends \fB\s-1ESC\s0 [ A\fR (Up) and \fB\s-1ESC\s0 [ B\fR (Down),
903respectively. 1184respectively.
904.SH "TEXT SELECTION AND INSERTION" 1185.SH "TEXT SELECTION AND INSERTION"
905.IX Header "TEXT SELECTION AND INSERTION" 1186.IX Header "TEXT SELECTION AND INSERTION"
906The behaviour of text selection and insertion mechanism is similar to 1187The behaviour of text selection and insertion mechanism is similar to
907\&\fIxterm\fR(1). 1188\&\fIxterm\fR(1).
908.IP "\fBSelection\fR:" 4 1189.IP "\fBSelection\fR:" 4
909.IX Item "Selection:" 1190.IX Item "Selection:"
910Left click at the beginning of the region, drag to the end of the 1191Left 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 1192and release; Right click to extend the marked region; Left double-click
912double-click to select a word; Left triple-click to select the entire 1193to select a word; Left triple-click to select the entire logical line
913line. 1194(which can span multiple screen lines), unless modified by resource
1195\&\fBtripleclickwords\fR.
914.Sp 1196.Sp
915Starting a selection while pressing the \fBMeta\fR key (or \fBMeta+Ctrl\fR keys) 1197Starting 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 1198(Compile: \fIfrills\fR) will create a rectangular selection instead of a
917one. 1199normal one. In this mode, every selected row becomes its own line in the
1200selection, and trailing whitespace is visually underlined and removed from
1201the selection.
918.IP "\fBInsertion\fR:" 4 1202.IP "\fBInsertion\fR:" 4
919.IX Item "Insertion:" 1203.IX Item "Insertion:"
920Pressing and releasing the Middle mouse button (or \fBShift-Insert\fR) in 1204Pressing and releasing the Middle mouse button (or \fBShift-Insert\fR) in
921an \fB@@RXVT_NAME@@\fR window causes the current text selection to be 1205an \fB@@RXVT_NAME@@\fR window causes the current text selection to be
922inserted as if it had been typed on the keyboard. 1206inserted as if it had been typed on the keyboard.
923.SH "CHANGING FONTS" 1207.SH "CHANGING FONTS"
924.IX Header "CHANGING FONTS" 1208.IX Header "CHANGING FONTS"
925Changing fonts (or font sizes, respectively) via the keypad is not yet 1209Changing fonts (or font sizes, respectively) via the keypad is not yet
926supported in rxvt\-unicode. Bug me if you need this. 1210supported in rxvt\-unicode. Bug me if you need this.
927.PP 1211.PP
928You can, however, switch fonts at runtime using escape sequences (and 1212You can, however, switch fonts at runtime using escape sequences, e.g.:
929therefore using the menubar), e.g.:
930.PP 1213.PP
931.Vb 1 1214.Vb 1
932\& printf '\ee]701;%s\e007' "9x15bold,xft:Kochi Gothic" 1215\& printf '\ee]710;%s\e007' "9x15bold,xft:Kochi Gothic"
1216.Ve
1217.PP
1218You can use keyboard shortcuts, too:
1219.PP
1220.Vb 2
1221\& URxvt.keysym.M-C-1: command:\e033]710;suxuseuro\e007\e033]711;suxuseuro\e007
1222\& URxvt.keysym.M-C-2: command:\e033]710;9x15bold\e007\e033]711;9x15bold\e007
933.Ve 1223.Ve
934.PP 1224.PP
935rxvt-unicode will automatically re-apply these fonts to the output so far. 1225rxvt-unicode will automatically re-apply these fonts to the output so far.
936.SH "ISO 14755 SUPPORT" 1226.SH "ISO 14755 SUPPORT"
937.IX Header "ISO 14755 SUPPORT" 1227.IX Header "ISO 14755 SUPPORT"
938\&\s-1ISO\s0 14755 is a standard for entering and viewing unicode characters 1228\&\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 1229and character codes using the keyboard. It consists of 4 parts. The
940first part is available rxvt-unicode has been compiled with 1230first 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 1231\&\f(CW\*(C`\-\-enable\-frills\*(C'\fR, the rest is available when rxvt-unicode was compiled
942with \f(CW\*(C`\-\-enable\-iso14755\*(C'\fR. 1232with \f(CW\*(C`\-\-enable\-iso14755\*(C'\fR.
943.IP "5.1: Basic method" 4 1233.IP "* 5.1: Basic method" 4
944.IX Item "5.1: Basic method" 1234.IX Item "5.1: Basic method"
945This allows you to enter unicode characters using their hexcode. 1235This allows you to enter unicode characters using their hexcode.
946.Sp 1236.Sp
947Start by pressing and holding both \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR, then enter 1237Start 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 1238hex-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 1244As 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 1245address, 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 1246address 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, 1247by 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. 1248followed by releasing the modifier keys.
959.IP "5.2: Keyboard symbols entry method" 4 1249.IP "* 5.2: Keyboard symbols entry method" 4
960.IX Item "5.2: Keyboard symbols entry method" 1250.IX Item "5.2: Keyboard symbols entry method"
961This mode lets you input characters representing the keycap symbols of 1251This mode lets you input characters representing the keycap symbols of
962your keyboard, if representable in the current locale encoding. 1252your keyboard, if representable in the current locale encoding.
963.Sp 1253.Sp
964Start by pressing \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR together, then releasing 1254Start 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 1256invoke it's usual function but instead will insert the corresponding
967keycap symbol. The symbol will only be entered when the key has been 1257keycap 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 1258released, 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 1259\&\f(CW\*(C`ISO Level 2 Switch\*(C'\fR, although your intention might have been to enter a
970reverse tab (Shift\-Tab). 1260reverse tab (Shift\-Tab).
971.IP "5.3: Screen-selection entry method" 4 1261.IP "* 5.3: Screen-selection entry method" 4
972.IX Item "5.3: Screen-selection entry method" 1262.IX Item "5.3: Screen-selection entry method"
973While this is implemented already (it's basically the selection 1263While this is implemented already (it's basically the selection
974mechanism), it could be extended by displaying a unicode character map. 1264mechanism), it could be extended by displaying a unicode character map.
975.IP "5.4: Feedback method for identifying displayed characters for later input" 4 1265.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" 1266.IX Item "5.4: Feedback method for identifying displayed characters for later input"
977This method lets you display the unicode character code associated with 1267This method lets you display the unicode character code associated with
978characters already displayed. 1268characters already displayed.
979.Sp 1269.Sp
980You enter this mode by holding down \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR together, then 1270You enter this mode by holding down \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR together, then
989.PP 1279.PP
990With respect to conformance, rxvt-unicode is supposed to be compliant to 1280With 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. 1281both scenario A and B of \s-1ISO\s0 14755, including part 5.2.
992.SH "LOGIN STAMP" 1282.SH "LOGIN STAMP"
993.IX Header "LOGIN STAMP" 1283.IX Header "LOGIN STAMP"
994\&\fB@@RXVT_NAME@@\fR tries to write an entry into the \fIutmp\fR(5) file so 1284\&\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. 1285it 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 1286allow this feature, \fB@@RXVT_NAME@@\fR may need to be installed setuid root
997some systems. 1287on some systems or setgid to root or to some other group on others.
998.SH "COLORS AND GRAPHICS" 1288.SH "COLORS AND GRAPHICS"
999.IX Header "COLORS AND GRAPHICS" 1289.IX Header "COLORS AND GRAPHICS"
1000In addition to the default foreground and background colours, 1290In 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 1291\&\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 1292high-intensity bold/blink versions of the same). Here is a list of the
1037.IX Item "@@RXVT_NAME@@ -fg Black -bg White -rv" 1327.IX Item "@@RXVT_NAME@@ -fg Black -bg White -rv"
1038would yield White on Black, while on \fIxterm\fR(1) it would yield Black 1328would yield White on Black, while on \fIxterm\fR(1) it would yield Black
1039on White. 1329on White.
1040.SH "ENVIRONMENT" 1330.SH "ENVIRONMENT"
1041.IX Header "ENVIRONMENT" 1331.IX Header "ENVIRONMENT"
1042\&\fB@@RXVT_NAME@@\fR sets the environment variables \fB\s-1TERM\s0\fR, \fB\s-1COLORTERM\s0\fR 1332\&\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 1333.IP "\fB\s-1TERM\s0\fR" 4
1044window id number of the \fB@@RXVT_NAME@@\fR window and it also uses and 1334.IX Item "TERM"
1045sets the environment variable \fB\s-1DISPLAY\s0\fR to specify which display 1335Normally 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 1336resources or on the commandline.
1047\&\fB\s-1RXVTPATH\s0\fR and \fB\s-1PATH\s0\fR to find \s-1XPM\s0 files. 1337.IP "\fB\s-1COLORTERM\s0\fR" 4
1338.IX Item "COLORTERM"
1339Either \f(CW\*(C`rxvt\*(C'\fR, \f(CW\*(C`rxvt\-xpm\*(C'\fR, depending on wether @@RXVT_NAME@@ was
1340compiled with \s-1XPM\s0 support, and optionally with the added extension
1341\&\f(CW\*(C`\-mono\*(C'\fR to indicate that rxvt-unicode runs on a monochrome screen.
1342.IP "\fB\s-1COLORFGBG\s0\fR" 4
1343.IX Item "COLORFGBG"
1344Set 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
1345the colour code used as default foreground/text colour (or the string
1346\&\f(CW\*(C`default\*(C'\fR to indicate that the default-colour escape sequence is to be
1347used), \f(CW\*(C`bg\*(C'\fR is the colour code used as default background colour (or the
1348string \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@@
1349was compiled with \s-1XPM\s0 support. Libraries like \f(CW\*(C`ncurses\*(C'\fR and \f(CW\*(C`slang\*(C'\fR can
1350(and do) use this information to optimize screen output.
1351.IP "\fB\s-1WINDOWID\s0\fR" 4
1352.IX Item "WINDOWID"
1353Set to the (decimal) X Window \s-1ID\s0 of the @@RXVT_NAME@@ window (the toplevel
1354window, which usually has subwindows for the scrollbar, the terminal
1355window and so on).
1356.IP "\fB\s-1TERMINFO\s0\fR" 4
1357.IX Item "TERMINFO"
1358Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
1359\&\f(CW\*(C`\-\-with\-terminfo=PATH\*(C'\fR.
1360.IP "\fB\s-1DISPLAY\s0\fR" 4
1361.IX Item "DISPLAY"
1362Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1363display in it's child processes.
1364.IP "\fB\s-1SHELL\s0\fR" 4
1365.IX Item "SHELL"
1366The shell to be used for command execution, defaults to \f(CW\*(C`/bin/sh\*(C'\fR.
1367.IP "\fB\s-1RXVT_SOCKET\s0\fR" 4
1368.IX Item "RXVT_SOCKET"
1369The unix domain socket path used by @@RXVT_NAME@@c(1) and
1370@@RXVT_NAME@@d(1).
1371.Sp
1372Default \fI$HOME/.rxvt\-unicode\-\fI<nodename\fI\fR.
1373.IP "\fB\s-1HOME\s0\fR" 4
1374.IX Item "HOME"
1375Used to locate the default directory for the unix domain socket for
1376daemon communications and to locate various resource files (such as
1377\&\f(CW\*(C`.Xdefaults\*(C'\fR)
1378.IP "\fB\s-1XAPPLRESDIR\s0\fR" 4
1379.IX Item "XAPPLRESDIR"
1380Directory where various X resource files are being located.
1381.IP "\fB\s-1XENVIRONMENT\s0\fR" 4
1382.IX Item "XENVIRONMENT"
1383If set and accessible, gives the name of a X resource file to be loaded by
1384@@RXVT_NAME@@.
1048.SH "FILES" 1385.SH "FILES"
1049.IX Header "FILES" 1386.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 1387.IP "\fB/usr/lib/X11/rgb.txt\fR" 4
1054.IX Item "/usr/lib/X11/rgb.txt" 1388.IX Item "/usr/lib/X11/rgb.txt"
1055Color names. 1389Color names.
1056.SH "SEE ALSO" 1390.SH "SEE ALSO"
1057.IX Header "SEE ALSO" 1391.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) 1392@@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" 1393.SH "CURRENT PROJECT COORDINATOR"
1067.IX Header "CURRENT PROJECT COORDINATOR" 1394.IX Header "CURRENT PROJECT COORDINATOR"
1068.IP "Project Coordinator" 4 1395.IP "Project Coordinator" 4
1069.IX Item "Project Coordinator" 1396.IX Item "Project Coordinator"
1070@@RXVT_MAINT@@ @@RXVT_MAINTEMAIL@@ 1397Marc 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 1398.Sp
1075@@RXVT_WEBPAGE@@ 1399<http://software.schmorp.de/#rxvt\-unicode>
1076.SH "AUTHORS" 1400.SH "AUTHORS"
1077.IX Header "AUTHORS" 1401.IX Header "AUTHORS"
1078.IP "John Bovey" 4 1402.IP "John Bovey" 4
1079.IX Item "John Bovey" 1403.IX Item "John Bovey"
1080University of Kent, 1992, wrote the original Xvt. 1404University of Kent, 1992, wrote the original Xvt.
1092.IP "Oezguer Kesim <kesim@math.fu\-berlin.de>" 4 1416.IP "Oezguer Kesim <kesim@math.fu\-berlin.de>" 4
1093.IX Item "Oezguer Kesim <kesim@math.fu-berlin.de>" 1417.IX Item "Oezguer Kesim <kesim@math.fu-berlin.de>"
1094Project Coordinator (changes.txt 2.21a to 2.4.5) 1418Project Coordinator (changes.txt 2.21a to 2.4.5)
1095.IP "Geoff Wing <gcw@pobox.com>" 4 1419.IP "Geoff Wing <gcw@pobox.com>" 4
1096.IX Item "Geoff Wing <gcw@pobox.com>" 1420.IX Item "Geoff Wing <gcw@pobox.com>"
1097Rewrote screen display and text selection routines. Project Coordinator 1421Rewrote screen display and text selection routines.
1422.Sp
1098(changes.txt 2.4.6 \- rxvt\-unicode) 1423Project Coordinator (changes.txt 2.4.6 \- rxvt\-unicode)
1099.IP "Marc Alexander Lehmann <rxvt@schmorp.de>" 4 1424.IP "Marc Alexander Lehmann <rxvt\-unicode@schmorp.de>" 4
1100.IX Item "Marc Alexander Lehmann <rxvt@schmorp.de>" 1425.IX Item "Marc Alexander Lehmann <rxvt-unicode@schmorp.de>"
1101Forked rxvt\-unicode, rewrote most of the display code and internal 1426Forked rxvt\-unicode, unicode support, rewrote almost all the code, perl
1102character handling to store text in unicode, improve xterm 1427extension, random hacks, numerous bugfixes and extensions.
1103compatibility and apply numerous other bugfixes and extensions.
1104.Sp 1428.Sp
1105Project Coordinator (Changes 1.0 \-) 1429Project Coordinator (Changes 1.0 \-)
1430.IP "Emanuele Giaquinta <e.giaquinta@glauco.it>" 4
1431.IX Item "Emanuele Giaquinta <e.giaquinta@glauco.it>"
1432Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines