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.28 by root, Thu Dec 22 16:44:10 2005 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 "2005-12-22" "6.0" "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).
… …
332.IP "\fB\-sr\fR|\fB+sr\fR" 4 345.IP "\fB\-sr\fR|\fB+sr\fR" 4
333.IX Item "-sr|+sr" 346.IX Item "-sr|+sr"
334Put scrollbar on right/left; resource \fBscrollBar_right\fR. 347Put scrollbar on right/left; resource \fBscrollBar_right\fR.
335.IP "\fB\-st\fR|\fB+st\fR" 4 348.IP "\fB\-st\fR|\fB+st\fR" 4
336.IX Item "-st|+st" 349.IX Item "-st|+st"
337Display normal (non XTerm/NeXT) scrollbar without/with a trough; 350Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
338resource \fBscrollBar_floating\fR. 351resource \fBscrollBar_floating\fR.
339.IP "\fB\-ptab\fR|\fB+ptab\fR" 4 352.IP "\fB\-ptab\fR|\fB+ptab\fR" 4
340.IX Item "-ptab|+ptab" 353.IX Item "-ptab|+ptab"
341If enabled (default), \*(L"Horizontal Tab\*(R" characters are being stored as 354If enabled (default), \*(L"Horizontal Tab\*(R" characters are being stored as
342actual wide characters in the screen buffer, which makes it possible to 355actual wide characters in the screen buffer, which makes it possible to
… …
386the program being executed if neither \fI\-title\fR (\fI\-T\fR) nor \fI\-n\fR are 399the 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 400given 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 401on 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, 402run the program specified by the \fB\s-1SHELL\s0\fR environment variable or,
390failing that, \fI\fIsh\fI\|(1)\fR. 403failing that, \fI\fIsh\fI\|(1)\fR.
404.Sp
405Please note that you must specify a program with arguments. If you want to
406run shell commands, you have to specify the shell, like this:
407.Sp
408.Vb 1
409\& @@RXVT_NAME@@ -e sh -c "shell commands"
410.Ve
391.IP "\fB\-title\fR \fItext\fR" 4 411.IP "\fB\-title\fR \fItext\fR" 4
392.IX Item "-title text" 412.IX Item "-title text"
393Window title (\fB\-T\fR still respected); the default title is the basename 413Window 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 414of the program specified after the \fB\-e\fR option, if any, otherwise the
395application name; resource \fBtitle\fR. 415application name; resource \fBtitle\fR.
… …
408.IP "\fB\-im\fR \fItext\fR" 4 428.IP "\fB\-im\fR \fItext\fR" 4
409.IX Item "-im text" 429.IX Item "-im text"
410Compile \fI\s-1XIM\s0\fR: input method name. resource \fBinputMethod\fR. 430Compile \fI\s-1XIM\s0\fR: input method name. resource \fBinputMethod\fR.
411.IP "\fB\-imlocale\fR \fIstring\fR" 4 431.IP "\fB\-imlocale\fR \fIstring\fR" 4
412.IX Item "-imlocale string" 432.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. 433The 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 434\&\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 435input extension to be able to input japanese characters while staying in
416another locale. 436another locale. resource \fBimLocale\fR.
437.IP "\fB\-imfont\fR \fIfontset\fR" 4
438.IX Item "-imfont fontset"
439Set the font set to use for the X Input Method, see resource \fBimFont\fR
440for more info.
441.IP "\fB\-tcw\fR" 4
442.IX Item "-tcw"
443Change the meaning of triple-click selection with the left mouse
444button. Instead of selecting a full line it will extend the selection the
445end of the logical line only. resource \fBtripleclickwords\fR.
417.IP "\fB\-insecure\fR" 4 446.IP "\fB\-insecure\fR" 4
418.IX Item "-insecure" 447.IX Item "-insecure"
419Enable \*(L"insecure\*(R" mode, which currently enables most of the escape 448Enable \*(L"insecure\*(R" mode, which currently enables most of the escape
420sequences that echo strings. See the resource \fBinsecure\fR for more 449sequences that echo strings. See the resource \fBinsecure\fR for more
421info. 450info.
… …
430\&\fBsecondaryScreen\fR. 459\&\fBsecondaryScreen\fR.
431.IP "\fB\-ssr\fR|\fB+ssr\fR" 4 460.IP "\fB\-ssr\fR|\fB+ssr\fR" 4
432.IX Item "-ssr|+ssr" 461.IX Item "-ssr|+ssr"
433Turn on/off secondary screen scroll (default enabled); resource 462Turn on/off secondary screen scroll (default enabled); resource
434\&\fBsecondaryScroll\fR. 463\&\fBsecondaryScroll\fR.
435.IP "\fB\-xrm\fR \fIresourcestring\fR" 4 464.IP "\fB\-hold\fR|\fB+hold\fR" 4
436.IX Item "-xrm resourcestring" 465.IX Item "-hold|+hold"
437No effect on rxvt\-unicode. Simply passes through an argument to be made 466Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
438available in the instance's argument list. Appears in \fI\s-1WM_COMMAND\s0\fR in 467will not immediately destroy its window when the program executed within
439some window managers. 468it exits. Instead, it will wait till it is being killed or closed by the
469user; resource \fBhold\fR.
470.IP "\fB\-keysym.\fR\fIsym\fR \fIstring\fR" 4
471.IX Item "-keysym.sym string"
472Remap a key symbol. See resource \fBkeysym\fR.
473.IP "\fB\-embed\fR \fIwindowid\fR" 4
474.IX Item "-embed windowid"
475Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window,
476which enables applications to easily embed a terminal.
477.Sp
478Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
479shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
480quite a bit, so don't expect it to keep some specific state. It's best to
481create an extra subwindow for @@RXVT_NAME@@ and leave it alone.
482.Sp
483The window will not be destroyed when @@RXVT_NAME@@ exits.
484.Sp
485It might be useful to know that @@RXVT_NAME@@ will not close file
486descriptors passed to it (except for stdin/out/err, of course), so you
487can use file descriptors to communicate with the programs within the
488terminal. This works regardless of wether the \f(CW\*(C`\-embed\*(C'\fR option was used or
489not.
490.Sp
491Here is a short Gtk2\-perl snippet that illustrates how this option can be
492used (a longer example is in \fIdoc/embed\fR):
493.Sp
494.Vb 5
495\& my $rxvt = new Gtk2::Socket;
496\& $rxvt->signal_connect_after (realize => sub {
497\& my $xid = $_[0]->window->get_xid;
498\& system "@@RXVT_NAME@@ -embed $xid &";
499\& });
500.Ve
501.IP "\fB\-pty\-fd\fR \fIfileno\fR" 4
502.IX Item "-pty-fd fileno"
503Tells @@RXVT_NAME@@ \s-1NOT\s0 to execute any commands or create a new pty/tty
504pair but instead use the given filehandle as the tty master. This is
505useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
506without having to run a program within it.
507.Sp
508If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
509entries and will not tinker with pty/tty permissions \- you have to do that
510yourself if you want that.
511.Sp
512Here is a example in perl that illustrates how this option can be used (a
513longer example is in \fIdoc/pty\-fd\fR):
514.Sp
515.Vb 2
516\& use IO::Pty;
517\& use Fcntl;
518.Ve
519.Sp
520.Vb 4
521\& my $pty = new IO::Pty;
522\& fcntl $pty, F_SETFD, 0; # clear close-on-exec
523\& system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";
524\& close $pty;
525.Ve
526.Sp
527.Vb 3
528\& # now communicate with rxvt
529\& my $slave = $pty->slave;
530\& while (<$slave>) { print $slave "got <$_>\en" }
531.Ve
440.SH "RESOURCES (available also as long\-options)" 532.SH "RESOURCES (available also as long\-options)"
441.IX Header "RESOURCES (available also as long-options)" 533.IX Header "RESOURCES (available also as long-options)"
442Note: `@@RXVT_NAME@@ \-\-help' gives a list of all resources (long 534Note: `@@RXVT_NAME@@ \-\-help' gives a list of all resources (long
443options) compiled into your version. 535options) compiled into your version.
444.PP 536.PP
445There are two different methods that @@RXVT_NAME@@ can use to get the 537There are two different methods that @@RXVT_NAME@@ can use to get the
446Xresource data: using the X libraries (Xrm*\-functions) or internal 538Xresource data: using the X libraries (Xrm*\-functions) or internal
447Xresources reader (\fB~/.Xdefaults\fR). For the first method (ie. 539Xresources reader (\fB~/.Xdefaults\fR). For the first method (ie.
448\&\fB@@RXVT_NAME@@ \-h\fR lists \fBXGetDefaults\fR), you can set and change the 540\&\fB@@RXVT_NAME@@ \-h\fR lists \fBXGetDefaults\fR), you can set and change the
449resources using X11 tools like \fBxset\fR. Many distribution do also load 541resources using X11 tools like \fBxrdb\fR. Many distribution do also load
450settings from the \fB~/.Xresources\fR file when X starts. 542settings from the \fB~/.Xresources\fR file when X starts. @@RXVT_NAME@@
543will consult the following files/resources in order, with later settings
544overwriting earlier ones:
545.PP
546.Vb 5
547\& 1. system-wide app-defaults file, either locale-dependent OR global
548\& 2. app-defaults file in $XAPPLRESDIR
549\& 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
550\& 4. SCREEN_RESOURCES for the current screen
551\& 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
552.Ve
451.PP 553.PP
452If compiled with internal Xresources support (i.e. \fB@@RXVT_NAME@@ \-h\fR 554If compiled with internal Xresources support (i.e. \fB@@RXVT_NAME@@ \-h\fR
453lists \fB.Xdefaults\fR) then \fB@@RXVT_NAME@@\fR accepts application defaults 555lists \fB.Xdefaults\fR) then \fB@@RXVT_NAME@@\fR accepts application defaults
454set in XAPPLOADDIR/URxvt (compile\-time defined: usually 556set in XAPPLOADDIR/URxvt (compile\-time defined: usually
455\&\fB/usr/lib/X11/app\-defaults/URxvt\fR) and resources set in 557\&\fB/usr/lib/X11/app\-defaults/URxvt\fR) and resources set in
… …
534\&\fBTrue\fR: make the background inherit the parent windows' pixmap, giving 636\&\fBTrue\fR: make the background inherit the parent windows' pixmap, giving
535artificial transparency. \fBFalse\fR: do not inherit the parent windows' 637artificial transparency. \fBFalse\fR: do not inherit the parent windows'
536pixmap. 638pixmap.
537.IP "\fBfading:\fR \fInumber\fR" 4 639.IP "\fBfading:\fR \fInumber\fR" 4
538.IX Item "fading: number" 640.IX Item "fading: number"
539Fade the text by the given percentage when focus is lost. 641Fade the text by the given percentage when focus is lost; option \fB\-fade\fR.
642.IP "\fBfadeColor:\fR \fIcolour\fR" 4
643.IX Item "fadeColor: colour"
644Fade to this colour, when fading is used (see \fBfading:\fR). The default
645colour is black; option \fB\-fadecolor\fR.
540.IP "\fBtintColor:\fR \fIcolour\fR" 4 646.IP "\fBtintColor:\fR \fIcolour\fR" 4
541.IX Item "tintColor: colour" 647.IX Item "tintColor: colour"
542Tint the transparent background pixmap with the given colour. 648Tint the transparent background pixmap with the given colour; option
649\&\fB\-tint\fR.
543.IP "\fBshading:\fR \fInumber\fR" 4 650.IP "\fBshading:\fR \fInumber\fR" 4
544.IX Item "shading: number" 651.IX Item "shading: number"
545Darken (0 .. 100) or lighten (\-1 .. \-100) the transparent background 652Darken (0 .. 100) or lighten (\-1 .. \-100) the transparent background
546image in addition to tinting it. 653image in addition to tinting it.
547.IP "\fBscrollColor:\fR \fIcolour\fR" 4 654.IP "\fBscrollColor:\fR \fIcolour\fR" 4
548.IX Item "scrollColor: colour" 655.IX Item "scrollColor: colour"
549Use the specified colour for the scrollbar [default #B2B2B2]. 656Use the specified colour for the scrollbar [default #B2B2B2].
550.IP "\fBtroughColor:\fR \fIcolour\fR" 4 657.IP "\fBtroughColor:\fR \fIcolour\fR" 4
551.IX Item "troughColor: colour" 658.IX Item "troughColor: colour"
552Use the specified colour for the scrollbar's trough area [default 659Use the specified colour for the scrollbar's trough area [default
553#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 660#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
554.IP "\fBborderColor:\fR \fIcolour\fR" 4 661.IP "\fBborderColor:\fR \fIcolour\fR" 4
555.IX Item "borderColor: colour" 662.IX Item "borderColor: colour"
556The colour of the border around the text area and between the scrollbar 663The colour of the border around the text area and between the scrollbar
557and the text. 664and the text.
558.IP "\fBbackgroundPixmap:\fR \fIfile[;geom]\fR" 4 665.IP "\fBbackgroundPixmap:\fR \fIfile[;geom]\fR" 4
… …
646xterm style with 2.20 old word selection, or anything else which gives 753xterm style with 2.20 old word selection, or anything else which gives
647xterm style selection. 754xterm style selection.
648.IP "\fBscrollstyle:\fR \fImode\fR" 4 755.IP "\fBscrollstyle:\fR \fImode\fR" 4
649.IX Item "scrollstyle: mode" 756.IX Item "scrollstyle: mode"
650Set scrollbar style to \fBrxvt\fR, \fBplain\fR, \fBnext\fR or \fBxterm\fR. \fBplain\fR is 757Set scrollbar style to \fBrxvt\fR, \fBplain\fR, \fBnext\fR or \fBxterm\fR. \fBplain\fR is
651the author's favourite.. 758the author's favourite.
652.IP "\fBtitle:\fR \fIstring\fR" 4 759.IP "\fBtitle:\fR \fIstring\fR" 4
653.IX Item "title: string" 760.IX Item "title: string"
654Set window title string, the default title is the command-line 761Set window title string, the default title is the command-line
655specified after the \fB\-e\fR option, if any, otherwise the application 762specified after the \fB\-e\fR option, if any, otherwise the application
656name; option \fB\-title\fR. 763name; option \fB\-title\fR.
… …
680.IP "\fBprint\-pipe:\fR \fIstring\fR" 4 787.IP "\fBprint\-pipe:\fR \fIstring\fR" 4
681.IX Item "print-pipe: string" 788.IX Item "print-pipe: string"
682Specify a command pipe for vt100 printer [default \fI\fIlpr\fI\|(1)\fR]. Use 789Specify 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 790\&\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. 791\&\fBShift-Print\fR to include the scrollback as well.
792.Sp
793The string will be interpreted as if typed into the shell as\-is.
794.Sp
795Example:
796.Sp
797.Vb 1
798\& URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
799.Ve
800.Sp
801This creates a new file in your home directory with the screen contents
802everytime you hit \f(CW\*(C`Print\*(C'\fR.
685.IP "\fBscrollBar:\fR \fIboolean\fR" 4 803.IP "\fBscrollBar:\fR \fIboolean\fR" 4
686.IX Item "scrollBar: boolean" 804.IX Item "scrollBar: boolean"
687\&\fBTrue\fR: enable the scrollbar [default]; option \fB\-sb\fR. \fBFalse\fR: 805\&\fBTrue\fR: enable the scrollbar [default]; option \fB\-sb\fR. \fBFalse\fR:
688disable the scrollbar; option \fB+sb\fR. 806disable the scrollbar; option \fB+sb\fR.
689.IP "\fBscrollBar_right:\fR \fIboolean\fR" 4 807.IP "\fBscrollBar_right:\fR \fIboolean\fR" 4
… …
704\&\fBFalse\fR: do not scroll to bottom when tty receives output; option 822\&\fBFalse\fR: do not scroll to bottom when tty receives output; option
705\&\fB+si\fR. 823\&\fB+si\fR.
706.IP "\fBscrollWithBuffer:\fR \fIboolean\fR" 4 824.IP "\fBscrollWithBuffer:\fR \fIboolean\fR" 4
707.IX Item "scrollWithBuffer: boolean" 825.IX Item "scrollWithBuffer: boolean"
708\&\fBTrue\fR: scroll with scrollback buffer when tty receives new lines (and 826\&\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 827\&\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. 828with scrollback buffer when tty recieves new lines; option \fB+sw\fR.
711.IP "\fBscrollTtyKeypress:\fR \fIboolean\fR" 4 829.IP "\fBscrollTtyKeypress:\fR \fIboolean\fR" 4
712.IX Item "scrollTtyKeypress: boolean" 830.IX Item "scrollTtyKeypress: boolean"
713\&\fBTrue\fR: scroll to bottom when a non-special key is pressed. Special keys 831\&\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 832are 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 833are not passed onto the shell; option \fB\-sk\fR. \fBFalse\fR: do not scroll to
… …
765.IP "\fBpointerColor2:\fR \fIcolour\fR" 4 883.IP "\fBpointerColor2:\fR \fIcolour\fR" 4
766.IX Item "pointerColor2: colour" 884.IX Item "pointerColor2: colour"
767Mouse pointer background colour. 885Mouse pointer background colour.
768.IP "\fBpointerBlankDelay:\fR \fInumber\fR" 4 886.IP "\fBpointerBlankDelay:\fR \fInumber\fR" 4
769.IX Item "pointerBlankDelay: number" 887.IX Item "pointerBlankDelay: number"
770Specifies number of seconds before blanking the pointer [default 2]. 888Specifies number of seconds before blanking the pointer [default 2]. Use a
889large number (e.g. \f(CW987654321\fR) to effectively disable the timeout.
771.IP "\fBbackspacekey:\fR \fIstring\fR" 4 890.IP "\fBbackspacekey:\fR \fIstring\fR" 4
772.IX Item "backspacekey: string" 891.IX Item "backspacekey: string"
773The string to send when the backspace key is pressed. If set to \fB\s-1DEC\s0\fR 892The 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 893or 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 894(code 8) \- which can be reversed with the appropriate \s-1DEC\s0 private mode
… …
791.IP "\fBinputMethod:\fR \fIname\fR" 4 910.IP "\fBinputMethod:\fR \fIname\fR" 4
792.IX Item "inputMethod: name" 911.IX Item "inputMethod: name"
793\&\fIname\fR of inputMethod to use; option \fB\-im\fR. 912\&\fIname\fR of inputMethod to use; option \fB\-im\fR.
794.IP "\fBimLocale:\fR \fIname\fR" 4 913.IP "\fBimLocale:\fR \fIname\fR" 4
795.IX Item "imLocale: name" 914.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. 915The 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 916\&\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 917input extension to be able to input japanese characters while staying in
799another locale. option \fB\-imlocale\fR. 918another locale. option \fB\-imlocale\fR.
919.IP "\fBimFont:\fR \fIfontset\fR" 4
920.IX Item "imFont: fontset"
921Specify the font-set used for \s-1XIM\s0 styles \f(CW\*(C`OverTheSpot\*(C'\fR or
922\&\f(CW\*(C`OffTheSpot\*(C'\fR. It must be a standard X font set (\s-1XLFD\s0 patterns separated
923by commas), i.e. it's not in the same format as the other font lists used
924in @@RXVT_NAME@@. The default will be set-up to chose *any* suitable found
925found, preferably one or two pixels differing in size to the base font.
926option \fB\-imfont\fR.
927.IP "\fBtripleclickwords:\fR \fIboolean\fR" 4
928.IX Item "tripleclickwords: boolean"
929Change the meaning of triple-click selection with the left mouse
930button. Instead of selecting a full line it will extend the selection to
931the end of the logical line only. option \fB\-tcw\fR.
800.IP "\fBinsecure:\fR \fIboolean\fR" 4 932.IP "\fBinsecure:\fR \fIboolean\fR" 4
801.IX Item "insecure: boolean" 933.IX Item "insecure: boolean"
802Enables \*(L"insecure\*(R" mode. Rxvt-unicode offers some escape sequences that 934Enables \*(L"insecure\*(R" mode. Rxvt-unicode offers some escape sequences that
803echo arbitrary strings like the icon name or the locale. This could be 935echo arbitrary strings like the icon name or the locale. This could be
804abused if somebody gets 8\-bit\-clean access to your display, whether 936abused if somebody gets 8\-bit\-clean access to your display, whether
805throuh a mail client displaying mail bodies unfiltered or though 937through a mail client displaying mail bodies unfiltered or through
806\&\fIwrite\fR\|(1). Therefore, these sequences are disabled by default. (Note 938\&\fIwrite\fR\|(1) or any other means. Therefore, these sequences are disabled by
807that other terminals, including xterm, have these sequences 939default. (Note that many other terminals, including xterm, have these
808enabled by default). You can enable them by setting this boolean 940sequences enabled by default, which doesn't make it safer, though).
809resource or specifying \fB\-insecure\fR as an option. At the moment, this 941.Sp
810enabled display\-answer, locale, findfont, icon label and window title 942You can enable them by setting this boolean resource or specifying
811requests as well as dynamic menubar dispatch. 943\&\fB\-insecure\fR as an option. At the moment, this enables display\-answer,
944locale, findfont, icon label and window title requests as well as dynamic
945menubar dispatch.
812.IP "\fBmodifier:\fR \fImodifier\fR" 4 946.IP "\fBmodifier:\fR \fImodifier\fR" 4
813.IX Item "modifier: modifier" 947.IX Item "modifier: modifier"
814Set the key to be interpreted as the Meta key to: \fBalt\fR, \fBmeta\fR, 948Set 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 949\&\fBhyper\fR, \fBsuper\fR, \fBmod1\fR, \fBmod2\fR, \fBmod3\fR, \fBmod4\fR, \fBmod5\fR; option
816\&\fB\-mod\fR. 950\&\fB\-mod\fR.
… …
826.IX Item "secondaryScroll: bool" 960.IX Item "secondaryScroll: bool"
827Turn on/off secondary screen scroll (default enabled). If the this 961Turn on/off secondary screen scroll (default enabled). If the this
828option is enabled, scrolls on the secondary screen will change the 962option is enabled, scrolls on the secondary screen will change the
829scrollback buffer and switching to/from the secondary screen will 963scrollback buffer and switching to/from the secondary screen will
830instead scroll the screen up. 964instead scroll the screen up.
965.IP "\fBhold\fR: \fIbool\fR" 4
966.IX Item "hold: bool"
967Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
968will not immediately destroy its window when the program executed within
969it exits. Instead, it will wait till it is being killed or closed by the
970user.
831.IP "\fBkeysym.\fR\fIsym\fR: \fIstring\fR" 4 971.IP "\fBkeysym.\fR\fIsym\fR: \fIstring\fR" 4
832.IX Item "keysym.sym: string" 972.IX Item "keysym.sym: string"
833Compile \fIfrills\fR: Associate \fIstring\fR with keysym \fIsym\fR. The 973Compile \fIfrills\fR: Associate \fIstring\fR with keysym \fIsym\fR. The
834intervening resource name \fBkeysym.\fR cannot be omitted. 974intervening resource name \fBkeysym.\fR cannot be omitted.
835.Sp 975.Sp
… …
839and the abbreviated \fBI\fR, \fBK\fR, \fBC\fR, \fBN\fR, \fBS\fR, \fBM\fR, \fBA\fR, \fBL\fR, \fB1\fR, 979and 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. 980\&\fB2\fR, \fB3\fR, \fB4\fR, \fB5\fR.
841.Sp 981.Sp
842The \fBNumLock\fR, \fBMeta\fR and \fBISOLevel3\fR modifiers are usually aliased to 982The \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 983whatever 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 984keys are being mapped. \fBAppKeypad\fR is a synthetic modifier mapped to the
845current application keymap mode state. 985current application keymap mode state.
846.Sp 986.Sp
847The spellings of \fIkey\fR can be obtained by using \fBxev\fR(1) command or 987The 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 988searching 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 989omitting 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, 994\&\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, 995\&\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 996\&\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. 997can start or end with whitespace.
858.Sp 998.Sp
999Please note that you need to double the \f(CW\*(C`\e\*(C'\fR when using
1000\&\f(CW\*(C`\-\-enable\-xgetdefault\*(C'\fR, as X itself does it's own de-escaping (you can
1001use \f(CW\*(C`\e033\*(C'\fR instead of \f(CW\*(C`\ee\*(C'\fR (and so on), which will work with both Xt and
1002@@RXVT_NAME@@'s own processing).
1003.Sp
859You can define a range of keysyms in one shot by providing a \fIstring\fR 1004You can define a range of keysyms in one shot by providing a \fIstring\fR
860with pattern \fBlist/PREFIX/MIDDLE/SUFFIX\fR, where the delimeter `/' 1005with pattern \fBlist/PREFIX/MIDDLE/SUFFIX\fR, where the delimeter `/'
861should be a character not used by the strings. 1006should be a character not used by the strings.
862.Sp 1007.Sp
863Its usage can be demonstrated by an example: 1008Its usage can be demonstrated by an example:
864.Sp 1009.Sp
865.Vb 1 1010.Vb 1
866\& URxvt.keysym.M-C-0x61: list|\ee<M-C-|abc|> 1011\& URxvt.keysym.M-C-0x61: list|\e033<M-C-|abc|>
867.Ve 1012.Ve
868.Sp 1013.Sp
869The above line is equivalent to the following three lines: 1014The above line is equivalent to the following three lines:
870.Sp 1015.Sp
871.Vb 3 1016.Vb 3
872\& URxvt.keysym.Meta-Control-0x61: \ee<M-C-a> 1017\& URxvt.keysym.Meta-Control-0x61: \e033<M-C-a>
873\& URxvt.keysym.Meta-Control-0x62: \ee<M-C-b> 1018\& URxvt.keysym.Meta-Control-0x62: \e033<M-C-b>
874\& URxvt.keysym.Meta-Control-0x63: \ee<M-C-c> 1019\& URxvt.keysym.Meta-Control-0x63: \e033<M-C-c>
875.Ve 1020.Ve
876.Sp 1021.Sp
877If \fIstring\fR takes the form of \f(CW\*(C`proto:STRING\*(C'\fR, the specified \fB\s-1STRING\s0\fR is 1022If \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, 1023is 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 1024example 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. 1025when Control-Meta-c is being pressed":
1026.Sp
1027.Vb 1
1028\& URxvt.keysym.M-C-c: command:\e033]701;zh_CN.GBK\e007
1029.Ve
1030.Sp
1031Due the the large number of modifier combinations, a defined key mapping
1032will match if at \fIat least\fR the specified identifiers are being set, and
1033no other key mappings with those and more bits are being defined. That
1034means that defining a key map for \f(CW\*(C`a\*(C'\fR will automatically provide
1035definitions for \f(CW\*(C`Meta\-a\*(C'\fR, \f(CW\*(C`Shift\-a\*(C'\fR and so on, unless some of those are defined
1036mappings themselves.
1037.Sp
1038Unfortunately, this will override built-in key mappings. For example
1039if you overwrite the \f(CW\*(C`Insert\*(C'\fR key you will disable @@RXVT_NAME@@'s
1040\&\f(CW\*(C`Shift\-Insert\*(C'\fR mapping. To re-enable that, you can poke \*(L"holes\*(R" into the
1041user-defined keymap using the \f(CW\*(C`builtin:\*(C'\fR replacement:
1042.Sp
1043.Vb 2
1044\& URxvt.keysym.Insert: <my insert key sequence>
1045\& URxvt.keysym.S-Insert: builtin:
1046.Ve
1047.Sp
1048The first line defines a mapping for \f(CW\*(C`Insert\*(C'\fR and \fIany\fR combination
1049of modifiers. The second line re-establishes the default mapping for
1050\&\f(CW\*(C`Shift\-Insert\*(C'\fR.
1051.Sp
1052The following example will map Control\-Meta\-1 and Control\-Meta\-2 to
1053the fonts \f(CW\*(C`suxuseuro\*(C'\fR and \f(CW\*(C`9x15bold\*(C'\fR, so you can have some limited
1054font-switching at runtime:
1055.Sp
1056.Vb 2
1057\& URxvt.keysym.M-C-1: command:\e033]50;suxuseuro\e007
1058\& URxvt.keysym.M-C-2: command:\e033]50;9x15bold\e007
1059.Ve
1060.Sp
1061Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1062info):
1063.Sp
1064.Vb 2
1065\& URxvt.keysym.M-C-3: command:\e033[8;25;80t
1066\& URxvt.keysym.M-C-4: command:\e033[8;48;110t
1067.Ve
881.SH "THE SCROLLBAR" 1068.SH "THE SCROLLBAR"
882.IX Header "THE SCROLLBAR" 1069.IX Header "THE SCROLLBAR"
883Lines of text that scroll off the top of the \fB@@RXVT_NAME@@\fR window 1070Lines 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 1071(resource: \fBsaveLines\fR) and can be scrolled back using the scrollbar
885or by keystrokes. The normal \fB@@RXVT_NAME@@\fR scrollbar has arrows and 1072or by keystrokes. The normal \fB@@RXVT_NAME@@\fR scrollbar has arrows and
… …
895the normal text selection/insertion, hold either the Shift or the Meta 1082the normal text selection/insertion, hold either the Shift or the Meta
896(Alt) key while performing the desired mouse action. 1083(Alt) key while performing the desired mouse action.
897.PP 1084.PP
898If mouse reporting mode is active, the normal scrollbar actions are 1085If mouse reporting mode is active, the normal scrollbar actions are
899disabled \*(-- on the assumption that we are using a fullscreen 1086disabled \*(-- on the assumption that we are using a fullscreen
900application. Instead, pressing Button1 and Button3 sends \fBESC[6~\fR 1087application. Instead, pressing Button1 and Button3 sends \fB\s-1ESC\s0 [ 6 ~\fR
901(Next) and \fBESC[5~\fR (Prior), respectively. Similarly, clicking on the 1088(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), 1089up and down arrows sends \fB\s-1ESC\s0 [ A\fR (Up) and \fB\s-1ESC\s0 [ B\fR (Down),
903respectively. 1090respectively.
904.SH "TEXT SELECTION AND INSERTION" 1091.SH "TEXT SELECTION AND INSERTION"
905.IX Header "TEXT SELECTION AND INSERTION" 1092.IX Header "TEXT SELECTION AND INSERTION"
906The behaviour of text selection and insertion mechanism is similar to 1093The behaviour of text selection and insertion mechanism is similar to
907\&\fIxterm\fR(1). 1094\&\fIxterm\fR(1).
908.IP "\fBSelection\fR:" 4 1095.IP "\fBSelection\fR:" 4
909.IX Item "Selection:" 1096.IX Item "Selection:"
910Left click at the beginning of the region, drag to the end of the 1097Left 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 1098and release; Right click to extend the marked region; Left double-click
912double-click to select a word; Left triple-click to select the entire 1099to select a word; Left triple-click to select the entire logical line
913line. 1100(which can span multiple screen lines), unless modified by resource
1101\&\fBtripleclickwords\fR.
914.Sp 1102.Sp
915Starting a selection while pressing the \fBMeta\fR key (or \fBMeta+Ctrl\fR keys) 1103Starting 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 1104(Compile: \fIfrills\fR) will create a rectangular selection instead of a normal
917one. 1105one.
918.IP "\fBInsertion\fR:" 4 1106.IP "\fBInsertion\fR:" 4
… …
927.PP 1115.PP
928You can, however, switch fonts at runtime using escape sequences (and 1116You can, however, switch fonts at runtime using escape sequences (and
929therefore using the menubar), e.g.: 1117therefore using the menubar), e.g.:
930.PP 1118.PP
931.Vb 1 1119.Vb 1
932\& printf '\ee]701;%s\e007' "9x15bold,xft:Kochi Gothic" 1120\& printf '\ee]710;%s\e007' "9x15bold,xft:Kochi Gothic"
933.Ve 1121.Ve
934.PP 1122.PP
935rxvt-unicode will automatically re-apply these fonts to the output so far. 1123rxvt-unicode will automatically re-apply these fonts to the output so far.
936.SH "ISO 14755 SUPPORT" 1124.SH "ISO 14755 SUPPORT"
937.IX Header "ISO 14755 SUPPORT" 1125.IX Header "ISO 14755 SUPPORT"
938\&\s-1ISO\s0 14755 is a standard for entering and viewing unicode characters 1126\&\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 1127and character codes using the keyboard. It consists of 4 parts. The
940first part is available rxvt-unicode has been compiled with 1128first 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 1129\&\f(CW\*(C`\-\-enable\-frills\*(C'\fR, the rest is available when rxvt-unicode was compiled
942with \f(CW\*(C`\-\-enable\-iso14755\*(C'\fR. 1130with \f(CW\*(C`\-\-enable\-iso14755\*(C'\fR.
943.IP "5.1: Basic method" 4 1131.IP "* 5.1: Basic method" 4
944.IX Item "5.1: Basic method" 1132.IX Item "5.1: Basic method"
945This allows you to enter unicode characters using their hexcode. 1133This allows you to enter unicode characters using their hexcode.
946.Sp 1134.Sp
947Start by pressing and holding both \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR, then enter 1135Start 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 1136hex-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 1142As 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 1143address, 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 1144address 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, 1145by 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. 1146followed by releasing the modifier keys.
959.IP "5.2: Keyboard symbols entry method" 4 1147.IP "* 5.2: Keyboard symbols entry method" 4
960.IX Item "5.2: Keyboard symbols entry method" 1148.IX Item "5.2: Keyboard symbols entry method"
961This mode lets you input characters representing the keycap symbols of 1149This mode lets you input characters representing the keycap symbols of
962your keyboard, if representable in the current locale encoding. 1150your keyboard, if representable in the current locale encoding.
963.Sp 1151.Sp
964Start by pressing \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR together, then releasing 1152Start 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 1154invoke it's usual function but instead will insert the corresponding
967keycap symbol. The symbol will only be entered when the key has been 1155keycap 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 1156released, 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 1157\&\f(CW\*(C`ISO Level 2 Switch\*(C'\fR, although your intention might have been to enter a
970reverse tab (Shift\-Tab). 1158reverse tab (Shift\-Tab).
971.IP "5.3: Screen-selection entry method" 4 1159.IP "* 5.3: Screen-selection entry method" 4
972.IX Item "5.3: Screen-selection entry method" 1160.IX Item "5.3: Screen-selection entry method"
973While this is implemented already (it's basically the selection 1161While this is implemented already (it's basically the selection
974mechanism), it could be extended by displaying a unicode character map. 1162mechanism), it could be extended by displaying a unicode character map.
975.IP "5.4: Feedback method for identifying displayed characters for later input" 4 1163.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" 1164.IX Item "5.4: Feedback method for identifying displayed characters for later input"
977This method lets you display the unicode character code associated with 1165This method lets you display the unicode character code associated with
978characters already displayed. 1166characters already displayed.
979.Sp 1167.Sp
980You enter this mode by holding down \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR together, then 1168You enter this mode by holding down \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR together, then
… …
989.PP 1177.PP
990With respect to conformance, rxvt-unicode is supposed to be compliant to 1178With 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. 1179both scenario A and B of \s-1ISO\s0 14755, including part 5.2.
992.SH "LOGIN STAMP" 1180.SH "LOGIN STAMP"
993.IX Header "LOGIN STAMP" 1181.IX Header "LOGIN STAMP"
994\&\fB@@RXVT_NAME@@\fR tries to write an entry into the \fIutmp\fR(5) file so 1182\&\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. 1183it 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 1184allow this feature, \fB@@RXVT_NAME@@\fR may need to be installed setuid root
997some systems. 1185on some systems or setgid to root or to some other group on others.
998.SH "COLORS AND GRAPHICS" 1186.SH "COLORS AND GRAPHICS"
999.IX Header "COLORS AND GRAPHICS" 1187.IX Header "COLORS AND GRAPHICS"
1000In addition to the default foreground and background colours, 1188In 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 1189\&\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 1190high-intensity bold/blink versions of the same). Here is a list of the
… …
1037.IX Item "@@RXVT_NAME@@ -fg Black -bg White -rv" 1225.IX Item "@@RXVT_NAME@@ -fg Black -bg White -rv"
1038would yield White on Black, while on \fIxterm\fR(1) it would yield Black 1226would yield White on Black, while on \fIxterm\fR(1) it would yield Black
1039on White. 1227on White.
1040.SH "ENVIRONMENT" 1228.SH "ENVIRONMENT"
1041.IX Header "ENVIRONMENT" 1229.IX Header "ENVIRONMENT"
1042\&\fB@@RXVT_NAME@@\fR sets the environment variables \fB\s-1TERM\s0\fR, \fB\s-1COLORTERM\s0\fR 1230\&\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 1231.IP "\fB\s-1TERM\s0\fR" 4
1044window id number of the \fB@@RXVT_NAME@@\fR window and it also uses and 1232.IX Item "TERM"
1045sets the environment variable \fB\s-1DISPLAY\s0\fR to specify which display 1233Normally 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 1234resources or on the commandline.
1047\&\fB\s-1RXVTPATH\s0\fR and \fB\s-1PATH\s0\fR to find \s-1XPM\s0 files. 1235.IP "\fB\s-1COLORTERM\s0\fR" 4
1236.IX Item "COLORTERM"
1237Either \f(CW\*(C`rxvt\*(C'\fR, \f(CW\*(C`rxvt\-xpm\*(C'\fR, depending on wether @@RXVT_NAME@@ was
1238compiled with \s-1XPM\s0 support, and optionally with the added extension
1239\&\f(CW\*(C`\-mono\*(C'\fR to indicate that rxvt-unicode runs on a monochrome screen.
1240.IP "\fB\s-1COLORFGBG\s0\fR" 4
1241.IX Item "COLORFGBG"
1242Set 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
1243the colour code used as default foreground/text colour (or the string
1244\&\f(CW\*(C`default\*(C'\fR to indicate that the default-colour escape sequence is to be
1245used), \f(CW\*(C`bg\*(C'\fR is the colour code used as default background colour (or the
1246string \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@@
1247was compiled with \s-1XPM\s0 support. Libraries like \f(CW\*(C`ncurses\*(C'\fR and \f(CW\*(C`slang\*(C'\fR can
1248(and do) use this information to optimize screen output.
1249.IP "\fB\s-1WINDOWID\s0\fR" 4
1250.IX Item "WINDOWID"
1251Set to the (decimal) X Window \s-1ID\s0 of the @@RXVT_NAME@@ window (the toplevel
1252window, which usually has subwindows for the scrollbar, the terminal
1253window and so on).
1254.IP "\fB\s-1TERMINFO\s0\fR" 4
1255.IX Item "TERMINFO"
1256Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
1257\&\f(CW\*(C`\-\-with\-terminfo=PATH\*(C'\fR.
1258.IP "\fB\s-1DISPLAY\s0\fR" 4
1259.IX Item "DISPLAY"
1260Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1261display in it's child processes.
1262.IP "\fB\s-1SHELL\s0\fR" 4
1263.IX Item "SHELL"
1264The shell to be used for command execution, defaults to \f(CW\*(C`/bin/sh\*(C'\fR.
1265.IP "\fB\s-1RXVTPATH\s0\fR" 4
1266.IX Item "RXVTPATH"
1267The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1268files.
1269.IP "\fB\s-1PATH\s0\fR" 4
1270.IX Item "PATH"
1271Used in the same way as \f(CW\*(C`RXVTPATH\*(C'\fR.
1272.IP "\fB\s-1RXVT_SOCKET\s0\fR" 4
1273.IX Item "RXVT_SOCKET"
1274The unix domain socket path used by @@RXVT_NAME@@c(1) and
1275@@RXVT_NAME@@d(1).
1276.Sp
1277Default \fI$HOME/.rxvt\-unicode\-\fI<nodename\fI\fR.
1278.IP "\fB\s-1HOME\s0\fR" 4
1279.IX Item "HOME"
1280Used to locate the default directory for the unix domain socket for
1281daemon communications and to locate various resource files (such as
1282\&\f(CW\*(C`.Xdefaults\*(C'\fR)
1283.IP "\fB\s-1XAPPLRESDIR\s0\fR" 4
1284.IX Item "XAPPLRESDIR"
1285Directory where various X resource files are being located.
1286.IP "\fB\s-1XENVIRONMENT\s0\fR" 4
1287.IX Item "XENVIRONMENT"
1288If set and accessible, gives the name of a X resource file to be loaded by
1289@@RXVT_NAME@@.
1048.SH "FILES" 1290.SH "FILES"
1049.IX Header "FILES" 1291.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 1292.IP "\fB/usr/lib/X11/rgb.txt\fR" 4
1054.IX Item "/usr/lib/X11/rgb.txt" 1293.IX Item "/usr/lib/X11/rgb.txt"
1055Color names. 1294Color names.
1056.SH "SEE ALSO" 1295.SH "SEE ALSO"
1057.IX Header "SEE ALSO" 1296.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) 1297@@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" 1298.SH "CURRENT PROJECT COORDINATOR"
1067.IX Header "CURRENT PROJECT COORDINATOR" 1299.IX Header "CURRENT PROJECT COORDINATOR"
1068.IP "Project Coordinator" 4 1300.IP "Project Coordinator" 4
1069.IX Item "Project Coordinator" 1301.IX Item "Project Coordinator"
1070@@RXVT_MAINT@@ @@RXVT_MAINTEMAIL@@ 1302Marc 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 1303.Sp
1075@@RXVT_WEBPAGE@@ 1304<http://software.schmorp.de/#rxvt\-unicode>
1076.SH "AUTHORS" 1305.SH "AUTHORS"
1077.IX Header "AUTHORS" 1306.IX Header "AUTHORS"
1078.IP "John Bovey" 4 1307.IP "John Bovey" 4
1079.IX Item "John Bovey" 1308.IX Item "John Bovey"
1080University of Kent, 1992, wrote the original Xvt. 1309University of Kent, 1992, wrote the original Xvt.
… …
1094Project Coordinator (changes.txt 2.21a to 2.4.5) 1323Project Coordinator (changes.txt 2.21a to 2.4.5)
1095.IP "Geoff Wing <gcw@pobox.com>" 4 1324.IP "Geoff Wing <gcw@pobox.com>" 4
1096.IX Item "Geoff Wing <gcw@pobox.com>" 1325.IX Item "Geoff Wing <gcw@pobox.com>"
1097Rewrote screen display and text selection routines. Project Coordinator 1326Rewrote screen display and text selection routines. Project Coordinator
1098(changes.txt 2.4.6 \- rxvt\-unicode) 1327(changes.txt 2.4.6 \- rxvt\-unicode)
1099.IP "Marc Alexander Lehmann <rxvt@schmorp.de>" 4 1328.IP "Marc Alexander Lehmann <rxvt\-unicode@schmorp.de>" 4
1100.IX Item "Marc Alexander Lehmann <rxvt@schmorp.de>" 1329.IX Item "Marc Alexander Lehmann <rxvt-unicode@schmorp.de>"
1101Forked rxvt\-unicode, rewrote most of the display code and internal 1330Forked rxvt\-unicode, rewrote most of the display code and internal
1102character handling to store text in unicode, improve xterm 1331character handling to store text in unicode, improve xterm
1103compatibility and apply numerous other bugfixes and extensions. 1332compatibility and apply numerous other bugfixes and extensions.
1104.Sp 1333.Sp
1105Project Coordinator (Changes 1.0 \-) 1334Project Coordinator (Changes 1.0 \-)

Diff Legend

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