Seth Woolley's Man Viewer

Manual for rxvt - man rxvt

([section] manual, -k keyword, -K [section] search, -f whatis)
man plain no title

RXVT(1)                             X Tools                            RXVT(1)



NAME
       rxvt(ouR XVT) [rxvt] (1,ouR XVT) [urxvtc] (1,ouR XVT) [urxvtd] (1,ouR XVT) [wterm] (1) (ouR XVT) - a VT102 emulator for the X window system


SYNOPSIS
       rxvt(ouR XVT) [rxvt] (1,ouR XVT) [urxvtc] (1,ouR XVT) [urxvtd] (1,ouR XVT) [wterm] (1) [options] [-e command [ args ]]


DESCRIPTION
       rxvt(ouR XVT) [rxvt] (1,ouR XVT) [urxvtc] (1,ouR XVT) [urxvtd] (1,ouR XVT) [wterm] (1),  version(1,3,5)  2.7.10, is a colour vt102 terminal emulator intended as
       an xterm(1) replacement for users(1,5) who do not require features  such  as
       Tektronix  4014  emulation  and  toolkit-style  configurability.   As a
       result, rxvt(ouR XVT) [rxvt] (1,ouR XVT) [urxvtc] (1,ouR XVT) [urxvtd] (1,ouR XVT) [wterm] (1) uses much less(1,3) swap space -- a significant advantage on  a
       machine serving many X sessions.



