Home
Main website
Display Sidebar
Hide Ads
Recent Changes
View Source:
rxvt-xterm(1)
Edit
PageHistory
Diff
Info
LikePages
1 !!!1 NAME SYNOPSIS DESCRIPTION OPTIONS RESOURCES (available also as long-options) THE SCROLLBAR MOUSE REPORTING TEXT SELECTION AND INSERTION CHANGING FONTS LOGIN STAMP COLORS AND GRAPHICS ENVIRONMENT FILES DEBIAN NOTES SEE ALSO BUGS FTP LOCATION CURRENT PROJECT COORDINATOR AUTHORS ---- !!NAME rxvt (ouR XVT) - a VT102 emulator for the X window system !!SYNOPSIS __rxvt__ [[options] [[-e command [[ args ]] !!DESCRIPTION __rxvt__, version __2.6.4__, is a colour vt102 terminal emulator intended as an xterm(1) replacement for users who do not require features such as Tektronix 4014 emulation and toolkit-style configurability. As a result, __rxvt__ uses much less swap space -- a significant advantage on a machine serving many X sessions. !!OPTIONS The __rxvt__ options (mostly a subset of ''xterm'''s) are listed below. In keeping with the smaller-is-better philosophy, options may be eliminated or default values chosen at compile-time, so options and defaults listed may not accurately reflect the version installed on your system. ``rxvt -h'' gives a list of major compile-time options on the usage line. Option descriptions may be prefixed with which compile option each is dependent upon. e.g. ``Compile ''XIM'':'' requires ''XIM'' on the usage line. Note: ``rxvt -help'' gives a list of all options compiled into your version. Note that __rxvt__ permits the resource name to be used as a long-option (--/++ option) so the potential command-line options are far greater than those listed. For example: ``rxvt --loginShell --color1 Orange''. __-help__, __--help__ Print out a message describing available options. __-display__ ''displayname'' Attempt to open a window on the named X display (__-d__ still respected). In the absence of this option, the display specified by the __DISPLAY__ environment variable is used. __-geometry__ ''geom'' Window geometry (__-g__ still respected); resource __geometry__. __-rv__|__+rv__ Turn on/off simulated reverse video; resource __reverseVideo__. __-ip__|__+ip__ Turn on/off inheriting parent window's pixmap. Alternative form is __-tr__; resource __inheritPixmap__. __-bg__ ''colour'' Window background colour; resource __background__. __-fg__ ''colour'' Window foreground colour; resource __foreground__. __-pixmap:__ ''file[[;geom]'' Compile ''XPM'': Specify XPM file for the background and also optionally specify its scaling with a geometry string. Note you may need to add quotes to avoid special shell interpretation of the ``;'' in the command-line; resource __backgroundPixmap__. __-cr__ ''colour'' The cursor colour; resource __cursorColor__. __-pr__ ''colour'' The mouse pointer colour; resource __pointerColor__. __-bd__ ''colour'' The colour of the border between the xterm scrollbar and the text; resource __borderColor__. __-fn__ ''fontname'' Main normal text font; resource __font__. __-fb__ ''fontname'' Main bold text font; resource __boldFont__. __-fm__ ''fontname'' Main multicharacter font; resource __mfont__. __-km__ ''mode'' Multiple-character font-set encoding mode; __eucj__: EUC Japanese encoding. __sjis__: Shift JIS encoding; resource __multichar_encoding__. __-grk__ ''mode'' Greek keyboard translation; __iso__: ISO-8859 mapping. __ibm__: IBM-437 mapping; resource __greek_keyboard__. __-name__ ''name'' Specify the application name under which resources are to be obtained, rather than the default executable file name. Name should not contain ``.'' or ``*'' characters. Also sets the icon and title name. __-ls__|__+ls__ Start as a login-shell/sub-shell; resource __loginShell__. __-ut__|__+ut__ Compile ''utmp'': Inhibit/enable writing a utmp entry; resource __utmpInhibit__. __-vb__|__+vb__ Turn on/off visual bell on receipt of a bell character; resource __visualBell__. __-sb__|__+sb__ Turn on/off scrollbar; resource __scrollBar__. __-si__|__+si__ Turn on/off scroll-to-bottom on TTY output inhibit; resource __scrollTtyOutput__ has opposite effect. __-sk__|__+sk__ Turn on/off scroll-to-bottom on keypress; resource __scrollTtyKeypress__. __-sr__|__+sr__ Put scrollbar on right/left; resource __scrollBar_right__. __-st__|__+st__ Display normal (non XTerm/NeXT) scrollbar without/with a trough; resource __scrollBar_floating__. __-iconic__ Start iconified, if the window manager supports that option. Alternative form is __-ic__. __-sl__ ''number'' Save ''number'' lines in the scrollback buffer; resource __saveLines__. __-tn__ ''termname'' This option specifies the name of the terminal type to be set in the __TERM__ environment variable. This terminal type must exist in the ''termcap(5)'' database and should have ''li#'' and ''co#'' entries; resource __termName__. __-im__ ''method'' This option specifies the input method to use; resource __inputMethod__. __-e__ ''command [[arguments]'' Run the command with its command-line arguments in the __rxvt__ window; also sets the window title and icon name to be the basename of the program being executed if neither ''-title'' (''-T'') nor ''-n'' are given on the command line. If this option is used, it must be the last on the command-line. If there is no __-e__ option then the default is to run the program specified by the __SHELL__ environment variable or, failing that, ''sh(1)''. __-title__ ''text'' Window title (__-T__ still respected); the default title is the basename of the program specified after the __-e__ option, if any, otherwise the application name; resource __title__. __-n__ ''text'' Icon name; the default name is the basename of the program specified after the __-e__ option, if any, otherwise the application name; resource __iconName__. __-C__ Capture system console messages. __-pt__ ''style'' Compile ''XIM'': input style for input method; __!OverTheSpot__, __!OffTheSpot__, __Root__; resource __preeditType__. __-im__ ''text'' Compile ''XIM'': input method name. resource __inputMethod__. __-mod__ ''modifier'' Override detection of Meta modifier with specified key: __alt__, __meta__, __hyper__, __super__, __mod1__, __mod2__, __mod3__, __mod4__, __mod5__; resource ''modifier''. __-xrm__ ''resourcestring'' No effect on rxvt. Simply passes through an argument to be made available in the instance's argument list. Appears in ''WM_COMMAND'' in some window managers. !!RESOURCES (available also as long-options) Note: ``rxvt --help'' gives a list of all resources (long options) compiled into your version. If compiled with internal Xresources support (i.e. __rxvt -h__ lists __.Xdefaults__) then __rxvt__ accepts application defaults set in XAPPLOADDIR/Rxvt (compile-time defined: usually __/usr/lib/X11/app-defaults/Rxvt__) and resources set in __~/.Xdefaults__, or __~/.Xresources__ if __~/.Xdefaults__ does not exist. Note that when reading X resources, __rxvt__ recognizes two class names: __XTerm__ and __Rxvt__. The class name __XTerm__ allows resources common to both __rxvt__ and ''xterm'' to be easily configured, while the class name __Rxvt__ allows resources unique to __rxvt__, notably colours and key-handling, to be shared between different __rxvt__ configurations. If no resources are specified, suitable defaults will be used. Command-line arguments can be used to override resource settings. The following resources are allowed: __geometry:__ ''geom'' Create the window with the specified X window geometry [[default 80x24]; option __-geometry__. __background:__ ''colour'' Use the specified colour as the window's background colour [[default White]; option __-bg__. __foreground:__ ''colour'' Use the specified colour as the window's foreground colour [[default Black]; option __-fg__. __color__''n''__:__ ''colour'' Use the specified colour for the colour value ''n'', where 0-7 corresponds to low-intensity (normal) colours and 8-15 corresponds to high-intensity (bold = bright foreground, blink = bright background) colours. The canonical names are as follows: 0=black, 1=red, 2=green, 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour names used are listed in the __COLORS AND GRAPHICS__ section. __colorBD:__ ''colour'' Use the specified colour to display bold characters when the foreground colour is the default. __colorUL:__ ''colour'' Use the specified colour to display underlined characters when the foreground colour is the default. __cursorColor:__ ''colour'' Use the specified colour for the cursor. The default is to use the foreground colour; option __-cr__. __cursorColor2:__ ''colour'' Use the specified colour for the colour of the cursor text. For this to take effect, __cursorColor__ must also be specified. The default is to use the background colour. __reverseVideo:__ ''boolean'' __True__: simulate reverse video by foreground and background colours; option __-rv__, __False__: regular screen colours [[default]; option __+rv__. See note in __COLORS AND GRAPHICS__ section. __inheritPixmap:__ ''boolean'' __True__: make the background inherit the parent windows' pixmap, giving artificial transparency. __False__: do not inherit the parent windows' pixmap. __scrollColor:__ ''colour'' Use the specified colour for the scrollbar [[default #B2B2B2]. __troughColor:__ ''colour'' Use the specified colour for the scrollbar's trough area [[default #969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. __backgroundPixmap:__ ''file[[;geom]'' Use the specified XPM file (note the ``.xpm'' extension is optional) for the background and also optionally specify its scaling with a geometry string __WxH+X+Y__, in which __``W'' / ``H''__ specify the horizontal/vertical scale (percent) and __``X'' / ``Y''__ locate the image centre (percent). A scale of 0 displays the image with tiling. A scale of 1 displays the image without any scaling. A scale of 2 to 9 specifies an integer number of images in that direction. No image will be magnified beyond 10 times its original size. The maximum permitted scale is 1000. [[default 0x0+50+50] __menu:__ ''file[[;tag]'' Read in the specified menu file (note the ``.menu'' extension is optional) and also optionally specify a starting tag to find. See the reference documentation for details on the syntax for the menuBar. __path:__ ''path'' Specify the colon-delimited search path for finding files (XPM and menus), in addition to the paths specified by the __RXVTPATH__ and __PATH__ environment variables. __font:__ ''fontname'' Select the main text font used [[default 7x14]; option __-fn__. __font__''n''__:__ ''fontname'' Specify the alternative font ''n''. The default font values: __boldFont:__ ''fontname'' Specify the name of the bold font to use if __colorBD__ has not been specified and it is not possible to map the default foreground colour to colour 8-15 [[default NONE]. This font must be the same height and width as the normal font; option __-fb__. __mfont:__ ''fontname'' Select the main multiple-character text font used [[default k14]; option __-fk__. __mfont__''n''__:__ ''fontname'' Specify the alternative multiple-character font ''n''. If compiled for multiple-character fonts, the Roman and multiple-character font sizes should match. __multichar_encoding:__ ''mode'' Set the encoding mode to be used when multicharacter encoding is received; __eucj__: EUC Japanese encoding [[default for Kanji]. __sjis__: Shift JIS encoding. __big5__: BIG5 encoding. __gb__: GB encoding; option __-km__. __greek_keyboard:__ ''mode'' Set the Greek keyboard translation mode to be used; __iso__: ISO-8859 mapping (elot-928) [[default]. __ibm__: IBM-437 mapping (DOS codepage 737); option __-grk__. Use __Mode_switch__ to toggle keyboard input. For more details, see the distributed file __README.greek__. __selectstyle:__ ''text'' Set mouse selection style to __old__ which is 2.20, __oldword__ which is xterm style with 2.20 old word selection, or anything else which gives xterm style selection. __title:__ ''text'' Set window title string, the default title is the command-line specified after the __-e__ option, if any, otherwise the application name; option __-title__. __iconName:__ ''text'' Set the name used to label the window's icon or displayed in an icon manager window, it also sets the window's title unless it is explicitly set; option __-n__. __mapAlert:__ ''boolean'' __True__: de-iconify (map) on receipt of a bell character. __False__: no de-iconify (map) on receipt of a bell character [[default]. __visualBell:__ ''boolean'' __True__: use visual bell on receipt of a bell character; option __-vb__. __False__: no visual bell [[default]; option __+vb__. __loginShell:__ ''boolean'' __True__: start as a login shell by prepending a ``-'' to __argv[[0]__ of the shell; option __-ls__. __False__: start as a normal sub-shell [[default]; option __+ls__. __utmpInhibit:__ ''boolean'' __True__: inhibit writing record into the system log file __utmp__; option __-ut__. __False__: write record into the system log file __utmp__ [[default]; option __+ut__. __print-pipe:__ ''string'' Specify a command pipe for vt100 printer [[default ''lpr(1)'']. Use __Print__ to initiate a screen dump to the printer and __Ctrl-Print__ or __Shift-Print__ to include the scrollback as well. __scrollBar:__ ''boolean'' __True__: enable the scrollbar [[default]; option __-sb__. __False__: disable the scrollbar; option __+sb__. __scrollBar_right:__ ''boolean'' __True__: place the scrollbar on the right of the window; option __-sr__. __False__: place the scrollbar on the left of the window; option __+sr__. __scrollBar_floating:__ ''boolean'' __True__: display an rxvt scrollbar without a trough; option __-st__. __False__: display an rxvt scrollbar with a trough; option __+st__. __scrollTtyOutput:__ ''boolean'' __True__: scroll to bottom when tty receives output; option(+si). __False__: do not scroll to bottom when tty receives output; option(-si). __scrollTtyKeypress:__ ''boolean'' __True__: scroll to bottom when a non-special key is pressed. Special keys are those which are intercepted by rxvt for special handling and are not passed onto the shell; option(-sk). __False__: do not scroll to bottom when a non-special key is pressed; option(+sk). __smallfont_key:__ ''keysym'' If enabled, use __Alt-__''keysym'' to toggle to a smaller font [[default __Alt-__] __bigfont_key:__ ''keysym'' If enabled, use __Alt-__''keysym'' to toggle to a bigger font [[default __Alt-__] __saveLines:__ ''number'' Save ''number'' lines in the scrollback buffer [[default 64]; option __-sl__. __termName:__ ''termname'' Specifies the terminal type name to be set in the __TERM__ environment variable; option __-tn__. __inputMethod:__ ''method'' Specifies the input method to use; option __-im__. __meta8:__ ''boolean'' __True__: handle Meta (Alt) + keypress to set the 8th bit. __False__: handle Meta (Alt) + keypress as an escape prefix [[default]. __backspacekey:__ ''string'' The string to send when the backspace key is pressed. If set to __DEC__ or unset it will send __Delete__ (code 127) or, if shifted, __Backspace__ (code 8) - which can be reversed with the appropriate DEC private mode escape sequence. __deletekey:__ ''string'' The string to send when the delete key (not the keypad delete key) is pressed. If unset it will send the sequence traditionally associated with the __Execute__ key. __cutchars:__ ''string'' The characters used as delimiters for double-click word selection. The built-in default:__ BACKSLASH ` __preeditType:__ ''style'' __!OverTheSpot__, __!OffTheSpot__, __Root__; option __-pt__. __inputMethod:__ ''name'' ''name'' of inputMethod to use; option __-im__. __modifier:__ ''modifier'' Set the key to be interpreted as the Meta key to: __alt__, __meta__, __hyper__, __super__, __mod1__, __mod2__, __mod3__, __mod4__, __mod5__; option __-mod__. __keysym.__''sym'': ''string'' Associate ''string'' with keysym ''sym'' (__0xFF00 - 0xFFFF__). It may contain escape values (a: bell, b: backspace, e, E: escape, n: newline, r: return, t: tab, 000: octal number) or control characters (^?: delete, ^@: null, ^A ...) and may enclosed with double quotes so that it can start or end with whitespace. The intervening resource name __keysym.__ cannot be omitted. This resource is only available when compiled with KEYSYM_RESOURCE. !!THE SCROLLBAR Lines of text that scroll off the top of the __rxvt__ window (resource: __saveLines__) and can be scrolled back using the scrollbar or by keystrokes. The normal __rxvt__ scrollbar has arrows and its behaviour is fairly intuitive. The __xterm-scrollbar__ is without arrows and its behaviour mimics that of ''xterm'' Scroll down with __Button1__ (__xterm-scrollbar__) or __Shift-Next__. Scroll up with __Button3__ (__xterm-scrollbar__) or __Shift-Prior__. Continuous scroll with __Button2__. !!MOUSE REPORTING To temporarily override mouse reporting, for either the scrollbar or the normal text selection/insertion, hold either the Shift or the Meta (Alt) key while performing the desired mouse action. If mouse reporting mode is active, the normal scrollbar actions are disabled -- on the assumption that we are using a fullscreen application. Instead, pressing Button1 and Button3 sends __ESC[[6~__ (Next) and __ESC[[5~__ (Prior), respectively. Similarly, clicking on the up and down arrows sends __ESC[[A__ (Up) and __ESC[[B__ (Down), respectively. !!TEXT SELECTION AND INSERTION The behaviour of text selection and insertion mechanism is similar to xterm(1). __Selection__: Left click at the beginning of the region, drag to the end of the region and release; Right click to extend the marked region; Left double-click to select a word; Left triple-click to select the entire line. __Insertion__: Pressing and releasing the Middle mouse button (or __Shift-Insert__) in an __rxvt__ window causes the current text selection to be inserted as if it had been typed on the keyboard. !!CHANGING FONTS You can change fonts on-the-fly, which is to say cycle through the default font and others of various sizes, by using __Shift-KP_Add__ and __Shift-KP_Subtract__. Or, alternatively (if enabled) with __Alt-__ and __Alt-__, where the actual key can be selected using resources __smallfont_key__/__bigfont_key__. !!LOGIN STAMP __rxvt__ tries to write an entry into the utmp(5) file so that it can be seen via the ''who(1)'' command, and can accept messages. To allow this feature, __rxvt__ must be installed setuid root on some systems. !!COLORS AND GRAPHICS If graphics support was enabled at compile-time, __rxvt__ can be queried with ANSI escape sequences and can address individual pixels instead of text characters. Note the graphics support is still considered beta code. In addition to the default foreground and background colours, __rxvt__ can display up to 16 colours (8 ANSI colours plus high-intensity bold/blink versions of the same). Here is a list of the colours with their __rgb.txt__ names. It is also possible to specify the colour values of __foreground__, __background__, __cursorColor__, __cursorColor2__, __colorBD__, __colorUL__ as a number 0-15, as a convenient shorthand to reference the colour name of color0-color15. Note that __-rv__ (__``reverseVideo: True''__) simulates reverse video by always swapping the foreground/background colours. This is in contrast to xterm(1) where the colours are only swapped if they have not otherwise been specified. For example, __rxvt -fg Black -bg White -rv__ would yield White on Black, while on xterm(1) it would yield Black on White. !!ENVIRONMENT __rxvt__ sets the environment variables __TERM__, __COLORTERM__ and __COLORFGBG__. The environment variable __WINDOWID__ is set to the X window id number of the __rxvt__ window and it also uses and sets the environment variable __DISPLAY__ to specify which display terminal to use. __rxvt__ uses the environment variables __RXVTPATH__ and __PATH__ to find XPM files. !!FILES __/etc/utmp__ System file for login records. __/usr/lib/X11/rgb.txt__ Color names. !!DEBIAN NOTES The standard Debian __rxvt__ package provides two versions of the __rxvt__ binary: __rxvt-xterm__ This version is compiled with no XPM support. It has been configured to be a smaller, more efficient xterm substitute. __rxvt-xpm__ This version is compiled with XPM and menu support. !!SEE ALSO xterm(1), sh(1), resize(1), ''X''(1), pty(4), tty(4), utmp(5) See rxvtRef.html rxvtRef.txt for detailed information on recognized escape sequences and menuBar syntax, etc. !!BUGS Check the BUGS file for an up-to-date list. Cursor change support is not yet implemented. Click-and-drag doesn't work with X11 mouse report overriding. Graphics support is fairly crude. !!FTP LOCATION rxvt-2.6.4.tar.gz can be found at the following ftp sites ftp://ftp.rxvt.org/pub/rxvt !!CURRENT PROJECT COORDINATOR Project Coordinator Geoff Wing Web page maintainter Oezguer Kesim Mailing list The Rxvt Workers !!AUTHORS John Bovey University of Kent, 1992, wrote the original Xvt. Rob Nation very heavily modified Xvt and came up with Rxvt Angelo Haritsis wrote the Greek Keyboard Input mj olesen Wrote the menu system. Project Coordinator (changes.txt 2.11 to 2.21) Oezguer Kesim Project Coordinator (changes.txt 2.21a to 2.4.5) Geoff Wing Rewrote screen display and text selection routines. Project Coordinator (changes.txt 2.4.6 - ) ----
One page links to
rxvt-xterm(1)
:
Man1r
This page is a man page (or other imported legacy content). We are unable to automatically determine the license status of this page.
