ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.1.txt
(Generate patch)

Comparing rxvt-unicode/doc/rxvt.1.txt (file contents):
Revision 1.58 by root, Tue Feb 21 01:00:40 2006 UTC vs.
Revision 1.63 by root, Thu Nov 2 17:37:47 2006 UTC

4 4
5SYNOPSIS 5SYNOPSIS
6 rxvt [options] [-e command [ args ]] 6 rxvt [options] [-e command [ args ]]
7 7
8DESCRIPTION 8DESCRIPTION
9 rxvt-unicode, version 7.6, is a colour vt102 terminal emulator intended 9 rxvt-unicode, version 8.0, is a colour vt102 terminal emulator intended
10 as an *xterm*(1) replacement for users who do not require features such 10 as an *xterm*(1) replacement for users who do not require features such
11 as Tektronix 4014 emulation and toolkit-style configurability. As a 11 as Tektronix 4014 emulation and toolkit-style configurability. As a
12 result, rxvt-unicode uses much less swap space -- a significant 12 result, rxvt-unicode uses much less swap space -- a significant
13 advantage on a machine serving many X sessions. 13 advantage on a machine serving many X sessions.
14 14
15FREQUENTLY ASKED QUESTIONS 15FREQUENTLY ASKED QUESTIONS
16 See rxvt(7) (try "man 7 rxvt") for a list of frequently asked questions 16 See rxvt(7) (try "man 7 rxvt") for a list of frequently asked questions
17 and answer to them and some common problems. That document is also 17 and answer to them and some common problems. That document is also
18 accessible on the World-Wide-Web at 18 accessible on the World-Wide-Web at
19 <http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>. 19 <http://cvs.schmorp.de/browse/rxvt-unicode/doc/rxvt.7.html>.
20 20
21RXVT-UNICODE VS. RXVT 21RXVT-UNICODE VS. RXVT
22 Unlike the original rxvt, rxvt-unicode stores all text in Unicode 22 Unlike the original rxvt, rxvt-unicode stores all text in Unicode
23 internally. That means it can store and display most scripts in the 23 internally. That means it can store and display most scripts in the
24 world. Being a terminal emulator, however, some things are very 24 world. Being a terminal emulator, however, some things are very
25 difficult, especially cursive scripts such as arabic, vertically written 25 difficult, especially cursive scripts such as arabic, vertically written
26 scripts like mongolian or scripts requiring extremely complex combining 26 scripts like mongolian or scripts requiring extremely complex combining
27 rules, like tibetan or devenagari. Don't expect pretty output when using 27 rules, like tibetan or devenagari. Don't expect pretty output when using
28 these scripts. Most other scripts, latin, cyrillic, kanji, thai etc. 28 these scripts. Most other scripts, latin, cyrillic, kanji, thai etc.
29 should work fine, though. A somewhat difficult case are left-to-right 29 should work fine, though. A somewhat difficult case are right-to-left
30 scripts, such as hebrew: rxvt-unicode adopts the view that bidirectional 30 scripts, such as hebrew: rxvt-unicode adopts the view that bidirectional
31 algorithms belong into the application, not the terminal emulator (too 31 algorithms belong into the application, not the terminal emulator (too
32 many things -- such as cursor-movement while editing -- break 32 many things -- such as cursor-movement while editing -- break
33 otherwise), but that might change. 33 otherwise), but that might change.
34 34
35 If you are looking for a terminal that supports more exotic scripts, let 35 If you are looking for a terminal that supports more exotic scripts, let
36 me recommend "mlterm", which is a very userfriendly, lean and clean 36 me recommend "mlterm", which is a very user friendly, lean and clean
37 terminal emulator. In fact, the reason rxvt-unicode was born was solely 37 terminal emulator. In fact, the reason rxvt-unicode was born was solely
38 because the author couldn't get "mlterm" to use one font for latin1 and 38 because the author couldn't get "mlterm" to use one font for latin1 and
39 another for japanese. 39 another for japanese.
40 40
41 Therefore another design rationale was the use of multiple fonts to 41 Therefore another design rationale was the use of multiple fonts to
42 display characters: The idea of a single unicode font which many other 42 display characters: The idea of a single unicode font which many other
43 programs force onto it's users never made sense to me: You should be 43 programs force onto its users never made sense to me: You should be able
44 able to choose any font for any script freely. 44 to choose any font for any script freely.
45 45
46 Apart from that, rxvt-unicode is also much better internationalised than 46 Apart from that, rxvt-unicode is also much better internationalised than
47 it's predecessor, supports things such as XFT and ISO 14755 that are 47 its predecessor, supports things such as XFT and ISO 14755 that are
48 handy in i18n-environments, is faster, and has a lot less bugs than the 48 handy in i18n-environments, is faster, and has a lot bugs less than the
49 original rxvt. This all in addition to dozens of other small 49 original rxvt. This all in addition to dozens of other small
50 improvements. 50 improvements.
51 51
52 It is still faithfully following the original rxvt idea of being lean 52 It is still faithfully following the original rxvt idea of being lean
53 and nice on resources: for example, you can still configure rxvt-unicode 53 and nice on resources: for example, you can still configure rxvt-unicode
54 without most of it's features to get a lean binary. It also comes with a 54 without most of its features to get a lean binary. It also comes with a
55 client/daemon pair that lets you open any number of terminal windows 55 client/daemon pair that lets you open any number of terminal windows
56 from within a single process, which makes startup time very fast and 56 from within a single process, which makes startup time very fast and
57 drastically reduces memory usage. See rxvtd(1) (daemon) and rxvtc(1) 57 drastically reduces memory usage. See rxvtd(1) (daemon) and rxvtc(1)
58 (client). 58 (client).
59 59
60 It also makes technical information about escape sequences (which have 60 It also makes technical information about escape sequences (which have
61 been extended) easier accessible: see rxvt(7) for technical reference 61 been extended) more accessible: see rxvt(7) for technical reference
62 documentation (escape sequences etc.). 62 documentation (escape sequences etc.).
63 63
64OPTIONS 64OPTIONS
65 The rxvt options (mostly a subset of *xterm*'s) are listed below. In 65 The rxvt options (mostly a subset of *xterm*'s) are listed below. In
66 keeping with the smaller-is-better philosophy, options may be eliminated 66 keeping with the smaller-is-better philosophy, options may be eliminated
102 -ip|+ip | -tr|+tr 102 -ip|+ip | -tr|+tr
103 Turn on/off inheriting parent window's pixmap. Alternative form is 103 Turn on/off inheriting parent window's pixmap. Alternative form is
104 -tr; resource inheritPixmap. 104 -tr; resource inheritPixmap.
105 105
106 *Please note that transparency of any kind if completely unsupported 106 *Please note that transparency of any kind if completely unsupported
107 by the author. Don't bug him with installation questions!* 107 by the author. Don't bug him with installation questions! Read the
108 FAQ (man 7 rxvt)!*
108 109
109 -fade *number* 110 -fade *number*
110 Fade the text by the given percentage when focus is lost. Small 111 Fade the text by the given percentage when focus is lost. Small
111 values fade a little only, 100 completely replaces all colours by 112 values fade a little only, 100 completely replaces all colours by
112 the fade colour; resource fading. 113 the fade colour; resource fading.
159 characters. The first font defines the cell size for characters; 160 characters. The first font defines the cell size for characters;
160 other fonts might be smaller, but not (in general) larger. A 161 other fonts might be smaller, but not (in general) larger. A
161 (hopefully) reasonable default font list is always appended to it. 162 (hopefully) reasonable default font list is always appended to it.
162 See resource font for more details. 163 See resource font for more details.
163 164
164 In short, to specify an X11 core font, just specify it's name or 165 In short, to specify an X11 core font, just specify its name or
165 prefix it with "x:". To specify an XFT-font, you need to prefix it 166 prefix it with "x:". To specify an XFT-font, you need to prefix it
166 with "xft:", e.g.: 167 with "xft:", e.g.:
167 168
168 rxvt -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" 169 rxvt -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
169 rxvt -fn "9x15bold,xft:Bitstream Vera Sans Mono" 170 rxvt -fn "9x15bold,xft:Bitstream Vera Sans Mono"
357 358
358 -keysym.*sym* *string* 359 -keysym.*sym* *string*
359 Remap a key symbol. See resource keysym. 360 Remap a key symbol. See resource keysym.
360 361
361 -embed *windowid* 362 -embed *windowid*
362 Tells rxvt to embed it's windows into an already-existing window, 363 Tells rxvt to embed its windows into an already-existing window,
363 which enables applications to easily embed a terminal. 364 which enables applications to easily embed a terminal.
364 365
365 Right now, rxvt will first unmap/map the specified window, so it 366 Right now, rxvt will first unmap/map the specified window, so it
366 shouldn't be a top-level window. rxvt will also reconfigure it quite 367 shouldn't be a top-level window. rxvt will also reconfigure it quite
367 a bit, so don't expect it to keep some specific state. It's best to 368 a bit, so don't expect it to keep some specific state. It's best to
370 The window will not be destroyed when rxvt exits. 371 The window will not be destroyed when rxvt exits.
371 372
372 It might be useful to know that rxvt will not close file descriptors 373 It might be useful to know that rxvt will not close file descriptors
373 passed to it (except for stdin/out/err, of course), so you can use 374 passed to it (except for stdin/out/err, of course), so you can use
374 file descriptors to communicate with the programs within the 375 file descriptors to communicate with the programs within the
375 terminal. This works regardless of wether the "-embed" option was 376 terminal. This works regardless of whether the "-embed" option was
376 used or not. 377 used or not.
377 378
378 Here is a short Gtk2-perl snippet that illustrates how this option 379 Here is a short Gtk2-perl snippet that illustrates how this option
379 can be used (a longer example is in doc/embed): 380 can be used (a longer example is in doc/embed):
380 381
384 system "rxvt -embed $xid &"; 385 system "rxvt -embed $xid &";
385 }); 386 });
386 387
387 -pty-fd *file descriptor* 388 -pty-fd *file descriptor*
388 Tells rxvt NOT to execute any commands or create a new pty/tty pair 389 Tells rxvt NOT to execute any commands or create a new pty/tty pair
389 but instead use the given filehandle as the tty master. This is 390 but instead use the given file descriptor as the tty master. This is
390 useful if you want to drive rxvt as a generic terminal emulator 391 useful if you want to drive rxvt as a generic terminal emulator
391 without having to run a program within it. 392 without having to run a program within it.
392 393
393 If this switch is given, rxvt will not create any utmp/wtmp entries 394 If this switch is given, rxvt will not create any utmp/wtmp entries
394 and will not tinker with pty/tty permissions - you have to do that 395 and will not tinker with pty/tty permissions - you have to do that
622 normal text font will being used for the given style. 623 normal text font will being used for the given style.
623 624
624 intensityStyles: *boolean* 625 intensityStyles: *boolean*
625 When font styles are not enabled, or this option is enabled (True, 626 When font styles are not enabled, or this option is enabled (True,
626 option -is, the default), bold and italic font styles imply high 627 option -is, the default), bold and italic font styles imply high
627 intensity foreground/backround colours. Disabling this option 628 intensity foreground/background colours. Disabling this option
628 (False, option +is) disables this behaviour, the high intensity 629 (False, option +is) disables this behaviour, the high intensity
629 colours are not reachable. 630 colours are not reachable.
630 631
631 selectstyle: *mode* 632 selectstyle: *mode*
632 Set mouse selection style to old which is 2.20, oldword which is 633 Set mouse selection style to old which is 2.20, oldword which is
675 Example: 676 Example:
676 677
677 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 678 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
678 679
679 This creates a new file in your home directory with the screen 680 This creates a new file in your home directory with the screen
680 contents everytime you hit "Print". 681 contents every time you hit "Print".
681 682
682 scrollBar: *boolean* 683 scrollBar: *boolean*
683 True: enable the scrollbar [default]; option -sb. False: disable the 684 True: enable the scrollbar [default]; option -sb. False: disable the
684 scrollbar; option +sb. 685 scrollbar; option +sb.
685 686
700 do not scroll to bottom when tty receives output; option +si. 701 do not scroll to bottom when tty receives output; option +si.
701 702
702 scrollWithBuffer: *boolean* 703 scrollWithBuffer: *boolean*
703 True: scroll with scrollback buffer when tty receives new lines (and 704 True: scroll with scrollback buffer when tty receives new lines (and
704 scrollTtyOutput is False); option -sw. False: do not scroll with 705 scrollTtyOutput is False); option -sw. False: do not scroll with
705 scrollback buffer when tty recieves new lines; option +sw. 706 scrollback buffer when tty receives new lines; option +sw.
706 707
707 scrollTtyKeypress: *boolean* 708 scrollTtyKeypress: *boolean*
708 True: scroll to bottom when a non-special key is pressed. Special 709 True: scroll to bottom when a non-special key is pressed. Special
709 keys are those which are intercepted by rxvt-unicode for special 710 keys are those which are intercepted by rxvt-unicode for special
710 handling and are not passed onto the shell; option -sk. False: do 711 handling and are not passed onto the shell; option -sk. False: do
885 886
886 *string* may contain escape values ("\a": bell, "\b": backspace, 887 *string* may contain escape values ("\a": bell, "\b": backspace,
887 "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab, 888 "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab,
888 "\000": octal number) or verbatim control characters ("^?": delete, 889 "\000": octal number) or verbatim control characters ("^?": delete,
889 "^@": null, "^A" ...) and may be enclosed with double quotes so that 890 "^@": null, "^A" ...) and may be enclosed with double quotes so that
890 it can start or end with whitespace. 891 it can start or end with whitespace. This feature is deprecated and
892 will be removed.
891 893
892 Please note that you need to double the "\" in resource files, as 894 Please note that you need to double the "\" in resource files, as
893 Xlib itself does it's own de-escaping (you can use "\033" instead of 895 Xlib itself does its own de-escaping (you can use "\033" instead of
894 "\e" (and so on), which will work with both Xt and rxvt's own 896 "\e" (and so on), which will work with both Xt and rxvt's own
895 processing). 897 processing).
896 898
897 You can define a range of keysyms in one shot by providing a 899 You can define a range of keysyms in one shot by providing a
898 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter 900 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimiter
899 `/' should be a character not used by the strings. 901 `/' should be a character not used by the strings.
900 902
901 Its usage can be demonstrated by an example: 903 Its usage can be demonstrated by an example:
902 904
903 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 905 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
965 For example, "default,-selection" will use all the default extension 967 For example, "default,-selection" will use all the default extension
966 except "selection". 968 except "selection".
967 969
968 Extension names can also be followed by an argument in angle 970 Extension names can also be followed by an argument in angle
969 brackets (e.g. "searchable-scrollback<M-s>", which binds the hotkey 971 brackets (e.g. "searchable-scrollback<M-s>", which binds the hotkey
970 for searchable scorllback to Alt/Meta-s). Mentioning the same 972 for searchable scrollback to Alt/Meta-s). Mentioning the same
971 extension multiple times with different arguments will pass multiple 973 extension multiple times with different arguments will pass multiple
972 arguments to the extension. 974 arguments to the extension.
973 975
974 Each extension is looked up in the library directories, loaded if 976 Each extension is looked up in the library directories, loaded if
975 necessary, and bound to the current terminal instance. 977 necessary, and bound to the current terminal instance.
1110 This mode lets you input characters representing the keycap symbols 1112 This mode lets you input characters representing the keycap symbols
1111 of your keyboard, if representable in the current locale encoding. 1113 of your keyboard, if representable in the current locale encoding.
1112 1114
1113 Start by pressing "Control" and "Shift" together, then releasing 1115 Start by pressing "Control" and "Shift" together, then releasing
1114 them. The next special key (cursor keys, home etc.) you enter will 1116 them. The next special key (cursor keys, home etc.) you enter will
1115 not invoke it's usual function but instead will insert the 1117 not invoke its usual function but instead will insert the
1116 corresponding keycap symbol. The symbol will only be entered when 1118 corresponding keycap symbol. The symbol will only be entered when
1117 the key has been released, otherwise pressing e.g. "Shift" would 1119 the key has been released, otherwise pressing e.g. "Shift" would
1118 enter the symbol for "ISO Level 2 Switch", although your intention 1120 enter the symbol for "ISO Level 2 Switch", although your intention
1119 might have been to enter a reverse tab (Shift-Tab). 1121 might have been to enter a reverse tab (Shift-Tab).
1120 1122
1220ENVIRONMENT 1222ENVIRONMENT
1221 rxvt sets and/or uses the following environment variables: 1223 rxvt sets and/or uses the following environment variables:
1222 1224
1223 TERM 1225 TERM
1224 Normally set to "rxvt-unicode", unless overwritten at configure 1226 Normally set to "rxvt-unicode", unless overwritten at configure
1225 time, via resources or on the commandline. 1227 time, via resources or on the command line.
1226 1228
1227 COLORTERM 1229 COLORTERM
1228 Either "rxvt", "rxvt-xpm", depending on wether rxvt was compiled 1230 Either "rxvt", "rxvt-xpm", depending on whether rxvt was compiled
1229 with XPM support, and optionally with the added extension "-mono" to 1231 with XPM support, and optionally with the added extension "-mono" to
1230 indicate that rxvt-unicode runs on a monochrome screen. 1232 indicate that rxvt-unicode runs on a monochrome screen.
1231 1233
1232 COLORFGBG 1234 COLORFGBG
1233 Set to a string of the form "fg;bg" or "fg;xpm;bg", where "fg" is 1235 Set to a string of the form "fg;bg" or "fg;xpm;bg", where "fg" is
1247 Set to the terminfo directory iff rxvt was configured with 1249 Set to the terminfo directory iff rxvt was configured with
1248 "--with-terminfo=PATH". 1250 "--with-terminfo=PATH".
1249 1251
1250 DISPLAY 1252 DISPLAY
1251 Used by rxvt to connect to the display and set to the correct 1253 Used by rxvt to connect to the display and set to the correct
1252 display in it's child processes. 1254 display in its child processes.
1253 1255
1254 SHELL 1256 SHELL
1255 The shell to be used for command execution, defaults to "/bin/sh". 1257 The shell to be used for command execution, defaults to "/bin/sh".
1256 1258
1257 RXVT_SOCKET 1259 RXVT_SOCKET
1281 1283
1282CURRENT PROJECT COORDINATOR 1284CURRENT PROJECT COORDINATOR
1283 Project Coordinator 1285 Project Coordinator
1284 Marc A. Lehmann <rxvt-unicode@schmorp.de> 1286 Marc A. Lehmann <rxvt-unicode@schmorp.de>
1285 1287
1286 <http://software.schmorp.de/#rxvt-unicode> 1288 <http://software.schmorp.de/pkg/rxvt-unicode.html>
1287 1289
1288AUTHORS 1290AUTHORS
1289 John Bovey 1291 John Bovey
1290 University of Kent, 1992, wrote the original Xvt. 1292 University of Kent, 1992, wrote the original Xvt.
1291 1293

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines