mrxvt.1

multi-tabed terminal based on rxvt

.\" {{{1 Macros
.
.
.de Vb \" Begin verbatim text (stolen from man files generated by pod2man)
. Bd -literal -offset 4n
..
.de Ve \" End verbatim text
. Ed
. Pp
..
.\" Boolean options
.de BO
.It Fl \\$1 Ns | Ns Cm +\\$1
..
.\" Resource list
.de RL
. It Cm \\$1
. Ar \\$2
..
.
.
.\" {{{1 manpage header
.
.
.Dd January 10, 2006
.Os X "Version 11"
.Dt mrxvt 1
.
.
.Sh NAME \"{{{1
.
.
.Nm mrxvt
.Nd A tabbed VT102 terminal emulator for X Window System
.
.
.Sh SYNOPSIS \"{{{1
.
.
.Nm
.Op options
.Op Fl e Ar cmd
.
.
.Sh DESCRIPTION \"{{{1
.
.
.Bd -filled
The
.Nm
program is a terminal emulator for X Window System. It provides
.Tn DEC VT102
compatible terminals for programs that cannot use the window system directly.
.Pp
.Nm
is based on
.Xr rxvt 1
version 2.7.11 CVS, and features most of functionality
of rxvt, with a few major enhancements (namely multiple tabs, and transparency). Like rxvt,
.Nm
aims to be light, fast, flexible and desktop independent, thus KDE or GNOME are not required.
.Pp
The primary features of
.Nm
include (but are not limited to) multiple tabs, dynamically changeable tab titles, customizable command for each tab, input broadcasting, true translucent window, fast pseudo transparency with tinting, user supplied background images (XPM, JPEG, PNG), off-focus fading, text shadow, multiple style (NeXT, Rxvt, Xterm, SGI, Plain) scrollbars, XIM, multi-language support (Chinese, Korean, Japanese), freetype font, logging and (in-)activity monitoring.
.Pp
.
The default
.Nm
behaviour can be set using the resource configuration file
.Pa ~/.mrxvtrc .
For backward compatibility, if
.Pa ~/.mrxvtrc
is not found,
.Nm
tries to load configuration settings from the files
.Pa ~/.Xdefaults
or
.Pa ~/.Xresources .
Alternately, you can specify which config file to load using the
.Fl cf
command line option.
.Ed
.
.
.Sh OPTIONS \"{{{1
.
.
.Bd -filled
This section describes the commandline options
.Nm
accepts. To disable an option, prefix it with an
.Sq Em +
instead of a
.Sq Em -
Most options can be set from your
.Pa ~/.mrxvtrc
file using the option name listed in brackets as
.Op Cm option_name .
The option name can also be used as a "long option" from the command line (i.e. by prefixing it with 
.Sq Em --
or
.Sq Em ++
as appropriate. For example
.Vb
mrxvt -tr -shade 85 +trt
.Ve
is the same as
.Vb
mrxvt --transparent --shading 85 ++transparentTabbar
.Ve
which is the same as putting the lines
.Vb
Mrxvt.transparent:		True
Mrxvt.shading:			85
Mrxvt.transparentTabbar:	False
.Ve
in your
.Pa ~/.mrxvtrc .
.Pp
.
All options are case sensitive. Some options are similar to those of other terminals, so if you find the explanation given here insufficient, we strongly recommend you look in the
.Xr rxvt 1
and
.Xr xterm 1
manpages.
.Ed
.\" {{{2 terminal name and display options
.Ss Terminal name and display options
.Bd -filled
.Bl -tag -width 4n
.
.It Fl display Ns | Ns Fl d Ar displayname
X display name, the X server to contact
.
.It Fl geometry Ns | Ns Fl g Ar geometry
geometry at startup
.Op Cm geometry
.
.It Fl ic Ar file Ns Op Ns ; Ns Ar geometry
application icon file.
.Op appIcon
.
.BO iconic
start iconic
.Op Cm iconic
.
.It Fl in Ar name
Icon name for window
.Op Cm iconName
.
.It Fl into Ar WinID
If given an X window identifier,
.Nm
will reparent its top-level shell widget to that window.
This is used to embed
.Nm
within other applications.
.
.It Fl name Ar name
Client instance, icon, and title strings
.Op Cm clientName .
.
.It Fl title Ar string
title name of the window
.Op Cm title
.
.It Fl tn Ar termname
The type of terminal
.Nm
should emulate. The value of the TERM environment variable is set to this value for all child processes launched by
.Nm .
Note that rxvt and most rxvt clones including 
.Nm Ns ,
have slightly different terminal capabilities than those of xterm(1). Thus
.Nm
will not always work properly with the terminal set to
.Ar xterm ,
and we recommend setting this value to
.Ar rxvt
instead. However some systems have incorrect (or even missing) terminfo(1) or termcap(1) entries for the terminal
.Ar rxvt .
If you experience problems with this, the ideal solution would be to correct your systems termcap and terminfo entries. If you are unable to do that, then you can try setting your terminal to
.Ar xterm
and hope everything works properly.
.Op Cm termName
.
.El
.Ed
.\" {{{2 transparency
.Ss Transparency related options
.Bd -filled
.Bl -tag -width 4n
.
.It Fl o Ar %d
Translucent window (true transparent) background opacity degree.
.Ar %d
is an integer between 0 and 100. This option needs translucent support by the X server, e.g., Xorg 6.8, and overrides the pseudo-transparency.
.Op Cm opacity
.
.It Fl od %d
Translucent window opacity degree increase/decrease interval.
.Ar %d
is an integer between 0 and 100
.Op Cm opacityDegree
.
.BO tr
Enable / disable background pseudo-transparency. To use this feature you must set your desktop wallpaper using an Esetroot compatible program ( i.e. a program that publishes the wallpaper using the
.Tn _XROOTPMAP_ID
atom). Some programs that will do this are
.Xr Esetroot 1 ,
.Xr feh 1 ,
.Xr fvwm-root 1
with the
.Sq Cm --retain-pixmap
option, or KDE. Note: To use your precious
.Cm backgroundFade , tinting
or
.Cm shading
options, you MUST set the desktop wallpaper in an Esetroot way.
.Op Cm transparent
.
.BO trf
If you choose NOT to set the background in an Esetroot compatible way, then you can still have transparency using this option. (You must also enable the
.Cm transparent
option). Background changes made by FvwmBacker, xsetbg (xli) or Esetroot compatible programs, will be automatically detected. However changes made by
.Xr xv 1 ,
.Xr xsetroot 1
or other non-Esetroot compatible programs will not be detected. If you're hell bent on non-Esetroot compatible programs to set your background, then do something like
.Vb
xsetroot -solid "#202040" && fvwm-root -d
.Ve
Note: To use your precious
.Cm backgroundFade , tinting
or
.Cm shading
options, you MUST set the desktop wallpaper in an Esetroot way.
.Op Cm transparentForce
.
.BO trm
Enable / disable pseudo-transparent menubar. Pseudo-transparency must be turned on.
.Op Cm transparentMenubar
.
.BO trs
Enable / disable pseudo-transparent scrollbar. Pseudo-transparency must be turned on.
.Op Cm transparentScrollbar
.
.BO trt
Enable / disable pseudo-transparent tabbar. Pseudo-transparency must be turned on.
.Op Cm transparentTabbar
.
.El
.Ed
.\" {{{2 background
.Ss Background image related options
.Bd -filled
.Bl -tag -width 4n
.
.It Fl mbpixmap Ar file Ns Op Ns ; Ns Ar geometry
Menubar background image. Pseudo-transparency must be turned off.
.Op Cm menubarPixmap
.
.It Fl pixmap Ar file Ns Op Ns ; Ns Ar geometry
Background image for all terminals if not set individually. Pseudo-transparency must be turned off.
.Op Cm Pixmap
.
.It Fl sbpixmap Ar file Ns Op Ns ; Ns Ar geometry
Scrollbar background image. Pseudo transparency must be turned off.
.Op Cm scrollbarPixmap
.
.It Fl tbpixmap Ar file Ns Op Ns ; Ns Ar geometry
Tabbar background image. Pseudo transparency must be turned off.
.Op Cm tabbarPixmap
.
.BO tupixmap
Apply tabbar background image to tabs.
.Op Cm tabUsePixmap
.
.El
.Ed
.\" {{{2 scrolling
.Ss Scrolling related options
.Bd -filled
.Bl -tag -width 4n
.
.BO mp
scroll one page when press mouse wheel button
.Op Cm mouseWheelScrollPage
.
.It Fl sa Ar mode
Scrollbar alignment (
.Ar top | bottom )
.Op Cm scrollbarAlign
.
.BO sb
Hide / show scrollbar
.Op Cm scrollBar
.
.It Fl sbt Ar width
Scrollbar thickness/width
.Op Cm scrollbarThickness
.
.BO si
Inhibit scrolling on tty output.
.Op Cm scrollTtyOutputInhibit
.
.BO sk
scroll-on-keypress
.Op Cm scrollTtyKeypress
.
.It Fl sl Ar n
The number of scrolled lines to save (for all tabs) if not set individually. The maximal number of saved lines is 65535.
.Op Cm saveLines
.
.BO sr
Scrollbar on right
.Op Cm scrollbarRight
.
.It Fl ss Ar mode
Scrollbar style.
.Ar mode
should be one of
.Ar plain , xterm , rxvt , next
or
.Ar sgi .
.Op Cm scrollbarStyle
.
.BO st
Draw floating scrollbar (i.e. without a trough).
.Op Cm scrollbarFloating
.
.El
.Ed
.\" {{{2 color
.Ss Color related options
.Bd -filled
.Bl -tag -width 4n
.
.It Fl bg Ar color
Background color
.Op Cm background
.
.It Fl bd Ar color
Border color
.Op Cm borderColor
.
.It Fl bgfade Ar %d
(Obsolete) Make colors
.Ar %d
darker for background image or pseudo-transparent background.
.Ar %d
is an integer between 0 and 100. This is like tinting the background with black. This option is obsolete, and you should use the
.Cm tint
and
.Cm shade
options instead.
.Op Cm backgroundFade
.
.It Fl bgtype Ar type
Transformation type for background pixmap (not implemented yet)
.
.It Fl cr Ar color
color of cursor
.Op Cm cursorColor
.
.It Fl fade Ar %d
Make colors
.Ar %d
darker when mrxvt looses focus.
.Ar %d
is an integer between 0 and 100
.Op Cm fading
.
.It Fl fg Ar color
Foreground color.
.Op Cm foreground
.
.It Fl itabbg Ar color
Background color of inactive tabs and tabbar.
.Op Cm itabBackground
.
.It Fl itabfg Ar color
Foreground color of inactive tabs.
.Op Cm itabForeground
.
.It Fl pr Ar color
color of pointer
.Op Cm pointerColor
.
.It Fl shade Ar %d
Shade background to
.Ar %d
degree when tinting the background.
.Ar %d
is an integer between 0 and 100. You must also define a color using the
.Cm tint
option. When compiled with XRender support, the tabbar, menubar and scroll bar are tinted with their respective background colors for pseudo-transparent terminals.
.Op Cm shading
.
.It Fl tabbg Ar color
background color of active tab.
.Op Cm tabBackground
.
.It Fl tabfg Ar color
Foreground color of tabbar
.Op Cm tabForeground
.
.It Fl tint Ar color
Color tinted on background image or pseudo-transparent background. This works differently depending on the tint type: With XRender (when compiled with --enable-xrender),
.Ar color
is the color you want to tint your background to. The brighter the color, the less transparent it will be (regardless of the shade degree specified by
.Fl shade ) .
For example, if you want your background tinted black, set
.Ar color
to
.Sq #000000 ,
however if you want a white tinted transparent background, set
.Ar color
to some level of grey (e.g.
.Sq #808080 )
but NOT to
.Sq #ffffff .
.Pp
When compiled without XRender support,
.Ar color
works like a color mask. Thus if you want a black tinted background, set
.Ar color
to
.Sq #ffffff .
.Pp
The shade degree (using
.Fl shade )
must be defined as well.
.Op Cm tintColor
.
.It Fl tinttype Ar type
Function applied for background tinting (not implemented yet).
.
.It Fl ts Ar color
color of text shadow
.Op Cm textShadow
.
.It Fl tsm Ar mode
Text shadow mode, specify shadow position of text:
.Ar left | right | top | bottom | topleft | topright | botleft | botright | none .
.Op Cm textShadowMode
.
.It Fl txttype type
Function applied for text drawing (not implemented yet)
.
.It Fl ufbg Ar color
Default background color when the terminal window looses focus.
.Op Cm ufBackground
.
.El
.Ed
.\" {{{2 font
.Ss Font related options
.Bd -filled
.Bl -tag -width 4n
.
.It Fl fb Ar fontname
bold text X11 font name
.Op Cm boldFont
.
.It Fl fm Ar fontname
multichar text X11 font name
.Op Cm mfont
.
.It Fl fn Ar fontname
normal text X11 font name
.Op Cm font
.
.BO xft
Use freetype font instead of X11 font. This option controls all other freetype font related options.
.Op Cm xft
.
.BO xftaa
Enable / disable antialiasing of freetype font. This makes font look much nicer, but significantly slows down the rendering speed. The
.Fl xft
option must be enabled.
.Op Cm xftAntialias
.
.BO xftah
Enable / disable autohint of freetype font. The
.Fl xft
option must be enabled
.Op Cm xftAutoHint
.
.It Fl xftfm Ar fontname
Multichar text freetype font family. The
.Fl xft
option must be enabled
.Op Cm xftmFont
.
.It Fl xftfn Ar fontname
Normal text freetype font family. The
.Fl xft
option must be enabled
.Op Cm xftFont
.
.BO xftga
Enable / disable global advance of freetype font. The
.Fl xft
option must be enabled
.Op Cm xftGlobalAdvance
.
.BO xftht
Enable / disable hinting of freetype font. The
.Fl xft
option must be enabled
.Op Cm xftHinting
.
.It Fl xftmsz Ar size
Freetype multichar font size in pixels. The
.Fl xft
option must be enabled.
.Op Cm xftmSize
.
.BO xftnfm
Do not load freetype mfont, but use freetype font instead. This can avoid a large line space if the size of font and mfont are very different. The