… | |
… | |
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-16" "5.2" "RXVT-UNICODE" |
132 | .TH rxvt 1 "2005-07-07" "5.6" "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\-embed\fR: \fIwindowid\fR" 4 |
449 | .IP "\fB\-embed\fR \fIwindowid\fR" 4 |
450 | .IX Item "-embed: windowid" |
450 | .IX Item "-embed windowid" |
451 | Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window, |
451 | Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window, |
452 | which enables applications to easily embed a terminal. |
452 | which enables applications to easily embed a terminal. |
453 | .Sp |
453 | .Sp |
454 | Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it |
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 |
455 | shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it |
… | |
… | |
461 | It might be useful to know that @@RXVT_NAME@@ will not close file |
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 |
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 |
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 |
464 | terminal. This works regardless of wether the \f(CW\*(C`\-embed\*(C'\fR option was used or |
465 | not. |
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 |
466 | .SH "RESOURCES (available also as long\-options)" |
508 | .SH "RESOURCES (available also as long\-options)" |
467 | .IX Header "RESOURCES (available also as long-options)" |
509 | .IX Header "RESOURCES (available also as long-options)" |
468 | Note: `@@RXVT_NAME@@ \-\-help' gives a list of all resources (long |
510 | Note: `@@RXVT_NAME@@ \-\-help' gives a list of all resources (long |
469 | options) compiled into your version. |
511 | options) compiled into your version. |
470 | .PP |
512 | .PP |
… | |
… | |
584 | .IX Item "scrollColor: colour" |
626 | .IX Item "scrollColor: colour" |
585 | Use the specified colour for the scrollbar [default #B2B2B2]. |
627 | Use the specified colour for the scrollbar [default #B2B2B2]. |
586 | .IP "\fBtroughColor:\fR \fIcolour\fR" 4 |
628 | .IP "\fBtroughColor:\fR \fIcolour\fR" 4 |
587 | .IX Item "troughColor: colour" |
629 | .IX Item "troughColor: colour" |
588 | Use the specified colour for the scrollbar's trough area [default |
630 | Use the specified colour for the scrollbar's trough area [default |
589 | #969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. |
631 | #969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar. |
590 | .IP "\fBborderColor:\fR \fIcolour\fR" 4 |
632 | .IP "\fBborderColor:\fR \fIcolour\fR" 4 |
591 | .IX Item "borderColor: colour" |
633 | .IX Item "borderColor: colour" |
592 | 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 |
593 | and the text. |
635 | and the text. |
594 | .IP "\fBbackgroundPixmap:\fR \fIfile[;geom]\fR" 4 |
636 | .IP "\fBbackgroundPixmap:\fR \fIfile[;geom]\fR" 4 |
… | |
… | |
682 | 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 |
683 | xterm style selection. |
725 | xterm style selection. |
684 | .IP "\fBscrollstyle:\fR \fImode\fR" 4 |
726 | .IP "\fBscrollstyle:\fR \fImode\fR" 4 |
685 | .IX Item "scrollstyle: mode" |
727 | .IX Item "scrollstyle: mode" |
686 | 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 |
687 | the author's favourite.. |
729 | the author's favourite. |
688 | .IP "\fBtitle:\fR \fIstring\fR" 4 |
730 | .IP "\fBtitle:\fR \fIstring\fR" 4 |
689 | .IX Item "title: string" |
731 | .IX Item "title: string" |
690 | Set window title string, the default title is the command-line |
732 | Set window title string, the default title is the command-line |
691 | 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 |
692 | name; option \fB\-title\fR. |
734 | name; option \fB\-title\fR. |
… | |
… | |
716 | .IP "\fBprint\-pipe:\fR \fIstring\fR" 4 |
758 | .IP "\fBprint\-pipe:\fR \fIstring\fR" 4 |
717 | .IX Item "print-pipe: string" |
759 | .IX Item "print-pipe: string" |
718 | Specify a command pipe for vt100 printer [default \fI\fIlpr\fI\|(1)\fR]. Use |
760 | Specify a command pipe for vt100 printer [default \fI\fIlpr\fI\|(1)\fR]. Use |
719 | \&\fBPrint\fR to initiate a screen dump to the printer and \fBCtrl-Print\fR or |
761 | \&\fBPrint\fR to initiate a screen dump to the printer and \fBCtrl-Print\fR or |
720 | \&\fBShift-Print\fR to include the scrollback as well. |
762 | \&\fBShift-Print\fR to include the scrollback as well. |
|
|
763 | .Sp |
|
|
764 | The string will be interpreted as if typed into the shell as\-is. |
|
|
765 | .Sp |
|
|
766 | Example: |
|
|
767 | .Sp |
|
|
768 | .Vb 1 |
|
|
769 | \& URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) |
|
|
770 | .Ve |
|
|
771 | .Sp |
|
|
772 | This creates a new file in your home directory with the screen contents |
|
|
773 | everytime you hit \f(CW\*(C`Print\*(C'\fR. |
721 | .IP "\fBscrollBar:\fR \fIboolean\fR" 4 |
774 | .IP "\fBscrollBar:\fR \fIboolean\fR" 4 |
722 | .IX Item "scrollBar: boolean" |
775 | .IX Item "scrollBar: boolean" |
723 | \&\fBTrue\fR: enable the scrollbar [default]; option \fB\-sb\fR. \fBFalse\fR: |
776 | \&\fBTrue\fR: enable the scrollbar [default]; option \fB\-sb\fR. \fBFalse\fR: |
724 | disable the scrollbar; option \fB+sb\fR. |
777 | disable the scrollbar; option \fB+sb\fR. |
725 | .IP "\fBscrollBar_right:\fR \fIboolean\fR" 4 |
778 | .IP "\fBscrollBar_right:\fR \fIboolean\fR" 4 |
… | |
… | |
801 | .IP "\fBpointerColor2:\fR \fIcolour\fR" 4 |
854 | .IP "\fBpointerColor2:\fR \fIcolour\fR" 4 |
802 | .IX Item "pointerColor2: colour" |
855 | .IX Item "pointerColor2: colour" |
803 | Mouse pointer background colour. |
856 | Mouse pointer background colour. |
804 | .IP "\fBpointerBlankDelay:\fR \fInumber\fR" 4 |
857 | .IP "\fBpointerBlankDelay:\fR \fInumber\fR" 4 |
805 | .IX Item "pointerBlankDelay: number" |
858 | .IX Item "pointerBlankDelay: number" |
806 | Specifies number of seconds before blanking the pointer [default 2]. |
859 | Specifies number of seconds before blanking the pointer [default 2]. Use a |
|
|
860 | large number (e.g. \f(CW987654321\fR) to effectively disable the timeout. |
807 | .IP "\fBbackspacekey:\fR \fIstring\fR" 4 |
861 | .IP "\fBbackspacekey:\fR \fIstring\fR" 4 |
808 | .IX Item "backspacekey: string" |
862 | .IX Item "backspacekey: string" |
809 | The string to send when the backspace key is pressed. If set to \fB\s-1DEC\s0\fR |
863 | The string to send when the backspace key is pressed. If set to \fB\s-1DEC\s0\fR |
810 | or unset it will send \fBDelete\fR (code 127) or, if shifted, \fBBackspace\fR |
864 | or unset it will send \fBDelete\fR (code 127) or, if shifted, \fBBackspace\fR |
811 | (code 8) \- which can be reversed with the appropriate \s-1DEC\s0 private mode |
865 | (code 8) \- which can be reversed with the appropriate \s-1DEC\s0 private mode |
… | |
… | |
935 | .Sp |
989 | .Sp |
936 | .Vb 1 |
990 | .Vb 1 |
937 | \& URxvt.keysym.M-C-c: command:\e033]701;zh_CN.GBK\e007 |
991 | \& URxvt.keysym.M-C-c: command:\e033]701;zh_CN.GBK\e007 |
938 | .Ve |
992 | .Ve |
939 | .Sp |
993 | .Sp |
|
|
994 | Due the the large number of modifier combinations, a defined key mapping |
|
|
995 | will match if at \fIat least\fR the specified identifiers are being set, and |
|
|
996 | no other key mappings with those and more bits are being defined. That |
|
|
997 | means that defining a key map for \f(CW\*(C`a\*(C'\fR will automatically provide |
|
|
998 | 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 |
|
|
999 | mappings themselves. |
|
|
1000 | .Sp |
|
|
1001 | Unfortunately, this will override built-in key mappings. For example |
|
|
1002 | if you overwrite the \f(CW\*(C`Insert\*(C'\fR key you will disable @@RXVT_NAME@@'s |
|
|
1003 | \&\f(CW\*(C`Shift\-Insert\*(C'\fR mapping. To re-enable that, you can poke \*(L"holes\*(R" into the |
|
|
1004 | user-defined keymap using the \f(CW\*(C`builtin:\*(C'\fR replacement: |
|
|
1005 | .Sp |
|
|
1006 | .Vb 2 |
|
|
1007 | \& URxvt.keysym.Insert: <my insert key sequence> |
|
|
1008 | \& URxvt.keysym.S-Insert: builtin: |
|
|
1009 | .Ve |
|
|
1010 | .Sp |
|
|
1011 | The first line defines a mapping for \f(CW\*(C`Insert\*(C'\fR and \fIany\fR combination |
|
|
1012 | of modifiers. The second line re-establishes the default mapping for |
|
|
1013 | \&\f(CW\*(C`Shift\-Insert\*(C'\fR. |
|
|
1014 | .Sp |
940 | The following example will map Control\-Meta\-1 and Control\-Meta\-2 to |
1015 | The following example will map Control\-Meta\-1 and Control\-Meta\-2 to |
941 | the fonts \f(CW\*(C`suxuseuro\*(C'\fR and \f(CW\*(C`9x15bold\*(C'\fR, so you can have some limited |
1016 | the fonts \f(CW\*(C`suxuseuro\*(C'\fR and \f(CW\*(C`9x15bold\*(C'\fR, so you can have some limited |
942 | font-switching at runtime: |
1017 | font-switching at runtime: |
943 | .Sp |
1018 | .Sp |
944 | .Vb 2 |
1019 | .Vb 2 |
… | |
… | |
1160 | .IP "\fB\s-1RXVT_SOCKET\s0\fR" 4 |
1235 | .IP "\fB\s-1RXVT_SOCKET\s0\fR" 4 |
1161 | .IX Item "RXVT_SOCKET" |
1236 | .IX Item "RXVT_SOCKET" |
1162 | The unix domain socket path used by @@RXVT_NAME@@c(1) and |
1237 | The unix domain socket path used by @@RXVT_NAME@@c(1) and |
1163 | @@RXVT_NAME@@d(1). |
1238 | @@RXVT_NAME@@d(1). |
1164 | .Sp |
1239 | .Sp |
1165 | Default \f(CW\*(C`$HOME/.rxvt\-unicode\-<nodename\*(C'\fR. |
1240 | Default \fI$HOME/.rxvt\-unicode\-\fI<nodename\fI\fR. |
1166 | .IP "\fB\s-1HOME\s0\fR" 4 |
1241 | .IP "\fB\s-1HOME\s0\fR" 4 |
1167 | .IX Item "HOME" |
1242 | .IX Item "HOME" |
1168 | Used to locate the default directory for the unix domain socket for |
1243 | Used to locate the default directory for the unix domain socket for |
1169 | daemon communications and to locate various resource files (such as |
1244 | daemon communications and to locate various resource files (such as |
1170 | \&\f(CW\*(C`.Xdefaults\*(C'\fR) |
1245 | \&\f(CW\*(C`.Xdefaults\*(C'\fR) |
… | |
… | |
1180 | .IP "\fB/usr/lib/X11/rgb.txt\fR" 4 |
1255 | .IP "\fB/usr/lib/X11/rgb.txt\fR" 4 |
1181 | .IX Item "/usr/lib/X11/rgb.txt" |
1256 | .IX Item "/usr/lib/X11/rgb.txt" |
1182 | Color names. |
1257 | Color names. |
1183 | .SH "SEE ALSO" |
1258 | .SH "SEE ALSO" |
1184 | .IX Header "SEE ALSO" |
1259 | .IX Header "SEE ALSO" |
1185 | @@RXVT_NAME@@(7), \fIxterm\fR\|(1), \fIsh\fR\|(1), \fIresize\fR\|(1), X(1), \fIpty\fR\|(4), \fItty\fR\|(4), \fIutmp\fR\|(5) |
1260 | @@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), \fIxterm\fR\|(1), \fIsh\fR\|(1), \fIresize\fR\|(1), X(1), \fIpty\fR\|(4), \fItty\fR\|(4), \fIutmp\fR\|(5) |
1186 | .SH "BUGS" |
1261 | .SH "BUGS" |
1187 | .IX Header "BUGS" |
1262 | .IX Header "BUGS" |
1188 | Check the \s-1BUGS\s0 file for an up-to-date list. |
1263 | Check the \s-1BUGS\s0 file for an up-to-date list. |
1189 | .PP |
1264 | .PP |
1190 | Cursor change support is not yet implemented. |
1265 | Cursor change support is not yet implemented. |