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.19 by root, Fri Feb 18 12:15:07 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-02-18" "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,
… …
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.
466.Sp
467Here is a short Gtk2\-perl snippet that illustrates how this option can be
468used (a longer example is in \fIdoc/embed\fR):
469.Sp
470.Vb 4
471\& my $rxvt = new Gtk2::DrawingArea;
472\& $...->add ($rxvt); # important to add it somewhere first
473\& $rxvt->realize; # now it can be realized
474\& my $xid = $rxvt->window->get_xid;
475.Ve
476.Sp
477.Vb 1
478\& system "@@RXVT_NAME@@ -embed $xid &";
479.Ve
480.IP "\fB\-pty\-fd\fR \fIfileno\fR" 4
481.IX Item "-pty-fd fileno"
482Tells @@RXVT_NAME@@ \s-1NOT\s0 to execute any commands or create a new pty/tty
483pair but instead use the given filehandle as the tty master. This is
484useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
485without having to run a program within it.
486.Sp
487If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
488entries and will not tinker with pty/tty permissions \- you have to do that
489yourself if you want that.
490.Sp
491Here is a example in perl that illustrates how this option can be used (a
492longer example is in \fIdoc/pty\-fd\fR):
493.Sp
494.Vb 2
495\& use IO::Pty;
496\& use Fcntl;
497.Ve
498.Sp
499.Vb 4
500\& my $pty = new IO::Pty;
501\& fcntl $pty, F_SETFD, 0; # clear close-on-exec
502\& system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";
503\& close $pty;
504.Ve
505.Sp
506.Vb 3
507\& # now communicate with rxvt
508\& my $slave = $pty->slave;
509\& while (<$slave>) { print $slave "got <$_>\en" }
510.Ve
440.SH "RESOURCES (available also as long\-options)" 511.SH "RESOURCES (available also as long\-options)"
441.IX Header "RESOURCES (available also as long-options)" 512.IX Header "RESOURCES (available also as long-options)"
442Note: `@@RXVT_NAME@@ \-\-help' gives a list of all resources (long 513Note: `@@RXVT_NAME@@ \-\-help' gives a list of all resources (long
443options) compiled into your version. 514options) compiled into your version.
444.PP 515.PP
445There are two different methods that @@RXVT_NAME@@ can use to get the 516There are two different methods that @@RXVT_NAME@@ can use to get the
446Xresource data: using the X libraries (Xrm*\-functions) or internal 517Xresource data: using the X libraries (Xrm*\-functions) or internal
447Xresources reader (\fB~/.Xdefaults\fR). For the first method (ie. 518Xresources reader (\fB~/.Xdefaults\fR). For the first method (ie.
448\&\fB@@RXVT_NAME@@ \-h\fR lists \fBXGetDefaults\fR), you can set and change the 519\&\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 520resources using X11 tools like \fBxrdb\fR. Many distribution do also load
450settings from the \fB~/.Xresources\fR file when X starts. 521settings from the \fB~/.Xresources\fR file when X starts. @@RXVT_NAME@@
522will consult the following files/resources in order, with later settings
523overwriting earlier ones:
524.PP
525.Vb 5
526\& 1. system-wide app-defaults file, either locale-dependent OR global
527\& 2. app-defaults file in $XAPPLRESDIR
528\& 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
529\& 4. SCREEN_RESOURCES for the current screen
530\& 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
531.Ve
451.PP 532.PP
452If compiled with internal Xresources support (i.e. \fB@@RXVT_NAME@@ \-h\fR 533If compiled with internal Xresources support (i.e. \fB@@RXVT_NAME@@ \-h\fR
453lists \fB.Xdefaults\fR) then \fB@@RXVT_NAME@@\fR accepts application defaults 534lists \fB.Xdefaults\fR) then \fB@@RXVT_NAME@@\fR accepts application defaults
454set in XAPPLOADDIR/URxvt (compile\-time defined: usually 535set in XAPPLOADDIR/URxvt (compile\-time defined: usually
455\&\fB/usr/lib/X11/app\-defaults/URxvt\fR) and resources set in 536\&\fB/usr/lib/X11/app\-defaults/URxvt\fR) and resources set in
… …
704\&\fBFalse\fR: do not scroll to bottom when tty receives output; option 785\&\fBFalse\fR: do not scroll to bottom when tty receives output; option
705\&\fB+si\fR. 786\&\fB+si\fR.
706.IP "\fBscrollWithBuffer:\fR \fIboolean\fR" 4 787.IP "\fBscrollWithBuffer:\fR \fIboolean\fR" 4
707.IX Item "scrollWithBuffer: boolean" 788.IX Item "scrollWithBuffer: boolean"
708\&\fBTrue\fR: scroll with scrollback buffer when tty receives new lines (and 789\&\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 790\&\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. 791with scrollback buffer when tty recieves new lines; option \fB+sw\fR.
711.IP "\fBscrollTtyKeypress:\fR \fIboolean\fR" 4 792.IP "\fBscrollTtyKeypress:\fR \fIboolean\fR" 4
712.IX Item "scrollTtyKeypress: boolean" 793.IX Item "scrollTtyKeypress: boolean"
713\&\fBTrue\fR: scroll to bottom when a non-special key is pressed. Special keys 794\&\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 795are 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 796are not passed onto the shell; option \fB\-sk\fR. \fBFalse\fR: do not scroll to
… …
791.IP "\fBinputMethod:\fR \fIname\fR" 4 872.IP "\fBinputMethod:\fR \fIname\fR" 4
792.IX Item "inputMethod: name" 873.IX Item "inputMethod: name"
793\&\fIname\fR of inputMethod to use; option \fB\-im\fR. 874\&\fIname\fR of inputMethod to use; option \fB\-im\fR.
794.IP "\fBimLocale:\fR \fIname\fR" 4 875.IP "\fBimLocale:\fR \fIname\fR" 4
795.IX Item "imLocale: name" 876.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. 877The 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 878\&\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 879input extension to be able to input japanese characters while staying in
799another locale. option \fB\-imlocale\fR. 880another locale. option \fB\-imlocale\fR.
881.IP "\fBimFont:\fR \fIfontset\fR" 4
882.IX Item "imFont: fontset"
883Specify the font-set used for \s-1XIM\s0 styles \f(CW\*(C`OverTheSpot\*(C'\fR or
884\&\f(CW\*(C`OffTheSpot\*(C'\fR. It must be a standard X font set (\s-1XLFD\s0 patterns separated
885by commas), i.e. it's not in the same format as the other font lists used
886in @@RXVT_NAME@@. The default will be set-up to chose *any* suitable found
887found, preferably one or two pixels differing in size to the base font.
888option \fB\-imfont\fR.
889.IP "\fBtripleclickwords:\fR \fIboolean\fR" 4
890.IX Item "tripleclickwords: boolean"
891Change the meaning of triple-click selection with the left mouse
892button. Instead of selecting a full line it will extend the selection to
893the end of the logical line only. option \fB\-tcw\fR.
800.IP "\fBinsecure:\fR \fIboolean\fR" 4 894.IP "\fBinsecure:\fR \fIboolean\fR" 4
801.IX Item "insecure: boolean" 895.IX Item "insecure: boolean"
802Enables \*(L"insecure\*(R" mode. Rxvt-unicode offers some escape sequences that 896Enables \*(L"insecure\*(R" mode. Rxvt-unicode offers some escape sequences that
803echo arbitrary strings like the icon name or the locale. This could be 897echo arbitrary strings like the icon name or the locale. This could be
804abused if somebody gets 8\-bit\-clean access to your display, whether 898abused if somebody gets 8\-bit\-clean access to your display, whether
… …
839and the abbreviated \fBI\fR, \fBK\fR, \fBC\fR, \fBN\fR, \fBS\fR, \fBM\fR, \fBA\fR, \fBL\fR, \fB1\fR, 933and 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. 934\&\fB2\fR, \fB3\fR, \fB4\fR, \fB5\fR.
841.Sp 935.Sp
842The \fBNumLock\fR, \fBMeta\fR and \fBISOLevel3\fR modifiers are usually aliased to 936The \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 937whatever 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 938keys are being mapped. \fBAppKeypad\fR is a synthetic modifier mapped to the
845current application keymap mode state. 939current application keymap mode state.
846.Sp 940.Sp
847The spellings of \fIkey\fR can be obtained by using \fBxev\fR(1) command or 941The 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 942searching 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 943omitting 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, 948\&\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, 949\&\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 950\&\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. 951can start or end with whitespace.
858.Sp 952.Sp
953Please note that you need to double the \f(CW\*(C`\e\*(C'\fR when using
954\&\f(CW\*(C`\-\-enable\-xgetdefault\*(C'\fR, as X itself does it's own de-escaping (you can
955use \f(CW\*(C`\e033\*(C'\fR instead of \f(CW\*(C`\ee\*(C'\fR (and so on), which will work with both Xt and
956@@RXVT_NAME@@'s own processing).
957.Sp
859You can define a range of keysyms in one shot by providing a \fIstring\fR 958You can define a range of keysyms in one shot by providing a \fIstring\fR
860with pattern \fBlist/PREFIX/MIDDLE/SUFFIX\fR, where the delimeter `/' 959with pattern \fBlist/PREFIX/MIDDLE/SUFFIX\fR, where the delimeter `/'
861should be a character not used by the strings. 960should be a character not used by the strings.
862.Sp 961.Sp
863Its usage can be demonstrated by an example: 962Its usage can be demonstrated by an example:
864.Sp 963.Sp
865.Vb 1 964.Vb 1
866\& URxvt.keysym.M-C-0x61: list|\ee<M-C-|abc|> 965\& URxvt.keysym.M-C-0x61: list|\e033<M-C-|abc|>
867.Ve 966.Ve
868.Sp 967.Sp
869The above line is equivalent to the following three lines: 968The above line is equivalent to the following three lines:
870.Sp 969.Sp
871.Vb 3 970.Vb 3
872\& URxvt.keysym.Meta-Control-0x61: \ee<M-C-a> 971\& URxvt.keysym.Meta-Control-0x61: \e033<M-C-a>
873\& URxvt.keysym.Meta-Control-0x62: \ee<M-C-b> 972\& URxvt.keysym.Meta-Control-0x62: \e033<M-C-b>
874\& URxvt.keysym.Meta-Control-0x63: \ee<M-C-c> 973\& URxvt.keysym.Meta-Control-0x63: \e033<M-C-c>
875.Ve 974.Ve
876.Sp 975.Sp
877If \fIstring\fR takes the form of \f(CW\*(C`proto:STRING\*(C'\fR, the specified \fB\s-1STRING\s0\fR is 976If \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, 977is 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 978example 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. 979when Control-Meta-c is being pressed":
980.Sp
981.Vb 1
982\& URxvt.keysym.M-C-c: command:\e033]701;zh_CN.GBK\e007
983.Ve
984.Sp
985The following example will map Control\-Meta\-1 and Control\-Meta\-2 to
986the fonts \f(CW\*(C`suxuseuro\*(C'\fR and \f(CW\*(C`9x15bold\*(C'\fR, so you can have some limited
987font-switching at runtime:
988.Sp
989.Vb 2
990\& URxvt.keysym.M-C-1: command:\e033]50;suxuseuro\e007
991\& URxvt.keysym.M-C-2: command:\e033]50;9x15bold\e007
992.Ve
993.Sp
994Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
995info):
996.Sp
997.Vb 2
998\& URxvt.keysym.M-C-3: command:\e033[8;25;80t
999\& URxvt.keysym.M-C-4: command:\e033[8;48;110t
1000.Ve
881.SH "THE SCROLLBAR" 1001.SH "THE SCROLLBAR"
882.IX Header "THE SCROLLBAR" 1002.IX Header "THE SCROLLBAR"
883Lines of text that scroll off the top of the \fB@@RXVT_NAME@@\fR window 1003Lines 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 1004(resource: \fBsaveLines\fR) and can be scrolled back using the scrollbar
885or by keystrokes. The normal \fB@@RXVT_NAME@@\fR scrollbar has arrows and 1005or by keystrokes. The normal \fB@@RXVT_NAME@@\fR scrollbar has arrows and
… …
895the normal text selection/insertion, hold either the Shift or the Meta 1015the normal text selection/insertion, hold either the Shift or the Meta
896(Alt) key while performing the desired mouse action. 1016(Alt) key while performing the desired mouse action.
897.PP 1017.PP
898If mouse reporting mode is active, the normal scrollbar actions are 1018If mouse reporting mode is active, the normal scrollbar actions are
899disabled \*(-- on the assumption that we are using a fullscreen 1019disabled \*(-- on the assumption that we are using a fullscreen
900application. Instead, pressing Button1 and Button3 sends \fBESC[6~\fR 1020application. Instead, pressing Button1 and Button3 sends \fB\s-1ESC\s0 [ 6 ~\fR
901(Next) and \fBESC[5~\fR (Prior), respectively. Similarly, clicking on the 1021(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), 1022up and down arrows sends \fB\s-1ESC\s0 [ A\fR (Up) and \fB\s-1ESC\s0 [ B\fR (Down),
903respectively. 1023respectively.
904.SH "TEXT SELECTION AND INSERTION" 1024.SH "TEXT SELECTION AND INSERTION"
905.IX Header "TEXT SELECTION AND INSERTION" 1025.IX Header "TEXT SELECTION AND INSERTION"
906The behaviour of text selection and insertion mechanism is similar to 1026The behaviour of text selection and insertion mechanism is similar to
907\&\fIxterm\fR(1). 1027\&\fIxterm\fR(1).
908.IP "\fBSelection\fR:" 4 1028.IP "\fBSelection\fR:" 4
909.IX Item "Selection:" 1029.IX Item "Selection:"
910Left click at the beginning of the region, drag to the end of the 1030Left 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 1031and release; Right click to extend the marked region; Left double-click
912double-click to select a word; Left triple-click to select the entire 1032to select a word; Left triple-click to select the entire logical line
913line. 1033(which can span multiple screen lines), unless modified by resource
1034\&\fBtripleclickwords\fR.
914.Sp 1035.Sp
915Starting a selection while pressing the \fBMeta\fR key (or \fBMeta+Ctrl\fR keys) 1036Starting 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 1037(Compile: \fIfrills\fR) will create a rectangular selection instead of a normal
917one. 1038one.
918.IP "\fBInsertion\fR:" 4 1039.IP "\fBInsertion\fR:" 4
… …
938\&\s-1ISO\s0 14755 is a standard for entering and viewing unicode characters 1059\&\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 1060and character codes using the keyboard. It consists of 4 parts. The
940first part is available rxvt-unicode has been compiled with 1061first 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 1062\&\f(CW\*(C`\-\-enable\-frills\*(C'\fR, the rest is available when rxvt-unicode was compiled
942with \f(CW\*(C`\-\-enable\-iso14755\*(C'\fR. 1063with \f(CW\*(C`\-\-enable\-iso14755\*(C'\fR.
943.IP "5.1: Basic method" 4 1064.IP "* 5.1: Basic method" 4
944.IX Item "5.1: Basic method" 1065.IX Item "5.1: Basic method"
945This allows you to enter unicode characters using their hexcode. 1066This allows you to enter unicode characters using their hexcode.
946.Sp 1067.Sp
947Start by pressing and holding both \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR, then enter 1068Start 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 1069hex-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 1075As 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 1076address, 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 1077address 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, 1078by 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. 1079followed by releasing the modifier keys.
959.IP "5.2: Keyboard symbols entry method" 4 1080.IP "* 5.2: Keyboard symbols entry method" 4
960.IX Item "5.2: Keyboard symbols entry method" 1081.IX Item "5.2: Keyboard symbols entry method"
961This mode lets you input characters representing the keycap symbols of 1082This mode lets you input characters representing the keycap symbols of
962your keyboard, if representable in the current locale encoding. 1083your keyboard, if representable in the current locale encoding.
963.Sp 1084.Sp
964Start by pressing \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR together, then releasing 1085Start 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 1087invoke it's usual function but instead will insert the corresponding
967keycap symbol. The symbol will only be entered when the key has been 1088keycap 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 1089released, 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 1090\&\f(CW\*(C`ISO Level 2 Switch\*(C'\fR, although your intention might have been to enter a
970reverse tab (Shift\-Tab). 1091reverse tab (Shift\-Tab).
971.IP "5.3: Screen-selection entry method" 4 1092.IP "* 5.3: Screen-selection entry method" 4
972.IX Item "5.3: Screen-selection entry method" 1093.IX Item "5.3: Screen-selection entry method"
973While this is implemented already (it's basically the selection 1094While this is implemented already (it's basically the selection
974mechanism), it could be extended by displaying a unicode character map. 1095mechanism), it could be extended by displaying a unicode character map.
975.IP "5.4: Feedback method for identifying displayed characters for later input" 4 1096.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" 1097.IX Item "5.4: Feedback method for identifying displayed characters for later input"
977This method lets you display the unicode character code associated with 1098This method lets you display the unicode character code associated with
978characters already displayed. 1099characters already displayed.
979.Sp 1100.Sp
980You enter this mode by holding down \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR together, then 1101You enter this mode by holding down \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR together, then
… …
989.PP 1110.PP
990With respect to conformance, rxvt-unicode is supposed to be compliant to 1111With 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. 1112both scenario A and B of \s-1ISO\s0 14755, including part 5.2.
992.SH "LOGIN STAMP" 1113.SH "LOGIN STAMP"
993.IX Header "LOGIN STAMP" 1114.IX Header "LOGIN STAMP"
994\&\fB@@RXVT_NAME@@\fR tries to write an entry into the \fIutmp\fR(5) file so 1115\&\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. 1116it 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 1117allow this feature, \fB@@RXVT_NAME@@\fR may need to be installed setuid root
997some systems. 1118on some systems or setgid to root or to some other group on others.
998.SH "COLORS AND GRAPHICS" 1119.SH "COLORS AND GRAPHICS"
999.IX Header "COLORS AND GRAPHICS" 1120.IX Header "COLORS AND GRAPHICS"
1000In addition to the default foreground and background colours, 1121In 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 1122\&\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 1123high-intensity bold/blink versions of the same). Here is a list of the
… …
1037.IX Item "@@RXVT_NAME@@ -fg Black -bg White -rv" 1158.IX Item "@@RXVT_NAME@@ -fg Black -bg White -rv"
1038would yield White on Black, while on \fIxterm\fR(1) it would yield Black 1159would yield White on Black, while on \fIxterm\fR(1) it would yield Black
1039on White. 1160on White.
1040.SH "ENVIRONMENT" 1161.SH "ENVIRONMENT"
1041.IX Header "ENVIRONMENT" 1162.IX Header "ENVIRONMENT"
1042\&\fB@@RXVT_NAME@@\fR sets the environment variables \fB\s-1TERM\s0\fR, \fB\s-1COLORTERM\s0\fR 1163\&\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 1164.IP "\fB\s-1TERM\s0\fR" 4
1044window id number of the \fB@@RXVT_NAME@@\fR window and it also uses and 1165.IX Item "TERM"
1045sets the environment variable \fB\s-1DISPLAY\s0\fR to specify which display 1166Normally 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 1167resources or on the commandline.
1047\&\fB\s-1RXVTPATH\s0\fR and \fB\s-1PATH\s0\fR to find \s-1XPM\s0 files. 1168.IP "\fB\s-1COLORTERM\s0\fR" 4
1169.IX Item "COLORTERM"
1170Either \f(CW\*(C`rxvt\*(C'\fR, \f(CW\*(C`rxvt\-xpm\*(C'\fR, depending on wether @@RXVT_NAME@@ was
1171compiled with \s-1XPM\s0 support, and optionally with the added extension
1172\&\f(CW\*(C`\-mono\*(C'\fR to indicate that rxvt-unicode runs on a monochrome screen.
1173.IP "\fB\s-1COLORFGBG\s0\fR" 4
1174.IX Item "COLORFGBG"
1175Set 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
1176the colour code used as default foreground/text colour (or the string
1177\&\f(CW\*(C`default\*(C'\fR to indicate that the default-colour escape sequence is to be
1178used), \f(CW\*(C`bg\*(C'\fR is the colour code used as default background colour (or the
1179string \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@@
1180was compiled with \s-1XPM\s0 support. Libraries like \f(CW\*(C`ncurses\*(C'\fR and \f(CW\*(C`slang\*(C'\fR can
1181(and do) use this information to optimize screen output.
1182.IP "\fB\s-1WINDOWID\s0\fR" 4
1183.IX Item "WINDOWID"
1184Set to the (decimal) X Window \s-1ID\s0 of the @@RXVT_NAME@@ window (the toplevel
1185window, which usually has subwindows for the scrollbar, the terminal
1186window and so on).
1187.IP "\fB\s-1TERMINFO\s0\fR" 4
1188.IX Item "TERMINFO"
1189Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
1190\&\f(CW\*(C`\-\-with\-terminfo=PATH\*(C'\fR.
1191.IP "\fB\s-1DISPLAY\s0\fR" 4
1192.IX Item "DISPLAY"
1193Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1194display in it's child processes.
1195.IP "\fB\s-1SHELL\s0\fR" 4
1196.IX Item "SHELL"
1197The shell to be used for command execution, defaults to \f(CW\*(C`/bin/sh\*(C'\fR.
1198.IP "\fB\s-1RXVTPATH\s0\fR" 4
1199.IX Item "RXVTPATH"
1200The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1201files.
1202.IP "\fB\s-1PATH\s0\fR" 4
1203.IX Item "PATH"
1204Used in the same way as \f(CW\*(C`RXVTPATH\*(C'\fR.
1205.IP "\fB\s-1RXVT_SOCKET\s0\fR" 4
1206.IX Item "RXVT_SOCKET"
1207The unix domain socket path used by @@RXVT_NAME@@c(1) and
1208@@RXVT_NAME@@d(1).
1209.Sp
1210Default \f(CW\*(C`$HOME/.rxvt\-unicode\-<nodename\*(C'\fR.
1211.IP "\fB\s-1HOME\s0\fR" 4
1212.IX Item "HOME"
1213Used to locate the default directory for the unix domain socket for
1214daemon communications and to locate various resource files (such as
1215\&\f(CW\*(C`.Xdefaults\*(C'\fR)
1216.IP "\fB\s-1XAPPLRESDIR\s0\fR" 4
1217.IX Item "XAPPLRESDIR"
1218Directory where various X resource files are being located.
1219.IP "\fB\s-1XENVIRONMENT\s0\fR" 4
1220.IX Item "XENVIRONMENT"
1221If set and accessible, gives the name of a X resource file to be loaded by
1222@@RXVT_NAME@@.
1048.SH "FILES" 1223.SH "FILES"
1049.IX Header "FILES" 1224.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 1225.IP "\fB/usr/lib/X11/rgb.txt\fR" 4
1054.IX Item "/usr/lib/X11/rgb.txt" 1226.IX Item "/usr/lib/X11/rgb.txt"
1055Color names. 1227Color names.
1056.SH "SEE ALSO" 1228.SH "SEE ALSO"
1057.IX Header "SEE ALSO" 1229.IX Header "SEE ALSO"
… …
1065Click-and-drag doesn't work with X11 mouse report overriding. 1237Click-and-drag doesn't work with X11 mouse report overriding.
1066.SH "CURRENT PROJECT COORDINATOR" 1238.SH "CURRENT PROJECT COORDINATOR"
1067.IX Header "CURRENT PROJECT COORDINATOR" 1239.IX Header "CURRENT PROJECT COORDINATOR"
1068.IP "Project Coordinator" 4 1240.IP "Project Coordinator" 4
1069.IX Item "Project Coordinator" 1241.IX Item "Project Coordinator"
1070@@RXVT_MAINT@@ @@RXVT_MAINTEMAIL@@ 1242Marc 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 1243.Sp
1075@@RXVT_WEBPAGE@@ 1244<http://software.schmorp.de/#rxvt\-unicode>
1076.SH "AUTHORS" 1245.SH "AUTHORS"
1077.IX Header "AUTHORS" 1246.IX Header "AUTHORS"
1078.IP "John Bovey" 4 1247.IP "John Bovey" 4
1079.IX Item "John Bovey" 1248.IX Item "John Bovey"
1080University of Kent, 1992, wrote the original Xvt. 1249University of Kent, 1992, wrote the original Xvt.
… …
1094Project Coordinator (changes.txt 2.21a to 2.4.5) 1263Project Coordinator (changes.txt 2.21a to 2.4.5)
1095.IP "Geoff Wing <gcw@pobox.com>" 4 1264.IP "Geoff Wing <gcw@pobox.com>" 4
1096.IX Item "Geoff Wing <gcw@pobox.com>" 1265.IX Item "Geoff Wing <gcw@pobox.com>"
1097Rewrote screen display and text selection routines. Project Coordinator 1266Rewrote screen display and text selection routines. Project Coordinator
1098(changes.txt 2.4.6 \- rxvt\-unicode) 1267(changes.txt 2.4.6 \- rxvt\-unicode)
1099.IP "Marc Alexander Lehmann <rxvt@schmorp.de>" 4 1268.IP "Marc Alexander Lehmann <rxvt\-unicode@schmorp.de>" 4
1100.IX Item "Marc Alexander Lehmann <rxvt@schmorp.de>" 1269.IX Item "Marc Alexander Lehmann <rxvt-unicode@schmorp.de>"
1101Forked rxvt\-unicode, rewrote most of the display code and internal 1270Forked rxvt\-unicode, rewrote most of the display code and internal
1102character handling to store text in unicode, improve xterm 1271character handling to store text in unicode, improve xterm
1103compatibility and apply numerous other bugfixes and extensions. 1272compatibility and apply numerous other bugfixes and extensions.
1104.Sp 1273.Sp
1105Project Coordinator (Changes 1.0 \-) 1274Project Coordinator (Changes 1.0 \-)

Diff Legend

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