… | |
… | |
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-02-11" "5.0" "RXVT-UNICODE" |
132 | .TH rxvt 1 "2005-06-18" "5.5" "RXVT-UNICODE" |
133 | .SH "NAME" |
133 | .SH "NAME" |
134 | rxvt\-unicode (ouR XVT, unicode) \- (a VT102 emulator for the X window system) |
134 | rxvt\-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 ]] |
… | |
… | |
334 | .IP "\fB\-sr\fR|\fB+sr\fR" 4 |
334 | .IP "\fB\-sr\fR|\fB+sr\fR" 4 |
335 | .IX Item "-sr|+sr" |
335 | .IX Item "-sr|+sr" |
336 | Put scrollbar on right/left; resource \fBscrollBar_right\fR. |
336 | Put scrollbar on right/left; resource \fBscrollBar_right\fR. |
337 | .IP "\fB\-st\fR|\fB+st\fR" 4 |
337 | .IP "\fB\-st\fR|\fB+st\fR" 4 |
338 | .IX Item "-st|+st" |
338 | .IX Item "-st|+st" |
339 | Display normal (non XTerm/NeXT) scrollbar without/with a trough; |
339 | Display rxvt (non XTerm/NeXT) scrollbar without/with a trough; |
340 | resource \fBscrollBar_floating\fR. |
340 | resource \fBscrollBar_floating\fR. |
341 | .IP "\fB\-ptab\fR|\fB+ptab\fR" 4 |
341 | .IP "\fB\-ptab\fR|\fB+ptab\fR" 4 |
342 | .IX Item "-ptab|+ptab" |
342 | .IX Item "-ptab|+ptab" |
343 | If enabled (default), \*(L"Horizontal Tab\*(R" characters are being stored as |
343 | If enabled (default), \*(L"Horizontal Tab\*(R" characters are being stored as |
344 | actual wide characters in the screen buffer, which makes it possible to |
344 | actual wide characters in the screen buffer, which makes it possible to |
… | |
… | |
441 | \&\fBsecondaryScreen\fR. |
441 | \&\fBsecondaryScreen\fR. |
442 | .IP "\fB\-ssr\fR|\fB+ssr\fR" 4 |
442 | .IP "\fB\-ssr\fR|\fB+ssr\fR" 4 |
443 | .IX Item "-ssr|+ssr" |
443 | .IX Item "-ssr|+ssr" |
444 | Turn on/off secondary screen scroll (default enabled); resource |
444 | Turn on/off secondary screen scroll (default enabled); resource |
445 | \&\fBsecondaryScroll\fR. |
445 | \&\fBsecondaryScroll\fR. |
446 | .IP "\fB\-keysym.\fR\fIsym\fR: \fIstring\fR" 4 |
446 | .IP "\fB\-keysym.\fR\fIsym\fR \fIstring\fR" 4 |
447 | .IX Item "-keysym.sym: string" |
447 | .IX Item "-keysym.sym string" |
448 | Remap a key symbol. See resource \fBkeysym\fR. |
448 | Remap a key symbol. See resource \fBkeysym\fR. |
449 | .IP "\fB\-xrm\fR \fIresourcestring\fR" 4 |
449 | .IP "\fB\-embed\fR \fIwindowid\fR" 4 |
450 | .IX Item "-xrm resourcestring" |
450 | .IX Item "-embed windowid" |
451 | No effect on rxvt\-unicode. Simply passes through an argument to be made |
451 | Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window, |
452 | available in the instance's argument list. Appears in \fI\s-1WM_COMMAND\s0\fR in |
452 | which enables applications to easily embed a terminal. |
453 | some window managers. |
453 | .Sp |
|
|
454 | Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it |
|
|
455 | shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it |
|
|
456 | quite a bit, so don't expect it to keep some specific state. It's best to |
|
|
457 | create an extra subwindow for @@RXVT_NAME@@ and leave it alone. |
|
|
458 | .Sp |
|
|
459 | The window will not be destroyed when @@RXVT_NAME@@ exits. |
|
|
460 | .Sp |
|
|
461 | It might be useful to know that @@RXVT_NAME@@ will not close file |
|
|
462 | descriptors passed to it (except for stdin/out/err, of course), so you |
|
|
463 | can use file descriptors to communicate with the programs within the |
|
|
464 | terminal. This works regardless of wether the \f(CW\*(C`\-embed\*(C'\fR option was used or |
|
|
465 | not. |
|
|
466 | .Sp |
|
|
467 | Here is a short Gtk2\-perl snippet that illustrates how this option can be |
|
|
468 | used (a longer example is in \fIdoc/embed\fR): |
|
|
469 | .Sp |
|
|
470 | .Vb 5 |
|
|
471 | \& my $rxvt = new Gtk2::Socket; |
|
|
472 | \& $rxvt->signal_connect_after (realize => sub { |
|
|
473 | \& my $xid = $_[0]->window->get_xid; |
|
|
474 | \& system "@@RXVT_NAME@@ -embed $xid &"; |
|
|
475 | \& }); |
|
|
476 | .Ve |
|
|
477 | .IP "\fB\-pty\-fd\fR \fIfileno\fR" 4 |
|
|
478 | .IX Item "-pty-fd fileno" |
|
|
479 | Tells @@RXVT_NAME@@ \s-1NOT\s0 to execute any commands or create a new pty/tty |
|
|
480 | pair but instead use the given filehandle as the tty master. This is |
|
|
481 | useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator |
|
|
482 | without having to run a program within it. |
|
|
483 | .Sp |
|
|
484 | If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp |
|
|
485 | entries and will not tinker with pty/tty permissions \- you have to do that |
|
|
486 | yourself if you want that. |
|
|
487 | .Sp |
|
|
488 | Here is a example in perl that illustrates how this option can be used (a |
|
|
489 | longer example is in \fIdoc/pty\-fd\fR): |
|
|
490 | .Sp |
|
|
491 | .Vb 2 |
|
|
492 | \& use IO::Pty; |
|
|
493 | \& use Fcntl; |
|
|
494 | .Ve |
|
|
495 | .Sp |
|
|
496 | .Vb 4 |
|
|
497 | \& my $pty = new IO::Pty; |
|
|
498 | \& fcntl $pty, F_SETFD, 0; # clear close-on-exec |
|
|
499 | \& system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&"; |
|
|
500 | \& close $pty; |
|
|
501 | .Ve |
|
|
502 | .Sp |
|
|
503 | .Vb 3 |
|
|
504 | \& # now communicate with rxvt |
|
|
505 | \& my $slave = $pty->slave; |
|
|
506 | \& while (<$slave>) { print $slave "got <$_>\en" } |
|
|
507 | .Ve |
454 | .SH "RESOURCES (available also as long\-options)" |
508 | .SH "RESOURCES (available also as long\-options)" |
455 | .IX Header "RESOURCES (available also as long-options)" |
509 | .IX Header "RESOURCES (available also as long-options)" |
456 | Note: `@@RXVT_NAME@@ \-\-help' gives a list of all resources (long |
510 | Note: `@@RXVT_NAME@@ \-\-help' gives a list of all resources (long |
457 | options) compiled into your version. |
511 | options) compiled into your version. |
458 | .PP |
512 | .PP |
… | |
… | |
572 | .IX Item "scrollColor: colour" |
626 | .IX Item "scrollColor: colour" |
573 | Use the specified colour for the scrollbar [default #B2B2B2]. |
627 | Use the specified colour for the scrollbar [default #B2B2B2]. |
574 | .IP "\fBtroughColor:\fR \fIcolour\fR" 4 |
628 | .IP "\fBtroughColor:\fR \fIcolour\fR" 4 |
575 | .IX Item "troughColor: colour" |
629 | .IX Item "troughColor: colour" |
576 | Use the specified colour for the scrollbar's trough area [default |
630 | Use the specified colour for the scrollbar's trough area [default |
577 | #969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. |
631 | #969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar. |
578 | .IP "\fBborderColor:\fR \fIcolour\fR" 4 |
632 | .IP "\fBborderColor:\fR \fIcolour\fR" 4 |
579 | .IX Item "borderColor: colour" |
633 | .IX Item "borderColor: colour" |
580 | The colour of the border around the text area and between the scrollbar |
634 | The colour of the border around the text area and between the scrollbar |
581 | and the text. |
635 | and the text. |
582 | .IP "\fBbackgroundPixmap:\fR \fIfile[;geom]\fR" 4 |
636 | .IP "\fBbackgroundPixmap:\fR \fIfile[;geom]\fR" 4 |
… | |
… | |
670 | xterm style with 2.20 old word selection, or anything else which gives |
724 | xterm style with 2.20 old word selection, or anything else which gives |
671 | xterm style selection. |
725 | xterm style selection. |
672 | .IP "\fBscrollstyle:\fR \fImode\fR" 4 |
726 | .IP "\fBscrollstyle:\fR \fImode\fR" 4 |
673 | .IX Item "scrollstyle: mode" |
727 | .IX Item "scrollstyle: mode" |
674 | Set scrollbar style to \fBrxvt\fR, \fBplain\fR, \fBnext\fR or \fBxterm\fR. \fBplain\fR is |
728 | Set scrollbar style to \fBrxvt\fR, \fBplain\fR, \fBnext\fR or \fBxterm\fR. \fBplain\fR is |
675 | the author's favourite.. |
729 | the author's favourite. |
676 | .IP "\fBtitle:\fR \fIstring\fR" 4 |
730 | .IP "\fBtitle:\fR \fIstring\fR" 4 |
677 | .IX Item "title: string" |
731 | .IX Item "title: string" |
678 | Set window title string, the default title is the command-line |
732 | Set window title string, the default title is the command-line |
679 | specified after the \fB\-e\fR option, if any, otherwise the application |
733 | specified after the \fB\-e\fR option, if any, otherwise the application |
680 | name; option \fB\-title\fR. |
734 | name; option \fB\-title\fR. |
… | |
… | |
728 | \&\fBFalse\fR: do not scroll to bottom when tty receives output; option |
782 | \&\fBFalse\fR: do not scroll to bottom when tty receives output; option |
729 | \&\fB+si\fR. |
783 | \&\fB+si\fR. |
730 | .IP "\fBscrollWithBuffer:\fR \fIboolean\fR" 4 |
784 | .IP "\fBscrollWithBuffer:\fR \fIboolean\fR" 4 |
731 | .IX Item "scrollWithBuffer: boolean" |
785 | .IX Item "scrollWithBuffer: boolean" |
732 | \&\fBTrue\fR: scroll with scrollback buffer when tty receives new lines (and |
786 | \&\fBTrue\fR: scroll with scrollback buffer when tty receives new lines (and |
733 | \&\fBscrollTtyOutput\fR is False); option \fB+sw\fR. \fBFalse\fR: do not scroll |
787 | \&\fBscrollTtyOutput\fR is False); option \fB\-sw\fR. \fBFalse\fR: do not scroll |
734 | with scrollback buffer when tty recieves new lines; option \fB\-sw\fR. |
788 | with scrollback buffer when tty recieves new lines; option \fB+sw\fR. |
735 | .IP "\fBscrollTtyKeypress:\fR \fIboolean\fR" 4 |
789 | .IP "\fBscrollTtyKeypress:\fR \fIboolean\fR" 4 |
736 | .IX Item "scrollTtyKeypress: boolean" |
790 | .IX Item "scrollTtyKeypress: boolean" |
737 | \&\fBTrue\fR: scroll to bottom when a non-special key is pressed. Special keys |
791 | \&\fBTrue\fR: scroll to bottom when a non-special key is pressed. Special keys |
738 | are those which are intercepted by rxvt-unicode for special handling and |
792 | are those which are intercepted by rxvt-unicode for special handling and |
739 | are not passed onto the shell; option \fB\-sk\fR. \fBFalse\fR: do not scroll to |
793 | are not passed onto the shell; option \fB\-sk\fR. \fBFalse\fR: do not scroll to |
… | |
… | |
789 | .IP "\fBpointerColor2:\fR \fIcolour\fR" 4 |
843 | .IP "\fBpointerColor2:\fR \fIcolour\fR" 4 |
790 | .IX Item "pointerColor2: colour" |
844 | .IX Item "pointerColor2: colour" |
791 | Mouse pointer background colour. |
845 | Mouse pointer background colour. |
792 | .IP "\fBpointerBlankDelay:\fR \fInumber\fR" 4 |
846 | .IP "\fBpointerBlankDelay:\fR \fInumber\fR" 4 |
793 | .IX Item "pointerBlankDelay: number" |
847 | .IX Item "pointerBlankDelay: number" |
794 | Specifies number of seconds before blanking the pointer [default 2]. |
848 | Specifies number of seconds before blanking the pointer [default 2]. Use a |
|
|
849 | large number (e.g. \f(CW987654321\fR) to effectively disable the timeout. |
795 | .IP "\fBbackspacekey:\fR \fIstring\fR" 4 |
850 | .IP "\fBbackspacekey:\fR \fIstring\fR" 4 |
796 | .IX Item "backspacekey: string" |
851 | .IX Item "backspacekey: string" |
797 | The string to send when the backspace key is pressed. If set to \fB\s-1DEC\s0\fR |
852 | The string to send when the backspace key is pressed. If set to \fB\s-1DEC\s0\fR |
798 | or unset it will send \fBDelete\fR (code 127) or, if shifted, \fBBackspace\fR |
853 | or unset it will send \fBDelete\fR (code 127) or, if shifted, \fBBackspace\fR |
799 | (code 8) \- which can be reversed with the appropriate \s-1DEC\s0 private mode |
854 | (code 8) \- which can be reversed with the appropriate \s-1DEC\s0 private mode |
… | |
… | |
923 | .Sp |
978 | .Sp |
924 | .Vb 1 |
979 | .Vb 1 |
925 | \& URxvt.keysym.M-C-c: command:\e033]701;zh_CN.GBK\e007 |
980 | \& URxvt.keysym.M-C-c: command:\e033]701;zh_CN.GBK\e007 |
926 | .Ve |
981 | .Ve |
927 | .Sp |
982 | .Sp |
|
|
983 | Due the the large number of modifier combinations, a defined key mapping |
|
|
984 | will match if at \fIat least\fR the specified identifiers are being set, and |
|
|
985 | no other key mappings with those and more bits are being defined. That |
|
|
986 | means that defining a key map for \f(CW\*(C`a\*(C'\fR will automatically provide |
|
|
987 | definitions for \f(CW\*(C`Meta\-a\*(C'\fR, \f(CW\*(C`Shift\-a\*(C'\fR and so on, unless some of those are defined |
|
|
988 | mappings themselves. |
|
|
989 | .Sp |
|
|
990 | Unfortunately, this will override built-in key mappings. For example |
|
|
991 | if you overwrite the \f(CW\*(C`Insert\*(C'\fR key you will disable @@RXVT_NAME@@'s |
|
|
992 | \&\f(CW\*(C`Shift\-Insert\*(C'\fR mapping. To re-enable that, you can poke \*(L"holes\*(R" into the |
|
|
993 | user-defined keymap using the \f(CW\*(C`builtin:\*(C'\fR replacement: |
|
|
994 | .Sp |
|
|
995 | .Vb 2 |
|
|
996 | \& URxvt.keysym.Insert: <my insert key sequence> |
|
|
997 | \& URxvt.keysym.S-Insert: builtin: |
|
|
998 | .Ve |
|
|
999 | .Sp |
|
|
1000 | The first line defines a mapping for \f(CW\*(C`Insert\*(C'\fR and \fIany\fR combination |
|
|
1001 | of modifiers. The second line re-establishes the default mapping for |
|
|
1002 | \&\f(CW\*(C`Shift\-Insert\*(C'\fR. |
|
|
1003 | .Sp |
928 | The following example will map Control\-Meta\-1 and Control\-Meta\-2 to |
1004 | The following example will map Control\-Meta\-1 and Control\-Meta\-2 to |
929 | the fonts \f(CW\*(C`suxuseuro\*(C'\fR and \f(CW\*(C`9x15bold\*(C'\fR, so you can have some limited |
1005 | the fonts \f(CW\*(C`suxuseuro\*(C'\fR and \f(CW\*(C`9x15bold\*(C'\fR, so you can have some limited |
930 | font-switching at runtime: |
1006 | font-switching at runtime: |
931 | .Sp |
1007 | .Sp |
932 | .Vb 2 |
1008 | .Vb 2 |
… | |
… | |
1118 | Set 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 |
1194 | Set 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 |
1119 | the colour code used as default foreground/text colour (or the string |
1195 | the colour code used as default foreground/text colour (or the string |
1120 | \&\f(CW\*(C`default\*(C'\fR to indicate that the default-colour escape sequence is to be |
1196 | \&\f(CW\*(C`default\*(C'\fR to indicate that the default-colour escape sequence is to be |
1121 | used), \f(CW\*(C`bg\*(C'\fR is the colour code used as default background colour (or the |
1197 | used), \f(CW\*(C`bg\*(C'\fR is the colour code used as default background colour (or the |
1122 | string \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@@ |
1198 | string \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@@ |
1123 | was compiled with \s-1XPM\s0 support. Libraries like \f(CW\*(C`slang\*(C'\fR can (and do) use |
1199 | was compiled with \s-1XPM\s0 support. Libraries like \f(CW\*(C`ncurses\*(C'\fR and \f(CW\*(C`slang\*(C'\fR can |
1124 | this information to optimize screen output. |
1200 | (and do) use this information to optimize screen output. |
1125 | .IP "\fB\s-1WINDOWID\s0\fR" 4 |
1201 | .IP "\fB\s-1WINDOWID\s0\fR" 4 |
1126 | .IX Item "WINDOWID" |
1202 | .IX Item "WINDOWID" |
1127 | Set to the (decimal) X Window \s-1ID\s0 of the @@RXVT_NAME@@ window (the toplevel |
1203 | Set to the (decimal) X Window \s-1ID\s0 of the @@RXVT_NAME@@ window (the toplevel |
1128 | window, which usually has subwindows for the scrollbar, the terminal |
1204 | window, which usually has subwindows for the scrollbar, the terminal |
1129 | window and so on). |
1205 | window and so on). |
… | |
… | |
1180 | Click-and-drag doesn't work with X11 mouse report overriding. |
1256 | Click-and-drag doesn't work with X11 mouse report overriding. |
1181 | .SH "CURRENT PROJECT COORDINATOR" |
1257 | .SH "CURRENT PROJECT COORDINATOR" |
1182 | .IX Header "CURRENT PROJECT COORDINATOR" |
1258 | .IX Header "CURRENT PROJECT COORDINATOR" |
1183 | .IP "Project Coordinator" 4 |
1259 | .IP "Project Coordinator" 4 |
1184 | .IX Item "Project Coordinator" |
1260 | .IX Item "Project Coordinator" |
1185 | @@RXVT_MAINT@@ @@RXVT_MAINTEMAIL@@ |
1261 | Marc A. Lehmann <rxvt\-unicode@schmorp.de> |
1186 | .Sp |
1262 | .Sp |
1187 | @@RXVT_WEBPAGE@@ |
1263 | <http://software.schmorp.de/#rxvt\-unicode> |
1188 | .SH "AUTHORS" |
1264 | .SH "AUTHORS" |
1189 | .IX Header "AUTHORS" |
1265 | .IX Header "AUTHORS" |
1190 | .IP "John Bovey" 4 |
1266 | .IP "John Bovey" 4 |
1191 | .IX Item "John Bovey" |
1267 | .IX Item "John Bovey" |
1192 | University of Kent, 1992, wrote the original Xvt. |
1268 | University of Kent, 1992, wrote the original Xvt. |
… | |
… | |
1206 | Project Coordinator (changes.txt 2.21a to 2.4.5) |
1282 | Project Coordinator (changes.txt 2.21a to 2.4.5) |
1207 | .IP "Geoff Wing <gcw@pobox.com>" 4 |
1283 | .IP "Geoff Wing <gcw@pobox.com>" 4 |
1208 | .IX Item "Geoff Wing <gcw@pobox.com>" |
1284 | .IX Item "Geoff Wing <gcw@pobox.com>" |
1209 | Rewrote screen display and text selection routines. Project Coordinator |
1285 | Rewrote screen display and text selection routines. Project Coordinator |
1210 | (changes.txt 2.4.6 \- rxvt\-unicode) |
1286 | (changes.txt 2.4.6 \- rxvt\-unicode) |
1211 | .IP "Marc Alexander Lehmann <rxvt@schmorp.de>" 4 |
1287 | .IP "Marc Alexander Lehmann <rxvt\-unicode@schmorp.de>" 4 |
1212 | .IX Item "Marc Alexander Lehmann <rxvt@schmorp.de>" |
1288 | .IX Item "Marc Alexander Lehmann <rxvt-unicode@schmorp.de>" |
1213 | Forked rxvt\-unicode, rewrote most of the display code and internal |
1289 | Forked rxvt\-unicode, rewrote most of the display code and internal |
1214 | character handling to store text in unicode, improve xterm |
1290 | character handling to store text in unicode, improve xterm |
1215 | compatibility and apply numerous other bugfixes and extensions. |
1291 | compatibility and apply numerous other bugfixes and extensions. |
1216 | .Sp |
1292 | .Sp |
1217 | Project Coordinator (Changes 1.0 \-) |
1293 | Project Coordinator (Changes 1.0 \-) |