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.62 by root, Mon Jul 17 19:20:29 2006 UTC vs.
Revision 1.63 by root, Mon Aug 7 16:17:30 2006 UTC

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

Diff Legend

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