… | |
… | |
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 "2006-07-17" "7.8" "RXVT-UNICODE" |
132 | .TH @@RXVT_NAME@@ 1 "2006-08-07" "7.9" "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 ]] |
… | |
… | |
155 | world. Being a terminal emulator, however, some things are very difficult, |
155 | world. Being a terminal emulator, however, some things are very difficult, |
156 | especially cursive scripts such as arabic, vertically written scripts |
156 | especially cursive scripts such as arabic, vertically written scripts |
157 | like mongolian or scripts requiring extremely complex combining rules, |
157 | like mongolian or scripts requiring extremely complex combining rules, |
158 | like tibetan or devenagari. Don't expect pretty output when using these |
158 | like tibetan or devenagari. Don't expect pretty output when using these |
159 | scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work |
159 | scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work |
160 | fine, though. A somewhat difficult case are left-to-right scripts, such |
160 | fine, though. A somewhat difficult case are right-to-left scripts, such |
161 | as hebrew: \fBrxvt-unicode\fR adopts the view that bidirectional algorithms |
161 | as hebrew: \fBrxvt-unicode\fR adopts the view that bidirectional algorithms |
162 | belong into the application, not the terminal emulator (too many things \*(-- |
162 | belong into the application, not the terminal emulator (too many things \*(-- |
163 | such as cursor-movement while editing \*(-- break otherwise), but that might |
163 | such as cursor-movement while editing \*(-- break otherwise), but that might |
164 | change. |
164 | change. |
165 | .PP |
165 | .PP |
166 | If you are looking for a terminal that supports more exotic scripts, let |
166 | If you are looking for a terminal that supports more exotic scripts, let |
167 | me recommend \f(CW\*(C`mlterm\*(C'\fR, which is a very userfriendly, lean and clean |
167 | me recommend \f(CW\*(C`mlterm\*(C'\fR, which is a very user friendly, lean and clean |
168 | terminal emulator. In fact, the reason rxvt-unicode was born was solely |
168 | terminal emulator. In fact, the reason rxvt-unicode was born was solely |
169 | because the author couldn't get \f(CW\*(C`mlterm\*(C'\fR to use one font for latin1 and |
169 | because the author couldn't get \f(CW\*(C`mlterm\*(C'\fR to use one font for latin1 and |
170 | another for japanese. |
170 | another for japanese. |
171 | .PP |
171 | .PP |
172 | Therefore another design rationale was the use of multiple fonts to |
172 | Therefore another design rationale was the use of multiple fonts to |
… | |
… | |
174 | programs force onto its users never made sense to me: You should be able |
174 | programs force onto its users never made sense to me: You should be able |
175 | to choose any font for any script freely. |
175 | to choose any font for any script freely. |
176 | .PP |
176 | .PP |
177 | Apart from that, rxvt-unicode is also much better internationalised than |
177 | Apart from that, rxvt-unicode is also much better internationalised than |
178 | its predecessor, supports things such as \s-1XFT\s0 and \s-1ISO\s0 14755 that are handy |
178 | its predecessor, supports things such as \s-1XFT\s0 and \s-1ISO\s0 14755 that are handy |
179 | in i18n\-environments, is faster, and has a lot less bugs than the original |
179 | in i18n\-environments, is faster, and has a lot bugs less than the original |
180 | rxvt. This all in addition to dozens of other small improvements. |
180 | rxvt. This all in addition to dozens of other small improvements. |
181 | .PP |
181 | .PP |
182 | It is still faithfully following the original rxvt idea of being lean |
182 | It is still faithfully following the original rxvt idea of being lean |
183 | and nice on resources: for example, you can still configure rxvt-unicode |
183 | and nice on resources: for example, you can still configure rxvt-unicode |
184 | without most of its features to get a lean binary. It also comes with |
184 | without most of its features to get a lean binary. It also comes with |
… | |
… | |
186 | from within a single process, which makes startup time very fast and |
186 | from within a single process, which makes startup time very fast and |
187 | drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and |
187 | drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and |
188 | @@RXVT_NAME@@c(1) (client). |
188 | @@RXVT_NAME@@c(1) (client). |
189 | .PP |
189 | .PP |
190 | It also makes technical information about escape sequences (which have |
190 | It also makes technical information about escape sequences (which have |
191 | been extended) easier accessible: see @@RXVT_NAME@@(7) for technical |
191 | been extended) more accessible: see @@RXVT_NAME@@(7) for technical |
192 | reference documentation (escape sequences etc.). |
192 | reference documentation (escape sequences etc.). |
193 | .SH "OPTIONS" |
193 | .SH "OPTIONS" |
194 | .IX Header "OPTIONS" |
194 | .IX Header "OPTIONS" |
195 | The \fB@@RXVT_NAME@@\fR options (mostly a subset of \fIxterm\fR's) are listed |
195 | The \fB@@RXVT_NAME@@\fR options (mostly a subset of \fIxterm\fR's) are listed |
196 | below. In keeping with the smaller-is-better philosophy, options may be |
196 | below. In keeping with the smaller-is-better philosophy, options may be |
… | |
… | |
233 | .IX Item "-ip|+ip | -tr|+tr" |
233 | .IX Item "-ip|+ip | -tr|+tr" |
234 | Turn on/off inheriting parent window's pixmap. Alternative form is |
234 | Turn on/off inheriting parent window's pixmap. Alternative form is |
235 | \&\fB\-tr\fR; resource \fBinheritPixmap\fR. |
235 | \&\fB\-tr\fR; resource \fBinheritPixmap\fR. |
236 | .Sp |
236 | .Sp |
237 | \&\fIPlease note that transparency of any kind if completely unsupported by |
237 | \&\fIPlease note that transparency of any kind if completely unsupported by |
238 | the author. Don't bug him with installation questions!\fR |
238 | the author. Don't bug him with installation questions! Read the \s-1FAQ\s0 (man 7 |
|
|
239 | @@RXVT_NAME@@)!\fR |
239 | .IP "\fB\-fade\fR \fInumber\fR" 4 |
240 | .IP "\fB\-fade\fR \fInumber\fR" 4 |
240 | .IX Item "-fade number" |
241 | .IX Item "-fade number" |
241 | Fade the text by the given percentage when focus is lost. Small values |
242 | Fade the text by the given percentage when focus is lost. Small values |
242 | fade a little only, 100 completely replaces all colours by the fade |
243 | fade a little only, 100 completely replaces all colours by the fade |
243 | colour; resource \fBfading\fR. |
244 | colour; resource \fBfading\fR. |
… | |
… | |
506 | The window will not be destroyed when @@RXVT_NAME@@ exits. |
507 | The window will not be destroyed when @@RXVT_NAME@@ exits. |
507 | .Sp |
508 | .Sp |
508 | It might be useful to know that @@RXVT_NAME@@ will not close file |
509 | It might be useful to know that @@RXVT_NAME@@ will not close file |
509 | descriptors passed to it (except for stdin/out/err, of course), so you |
510 | descriptors passed to it (except for stdin/out/err, of course), so you |
510 | can use file descriptors to communicate with the programs within the |
511 | can use file descriptors to communicate with the programs within the |
511 | terminal. This works regardless of wether the \f(CW\*(C`\-embed\*(C'\fR option was used or |
512 | terminal. This works regardless of whether the \f(CW\*(C`\-embed\*(C'\fR option was used or |
512 | not. |
513 | not. |
513 | .Sp |
514 | .Sp |
514 | Here is a short Gtk2\-perl snippet that illustrates how this option can be |
515 | Here is a short Gtk2\-perl snippet that illustrates how this option can be |
515 | used (a longer example is in \fIdoc/embed\fR): |
516 | used (a longer example is in \fIdoc/embed\fR): |
516 | .Sp |
517 | .Sp |
… | |
… | |
522 | \& }); |
523 | \& }); |
523 | .Ve |
524 | .Ve |
524 | .IP "\fB\-pty\-fd\fR \fIfile descriptor\fR" 4 |
525 | .IP "\fB\-pty\-fd\fR \fIfile descriptor\fR" 4 |
525 | .IX Item "-pty-fd file descriptor" |
526 | .IX Item "-pty-fd file descriptor" |
526 | Tells @@RXVT_NAME@@ \s-1NOT\s0 to execute any commands or create a new pty/tty |
527 | Tells @@RXVT_NAME@@ \s-1NOT\s0 to execute any commands or create a new pty/tty |
527 | pair but instead use the given filehandle as the tty master. This is |
528 | pair but instead use the given file descriptor as the tty master. This is |
528 | useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator |
529 | useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator |
529 | without having to run a program within it. |
530 | without having to run a program within it. |
530 | .Sp |
531 | .Sp |
531 | If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp |
532 | If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp |
532 | entries and will not tinker with pty/tty permissions \- you have to do that |
533 | entries and will not tinker with pty/tty permissions \- you have to do that |
… | |
… | |
767 | text font will being used for the given style. |
768 | text font will being used for the given style. |
768 | .IP "\fBintensityStyles:\fR \fIboolean\fR" 4 |
769 | .IP "\fBintensityStyles:\fR \fIboolean\fR" 4 |
769 | .IX Item "intensityStyles: boolean" |
770 | .IX Item "intensityStyles: boolean" |
770 | When font styles are not enabled, or this option is enabled (\fBTrue\fR, |
771 | When font styles are not enabled, or this option is enabled (\fBTrue\fR, |
771 | option \fB\-is\fR, the default), bold and italic font styles imply high |
772 | option \fB\-is\fR, the default), bold and italic font styles imply high |
772 | intensity foreground/backround colours. Disabling this option (\fBFalse\fR, |
773 | intensity foreground/background colours. Disabling this option (\fBFalse\fR, |
773 | option \fB+is\fR) disables this behaviour, the high intensity colours are not |
774 | option \fB+is\fR) disables this behaviour, the high intensity colours are not |
774 | reachable. |
775 | reachable. |
775 | .IP "\fBselectstyle:\fR \fImode\fR" 4 |
776 | .IP "\fBselectstyle:\fR \fImode\fR" 4 |
776 | .IX Item "selectstyle: mode" |
777 | .IX Item "selectstyle: mode" |
777 | Set mouse selection style to \fBold\fR which is 2.20, \fBoldword\fR which is |
778 | Set mouse selection style to \fBold\fR which is 2.20, \fBoldword\fR which is |
… | |
… | |
822 | .Vb 1 |
823 | .Vb 1 |
823 | \& URxvt.print\-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) |
824 | \& URxvt.print\-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) |
824 | .Ve |
825 | .Ve |
825 | .Sp |
826 | .Sp |
826 | This creates a new file in your home directory with the screen contents |
827 | This creates a new file in your home directory with the screen contents |
827 | everytime you hit \f(CW\*(C`Print\*(C'\fR. |
828 | every time you hit \f(CW\*(C`Print\*(C'\fR. |
828 | .IP "\fBscrollBar:\fR \fIboolean\fR" 4 |
829 | .IP "\fBscrollBar:\fR \fIboolean\fR" 4 |
829 | .IX Item "scrollBar: boolean" |
830 | .IX Item "scrollBar: boolean" |
830 | \&\fBTrue\fR: enable the scrollbar [default]; option \fB\-sb\fR. \fBFalse\fR: |
831 | \&\fBTrue\fR: enable the scrollbar [default]; option \fB\-sb\fR. \fBFalse\fR: |
831 | disable the scrollbar; option \fB+sb\fR. |
832 | disable the scrollbar; option \fB+sb\fR. |
832 | .IP "\fBscrollBar_right:\fR \fIboolean\fR" 4 |
833 | .IP "\fBscrollBar_right:\fR \fIboolean\fR" 4 |
… | |
… | |
848 | \&\fB+si\fR. |
849 | \&\fB+si\fR. |
849 | .IP "\fBscrollWithBuffer:\fR \fIboolean\fR" 4 |
850 | .IP "\fBscrollWithBuffer:\fR \fIboolean\fR" 4 |
850 | .IX Item "scrollWithBuffer: boolean" |
851 | .IX Item "scrollWithBuffer: boolean" |
851 | \&\fBTrue\fR: scroll with scrollback buffer when tty receives new lines (and |
852 | \&\fBTrue\fR: scroll with scrollback buffer when tty receives new lines (and |
852 | \&\fBscrollTtyOutput\fR is False); option \fB\-sw\fR. \fBFalse\fR: do not scroll |
853 | \&\fBscrollTtyOutput\fR is False); option \fB\-sw\fR. \fBFalse\fR: do not scroll |
853 | with scrollback buffer when tty recieves new lines; option \fB+sw\fR. |
854 | with scrollback buffer when tty receives new lines; option \fB+sw\fR. |
854 | .IP "\fBscrollTtyKeypress:\fR \fIboolean\fR" 4 |
855 | .IP "\fBscrollTtyKeypress:\fR \fIboolean\fR" 4 |
855 | .IX Item "scrollTtyKeypress: boolean" |
856 | .IX Item "scrollTtyKeypress: boolean" |
856 | \&\fBTrue\fR: scroll to bottom when a non-special key is pressed. Special keys |
857 | \&\fBTrue\fR: scroll to bottom when a non-special key is pressed. Special keys |
857 | are those which are intercepted by rxvt-unicode for special handling and |
858 | are those which are intercepted by rxvt-unicode for special handling and |
858 | are not passed onto the shell; option \fB\-sk\fR. \fBFalse\fR: do not scroll to |
859 | are not passed onto the shell; option \fB\-sk\fR. \fBFalse\fR: do not scroll to |
… | |
… | |
1038 | Xlib itself does its own de-escaping (you can use \f(CW\*(C`\e033\*(C'\fR instead of |
1039 | Xlib itself does its own de-escaping (you can use \f(CW\*(C`\e033\*(C'\fR instead of |
1039 | \&\f(CW\*(C`\ee\*(C'\fR (and so on), which will work with both Xt and @@RXVT_NAME@@'s own |
1040 | \&\f(CW\*(C`\ee\*(C'\fR (and so on), which will work with both Xt and @@RXVT_NAME@@'s own |
1040 | processing). |
1041 | processing). |
1041 | .Sp |
1042 | .Sp |
1042 | You can define a range of keysyms in one shot by providing a \fIstring\fR |
1043 | You can define a range of keysyms in one shot by providing a \fIstring\fR |
1043 | with pattern \fBlist/PREFIX/MIDDLE/SUFFIX\fR, where the delimeter `/' |
1044 | with pattern \fBlist/PREFIX/MIDDLE/SUFFIX\fR, where the delimiter `/' |
1044 | should be a character not used by the strings. |
1045 | should be a character not used by the strings. |
1045 | .Sp |
1046 | .Sp |
1046 | Its usage can be demonstrated by an example: |
1047 | Its usage can be demonstrated by an example: |
1047 | .Sp |
1048 | .Sp |
1048 | .Vb 1 |
1049 | .Vb 1 |
… | |
… | |
1127 | example, \f(CW\*(C`default,\-selection\*(C'\fR will use all the default extension except |
1128 | example, \f(CW\*(C`default,\-selection\*(C'\fR will use all the default extension except |
1128 | \&\f(CW\*(C`selection\*(C'\fR. |
1129 | \&\f(CW\*(C`selection\*(C'\fR. |
1129 | .Sp |
1130 | .Sp |
1130 | Extension names can also be followed by an argument in angle brackets |
1131 | Extension names can also be followed by an argument in angle brackets |
1131 | (e.g. \f(CW\*(C`searchable\-scrollback<M\-s>\*(C'\fR, which binds the hotkey for |
1132 | (e.g. \f(CW\*(C`searchable\-scrollback<M\-s>\*(C'\fR, which binds the hotkey for |
1132 | searchable scorllback to Alt/Meta\-s). Mentioning the same extension |
1133 | searchable scrollback to Alt/Meta\-s). Mentioning the same extension |
1133 | multiple times with different arguments will pass multiple arguments to |
1134 | multiple times with different arguments will pass multiple arguments to |
1134 | the extension. |
1135 | the extension. |
1135 | .Sp |
1136 | .Sp |
1136 | Each extension is looked up in the library directories, loaded if |
1137 | Each extension is looked up in the library directories, loaded if |
1137 | necessary, and bound to the current terminal instance. |
1138 | necessary, and bound to the current terminal instance. |
… | |
… | |
1387 | .IX Header "ENVIRONMENT" |
1388 | .IX Header "ENVIRONMENT" |
1388 | \&\fB@@RXVT_NAME@@\fR sets and/or uses the following environment variables: |
1389 | \&\fB@@RXVT_NAME@@\fR sets and/or uses the following environment variables: |
1389 | .IP "\fB\s-1TERM\s0\fR" 4 |
1390 | .IP "\fB\s-1TERM\s0\fR" 4 |
1390 | .IX Item "TERM" |
1391 | .IX Item "TERM" |
1391 | Normally set to \f(CW\*(C`rxvt\-unicode\*(C'\fR, unless overwritten at configure time, via |
1392 | Normally set to \f(CW\*(C`rxvt\-unicode\*(C'\fR, unless overwritten at configure time, via |
1392 | resources or on the commandline. |
1393 | resources or on the command line. |
1393 | .IP "\fB\s-1COLORTERM\s0\fR" 4 |
1394 | .IP "\fB\s-1COLORTERM\s0\fR" 4 |
1394 | .IX Item "COLORTERM" |
1395 | .IX Item "COLORTERM" |
1395 | Either \f(CW\*(C`rxvt\*(C'\fR, \f(CW\*(C`rxvt\-xpm\*(C'\fR, depending on wether @@RXVT_NAME@@ was |
1396 | Either \f(CW\*(C`rxvt\*(C'\fR, \f(CW\*(C`rxvt\-xpm\*(C'\fR, depending on whether @@RXVT_NAME@@ was |
1396 | compiled with \s-1XPM\s0 support, and optionally with the added extension |
1397 | compiled with \s-1XPM\s0 support, and optionally with the added extension |
1397 | \&\f(CW\*(C`\-mono\*(C'\fR to indicate that rxvt-unicode runs on a monochrome screen. |
1398 | \&\f(CW\*(C`\-mono\*(C'\fR to indicate that rxvt-unicode runs on a monochrome screen. |
1398 | .IP "\fB\s-1COLORFGBG\s0\fR" 4 |
1399 | .IP "\fB\s-1COLORFGBG\s0\fR" 4 |
1399 | .IX Item "COLORFGBG" |
1400 | .IX Item "COLORFGBG" |
1400 | 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 |
1401 | 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 |