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.2 by root, Sun Jan 16 15:59:45 2005 UTC vs.
Revision 1.17 by root, Wed Feb 16 22:16:30 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-16" "4.8" "RXVT-UNICODE" 132.TH rxvt 1 "2005-02-16" "5.2" "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,
248.IX Item "-fg colour" 250.IX Item "-fg colour"
249Window foreground colour; resource \fBforeground\fR. 251Window foreground colour; resource \fBforeground\fR.
250.IP "\fB\-pixmap\fR \fIfile[;geom]\fR" 4 252.IP "\fB\-pixmap\fR \fIfile[;geom]\fR" 4
251.IX Item "-pixmap file[;geom]" 253.IX Item "-pixmap file[;geom]"
252Compile \fI\s-1XPM\s0\fR: Specify \s-1XPM\s0 file for the background and also optionally 254Compile \fI\s-1XPM\s0\fR: Specify \s-1XPM\s0 file for the background and also optionally
253specify its scaling with a geometry string. Note you may need to add 255specify its scaling with a geometry string. Note you may need to
254quotes to avoid special shell interpretation of the `;' in the 256add quotes to avoid special shell interpretation of the \f(CW\*(C`;\*(C'\fR in the
255command\-line; resource \fBbackgroundPixmap\fR. 257command\-line; resource \fBbackgroundPixmap\fR.
256.IP "\fB\-cr\fR \fIcolour\fR" 4 258.IP "\fB\-cr\fR \fIcolour\fR" 4
257.IX Item "-cr colour" 259.IX Item "-cr colour"
258The cursor colour; resource \fBcursorColor\fR. 260The cursor colour; resource \fBcursorColor\fR.
259.IP "\fB\-pr\fR \fIcolour\fR" 4 261.IP "\fB\-pr\fR \fIcolour\fR" 4
408.IP "\fB\-im\fR \fItext\fR" 4 410.IP "\fB\-im\fR \fItext\fR" 4
409.IX Item "-im text" 411.IX Item "-im text"
410Compile \fI\s-1XIM\s0\fR: input method name. resource \fBinputMethod\fR. 412Compile \fI\s-1XIM\s0\fR: input method name. resource \fBinputMethod\fR.
411.IP "\fB\-imlocale\fR \fIstring\fR" 4 413.IP "\fB\-imlocale\fR \fIstring\fR" 4
412.IX Item "-imlocale string" 414.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. 415The 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 416\&\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 417input extension to be able to input japanese characters while staying in
416another locale. 418another locale. resource \fBimLocale\fR.
419.IP "\fB\-imfont\fR \fIfontset\fR" 4
420.IX Item "-imfont fontset"
421Set the font set to use for the X Input Method, see resource \fBimFont\fR
422for more info.
423.IP "\fB\-tcw\fR" 4
424.IX Item "-tcw"
425Change the meaning of triple-click selection with the left mouse
426button. Instead of selecting a full line it will extend the selection the
427end of the logical line only. resource \fBtripleclickwords\fR.
417.IP "\fB\-insecure\fR" 4 428.IP "\fB\-insecure\fR" 4
418.IX Item "-insecure" 429.IX Item "-insecure"
419Enable \*(L"insecure\*(R" mode, which currently enables most of the escape 430Enable \*(L"insecure\*(R" mode, which currently enables most of the escape
420sequences that echo strings. See the resource \fBinsecure\fR for more 431sequences that echo strings. See the resource \fBinsecure\fR for more
421info. 432info.
430\&\fBsecondaryScreen\fR. 441\&\fBsecondaryScreen\fR.
431.IP "\fB\-ssr\fR|\fB+ssr\fR" 4 442.IP "\fB\-ssr\fR|\fB+ssr\fR" 4
432.IX Item "-ssr|+ssr" 443.IX Item "-ssr|+ssr"
433Turn on/off secondary screen scroll (default enabled); resource 444Turn on/off secondary screen scroll (default enabled); resource
434\&\fBsecondaryScroll\fR. 445\&\fBsecondaryScroll\fR.
435.IP "\fB\-xrm\fR \fIresourcestring\fR" 4 446.IP "\fB\-keysym.\fR\fIsym\fR: \fIstring\fR" 4
436.IX Item "-xrm resourcestring" 447.IX Item "-keysym.sym: string"
437No effect on rxvt\-unicode. Simply passes through an argument to be made 448Remap a key symbol. See resource \fBkeysym\fR.
438available in the instance's argument list. Appears in \fI\s-1WM_COMMAND\s0\fR in 449.IP "\fB\-embed\fR: \fIwindowid\fR" 4
439some window managers. 450.IX Item "-embed: windowid"
451Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window,
452which enables applications to easily embed a terminal.
453.Sp
454Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
455shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
456quite a bit, so don't expect it to keep some specific state. It's best to
457create an extra subwindow for @@RXVT_NAME@@ and leave it alone.
458.Sp
459The window will not be destroyed when @@RXVT_NAME@@ exits.
460.Sp
461It might be useful to know that @@RXVT_NAME@@ will not close file
462descriptors passed to it (except for stdin/out/err, of course), so you
463can use file descriptors to communicate with the programs within the
464terminal. This works regardless of wether the \f(CW\*(C`\-embed\*(C'\fR option was used or
465not.
440.SH "RESOURCES (available also as long\-options)" 466.SH "RESOURCES (available also as long\-options)"
441.IX Header "RESOURCES (available also as long-options)" 467.IX Header "RESOURCES (available also as long-options)"
442Note: `@@RXVT_NAME@@ \-\-help' gives a list of all resources (long 468Note: `@@RXVT_NAME@@ \-\-help' gives a list of all resources (long
443options) compiled into your version. 469options) compiled into your version.
444.PP 470.PP
445There are two different methods that @@RXVT_NAME@@ can use to get the 471There are two different methods that @@RXVT_NAME@@ can use to get the
446Xresource data: using the X libraries (Xrm*\-functions) or internal 472Xresource data: using the X libraries (Xrm*\-functions) or internal
447Xresources reader (\fB~/.Xdefaults\fR). For the first method (ie. 473Xresources reader (\fB~/.Xdefaults\fR). For the first method (ie.
448\&\fB@@RXVT_NAME@@ \-h\fR lists \fBXGetDefaults\fR), you can set and change the 474\&\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 475resources using X11 tools like \fBxrdb\fR. Many distribution do also load
450settings from the \fB~/.Xresources\fR file when X starts. 476settings from the \fB~/.Xresources\fR file when X starts. @@RXVT_NAME@@
477will consult the following files/resources in order, with later settings
478overwriting earlier ones:
479.PP
480.Vb 5
481\& 1. system-wide app-defaults file, either locale-dependent OR global
482\& 2. app-defaults file in $XAPPLRESDIR
483\& 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
484\& 4. SCREEN_RESOURCES for the current screen
485\& 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
486.Ve
451.PP 487.PP
452If compiled with internal Xresources support (i.e. \fB@@RXVT_NAME@@ \-h\fR 488If compiled with internal Xresources support (i.e. \fB@@RXVT_NAME@@ \-h\fR
453lists \fB.Xdefaults\fR) then \fB@@RXVT_NAME@@\fR accepts application defaults 489lists \fB.Xdefaults\fR) then \fB@@RXVT_NAME@@\fR accepts application defaults
454set in XAPPLOADDIR/URxvt (compile\-time defined: usually 490set in XAPPLOADDIR/URxvt (compile\-time defined: usually
455\&\fB/usr/lib/X11/app\-defaults/URxvt\fR) and resources set in 491\&\fB/usr/lib/X11/app\-defaults/URxvt\fR) and resources set in
495.IP "\fBcolorIT:\fR \fIcolour\fR" 4 531.IP "\fBcolorIT:\fR \fIcolour\fR" 4
496.IX Item "colorIT: colour" 532.IX Item "colorIT: colour"
497.PD 533.PD
498Use the specified colour to display bold or italic characters when the 534Use the specified colour to display bold or italic characters when the
499foreground colour is the default. If font styles are not available 535foreground colour is the default. If font styles are not available
500(Compile styles) and this option is unset, reverse video is used instead. 536(Compile \fIstyles\fR) and this option is unset, reverse video is used instead.
501.IP "\fBcolorUL:\fR \fIcolour\fR" 4 537.IP "\fBcolorUL:\fR \fIcolour\fR" 4
502.IX Item "colorUL: colour" 538.IX Item "colorUL: colour"
503Use the specified colour to display underlined characters when the 539Use the specified colour to display underlined characters when the
504foreground colour is the default. 540foreground colour is the default.
505.IP "\fBcolorRV:\fR \fIcolour\fR" 4 541.IP "\fBcolorRV:\fR \fIcolour\fR" 4
583The first font defines the cell size for characters; other fonts might 619The first font defines the cell size for characters; other fonts might
584be smaller, but not larger. A reasonable default font list is always 620be smaller, but not larger. A reasonable default font list is always
585appended to it. option \fB\-fn\fR. 621appended to it. option \fB\-fn\fR.
586.Sp 622.Sp
587Each font can either be a standard X11 core font (\s-1XLFD\s0) name, with 623Each 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 xft), prefixed with \f(CW\*(C`xft:\*(C'\fR. 624optional prefix \f(CW\*(C`x:\*(C'\fR or a Xft font (Compile \fIxft\fR), prefixed with \f(CW\*(C`xft:\*(C'\fR.
589.Sp 625.Sp
590In addition, each font can be prefixed with additional hints and 626In addition, each font can be prefixed with additional hints and
591specifications enclosed in square brackets (\f(CW\*(C`[]\*(C'\fR). The only available 627specifications enclosed in square brackets (\f(CW\*(C`[]\*(C'\fR). The only available
592hint currently is \f(CW\*(C`codeset=codeset\-name\*(C'\fR, and this is only used for Xft 628hint currently is \f(CW\*(C`codeset=codeset\-name\*(C'\fR, and this is only used for Xft
593fonts. 629fonts.
704\&\fBFalse\fR: do not scroll to bottom when tty receives output; option 740\&\fBFalse\fR: do not scroll to bottom when tty receives output; option
705\&\fB+si\fR. 741\&\fB+si\fR.
706.IP "\fBscrollWithBuffer:\fR \fIboolean\fR" 4 742.IP "\fBscrollWithBuffer:\fR \fIboolean\fR" 4
707.IX Item "scrollWithBuffer: boolean" 743.IX Item "scrollWithBuffer: boolean"
708\&\fBTrue\fR: scroll with scrollback buffer when tty receives new lines (and 744\&\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 745\&\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. 746with scrollback buffer when tty recieves new lines; option \fB+sw\fR.
711.IP "\fBscrollTtyKeypress:\fR \fIboolean\fR" 4 747.IP "\fBscrollTtyKeypress:\fR \fIboolean\fR" 4
712.IX Item "scrollTtyKeypress: boolean" 748.IX Item "scrollTtyKeypress: boolean"
713\&\fBTrue\fR: scroll to bottom when a non-special key is pressed. Special keys 749\&\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 750are 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 751are not passed onto the shell; option \fB\-sk\fR. \fBFalse\fR: do not scroll to
791.IP "\fBinputMethod:\fR \fIname\fR" 4 827.IP "\fBinputMethod:\fR \fIname\fR" 4
792.IX Item "inputMethod: name" 828.IX Item "inputMethod: name"
793\&\fIname\fR of inputMethod to use; option \fB\-im\fR. 829\&\fIname\fR of inputMethod to use; option \fB\-im\fR.
794.IP "\fBimLocale:\fR \fIname\fR" 4 830.IP "\fBimLocale:\fR \fIname\fR" 4
795.IX Item "imLocale: name" 831.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. 832The 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 833\&\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 834input extension to be able to input japanese characters while staying in
799another locale. option \fB\-imlocale\fR. 835another locale. option \fB\-imlocale\fR.
836.IP "\fBimFont:\fR \fIfontset\fR" 4
837.IX Item "imFont: fontset"
838Specify the font-set used for \s-1XIM\s0 styles \f(CW\*(C`OverTheSpot\*(C'\fR or
839\&\f(CW\*(C`OffTheSpot\*(C'\fR. It must be a standard X font set (\s-1XLFD\s0 patterns separated
840by commas), i.e. it's not in the same format as the other font lists used
841in @@RXVT_NAME@@. The default will be set-up to chose *any* suitable found
842found, preferably one or two pixels differing in size to the base font.
843option \fB\-imfont\fR.
844.IP "\fBtripleclickwords:\fR \fIboolean\fR" 4
845.IX Item "tripleclickwords: boolean"
846Change the meaning of triple-click selection with the left mouse
847button. Instead of selecting a full line it will extend the selection to
848the end of the logical line only. option \fB\-tcw\fR.
800.IP "\fBinsecure:\fR \fIboolean\fR" 4 849.IP "\fBinsecure:\fR \fIboolean\fR" 4
801.IX Item "insecure: boolean" 850.IX Item "insecure: boolean"
802Enables \*(L"insecure\*(R" mode. Rxvt-unicode offers some escape sequences that 851Enables \*(L"insecure\*(R" mode. Rxvt-unicode offers some escape sequences that
803echo arbitrary strings like the icon name or the locale. This could be 852echo arbitrary strings like the icon name or the locale. This could be
804abused if somebody gets 8\-bit\-clean access to your display, whether 853abused if somebody gets 8\-bit\-clean access to your display, whether
828option is enabled, scrolls on the secondary screen will change the 877option is enabled, scrolls on the secondary screen will change the
829scrollback buffer and switching to/from the secondary screen will 878scrollback buffer and switching to/from the secondary screen will
830instead scroll the screen up. 879instead scroll the screen up.
831.IP "\fBkeysym.\fR\fIsym\fR: \fIstring\fR" 4 880.IP "\fBkeysym.\fR\fIsym\fR: \fIstring\fR" 4
832.IX Item "keysym.sym: string" 881.IX Item "keysym.sym: string"
833Associate \fIstring\fR with keysym \fIsym\fR. The intervening resource 882Compile \fIfrills\fR: Associate \fIstring\fR with keysym \fIsym\fR. The
834name \fBkeysym.\fR cannot be omitted. This resource is only available 883intervening resource name \fBkeysym.\fR cannot be omitted.
835when compiled with \s-1KEYSYM_RESOURCE\s0.
836.Sp 884.Sp
837The format of \fIsym\fR is "\fI(mask\-)key\fR", 885The format of \fIsym\fR is "\fI(modifiers\-)key\fR", where \fImodifiers\fR can be
838where \fImask\fR can be any combination of \fBControl\fR, \fBNumLock\fR, 886any combination of \fBISOLevel3\fR, \fBAppKeypad\fR, \fBControl\fR, \fBNumLock\fR,
839\&\fBShift\fR, \fBMeta\fR, \fBLock\fR, \fBMod1\fR, \fBMod2\fR, \fBMod3\fR, \fBMod4\fR, 887\&\fBShift\fR, \fBMeta\fR, \fBLock\fR, \fBMod1\fR, \fBMod2\fR, \fBMod3\fR, \fBMod4\fR, \fBMod5\fR,
840\&\fBMod5\fR, and the abbreviated 888and the abbreviated \fBI\fR, \fBK\fR, \fBC\fR, \fBN\fR, \fBS\fR, \fBM\fR, \fBA\fR, \fBL\fR, \fB1\fR,
841\&\fBC\fR, \fBN\fR, \fBS\fR, \fBM\fR, \fBA\fR, \fBL\fR, \fB1\fR, \fB2\fR, \fB3\fR, \fB4\fR, \fB5\fR. 889\&\fB2\fR, \fB3\fR, \fB4\fR, \fB5\fR.
890.Sp
891The \fBNumLock\fR, \fBMeta\fR and \fBISOLevel3\fR modifiers are usually aliased to
892whatever modifier the NumLock key, Meta/Alt keys or \s-1ISO\s0 Level3 Shift/AltGr
893keys are being mapped. \fBAppKeypad\fR is a synthetic modifier mapped to the
894current application keymap mode state.
895.Sp
842The spellings of \fIkey\fR can be obtained by using \fBxev\fR(1) 896The spellings of \fIkey\fR can be obtained by using \fBxev\fR(1) command or
843command or searching keysym macros from 897searching keysym macros from \fB/usr/X11R6/include/X11/keysymdef.h\fR and
844\&\fB/usr/X11R6/include/X11/keysymdef.h\fR and omit the prefix \fB\s-1XK_\s0\fR. 898omitting the prefix \fB\s-1XK_\s0\fR. Alternatively you can specify \fIkey\fR by its hex
845Alternatively you can specify \fIkey\fR by its hex keysym value 899keysym value (\fB0x0000 \- 0xFFFF\fR). Note that the lookup of \fIsym\fRs is not
846(\fB0x0000 \- 0xFFFF\fR). 900performed in an exact manner; however, the closest match is assured.
847Note that the lookup of \fIsym\fRs is not performed in an exact manner;
848however, the closest match is assured.
849.Sp 901.Sp
850\&\fIstring\fR may 902\&\fIstring\fR may contain escape values (\f(CW\*(C`\ea\*(C'\fR: bell, \f(CW\*(C`\eb\*(C'\fR: backspace,
851contain escape values (\ea: bell, \eb: backspace, \ee, \eE: escape, \en: 903\&\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,
852newline, \er: return, \et: 904\&\f(CW\*(C`\e000\*(C'\fR: octal number) or verbatim control characters (\f(CW\*(C`^?\*(C'\fR: delete,
853tab, \e000: octal number) or control characters (^?: delete, ^@: null, 905\&\f(CW\*(C`^@\*(C'\fR: null, \f(CW\*(C`^A\*(C'\fR ...) and may be enclosed with double quotes so that it
854^A ...) and may enclosed with double quotes so that it can start or end 906can start or end with whitespace.
855with whitespace. 907.Sp
908Please note that you need to double the \f(CW\*(C`\e\*(C'\fR when using
909\&\f(CW\*(C`\-\-enable\-xgetdefault\*(C'\fR, as X itself does it's own de-escaping (you can
910use \f(CW\*(C`\e033\*(C'\fR instead of \f(CW\*(C`\ee\*(C'\fR (and so on), which will work with both Xt and
911@@RXVT_NAME@@'s own processing).
856.Sp 912.Sp
857You can define a range of keysyms in one shot by providing a \fIstring\fR 913You can define a range of keysyms in one shot by providing a \fIstring\fR
858with pattern \fBlist/STRING1/STRING2/STRING3\fR, where the delimeter `/' 914with pattern \fBlist/PREFIX/MIDDLE/SUFFIX\fR, where the delimeter `/'
859should be a character not used by the \fB\s-1STRING\s0\fRs. 915should be a character not used by the strings.
860.Sp 916.Sp
861Its usage can be demonstrated by an example: 917Its usage can be demonstrated by an example:
862 URxvt.keysym.M\-C\-0x61: list.abc.\ee<M\-C\-.> 918.Sp
919.Vb 1
920\& URxvt.keysym.M-C-0x61: list|\e033<M-C-|abc|>
921.Ve
863.Sp 922.Sp
864The above line is equivalent to the following three lines: 923The above line is equivalent to the following three lines:
924.Sp
925.Vb 3
865 URxvt.keysym.Meta\-Control\-0x61: \ee<M\-C\-a> 926\& URxvt.keysym.Meta-Control-0x61: \e033<M-C-a>
866 URxvt.keysym.Meta\-Control\-0x62: \ee<M\-C\-b> 927\& URxvt.keysym.Meta-Control-0x62: \e033<M-C-b>
867 URxvt.keysym.Meta\-Control\-0x63: \ee<M\-C\-c> 928\& URxvt.keysym.Meta-Control-0x63: \e033<M-C-c>
929.Ve
868.Sp 930.Sp
869If \fIstring\fR takes the form of \fBproto:STRING\fR, 931If \fIstring\fR takes the form of \f(CW\*(C`command:STRING\*(C'\fR, the specified \fB\s-1STRING\s0\fR
870the specified \fB\s-1STRING\s0\fR is interpreted and executed as \fB@@RXVT_NAME@@\fR's 932is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
871control sequence. For example, \fB\*(L"proto:\e033]701;zh_CN.GBK\e007\*(R"\fR 933example the following means "change the current locale to \f(CW\*(C`zh_CN.GBK\*(C'\fR
872means changing the current locale to zh_CN.GBK. 934when Control-Meta-c is being pressed":
935.Sp
936.Vb 1
937\& URxvt.keysym.M-C-c: command:\e033]701;zh_CN.GBK\e007
938.Ve
939.Sp
940The following example will map Control\-Meta\-1 and Control\-Meta\-2 to
941the fonts \f(CW\*(C`suxuseuro\*(C'\fR and \f(CW\*(C`9x15bold\*(C'\fR, so you can have some limited
942font-switching at runtime:
943.Sp
944.Vb 2
945\& URxvt.keysym.M-C-1: command:\e033]50;suxuseuro\e007
946\& URxvt.keysym.M-C-2: command:\e033]50;9x15bold\e007
947.Ve
948.Sp
949Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
950info):
951.Sp
952.Vb 2
953\& URxvt.keysym.M-C-3: command:\e033[8;25;80t
954\& URxvt.keysym.M-C-4: command:\e033[8;48;110t
955.Ve
873.SH "THE SCROLLBAR" 956.SH "THE SCROLLBAR"
874.IX Header "THE SCROLLBAR" 957.IX Header "THE SCROLLBAR"
875Lines of text that scroll off the top of the \fB@@RXVT_NAME@@\fR window 958Lines of text that scroll off the top of the \fB@@RXVT_NAME@@\fR window
876(resource: \fBsaveLines\fR) and can be scrolled back using the scrollbar 959(resource: \fBsaveLines\fR) and can be scrolled back using the scrollbar
877or by keystrokes. The normal \fB@@RXVT_NAME@@\fR scrollbar has arrows and 960or by keystrokes. The normal \fB@@RXVT_NAME@@\fR scrollbar has arrows and
887the normal text selection/insertion, hold either the Shift or the Meta 970the normal text selection/insertion, hold either the Shift or the Meta
888(Alt) key while performing the desired mouse action. 971(Alt) key while performing the desired mouse action.
889.PP 972.PP
890If mouse reporting mode is active, the normal scrollbar actions are 973If mouse reporting mode is active, the normal scrollbar actions are
891disabled \*(-- on the assumption that we are using a fullscreen 974disabled \*(-- on the assumption that we are using a fullscreen
892application. Instead, pressing Button1 and Button3 sends \fBESC[6~\fR 975application. Instead, pressing Button1 and Button3 sends \fB\s-1ESC\s0 [ 6 ~\fR
893(Next) and \fBESC[5~\fR (Prior), respectively. Similarly, clicking on the 976(Next) and \fB\s-1ESC\s0 [ 5 ~\fR (Prior), respectively. Similarly, clicking on the
894up and down arrows sends \fBESC[A\fR (Up) and \fBESC[B\fR (Down), 977up and down arrows sends \fB\s-1ESC\s0 [ A\fR (Up) and \fB\s-1ESC\s0 [ B\fR (Down),
895respectively. 978respectively.
896.SH "TEXT SELECTION AND INSERTION" 979.SH "TEXT SELECTION AND INSERTION"
897.IX Header "TEXT SELECTION AND INSERTION" 980.IX Header "TEXT SELECTION AND INSERTION"
898The behaviour of text selection and insertion mechanism is similar to 981The behaviour of text selection and insertion mechanism is similar to
899\&\fIxterm\fR(1). 982\&\fIxterm\fR(1).
900.IP "\fBSelection\fR:" 4 983.IP "\fBSelection\fR:" 4
901.IX Item "Selection:" 984.IX Item "Selection:"
902Left click at the beginning of the region, drag to the end of the 985Left click at the beginning of the region, drag to the end of the region
903region and release; Right click to extend the marked region; Left 986and release; Right click to extend the marked region; Left double-click
904double-click to select a word; Left triple-click to select the entire 987to select a word; Left triple-click to select the entire logical line
905line. 988(which can span multiple screen lines), unless modified by resource
989\&\fBtripleclickwords\fR.
906.Sp 990.Sp
907Starting a selection while pressing the \fBMeta\fR key (or \fBMeta+Ctrl\fR keys) 991Starting a selection while pressing the \fBMeta\fR key (or \fBMeta+Ctrl\fR keys)
908(Compile: frills) will create a rectangular selection instead of a normal 992(Compile: \fIfrills\fR) will create a rectangular selection instead of a normal
909one. 993one.
910.IP "\fBInsertion\fR:" 4 994.IP "\fBInsertion\fR:" 4
911.IX Item "Insertion:" 995.IX Item "Insertion:"
912Pressing and releasing the Middle mouse button (or \fBShift-Insert\fR) in 996Pressing and releasing the Middle mouse button (or \fBShift-Insert\fR) in
913an \fB@@RXVT_NAME@@\fR window causes the current text selection to be 997an \fB@@RXVT_NAME@@\fR window causes the current text selection to be
930\&\s-1ISO\s0 14755 is a standard for entering and viewing unicode characters 1014\&\s-1ISO\s0 14755 is a standard for entering and viewing unicode characters
931and character codes using the keyboard. It consists of 4 parts. The 1015and character codes using the keyboard. It consists of 4 parts. The
932first part is available rxvt-unicode has been compiled with 1016first part is available rxvt-unicode has been compiled with
933\&\f(CW\*(C`\-\-enable\-frills\*(C'\fR, the rest is available when rxvt-unicode was compiled 1017\&\f(CW\*(C`\-\-enable\-frills\*(C'\fR, the rest is available when rxvt-unicode was compiled
934with \f(CW\*(C`\-\-enable\-iso14755\*(C'\fR. 1018with \f(CW\*(C`\-\-enable\-iso14755\*(C'\fR.
935.IP "5.1: Basic method" 4 1019.IP "* 5.1: Basic method" 4
936.IX Item "5.1: Basic method" 1020.IX Item "5.1: Basic method"
937This allows you to enter unicode characters using their hexcode. 1021This allows you to enter unicode characters using their hexcode.
938.Sp 1022.Sp
939Start by pressing and holding both \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR, then enter 1023Start by pressing and holding both \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR, then enter
940hex-digits (between one and six). Releasing \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR will 1024hex-digits (between one and six). Releasing \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR will
946As an example of use, imagine a business card with a japanese e\-mail 1030As an example of use, imagine a business card with a japanese e\-mail
947address, which you cannot type. Fortunately, the card has the e\-mail 1031address, which you cannot type. Fortunately, the card has the e\-mail
948address printed as hexcodes, e.g. \f(CW\*(C`671d 65e5\*(C'\fR. You can enter this easily 1032address printed as hexcodes, e.g. \f(CW\*(C`671d 65e5\*(C'\fR. You can enter this easily
949by 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, 1033by 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,
950followed by releasing the modifier keys. 1034followed by releasing the modifier keys.
951.IP "5.2: Keyboard symbols entry method" 4 1035.IP "* 5.2: Keyboard symbols entry method" 4
952.IX Item "5.2: Keyboard symbols entry method" 1036.IX Item "5.2: Keyboard symbols entry method"
953This mode lets you input characters representing the keycap symbols of 1037This mode lets you input characters representing the keycap symbols of
954your keyboard, if representable in the current locale encoding. 1038your keyboard, if representable in the current locale encoding.
955.Sp 1039.Sp
956Start by pressing \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR together, then releasing 1040Start by pressing \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR together, then releasing
958invoke it's usual function but instead will insert the corresponding 1042invoke it's usual function but instead will insert the corresponding
959keycap symbol. The symbol will only be entered when the key has been 1043keycap symbol. The symbol will only be entered when the key has been
960released, otherwise pressing e.g. \f(CW\*(C`Shift\*(C'\fR would enter the symbol for 1044released, otherwise pressing e.g. \f(CW\*(C`Shift\*(C'\fR would enter the symbol for
961\&\f(CW\*(C`ISO Level 2 Switch\*(C'\fR, although your intention might have been to enter a 1045\&\f(CW\*(C`ISO Level 2 Switch\*(C'\fR, although your intention might have been to enter a
962reverse tab (Shift\-Tab). 1046reverse tab (Shift\-Tab).
963.IP "5.3: Screen-selection entry method" 4 1047.IP "* 5.3: Screen-selection entry method" 4
964.IX Item "5.3: Screen-selection entry method" 1048.IX Item "5.3: Screen-selection entry method"
965While this is implemented already (it's basically the selection 1049While this is implemented already (it's basically the selection
966mechanism), it could be extended by displaying a unicode character map. 1050mechanism), it could be extended by displaying a unicode character map.
967.IP "5.4: Feedback method for identifying displayed characters for later input" 4 1051.IP "* 5.4: Feedback method for identifying displayed characters for later input" 4
968.IX Item "5.4: Feedback method for identifying displayed characters for later input" 1052.IX Item "5.4: Feedback method for identifying displayed characters for later input"
969This method lets you display the unicode character code associated with 1053This method lets you display the unicode character code associated with
970characters already displayed. 1054characters already displayed.
971.Sp 1055.Sp
972You enter this mode by holding down \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR together, then 1056You enter this mode by holding down \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR together, then
981.PP 1065.PP
982With respect to conformance, rxvt-unicode is supposed to be compliant to 1066With respect to conformance, rxvt-unicode is supposed to be compliant to
983both scenario A and B of \s-1ISO\s0 14755, including part 5.2. 1067both scenario A and B of \s-1ISO\s0 14755, including part 5.2.
984.SH "LOGIN STAMP" 1068.SH "LOGIN STAMP"
985.IX Header "LOGIN STAMP" 1069.IX Header "LOGIN STAMP"
986\&\fB@@RXVT_NAME@@\fR tries to write an entry into the \fIutmp\fR(5) file so 1070\&\fB@@RXVT_NAME@@\fR tries to write an entry into the \fIutmp\fR(5) file so that
987that it can be seen via the \fI\fIwho\fI\|(1)\fR command, and can accept messages. 1071it can be seen via the \fI\fIwho\fI\|(1)\fR command, and can accept messages. To
988To allow this feature, \fB@@RXVT_NAME@@\fR must be installed setuid root on 1072allow this feature, \fB@@RXVT_NAME@@\fR may need to be installed setuid root
989some systems. 1073on some systems or setgid to root or to some other group on others.
990.SH "COLORS AND GRAPHICS" 1074.SH "COLORS AND GRAPHICS"
991.IX Header "COLORS AND GRAPHICS" 1075.IX Header "COLORS AND GRAPHICS"
992In addition to the default foreground and background colours, 1076In addition to the default foreground and background colours,
993\&\fB@@RXVT_NAME@@\fR can display up to 16 colours (8 \s-1ANSI\s0 colours plus 1077\&\fB@@RXVT_NAME@@\fR can display up to 16 colours (8 \s-1ANSI\s0 colours plus
994high-intensity bold/blink versions of the same). Here is a list of the 1078high-intensity bold/blink versions of the same). Here is a list of the
1029.IX Item "@@RXVT_NAME@@ -fg Black -bg White -rv" 1113.IX Item "@@RXVT_NAME@@ -fg Black -bg White -rv"
1030would yield White on Black, while on \fIxterm\fR(1) it would yield Black 1114would yield White on Black, while on \fIxterm\fR(1) it would yield Black
1031on White. 1115on White.
1032.SH "ENVIRONMENT" 1116.SH "ENVIRONMENT"
1033.IX Header "ENVIRONMENT" 1117.IX Header "ENVIRONMENT"
1034\&\fB@@RXVT_NAME@@\fR sets the environment variables \fB\s-1TERM\s0\fR, \fB\s-1COLORTERM\s0\fR 1118\&\fB@@RXVT_NAME@@\fR sets and/or uses the following environment variables:
1035and \fB\s-1COLORFGBG\s0\fR. The environment variable \fB\s-1WINDOWID\s0\fR is set to the X 1119.IP "\fB\s-1TERM\s0\fR" 4
1036window id number of the \fB@@RXVT_NAME@@\fR window and it also uses and 1120.IX Item "TERM"
1037sets the environment variable \fB\s-1DISPLAY\s0\fR to specify which display 1121Normally set to \f(CW\*(C`rxvt\-unicode\*(C'\fR, unless overwritten at configure time, via
1038terminal to use. \fB@@RXVT_NAME@@\fR uses the environment variables 1122resources or on the commandline.
1039\&\fB\s-1RXVTPATH\s0\fR and \fB\s-1PATH\s0\fR to find \s-1XPM\s0 files. 1123.IP "\fB\s-1COLORTERM\s0\fR" 4
1124.IX Item "COLORTERM"
1125Either \f(CW\*(C`rxvt\*(C'\fR, \f(CW\*(C`rxvt\-xpm\*(C'\fR, depending on wether @@RXVT_NAME@@ was
1126compiled with \s-1XPM\s0 support, and optionally with the added extension
1127\&\f(CW\*(C`\-mono\*(C'\fR to indicate that rxvt-unicode runs on a monochrome screen.
1128.IP "\fB\s-1COLORFGBG\s0\fR" 4
1129.IX Item "COLORFGBG"
1130Set 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
1131the colour code used as default foreground/text colour (or the string
1132\&\f(CW\*(C`default\*(C'\fR to indicate that the default-colour escape sequence is to be
1133used), \f(CW\*(C`bg\*(C'\fR is the colour code used as default background colour (or the
1134string \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@@
1135was compiled with \s-1XPM\s0 support. Libraries like \f(CW\*(C`ncurses\*(C'\fR and \f(CW\*(C`slang\*(C'\fR can
1136(and do) use this information to optimize screen output.
1137.IP "\fB\s-1WINDOWID\s0\fR" 4
1138.IX Item "WINDOWID"
1139Set to the (decimal) X Window \s-1ID\s0 of the @@RXVT_NAME@@ window (the toplevel
1140window, which usually has subwindows for the scrollbar, the terminal
1141window and so on).
1142.IP "\fB\s-1TERMINFO\s0\fR" 4
1143.IX Item "TERMINFO"
1144Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
1145\&\f(CW\*(C`\-\-with\-terminfo=PATH\*(C'\fR.
1146.IP "\fB\s-1DISPLAY\s0\fR" 4
1147.IX Item "DISPLAY"
1148Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1149display in it's child processes.
1150.IP "\fB\s-1SHELL\s0\fR" 4
1151.IX Item "SHELL"
1152The shell to be used for command execution, defaults to \f(CW\*(C`/bin/sh\*(C'\fR.
1153.IP "\fB\s-1RXVTPATH\s0\fR" 4
1154.IX Item "RXVTPATH"
1155The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1156files.
1157.IP "\fB\s-1PATH\s0\fR" 4
1158.IX Item "PATH"
1159Used in the same way as \f(CW\*(C`RXVTPATH\*(C'\fR.
1160.IP "\fB\s-1RXVT_SOCKET\s0\fR" 4
1161.IX Item "RXVT_SOCKET"
1162The unix domain socket path used by @@RXVT_NAME@@c(1) and
1163@@RXVT_NAME@@d(1).
1164.Sp
1165Default \f(CW\*(C`$HOME/.rxvt\-unicode\-<nodename\*(C'\fR.
1166.IP "\fB\s-1HOME\s0\fR" 4
1167.IX Item "HOME"
1168Used to locate the default directory for the unix domain socket for
1169daemon communications and to locate various resource files (such as
1170\&\f(CW\*(C`.Xdefaults\*(C'\fR)
1171.IP "\fB\s-1XAPPLRESDIR\s0\fR" 4
1172.IX Item "XAPPLRESDIR"
1173Directory where various X resource files are being located.
1174.IP "\fB\s-1XENVIRONMENT\s0\fR" 4
1175.IX Item "XENVIRONMENT"
1176If set and accessible, gives the name of a X resource file to be loaded by
1177@@RXVT_NAME@@.
1040.SH "FILES" 1178.SH "FILES"
1041.IX Header "FILES" 1179.IX Header "FILES"
1042.IP "\fB/etc/utmp\fR" 4
1043.IX Item "/etc/utmp"
1044System file for login records.
1045.IP "\fB/usr/lib/X11/rgb.txt\fR" 4 1180.IP "\fB/usr/lib/X11/rgb.txt\fR" 4
1046.IX Item "/usr/lib/X11/rgb.txt" 1181.IX Item "/usr/lib/X11/rgb.txt"
1047Color names. 1182Color names.
1048.SH "SEE ALSO" 1183.SH "SEE ALSO"
1049.IX Header "SEE ALSO" 1184.IX Header "SEE ALSO"
1057Click-and-drag doesn't work with X11 mouse report overriding. 1192Click-and-drag doesn't work with X11 mouse report overriding.
1058.SH "CURRENT PROJECT COORDINATOR" 1193.SH "CURRENT PROJECT COORDINATOR"
1059.IX Header "CURRENT PROJECT COORDINATOR" 1194.IX Header "CURRENT PROJECT COORDINATOR"
1060.IP "Project Coordinator" 4 1195.IP "Project Coordinator" 4
1061.IX Item "Project Coordinator" 1196.IX Item "Project Coordinator"
1062@@RXVT_MAINT@@ @@RXVT_MAINTEMAIL@@ 1197Marc A. Lehmann <rxvt\-unicode@schmorp.de>
1063.IP "Web page maintainter" 4
1064.IX Item "Web page maintainter"
1065@@RXVT_WEBMAINT@@ @@RXVT_WEBMAINTEMAIL@@
1066.Sp 1198.Sp
1067@@RXVT_WEBPAGE@@ 1199<http://software.schmorp.de/#rxvt\-unicode>
1068.SH "AUTHORS" 1200.SH "AUTHORS"
1069.IX Header "AUTHORS" 1201.IX Header "AUTHORS"
1070.IP "John Bovey" 4 1202.IP "John Bovey" 4
1071.IX Item "John Bovey" 1203.IX Item "John Bovey"
1072University of Kent, 1992, wrote the original Xvt. 1204University of Kent, 1992, wrote the original Xvt.
1086Project Coordinator (changes.txt 2.21a to 2.4.5) 1218Project Coordinator (changes.txt 2.21a to 2.4.5)
1087.IP "Geoff Wing <gcw@pobox.com>" 4 1219.IP "Geoff Wing <gcw@pobox.com>" 4
1088.IX Item "Geoff Wing <gcw@pobox.com>" 1220.IX Item "Geoff Wing <gcw@pobox.com>"
1089Rewrote screen display and text selection routines. Project Coordinator 1221Rewrote screen display and text selection routines. Project Coordinator
1090(changes.txt 2.4.6 \- rxvt\-unicode) 1222(changes.txt 2.4.6 \- rxvt\-unicode)
1091.IP "Marc Alexander Lehmann <rxvt@schmorp.de>" 4 1223.IP "Marc Alexander Lehmann <rxvt\-unicode@schmorp.de>" 4
1092.IX Item "Marc Alexander Lehmann <rxvt@schmorp.de>" 1224.IX Item "Marc Alexander Lehmann <rxvt-unicode@schmorp.de>"
1093Forked rxvt\-unicode, rewrote most of the display code and internal 1225Forked rxvt\-unicode, rewrote most of the display code and internal
1094character handling to store text in unicode, improve xterm 1226character handling to store text in unicode, improve xterm
1095compatibility and apply numerous other bugfixes and extensions. 1227compatibility and apply numerous other bugfixes and extensions.
1096.Sp 1228.Sp
1097Project Coordinator (Changes 1.0 \-) 1229Project Coordinator (Changes 1.0 \-)

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines