1 | .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.3 |
1 | .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.35 |
2 | .\" |
2 | .\" |
3 | .\" Standard preamble: |
3 | .\" Standard preamble: |
4 | .\" ======================================================================== |
4 | .\" ======================================================================== |
5 | .de Sh \" Subsection heading |
5 | .de Sh \" Subsection heading |
6 | .br |
6 | .br |
… | |
… | |
127 | .\} |
127 | .\} |
128 | .rm #[ #] #H #V #F C |
128 | .rm #[ #] #H #V #F C |
129 | .\" ======================================================================== |
129 | .\" ======================================================================== |
130 | .\" |
130 | .\" |
131 | .IX Title "@@RXVT_NAME@@ 1" |
131 | .IX Title "@@RXVT_NAME@@ 1" |
132 | .TH @@RXVT_NAME@@ 1 "2007-10-26" "8.3" "RXVT-UNICODE" |
132 | .TH @@RXVT_NAME@@ 1 "2007-10-27" "8.4" "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 ]] |
… | |
… | |
262 | thus yielding performance gain of two orders of magnitude. These colours are: |
262 | thus yielding performance gain of two orders of magnitude. These colours are: |
263 | blue, red, green, cyan, magenta, yellow, and those close to them; resource |
263 | blue, red, green, cyan, magenta, yellow, and those close to them; resource |
264 | \&\fItintColor\fR. Example: |
264 | \&\fItintColor\fR. Example: |
265 | .Sp |
265 | .Sp |
266 | .Vb 1 |
266 | .Vb 1 |
267 | \& @@RXVT_NAME@@ \-tr \-tint blue \-sh 40 |
267 | \& @@RXVT_NAME@@ -tr -tint blue -sh 40 |
268 | .Ve |
268 | .Ve |
269 | .IP "\fB\-sh\fR \fInumber\fR" 4 |
269 | .IP "\fB\-sh\fR \fInumber\fR" 4 |
270 | .IX Item "-sh number" |
270 | .IX Item "-sh number" |
271 | Darken (0 .. 100) or lighten (\-1 .. \-100) the transparent |
271 | Darken (0 .. 100) or lighten (\-1 .. \-100) the transparent |
272 | background image in addition to (or instead of) tinting it; |
272 | background image in addition to (or instead of) tinting it; |
… | |
… | |
324 | In short, to specify an X11 core font, just specify its name or prefix it |
324 | In short, to specify an X11 core font, just specify its name or prefix it |
325 | with \f(CW\*(C`x:\*(C'\fR. To specify an XFT\-font, you need to prefix it with \f(CW\*(C`xft:\*(C'\fR, |
325 | with \f(CW\*(C`x:\*(C'\fR. To specify an XFT\-font, you need to prefix it with \f(CW\*(C`xft:\*(C'\fR, |
326 | e.g.: |
326 | e.g.: |
327 | .Sp |
327 | .Sp |
328 | .Vb 2 |
328 | .Vb 2 |
329 | \& @@RXVT_NAME@@ \-fn "xft:Bitstream Vera Sans Mono:pixelsize=15" |
329 | \& @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" |
330 | \& @@RXVT_NAME@@ \-fn "9x15bold,xft:Bitstream Vera Sans Mono" |
330 | \& @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono" |
331 | .Ve |
331 | .Ve |
332 | .Sp |
332 | .Sp |
333 | See also the question \*(L"How does rxvt-unicode choose fonts?\*(R" in the \s-1FAQ\s0 |
333 | See also the question \*(L"How does rxvt-unicode choose fonts?\*(R" in the \s-1FAQ\s0 |
334 | section of @@RXVT_NAME@@(7). |
334 | section of @@RXVT_NAME@@(7). |
335 | .IP "\fB\-fb\fR \fIfontlist\fR" 4 |
335 | .IP "\fB\-fb\fR \fIfontlist\fR" 4 |
… | |
… | |
454 | .Sp |
454 | .Sp |
455 | Please note that you must specify a program with arguments. If you want to |
455 | Please note that you must specify a program with arguments. If you want to |
456 | run shell commands, you have to specify the shell, like this: |
456 | run shell commands, you have to specify the shell, like this: |
457 | .Sp |
457 | .Sp |
458 | .Vb 1 |
458 | .Vb 1 |
459 | \& @@RXVT_NAME@@ \-e sh \-c "shell commands" |
459 | \& @@RXVT_NAME@@ -e sh -c "shell commands" |
460 | .Ve |
460 | .Ve |
461 | .IP "\fB\-title\fR \fItext\fR" 4 |
461 | .IP "\fB\-title\fR \fItext\fR" 4 |
462 | .IX Item "-title text" |
462 | .IX Item "-title text" |
463 | Window title (\fB\-T\fR still respected); the default title is the basename |
463 | Window title (\fB\-T\fR still respected); the default title is the basename |
464 | of the program specified after the \fB\-e\fR option, if any, otherwise the |
464 | of the program specified after the \fB\-e\fR option, if any, otherwise the |
… | |
… | |
542 | Here is a short Gtk2\-perl snippet that illustrates how this option can be |
542 | Here is a short Gtk2\-perl snippet that illustrates how this option can be |
543 | used (a longer example is in \fIdoc/embed\fR): |
543 | used (a longer example is in \fIdoc/embed\fR): |
544 | .Sp |
544 | .Sp |
545 | .Vb 5 |
545 | .Vb 5 |
546 | \& my $rxvt = new Gtk2::Socket; |
546 | \& my $rxvt = new Gtk2::Socket; |
547 | \& $rxvt\->signal_connect_after (realize => sub { |
547 | \& $rxvt->signal_connect_after (realize => sub { |
548 | \& my $xid = $_[0]\->window\->get_xid; |
548 | \& my $xid = $_[0]->window->get_xid; |
549 | \& system "@@RXVT_NAME@@ \-embed $xid &"; |
549 | \& system "@@RXVT_NAME@@ -embed $xid &"; |
550 | \& }); |
550 | \& }); |
551 | .Ve |
551 | .Ve |
552 | .IP "\fB\-pty\-fd\fR \fIfile descriptor\fR" 4 |
552 | .IP "\fB\-pty\-fd\fR \fIfile descriptor\fR" 4 |
553 | .IX Item "-pty-fd file descriptor" |
553 | .IX Item "-pty-fd file descriptor" |
554 | Tells @@RXVT_NAME@@ \s-1NOT\s0 to execute any commands or create a new pty/tty |
554 | Tells @@RXVT_NAME@@ \s-1NOT\s0 to execute any commands or create a new pty/tty |
… | |
… | |
571 | \& use Fcntl; |
571 | \& use Fcntl; |
572 | .Ve |
572 | .Ve |
573 | .Sp |
573 | .Sp |
574 | .Vb 4 |
574 | .Vb 4 |
575 | \& my $pty = new IO::Pty; |
575 | \& my $pty = new IO::Pty; |
576 | \& fcntl $pty, F_SETFD, 0; # clear close\-on\-exec |
576 | \& fcntl $pty, F_SETFD, 0; # clear close-on-exec |
577 | \& system "@@RXVT_NAME@@ \-pty\-fd " . (fileno $pty) . "&"; |
577 | \& system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&"; |
578 | \& close $pty; |
578 | \& close $pty; |
579 | .Ve |
579 | .Ve |
580 | .Sp |
580 | .Sp |
581 | .Vb 3 |
581 | .Vb 3 |
582 | \& # now communicate with rxvt |
582 | \& # now communicate with rxvt |
583 | \& my $slave = $pty\->slave; |
583 | \& my $slave = $pty->slave; |
584 | \& while (<$slave>) { print $slave "got <$_>\en" } |
584 | \& while (<$slave>) { print $slave "got <$_>\en" } |
585 | .Ve |
585 | .Ve |
586 | .IP "\fB\-pe\fR \fIstring\fR" 4 |
586 | .IP "\fB\-pe\fR \fIstring\fR" 4 |
587 | .IX Item "-pe string" |
587 | .IX Item "-pe string" |
588 | Comma-separated list of perl extension scripts to use (or not to use) in |
588 | Comma-separated list of perl extension scripts to use (or not to use) in |
… | |
… | |
596 | distribution do also load settings from the \fB~/.Xresources\fR file when X |
596 | distribution do also load settings from the \fB~/.Xresources\fR file when X |
597 | starts. @@RXVT_NAME@@ will consult the following files/resources in order, |
597 | starts. @@RXVT_NAME@@ will consult the following files/resources in order, |
598 | with later settings overwriting earlier ones: |
598 | with later settings overwriting earlier ones: |
599 | .PP |
599 | .PP |
600 | .Vb 5 |
600 | .Vb 5 |
601 | \& 1. system\-wide app\-defaults file, either locale\-dependent OR global |
601 | \& 1. system-wide app-defaults file, either locale-dependent OR global |
602 | \& 2. app\-defaults file in $XAPPLRESDIR |
602 | \& 2. app-defaults file in $XAPPLRESDIR |
603 | \& 3. RESOURCE_MANAGER property on root\-window OR $HOME/.Xdefaults |
603 | \& 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults |
604 | \& 4. SCREEN_RESOURCES for the current screen |
604 | \& 4. SCREEN_RESOURCES for the current screen |
605 | \& 5. $XENVIRONMENT file OR $HOME/.Xdefaults\-<nodename> |
605 | \& 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> |
606 | .Ve |
606 | .Ve |
607 | .PP |
607 | .PP |
608 | Note that when reading X resources, \fB@@RXVT_NAME@@\fR recognizes two class |
608 | Note that when reading X resources, \fB@@RXVT_NAME@@\fR recognizes two class |
609 | names: \fBRxvt\fR and \fBURxvt\fR. The class name \fBRxvt\fR allows resources |
609 | names: \fBRxvt\fR and \fBURxvt\fR. The class name \fBRxvt\fR allows resources |
610 | common to both \fB@@RXVT_NAME@@\fR and the original \fIrxvt\fR to be easily |
610 | common to both \fB@@RXVT_NAME@@\fR and the original \fIrxvt\fR to be easily |
… | |
… | |
778 | .Sp |
778 | .Sp |
779 | For example, this font resource |
779 | For example, this font resource |
780 | .Sp |
780 | .Sp |
781 | .Vb 5 |
781 | .Vb 5 |
782 | \& URxvt.font: 9x15bold,\e |
782 | \& URxvt.font: 9x15bold,\e |
783 | \& \-misc\-fixed\-bold\-r\-normal\-\-15\-140\-75\-75\-c\-90\-iso10646\-1,\e |
783 | \& -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\e |
784 | \& \-misc\-fixed\-medium\-r\-normal\-\-15\-140\-75\-75\-c\-90\-iso10646\-1, \e |
784 | \& -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \e |
785 | \& [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \e |
785 | \& [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \e |
786 | \& xft:Code2000:antialias=false |
786 | \& xft:Code2000:antialias=false |
787 | .Ve |
787 | .Ve |
788 | .Sp |
788 | .Sp |
789 | specifies five fonts to be used. The first one is \f(CW\*(C`9x15bold\*(C'\fR (actually |
789 | specifies five fonts to be used. The first one is \f(CW\*(C`9x15bold\*(C'\fR (actually |
… | |
… | |
882 | The string will be interpreted as if typed into the shell as\-is. |
882 | The string will be interpreted as if typed into the shell as\-is. |
883 | .Sp |
883 | .Sp |
884 | Example: |
884 | Example: |
885 | .Sp |
885 | .Sp |
886 | .Vb 1 |
886 | .Vb 1 |
887 | \& URxvt.print\-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) |
887 | \& URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) |
888 | .Ve |
888 | .Ve |
889 | .Sp |
889 | .Sp |
890 | This creates a new file in your home directory with the screen contents |
890 | This creates a new file in your home directory with the screen contents |
891 | every time you hit \f(CW\*(C`Print\*(C'\fR. |
891 | every time you hit \f(CW\*(C`Print\*(C'\fR. |
892 | .IP "\fBscrollBar:\fR \fIboolean\fR" 4 |
892 | .IP "\fBscrollBar:\fR \fIboolean\fR" 4 |
… | |
… | |
1100 | should be a character not used by the strings. |
1100 | should be a character not used by the strings. |
1101 | .Sp |
1101 | .Sp |
1102 | Its usage can be demonstrated by an example: |
1102 | Its usage can be demonstrated by an example: |
1103 | .Sp |
1103 | .Sp |
1104 | .Vb 1 |
1104 | .Vb 1 |
1105 | \& URxvt.keysym.M\-C\-0x61: list|\e033<M\-C\-|abc|> |
1105 | \& URxvt.keysym.M-C-0x61: list|\e033<M-C-|abc|> |
1106 | .Ve |
1106 | .Ve |
1107 | .Sp |
1107 | .Sp |
1108 | The above line is equivalent to the following three lines: |
1108 | The above line is equivalent to the following three lines: |
1109 | .Sp |
1109 | .Sp |
1110 | .Vb 3 |
1110 | .Vb 3 |
1111 | \& URxvt.keysym.Meta\-Control\-0x61: \e033<M\-C\-a> |
1111 | \& URxvt.keysym.Meta-Control-0x61: \e033<M-C-a> |
1112 | \& URxvt.keysym.Meta\-Control\-0x62: \e033<M\-C\-b> |
1112 | \& URxvt.keysym.Meta-Control-0x62: \e033<M-C-b> |
1113 | \& URxvt.keysym.Meta\-Control\-0x63: \e033<M\-C\-c> |
1113 | \& URxvt.keysym.Meta-Control-0x63: \e033<M-C-c> |
1114 | .Ve |
1114 | .Ve |
1115 | .Sp |
1115 | .Sp |
1116 | If \fIstring\fR takes the form of \f(CW\*(C`command:STRING\*(C'\fR, the specified \fB\s-1STRING\s0\fR |
1116 | If \fIstring\fR takes the form of \f(CW\*(C`command:STRING\*(C'\fR, the specified \fB\s-1STRING\s0\fR |
1117 | is interpreted and executed as @@RXVT_NAME@@'s control sequence. For |
1117 | is interpreted and executed as @@RXVT_NAME@@'s control sequence. For |
1118 | example the following means "change the current locale to \f(CW\*(C`zh_CN.GBK\*(C'\fR |
1118 | example the following means "change the current locale to \f(CW\*(C`zh_CN.GBK\*(C'\fR |
1119 | when Control-Meta-c is being pressed": |
1119 | when Control-Meta-c is being pressed": |
1120 | .Sp |
1120 | .Sp |
1121 | .Vb 1 |
1121 | .Vb 1 |
1122 | \& URxvt.keysym.M\-C\-c: command:\e033]701;zh_CN.GBK\e007 |
1122 | \& URxvt.keysym.M-C-c: command:\e033]701;zh_CN.GBK\e007 |
1123 | .Ve |
1123 | .Ve |
1124 | .Sp |
1124 | .Sp |
1125 | If \fIstring\fR takes the form \f(CW\*(C`perl:STRING\*(C'\fR, then the specified \fB\s-1STRING\s0\fR |
1125 | If \fIstring\fR takes the form \f(CW\*(C`perl:STRING\*(C'\fR, then the specified \fB\s-1STRING\s0\fR |
1126 | is passed to the \f(CW\*(C`on_keyboard_command\*(C'\fR perl handler. See the @@RXVT_NAME@@\fIperl\fR\|(3) |
1126 | is passed to the \f(CW\*(C`on_keyboard_command\*(C'\fR perl handler. See the @@RXVT_NAME@@\fIperl\fR\|(3) |
1127 | manpage. For example, the \fIselection\fR extension (activated via |
1127 | manpage. For example, the \fIselection\fR extension (activated via |
1128 | \&\f(CW\*(C`@@RXVT_NAME@@ \-pe selection\*(C'\fR) listens for \f(CW\*(C`selection:rot13\*(C'\fR events: |
1128 | \&\f(CW\*(C`@@RXVT_NAME@@ \-pe selection\*(C'\fR) listens for \f(CW\*(C`selection:rot13\*(C'\fR events: |
1129 | .Sp |
1129 | .Sp |
1130 | .Vb 1 |
1130 | .Vb 1 |
1131 | \& URxvt.keysym.M\-C\-c: perl:selection:rot13 |
1131 | \& URxvt.keysym.M-C-c: perl:selection:rot13 |
1132 | .Ve |
1132 | .Ve |
1133 | .Sp |
1133 | .Sp |
1134 | Due the the large number of modifier combinations, a defined key mapping |
1134 | Due the the large number of modifier combinations, a defined key mapping |
1135 | will match if at \fIat least\fR the specified identifiers are being set, and |
1135 | will match if at \fIat least\fR the specified identifiers are being set, and |
1136 | no other key mappings with those and more bits are being defined. That |
1136 | no other key mappings with those and more bits are being defined. That |
… | |
… | |
1143 | \&\f(CW\*(C`Shift\-Insert\*(C'\fR mapping. To re-enable that, you can poke \*(L"holes\*(R" into the |
1143 | \&\f(CW\*(C`Shift\-Insert\*(C'\fR mapping. To re-enable that, you can poke \*(L"holes\*(R" into the |
1144 | user-defined keymap using the \f(CW\*(C`builtin:\*(C'\fR replacement: |
1144 | user-defined keymap using the \f(CW\*(C`builtin:\*(C'\fR replacement: |
1145 | .Sp |
1145 | .Sp |
1146 | .Vb 2 |
1146 | .Vb 2 |
1147 | \& URxvt.keysym.Insert: <my insert key sequence> |
1147 | \& URxvt.keysym.Insert: <my insert key sequence> |
1148 | \& URxvt.keysym.S\-Insert: builtin: |
1148 | \& URxvt.keysym.S-Insert: builtin: |
1149 | .Ve |
1149 | .Ve |
1150 | .Sp |
1150 | .Sp |
1151 | The first line defines a mapping for \f(CW\*(C`Insert\*(C'\fR and \fIany\fR combination |
1151 | The first line defines a mapping for \f(CW\*(C`Insert\*(C'\fR and \fIany\fR combination |
1152 | of modifiers. The second line re-establishes the default mapping for |
1152 | of modifiers. The second line re-establishes the default mapping for |
1153 | \&\f(CW\*(C`Shift\-Insert\*(C'\fR. |
1153 | \&\f(CW\*(C`Shift\-Insert\*(C'\fR. |
… | |
… | |
1155 | The following example will map Control\-Meta\-1 and Control\-Meta\-2 to |
1155 | The following example will map Control\-Meta\-1 and Control\-Meta\-2 to |
1156 | the fonts \f(CW\*(C`suxuseuro\*(C'\fR and \f(CW\*(C`9x15bold\*(C'\fR, so you can have some limited |
1156 | the fonts \f(CW\*(C`suxuseuro\*(C'\fR and \f(CW\*(C`9x15bold\*(C'\fR, so you can have some limited |
1157 | font-switching at runtime: |
1157 | font-switching at runtime: |
1158 | .Sp |
1158 | .Sp |
1159 | .Vb 2 |
1159 | .Vb 2 |
1160 | \& URxvt.keysym.M\-C\-1: command:\e033]50;suxuseuro\e007 |
1160 | \& URxvt.keysym.M-C-1: command:\e033]50;suxuseuro\e007 |
1161 | \& URxvt.keysym.M\-C\-2: command:\e033]50;9x15bold\e007 |
1161 | \& URxvt.keysym.M-C-2: command:\e033]50;9x15bold\e007 |
1162 | .Ve |
1162 | .Ve |
1163 | .Sp |
1163 | .Sp |
1164 | Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more |
1164 | Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more |
1165 | info): |
1165 | info): |
1166 | .Sp |
1166 | .Sp |
1167 | .Vb 2 |
1167 | .Vb 2 |
1168 | \& URxvt.keysym.M\-C\-3: command:\e033[8;25;80t |
1168 | \& URxvt.keysym.M-C-3: command:\e033[8;25;80t |
1169 | \& URxvt.keysym.M\-C\-4: command:\e033[8;48;110t |
1169 | \& URxvt.keysym.M-C-4: command:\e033[8;48;110t |
1170 | .Ve |
1170 | .Ve |
1171 | .IP "\fBperl-ext-common\fR: \fIstring\fR" 4 |
1171 | .IP "\fBperl-ext-common\fR: \fIstring\fR" 4 |
1172 | .IX Item "perl-ext-common: string" |
1172 | .IX Item "perl-ext-common: string" |
1173 | .PD 0 |
1173 | .PD 0 |
1174 | .IP "\fBperl-ext\fR: \fIstring\fR" 4 |
1174 | .IP "\fBperl-ext\fR: \fIstring\fR" 4 |
… | |
… | |
1296 | .Ve |
1296 | .Ve |
1297 | .PP |
1297 | .PP |
1298 | You can use keyboard shortcuts, too: |
1298 | You can use keyboard shortcuts, too: |
1299 | .PP |
1299 | .PP |
1300 | .Vb 2 |
1300 | .Vb 2 |
1301 | \& URxvt.keysym.M\-C\-1: command:\e033]710;suxuseuro\e007\e033]711;suxuseuro\e007 |
1301 | \& URxvt.keysym.M-C-1: command:\e033]710;suxuseuro\e007\e033]711;suxuseuro\e007 |
1302 | \& URxvt.keysym.M\-C\-2: command:\e033]710;9x15bold\e007\e033]711;9x15bold\e007 |
1302 | \& URxvt.keysym.M-C-2: command:\e033]710;9x15bold\e007\e033]711;9x15bold\e007 |
1303 | .Ve |
1303 | .Ve |
1304 | .PP |
1304 | .PP |
1305 | rxvt-unicode will automatically re-apply these fonts to the output so far. |
1305 | rxvt-unicode will automatically re-apply these fonts to the output so far. |
1306 | .SH "ISO 14755 SUPPORT" |
1306 | .SH "ISO 14755 SUPPORT" |
1307 | .IX Header "ISO 14755 SUPPORT" |
1307 | .IX Header "ISO 14755 SUPPORT" |
… | |
… | |
1434 | .PP |
1434 | .PP |
1435 | For example, the following selects an almost completely transparent red |
1435 | For example, the following selects an almost completely transparent red |
1436 | background, and an almost opaque pink foreground: |
1436 | background, and an almost opaque pink foreground: |
1437 | .PP |
1437 | .PP |
1438 | .Vb 1 |
1438 | .Vb 1 |
1439 | \& @@RXVT_NAME@@ \-depth 32 \-bg rgba:0000/0000/0000/aaaa \-fg "[80]pink" |
1439 | \& @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink" |
1440 | .Ve |
1440 | .Ve |
1441 | .PP |
1441 | .PP |
1442 | \&\fIPlease note that transparency of any kind if completely unsupported by |
1442 | \&\fIPlease note that transparency of any kind if completely unsupported by |
1443 | the author. Don't bug him with installation questions!\fR |
1443 | the author. Don't bug him with installation questions!\fR |
1444 | .SH "ENVIRONMENT" |
1444 | .SH "ENVIRONMENT" |