OPTIONS
       The  rxvt(ouR XVT) [rxvt] (1,ouR XVT) [urxvtc] (1,ouR XVT) [urxvtd] (1,ouR XVT) [wterm] (1)  options  (mostly  a subset of xterm´s) are listed below.  In
       keeping with the smaller-is-better philosophy, options  may  be  elimi-
       nated or default values chosen at compile-time, so options and defaults
       listed may not accurately reflect the version(1,3,5) installed on your system.
       `rxvt(ouR XVT) [rxvt] (1,ouR XVT) [urxvtc] (1,ouR XVT) [urxvtd] (1,ouR XVT) [wterm] (1)  -h´  gives  a  list of major compile-time options on the Options
       line.  Option descriptions may be prefixed with  which  compile  option
       each  is  dependent  upon.   e.g.  `Compile  XIM:´  requires XIM on the
       Options line.  Note: `rxvt(ouR XVT) [rxvt] (1,ouR XVT) [urxvtc] (1,ouR XVT) [urxvtd] (1,ouR XVT) [wterm] (1) -help´ gives  a  list  of  all  command-line
       options compiled into your version.

       Note  that  rxvt(ouR XVT) [rxvt] (1,ouR XVT) [urxvtc] (1,ouR XVT) [urxvtd] (1,ouR XVT) [wterm] (1)  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(ouR XVT) [rxvt] (1,ouR XVT) [urxvtc] (1,ouR XVT) [urxvtd] (1,ouR XVT) [wterm] (1) --loginShell --color1 Orange´.

       Also  note that if(3,n) you do not explictly specify a font (-fn and -fm) or
       a multichar encoding(3,n) method (-km), rxvt(ouR XVT) [rxvt] (1,ouR XVT) [urxvtc] (1,ouR XVT) [urxvtd] (1,ouR XVT) [wterm] (1) will  select(2,7,2 select_tut)  a  font  for  the
       preferable encoding(3,n) according to your locale.  Supported encodings are:
       ISO-8859-n (n=1...15), KOI8-R, KOI8-U, EUC-JP, Shift_JIS, EUC-KR,  EUC-
       CN (aka GB), and Big5.

       The following options are available:


       -help, --help
              Print out a message describing available options.

       -display displayname
              Attempt  to  open(2,3,n)  a  window  on  the  named(5,8) X display (-d still
              respected).  In the absence of this option, the  display  speci-
              fied 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.

       -j|+j  Turn on/off jump scrolling; resource jumpScroll.

       -ip|+ip(7,8)
              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(1,n)[;geom]
              Compile XPM: Specify  XPM  file(1,n)  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(1,8) 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
              Compile multichar_languages: Multiple-character font-set  encod-
              ing(3,n)  mode;  eucj: EUC Japanese encoding.  sjis: Shift JIS encod-
              ing.  big5: BIG5 encoding.  gb: GB  encoding.   kr:  EUC  Korean
              encoding.  noenc: no encoding(3,n); resource multichar_encoding.

       -grk mode
              Compile  Greek:  Greek  keyboard translation; iso: ISO-8859 map-
              ping.  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(1,n) 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 scrollTtyKey-
              press.

       -sw|+sw
              Turn  on/off  scrolling  with the scrollback buffer as new lines
              appear.  This only takes effect if(3,n) -si is also  given;  resource
              scrollWithBuffer.

       -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.

       -mcc|+mcc
              Compile multichar_languages: treat multibyte  glyphs  as  single
              character  for  backspace,  delete  and  cursor  movement  keys;
              resource multibyte_cursor.

       -iconic
              Start iconified, if(3,n) the window  manager  supports  that  option.
              Alternative form is -ic.

       -sl number
              Save  number lines in(1,8) the scrollback buffer.  See resource entry
              for limits; resource saveLines.

       -b number
              Compile frills: Internal border of number pixels.  See  resource
              entry for limits; resource internalBorder.

       -w number
              Compile frills: External border of number pixels.  Also, -bw and
              -borderwidth.  See resource entry for limits; resource external-
              Border.

       -lsp number
              Compile  linespace:  Lines (pixel height) to insert between each
              row of the display; resource linespace.

       -tn termname
              This option specifies the name of the terminal type to be set(7,n,1 builtins) in(1,8)
              the  TERM environment variable. This terminal type must exist in(1,8)
              the termcap(5) database and should have  li#  and  co#  entries;
              resource termName.

       -e command [arguments]
              Run the command with its command-line arguments in(1,8) the rxvt(ouR XVT) [rxvt] (1,ouR XVT) [urxvtc] (1,ouR XVT) [urxvtd] (1,ouR XVT) [wterm] (1) win-
              dow; also sets the window title and icon name to be the basename(1,3,3 File::Basename)
              of  the program being executed if(3,n) 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(1,3,3 File::Basename) of the program specified after the -e option,  if(3,n)  any,
              otherwise the application name; resource title.

       -n text
              Icon name; the default name is the basename(1,3,3 File::Basename) of the program spec-
              ified after the -e option, if(3,n)  any,  otherwise  the  application
              name; resource iconName.

       -C     Capture system console(4,n) messages.

       -pt style
              Compile XIM: input style for input method; OverTheSpot, OffTheS-
              pot, 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 modi-
              fier.

       -xrm resourcestring
              No effect on rxvt.  Simply passes through an argument to be made
              available  in(1,8)  the instance´s argument list.  Appears in(1,8) WM_COM-
              MAND in(1,8) some window managers.

RESOURCES (available also as long-options)
       Note: `rxvt(ouR XVT) [rxvt] (1,ouR XVT) [urxvtc] (1,ouR XVT) [urxvtd] (1,ouR XVT) [wterm] (1) --help´ gives a list of all resources (long  options)  com-
       piled  into your version.  If compiled with internal Xresources support
       (i.e. rxvt(ouR XVT) [rxvt] (1,ouR XVT) [urxvtc] (1,ouR XVT) [urxvtd] (1,ouR XVT) [wterm] (1) -h lists .Xdefaults) then rxvt(ouR XVT) [rxvt] (1,ouR XVT) [urxvtc] (1,ouR XVT) [urxvtd] (1,ouR XVT) [wterm] (1) accepts application  defaults
       set(7,n,1 builtins)     in(1,8)     XAPPLOADDIR/Rxvt    (compile-time    defined:    usually
       /usr/lib/X11/app-defaults/Rxvt) and resources set(7,n,1 builtins) in(1,8)  ~/.Xdefaults,  or
       ~/.Xresources if(3,n) ~/.Xdefaults does not exist.  Note that when reading X
       resources, rxvt(ouR XVT) [rxvt] (1,ouR XVT) [urxvtc] (1,ouR XVT) [urxvtd] (1,ouR XVT) [wterm] (1) recognizes two class names: XTerm and Rxvt.  The  class
       name  XTerm allows resources common to both rxvt(ouR XVT) [rxvt] (1,ouR XVT) [urxvtc] (1,ouR XVT) [urxvtd] (1,ouR XVT) [wterm] (1) and xterm to be easily
       configured, while the class name Rxvt allows resources unique to  rxvt(ouR XVT) [rxvt] (1,ouR XVT) [urxvtc] (1,ouR XVT) [urxvtd] (1,ouR XVT) [wterm] (1),
       notably  colours  and key-handling, to be shared between different rxvt(ouR XVT) [rxvt] (1,ouR XVT) [urxvtc] (1,ouR XVT) [urxvtd] (1,ouR XVT) [wterm] (1)
       configurations.  If no resources are specified, suitable defaults  will
       be  used.  Command-line arguments can be used to override resource set-
       tings.  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.

       colorn: colour
              Use  the specified colour for the colour value n, where 0-7 cor-
              responds 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(1,8) the COL-
              ORS 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.

       colorRV: colour
              Use  the  specified  colour  as the background for reverse video
              characters.

       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  sp