.\" {{{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 loses 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
.Fl xft
option must be enabled
.Op Cm xftNomFont
.
.It Fl xftpfn Ar font
Specify a proportionally spaced font to use for drawing tab-titles. If set, the tab bar behaves like Firefox's tab-bar: All tabs have the same width, and the widths are shrunk / expanded to keep the number of tabs specified by
.Cm minVisibleTabs
visible. The active tab title is drawn in a bold font. (Your colors are still used).
.Op Cm xftPFont
.
.It Fl xftpsz Ar number
Proportional freetype font size in pixels.
.Op Cm xftPSize
.
.It Fl xftrgb Ar style
Freetype font sub-pixel order:
.Ar rgb | bgr | vrgb | vbgr | none .
The
.Fl xft
option must be enabled.
.Op Cm xftRGBA
.
.BO xftslow
Display freetype multichar string in slow mode for better display effect. The xft option must be enabled.
.Op Cm xftSlowOutput
.
.It Fl xftst Ar style
Freetype font slant:
.Ar roman | italic | oblique .
The
.Fl xft
option must be enabled.
.Op Cm xftSlant
.
.It Fl xftsz Ar number
Freetype font size in pixel. The
.Fl xft
option must be enabled
.Op Cm xftSize
.
.It Fl xftbwt Ar style
Freetype bold font weight:
.Ar light | medium | demibold | bold | black .
The
.Fl xft
option must be enabled.
.Op Cm xftBoldWeight
.
.It Fl xftwd Ar style
Freetype font width:
.Ar ultracondensed | condensed | normal | expanded | ultraexpanded .
The
.Fl xft
option must be enabled.
.Op Cm xftWidth
.
.It Fl xftwt Ar style
Freetype font weight:
.Ar light | medium | demibold | bold | black .
The
.Fl xft
option must be enabled.
.Op Cm xftWeight
.
.El
.Ed
.\" {{{2 tabs and commands
.Ss Tabs and command related options
.Bd -filled
.Bl -tag -width 4n
.
.It Fl aht
Automatically hide or show the tab bar depending on the number of tabs. On startup, the tabbar is shown only if there are more than one tabs present. If there is only one tab, and a new one is created, then the tabbar is shown. If there are two tabs and one is closed, then the tabbar is hidden. A keyboard shortcut used at any time to hide / show the tabbar.
.Op Cm autohideTabbar
.BO at
Run command specified with
.Fl e
on all tabs (by default the command specified by
.Fl e
is only used for the first tab opened). This causes the profile option
.Cm command
to be ignored. However a command specified via the
.Cm NewTab
macro is honored.
.Op Cm cmdAllTabs
.
.BO bt
Show tabbar at bottom.
.Op Cm bottomTabbar
.
.It Fl e Op Ar arguments ...
Specifies the program (and its command line arguments) to be run in the
.Nm
window. By default this command is only run initially, and all tabs created after startup will run the default shell (or program supplied by
.Fl profile Ns Ar %d Ns ). This behaviour can be overridden with the
.Fl at
option.
.Op Cm command
.
.BO hb
Hide buttons in the tabbar.
.Op Cm hideButtons
.
.It Fl het Ar string
Message to display in tabs after the child process exits. (This string is escape and percent interpolated).
.Op Cm holdExitText
.
.It Fl heT Ar string
Set the title of tabs to
.Ar string
after the process in the tab exits. (This string is escape and percent interpolated).
.Op Cm holdExitTitle
.
.It Fl hold Ar mask
Hold the tab open after the child process in it exits.
.Ar mask
is the mask of flags which control weather the tab will be held open based on the exit status of the child process. If the lowest bit (0x01) of
.Ar mask
is set, then the tab will always be held open after the child exits. If the next bit (0x02) is set, then the tab will only be held open if the child exits abnormally (e.g. via
.Xr abort 1 ) .
If the third bit (0x04) is set, then the tab will be held open if the child exits with non-zero status.
.Pp
NOTE: In previous versions of
.Nm
this was a boolean option. For backward compatibility, the value of
.Ar True , On, Yes
will be treated as
.Ar 1
and anything illegal will be treated as
.Ar 0 .
The default is 0x06.
.Op Cm holdExit
.
.BO ht
Hide tabbar on initialization
.Op Cm hideTabbar
.
.BO htb
Highlight inactive tabs only when bell sounds. Default is to highlight inactive tabs whenever they produce output.
.Op Cm highlightTabOnBell
.
.It Fl ip Ar profiles
.Ar profiles
is a comma separated list of profiles numbers. On startup
.Nm
opens each of these profiles in a tab.
.Op Cm initProfileList
.
.BO ls
Indicates that the shell that is started in the
.Nm
window will be a login shell (i.e., the first character of argv[0] will be a dash, indicating to the shell that it should read the user's
.Pa .login
or
.Pa .profile).
.Op Cm loginShell
.
.It Fl mtw Ar width
The maximum width (in characters) of the displayed tabs. This can not be larger than 40. If you use Xft, then you might want to use the
.Cm minVisibleTabs
option instead.
.Op Cm maxTabWidth
.
.It Fl mvt Ar n
When using
.Cm xftPFont
to display tabs, keep at least
.Ar n
tabs visible.
.Op Cm minVisibleTabs
.
.It Fl profile Ns Ar N Ns Cm . Ns Ar option Ar value
Set
.Ar option
to
.Ar value
in profile
.Ar N .
When a new tab is created with profile
.Ar N
it uses all options that are set for this profile. Currently the only options that can be set per profile are
.Cm Pixmap , background , command , foreground , saveLines , holdExit , holdExitText , holdExitTitle , tabTitle , titleFormat , winTitleFormat
and
.Cm workingDirectory .
Then all the settings from that profile number are used.
.Pp
.
.Ar N
can be the special number 0 (which stores default settings that apply to all profiles where those settings
are not explicitly overridden, e.g.
.Fl profile0.tt Ar mrxvt
sets the tab title to
.Ar mrxvt
for all profiles where the tab title has not been set - in this case the
.Fl profile0.
can be omitted entirely, i.e.
.Fl profile0.tt
is equivalent to
.Fl tt )
or a number between 0 and the compiled-in maximum (10 on Debian systems), exclusive.
.Pp
This option is intended to replace the
.Fl vt Ns Ar %d Ns Cm .xx
options from
.Nm
version 0.5.0. The old
.Fl vt Ns Ar %d Ns Cm .xx
would set options for the
.Ar %d Ns th
tab. This causes inconsistent behaviour when the user moves / closes tabs. The behaviour of the
.Fl profile
option is to set options for a particular profile, and then these settings can be associated (on demand) to newly created tabs.
.
.Op Cm profile Ns Ar N Ns Cm . Ns Ar option
.
.BO ps
Protect tab from being closed if it is using the secondary screen, for example, when the user is running
.Xr vim 1
or
.Xr mutt 1 ,
this can prevent the terminal from being accidentally closed.
.Op Cm protectSecondary
.
.BO sti
Synchronize icon name with tab title when switch to a new tab or the title of the active tab changes.
.Op Cm syncTabIcon
.
.BO stt
Synchronize terminal title with tab title when switch to a new tab or the title of the active tab changes. (See also the
.Fl wtf
option).
.Op Cm syncTabTitle
.
.It Fl tnum Ar N
OBSOLETE. Opens
.Ar N
tabs on startup. For backward compatibility, the tabs are opened with profile 0, 1, ...
.Ar N Ns -1 .
.Op Cm initTermNumber
.
.It Fl tt Ar string
Title of the tab
.Op Cm tabTitle
.
.It Fl tf Ar format
If set, this controls the displayed title of each tab.
.Ar format
is % interpolated, and the result is displayed as the tab title.
.Pp
.Sy NOTE:
Currently this option requires the tab titles to be drawn with a proportionally spaced font (which is currently only possible with Xft). Also, this option only affects the displayed tab title, and thus
.Ar %t
will still expand to the actual tab title, as set via an escape sequence, or macro. For example, setting this option to
.Sq Ar %n. %t
will cause all the tabs to be numbered.
.Op Cm titleFormat
.
.BO ut
Utmp inhibit.
.Op Cm utmpInhibit
.
.BO vbf
If unset, colored bold text will not be rendered using overstrike / bold font. See also
.Cm boldColors
and
.Cm veryBright .
.Op Cm veryBoldFont
.
.It Fl wd
Working directory of the child process. If non-empty, then the child process is started in this directory. If set to
.Sq \&.
then the child process is run in the working directory of the current tab if possible. On Linux, this is the default. (NOTE: It is not always possible to find the working directory of the current tab. This works fine on Linux, but causes problems on other systems [e.g. OpenBSD], which is why it is only enabled by default on Linux).
.Op Cm workingDirectory
.
.It Fl wtf Ar format
Controls the format of the window title. If set, and the option
.Fl stt
is used, then the window title is set to
.Ar format
(after % interpolation), instead of the tab title.
.Op Cm winTitleFormat
.El
.Ed
.\" {{{2 multichar stuff
.Ss Multichar and multi-language support
.Bd -filled
.Bl -tag -width 4n
.
.BO mcc
Multichar cursor movement
.Op Cm multibyte_cursor
.
.It Fl km Ar mode
multichar encoding mode
.Op Cm multichar_encoding
.
.It Fl im Ar name
name of X Input Method (XIM)
.Op Cm inputMethod
.
.It Fl pt Ar mode
XIM input style:
.Ar OverTheSpot Ns | Ns Ar OffTheSpot Ns | Ns Ar Root
.Op Cm preeditType
.
.BO thai
Thai support
.Op Cm thai
.
.It Fl grk Ar mode
Greek keyboard mapping:
.Ar iso Ns | Ns Ar ibm
.Op Cm greek_keyboard
.
.El
.Ed
.\" {{{2 menu
.Ss Menu related options
.Bd -filled
.
.Bl -tag -width 4n
.
.It Fl menu Ar filename Ns Op ; Ns Ar tag
Menubar definition file.
.Op Cm menu
.
.BO showmenu
show menubar
.Op Cm showMenu
.
.El
.Ed
.\" {{{2 keyboard / window
.Ss Keyboard and window related options
.Bd -filled
.Bl -tag -width 4n
.
.It Fl b Ar number
internal border width
.Op Cm internalBorder
.
.BO bc
Display a blinking cursor.
.Op Cm cursorBlink
.
.BO bcst
Enable / disable broadcasting input to all terminals
.Op Cm broadcast
.
.It Fl bci Ar number
Cursor blink interval (ms)
.Op Cm cursorBlinkInterval
.
.BO bl
Use a borderless window.
.Op Cm borderLess
.
.It Fl blc Ar cmd
Bell command instead of beeping. If
.Ar cmd
begins with
.Sq \&!
then it is passed to
.Cd /bin/sh -c
for execution. Otherwise it is split into words at spaces or tabs only, and executed via
.Xr execvp 3 .
If you don't want a space or tab to cause word splitting, then precede it with a
.Sq Sy \e .
If you want to pass
.Sq \e\ 
as an argument, double the
.Sq \e .
.Pp
Note: Only backslashes (or chains of backslashes) that precede a space or tab character are treated specially. That is
.Sq \e\ea
will be left untouched, however
.Sq \e\e\ 
will expand to a
.Sq \e
and the
.Sq \ 
will cause a word break, and
.Sq \e\ 
will expand to a
.Sq \ 
which does not cause a word break.
.Op Cm bellCommand
.
.It Fl bw Ns | Ns Fl w Ar number
external border width
.Op Cm externalBorder
.
.BO ctvb
Use a visual bell only for the current tab (i.e. the active tab of a currently focused window).
.Op Cm currentTabVBell
.
.It Fl desktop Ar number
Desktop to place the window (for gnome compatible window manager). The number starts from 0, NOT 1!
.Op Cm desktop
.
.BO dm
Enable / disable all keyboard macros. This functionality can be toggled at runtime via a pop-up menu, or the
.Ic ToggleMacros
keyboard shortcut. NOTE: When keyboard macros are disabled, the
.Ic ToggleMacros
keyboard macro will still work. Thus you can re-enable your keyboard macros via the keyboard using this function.
.Op Cm disableMacros
.
.BO fs
Startup fullscreen. Use in conjunction with
.Op smoothResize
to really make it full screen. Requires an EWMH compatible window manager.
.Op Cm fullscreen
.
.BO lk
Enable Linux console style Home/End keys
.Op Cm linuxHomeEndKey
.It Fl mod Ar mode
Meta modifier:
.Ar alt Ns | Ns Ar meta Ns | Ns Ar hyper Ns | Ns Ar super Ns | Ns Ar mod1 Ns | Ns Ar ... Ns | Ns Ar mod5 .
.Op Cm modifier
.
.It Fl lsp Ar number
Line space between rows
.Op Cm lineSpace
.
.BO m
Start maximized (requires an EWMH compatible window manager).
.Op Cm maximized
.
.BO m8
Enable / disable meta8
.Op Cm meta8
.
.BO nsc
Enable / disable reading the system wide configuration file. Only the default keyboard macros are defined in this file, so this option can effectively disable all default keyboard shortcuts.
.Op Cm noSysConfig
.
.BO or
Override redirect
.Op Cm overrideRedirect
.
.BO pb
.No Pointer blank (see also Cm pointerBlankDelay ) .
.Op Cm pointerBlank
.
.BO rv
reverse video
.Op Cm reverseVideo
.
.BO tcw
Triple click word selection
.Op Cm tripleclickwords
.
.BO vb
Visual bell
.Op Cm visualBell
.
.El
.Ed
.\" {{{2 misc
.Ss Miscellaneous options
.Bd -filled
.Bl -tag -width 4n
.
.It Fl C
Intercept console messages
.
.It Fl dmask Ar namelist
Print out debug message defined by a coma separated name list. Available
names include: command, screen, ptytty, init, main, logging, macros,
menubar, tabbar, scrollbar, images, pixmap, transparent, encoding, 
gkrelot, memory, session, string, resource, xftacs, misc, and all.
.
.It Fl dlevel Ar verboselevel
Print out debug message defined by verboselevel. Available verboselevel
are: fatal, error, warn, info, verbose, and debug. The latter, the more
information is printed
.
.It Fl cf Ar filename
X resource configuration file
.It Fl cfs Ar filename
X resource configuration file to save the current configuration
.Op Cm confFileSave
.
.It Fl path Ar path
Colon delimited list of directories to search for background images and menu files.
.Nm
first searches for the file in the current directory, then in the directories specified by
.Ar path ,
then in the directories specified by the environment variable
.Ev PATH_ENV
and finally tries in the user configuration directory
.Pa ~/.mrxvt
and the (compiled in) system wide configuration directory
.Pa /etc/mrxvt .
.Op Cm path
.
.It Fl sid Ar string
Client identity of mrxvt for X session management
.Op Cm smClientID
.
.BO sm
enable X session management
.Op Cm sessionMgt
.
.El
.Ed
.\" {{{2 resource option list
.Ss Long options
.Bd -filled
.
The following options do not have a
.Dq short
form. If these options are to be used on the command line, they must be prefixed with a
.Sq Em --
(or
.Sq Em ++
for boolean options). They can of course be used in the
.Nm
configuration file.
.
.
.Bl -tag -width 4n
.It Cm answerBackString Ar string
Specify the reply
.Nm
sends to the shell when an ENQ (control-E) character is passed through. It may contain escape values as described in the entry on
.Cm keysym
following.
.
.It Cm backspaceKey Ar 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.
.
.It Cm bgRefreshInterval Ar delay
Specify the delay (ms) to wait before refreshing the background in pseudo-transparency. Generally tinting and refreshing the background is slow (especially with XRender), and causes lags while dragging the window. This delay causes enables the window to be dragged smoothly. If you have a fast system, you can reduce or disable this (by setting it to 0). The default value is 100ms.
.
.It Cm boldFont Ns Ar N Ar font
Specifies bold font to use along with fontset
.Ar N .
.
.It Cm boldColors Ar True Ns | Ns Ar False
If false, the bold primary colors (0 -- 7) will be rendered using the brighter analogues (8--15) in a regular font. If true a bold font will be used. See also
.Cm veryBright .
.
.It Cm color Ns Ar N Ar color
Use the specified colour for the colour value
.Ar N ,
where 0-7 corresponds to low-intensity (normal) colours and 8-15 corresponds to high-intensity colours.
.It Cm colorBD Ar color
Color to use to display bold text. If unspecified, the text will be displayed using a bold font / overstrike.
.
.It Cm colorRV Ar color
Color to use to display reverse video text. If unspecified, the text will be displayed as reverse video.
.
.It Cm colorUL Ar color
Color to use to display underlined text. If unspecified, the text will be displayed as underlined.
.
.It Cm cursorColor2 Ar color
Second color of cursor.
.
.It Cm cutChars Ar string
String containing all characters to be treated as one word for double click selection. If you want double clicks to select URL's, then set this to a string containing all letters (both upper and lower case), digits and punctuation you find in urls.
.
.It Cm deleteKey Ar 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
.Sy Execute
key.
.
.It Cm focusDelay Ar msec
The time interval (in mili-seconds) to wait after getting / losing focus, before fading the colors and changing the background color as specified by the
.Fl fade
and
.Fl ufbg
options. Set it to 0 if you want your colors faded immediately on focus change events.
.Pp
This option is there mainly to work around a bug in some window managers which send focus in immediately followed by focus out events when moving windows, or pressing Alt+Tab (e.g. fvwm-2.5.16).
.
.It Cm font Ns Ar N Ar font
Specify the alternative font
.Ar n . n No can be 1, 2, 3, 4 or 5.
.
.It Cm greektoggle_key Ar keysym
Key to toggle into greek keyboard mapping. See
.Pa README.greek
for details.
.
.It Cm highlightColor Ar color
Color to use for selection. If not specified, reverse video is used. (Note blinking text is also displayed with this color).
.
.It Cm mapAlert Ar True Ns | Ns Ar False
If true, de-iconifies the window when a bell is received.
.
.It Cm mfont Ns Ar n font
Specify alternative multiple character font
.Ar n .
.
.It Cm pointerBlankDelay Ar delay
Delay (ms) to blank pointer after.
.
.It Cm printPipe Ar cmd
Specify a command pipe for vt100 printer.
.
.It Cm refreshLimit Ar N
This option and
.Cm skipPages
are to be used to replace the
.Sq jump scroll
behaviour of other terminal emulators (and previous version of
.Nm ) .
Generally when data is available from a tab,
.Nm
reads as much of it as is available (up to our buffer size), and process it. After we are done processing it (generally takes a fraction of a mili-second), we look for more data from the tab. If we obtain not more than
.Ar N
characters, then we request a screen refresh (which takes a while, especially if you use Xft with anti aliasing). If we obtain more than
.Ar N
characters from the tab, then we delay the screen refresh until the tab eventually has either
.Ar N
or fewer characters of output, or the tab has (cumulatively) produced at least
.Cm skipPages
of data.
.Pp
The default value is 0. On new fast machines, this is probably the best. If you find screen refreshes laggy on on slow older machines, then increase this value a little (say to 10). Setting it to something enormous (say BUFSIZ) will cause
.Nm
to request screen refreshes every time the active tab has data, and effectively disable the so called
.Sq jump scrolling .
.
.It Cm scrollColor Ar color
Color of scrollbar (see also
.Cm troughColor ) .
.
.It Cm selectStyle Ar mode
Set mouse selection style to
.Cm old
which is 2.20,
.Cm oldword
which is xterm style with 2.20 old word selection, or anything else which gives xterm style selection.
.
.It Cm skipPages Ar N
This option and
.Cm refreshLimit
are to be used to replace the
.Sq jump scroll
behaviour of other terminal emulators (and previous version of
.Nm ) .
If the screen refresh is delayed because of the
.Cm refreshLimit
option, then
.Nm
will refresh the screen every
.Ar N
pages of output. The default is 25. If you set it to a very large value (say INT_MAX), then
.Nm
will refresh the screen only after the tab has stopped
.Sq flat out
scrolling.
.
.It Cm smartResize Ar True Ns | Ns Ar False
Enable / disable smart resize. When the tabbar is shown, or font size is increased, the resize terminal window could be partially off screen. If
.Cm smartResize No is enabled, then Nm No tries to move the terminal window to stay on  screen.
.
.It Cm smoothResize Ar True Ns | Ns Ar False
.No Enable / disable smooth resize. If enabled, then the Nm No window is resized in pixel increments (instead of character increments). This is useful if you want a full screen / maximized Nm No window that covers the entire screen (without leaving an annoying few pixel wide strip uncovered).
.
.It Cm troughColor
Color of scrollbar trough (see also
.Cm scrollColor ) .
.
.It Cm useFifo Ar True Ns | Ns Ar False
If enabled, then mrxvt will create a
.Xr fifo 7 Pa /tmp/.mrxvt-%pid
and listen for macros on it. To execute macros, just write them to this fifo. For example
.Vb
/bin/echo \-e "NewTab\enRaise" >> /tmp/.mrxvt-%pid
.Ve
creates a new tab and raises the
.Nm
window with process ID
.Em %pid .
.Sy NOTE:
The meaning and syntax of this option might change in future versions.
.
.It Cm vBellDuration Ar ms
Amount of time (in milliseconds) to flash the screen if using a visual bell.
.
.It Cm monitorTimeout Ar ms
Amount of time (in milliseconds) to detect the type of monitoring type or tab-inactivity.
Default value is 2000 ms this causes that mrxvt is waiting 2 seconds after invoking the 
.Ic MonitorTab
macro with argument "AUTO" or "INACTIVITY" to determine if or what type a notification is 
needed. The detection of "ACTIVITY" does not make use of the configuration value.
.
.It Cm monitorCommand Ar command
Specifies a command which will be executed if a activity or inactivity event is raised
by the
.Ic MonitorTab
macro. (This string is escape and percent interpolated)
.
.It Cm veryBright Ar True Ns | Ns Ar False
If true, and if
.Cm boldColors
is false, then bold primary colors are rendered as bright colors with a bold font (this was the default behaviour in 0.5.2 and earlier versions).
.
.El
.Ed
.\"}}}
.
.
.Sh CONFIGURATION FILE SYNTAX \"{{{1
.Bd -filled
.
.
A line in the config file generally looks like this
.Vb
ClassName.OptionName:	Value
.Ve
Blank lines, and lines beginning with
.Sq Em #
are ignored (comments).
.Pp
.
The ClassName is the name specified via the
.Fl name
option (by default
.Sq Em mrxvt ) .
When
.Nm
starts up, it ONLY reads options with ClassName
.Sq Em Mrxvt ,
.Sq Em XTerm ,
or the class specified via the
.Fl name
option. See
.Pa /etc/mrxvt/mrxvtrc.sample
for how this feature can be used.
.Pp
.
The OptionName is the long name of the option you want to set. It can be any long option (listed under the
.Sx "Long Options"
sub section), or is specified in brackets as
.Op Cm option_name
alongside regular options in this man page. Finally Value is the value of this option.
.Pp
.Ed
.\" {{{2 Example
.Ss Example
.Bd -filled
The following is an example
.Pa ~/.mrxvtrc
file, or in a configuration file you will load with 
.Fl cf
option at startup. You can consult the
.Pa doc/mrxvtrc.sample
in the directory for more details.
.Vb
Mrxvt.profile0.tabTitle:        term1
Mrxvt.profile1.tabTitle:        term2
Mrxvt.profile2.tabTitle:        term3
Mrxvt.profile0.saveLines:       600
Mrxvt.profile1.saveLines:       600
Mrxvt.profile2.saveLines:       600
# Mrxvt.profile0.Pixmap:        /home/images/vt0bg.xpm
# Mrxvt.profile1.Pixmap:        /home/images/vt1bg.xpm
# Mrxvt.profile2.Pixmap:        /home/images/vt2bg.xpm
Mrxvt.scrollbarStyle:           next
Mrxvt.initTermNumber:           3
Mrxvt.transparent:              True
Mrxvt.transparentScrollbar:     True
Mrxvt.transparentTabbar:        False
Mrxvt.transparentMenubar:       False
Mrxvt.tintColor:                #ffffff
Mrxvt.shading:                  85
Mrxvt.foreground:               white
Mrxvt.background:               black
.Ve
.Ed
.\"}}}
.
.
.Sh MENUS \"{{{1
.
.
.Bd -filled
The menu system is similar to rxvt's menus (see the included file
.Pa rxvtRef.txt )
with a few enhancements, and a few notable exceptions:
.Bl -dash -width 2
.It
The menus can use a proportionally spaced font under Xft (
.Fl xftpfn )
which is significantly less ugly than a mono-spaced font.
.It
.Nm
supports pop-up menus. If you create a menu named
.Ic PopupButton Ns Ar N No (where Ar N No is 1, 2, or 3) then that menu is popped up when you control click (with the appropriate mouse button) on the terminal window. Additionally if you right click on the Tab bar, then the menu Ic PopupButton1 No is popped up.
.It
To create a menu containing a list of all open tabs, create an empty menu called
.Ic PopupButton Ns Ar N
(which will be popped on control click's as described above). To include a list of all open tabs as a sub menu, create a sub-menu called
.Sq Switch to tab .
.It
Menu actions are completely different in
.Nm
than the original implementation in
.Xr rxvt 1 .
The menu actions are exactly the same as macro actions, and are described in the section
.Sx "Defining custom shortcuts" .
.It
On startup
.Nm
reads the file
.Pa default.menu
which contains the default menu definitions. The file is searched for in your search path (specified by option
.Fl path ) .
.El
.Ed
.
.
.Sh KEYBOARD AND MOUSE SHORTCUTS \"{{{1
.
.
.Bd -filled
You have several default keyboard shortcuts to ease the use of mrxvt. The default gnome-terminal, Konsole, rxvt shortcuts are predefined for you. You can also define your own shortcuts as described in
.Sx "Defining custom shortcuts" .
.Ed
.Ss "Default keyboard shortcuts" \"{{{2
.Bd -filled
The following key combinations are defined by default. These are defined in the system configuration file
.Pa /etc/mrxvt/mrxvtrc ,
and can be disabled using the option
.Fl nsc .
See the next section for instructions on defining your own custom keyboard shortcuts.
.Pp
.Em Gnome-terminal style shortcuts:
.Bl -tag -width 18n -compact -offset 4n
.It Ctrl+Shift+t
create a new tab
.It Ctrl+Shift+q
Close all tabs and exit
.It Ctrl+Shift+w
Close active tab, and do not hold it open if it exits abnormally.
.It Ctrl+PgUp
activate left tab
.It Ctrl+PgDn
activate right tab
.It Meta+1
activate 1st tab
.It ...
.It Meta+0
activate 10th tab
.It Ctrl+equal
increase font size (next font)
.It Ctrl+Shift+plus
increase font size by 2
.It Ctrl+minus
decrease font size (previous font)
.It Ctrl+Shift+underscore
decrease font size by 2
.El
.Pp
.
.Em Konsole style default shortcuts:
.
.Bl -tag -width 18n -compact -offset 4n
.It Ctrl+Shift+Left
move active tab to left
.It Ctrl+Shift+Right:
active tab to right
.It Shift+Left
Activate left tab (Primary only)
.It Shift+Right
Activate right tab (Primary only)
.It Ctrl+Shift+n
Create a new tab with the same profile as the current tab.
.El
.Pp
.
.Em Vi style default shortcuts:
.
.Bl -tag -width 18n -compact -offset 4n
.It Ctrl+Shift+h
activate left tab
.It Ctrl+Shift+l
activate right tab
.El
.Pp
.
.Em Screen style default shortcuts:
.
.Bl -tag -width 18n -compact -offset 4n
.It Ctrl+Shift+p
activate previous active tab
.El
.Pp
.
.Em Mrxvt default shortcuts:
.
.Bl -tag -width 18n -compact -offset 4n
.It Ctrl+Shift+1
Move tab to 1st position
.It ...
.It Ctrl+Shift+0
Move tab to 10th position
.It Ctrl+Tab
activate previous active tab
.It Ctrl+Shift+less_than
Move active tab left
.It Ctrl+Shift+greater_than
Move active tab right
.
.It Ctrl+Shift+o
Change opacity of terminal to make it more transparent.
.It Ctrl+Shift+u
Change opacity of terminal to make it less transparent.
.It Ctrl+Shift+j
Change shading of terminal to make it more transparent.
.It Ctrl+Shift+k
Change shading of terminal to make it less transparent.
.It Ctrl+Shift+r
Toggle pseudo-transparency
.
.It Ctrl+Shift+i
Hide/show tabbar
.It Ctrl+Shift+s
Hide/show scrollbar
.It Ctrl+Shift+m
Hide/show menubar
.It Ctrl+Shift+a
Hide/show tabbar buttons
.
.It Ctrl+Shift+b
Toggle very bold font
.It Ctrl+Shift+z
Open a
.Nm
console in a new tab, and enable the
.Ic useFifo
option if necessary. Anything typed in this console will be executed as a macro. On clean exit the
.Ic useFifo
option will be disabled.
.It Ctrl+Shift+d
Toggle input broadcasting (unbound by default)
.It Ctrl+Shift+e
Toggle holding exited tab
.It Ctrl+Shift+f
Toggle full screen mode
.It Ctrl+Shift+x
Save current configuration
.
.It Shift+Del
Set title of active tab to selection.
.It Shift+Insert
Paste X selection into active tab.
.It Ctrl+Shift+v
Paste X selection into active tab.
.It Ctrl+Shift+c
Paste clipboard into active tab.
.
.It Shift+Up
Scroll up one line (Primary screen only)
.It Shift+Dn
scroll down one line (Primary screen only)
.It Shift+PgUp
scroll up one page (Primary screen only)
.It Shift+PgDn
scroll down one page (Primary screen only)
.It Shift+Home
Scroll to beginning of scroll-back buffer (Primary screen only)
.It Shift+End
Scroll to end of scroll-back buffer (Primary screen only)
.
.It Shift+KeypadPlus
Increase font size
.It Shift+KeypadMinus
Decrease font size
.
.
.It Ctrl+Shift+F1
Open
.Nm
man page in a new tab.
.It Ctrl+Shift+F12
Enable / disable all keyboard macros (except this one of course).
.El
.Ed
.
.Ss "Defining custom shortcuts" \"{{{2
.Bd -filled
NOTE: The 
.Sq hotkey
mechanism used in versions 0.4.2 and earlier is now obsolete. It has been replaced by the
.Sq macro
functionality (described below) as of version 0.5.0.
.Pp
You can define your own keyboard shortcuts in your configuration file by using the following syntax:
.Vb
Mrxvt.macro.[modifiers+]keyname:         action
.Ve
Here
.Sq modifiers
is a
.Sq +
separated list of modifiers
.Sq Em Ctrl ,
.Sq Em Alt ,
.Sq Em Meta ,
.Sq Em Shift .
.Sq Em Primary .
and
.Sq Em Add .
The first four refer to the respective modifier keys.
.Sq Em Primary
tells
.Nm
to make the macro available ONLY when the primary screen is displayed (e.g.
.Sq Em Primary
macros will not be effective when you are running
.Xr vim 1 ,
but will be effective when you are at the shell prompt). Finally
.Sq Em Add
tells
.Nm
to add the macro action to any previous action associated to that particular key. For instance
.Vb
Mrxvt.macro.Primary+Shift+Return:	Esc \eec
Mrxvt.macro.Primary+Add+Shift+Return:	Str ^M
.Ve
will define the macro
.Sq Shift+Return
to first send the escape sequence
.Sq \eec
to
.Nm
(which has the effect of clearing the scroll back buffer) and then send
.Sq Ctrl-M
to the child process, but ONLY in the primary screen. If you're running a shell, then this effectively clears the scroll back buffer and executes the command.
.Pp
.
If the
.Sq Em Add
modifier is not specified, then the macro action replaces any previous action (if any) associated to the specified key. It is an error to add a macro to a non-existing macro. Currently one key can have at most 16 actions associated to it (this might be reduced to 8 in future).
.Pp
.
.Sq keyname
is the name of the key you want to bind to the specified macro. Non alpha numeric keys (e.g. punctuation, or cursor/keypad keys) are specified by using their keyname, which you can find by xev(1), or looking directly in the system header file
.Pa /usr/include/X11/keysymdef.h .
.Pp
.
In case you want to unbind a default keyboard macro, just bind the appropriate key to the function
.Sq Ic Dummy .
For example
.Vb
Mrxvt.macro.Ctrl+Shift+t:	Dummy
.Ve
will disable the default keyboard shortcut
.Sq Ctrl+Shift+t .
If you want to disable all keyboard macros, use the option
.Sq Fl dm
(which can also be accessed via a pop-up menu). The default keyboard macros are defined in the system configuration file
.Pa /etc/mrxvt/mrxvtrc
so if you only want to disable all default shortcuts keys, don't read the system configuration file by using the 
.Fl nsc
option.
.Pp
.
Notice that keyboard shortcuts definitions are incompatible with X Windows own resource parsing API, i.e., XGetDefaults. So, to enable the keyboard shortcuts, you will need to enable resources but disable xgetdefault when you configure
.Nm Ns .
.Pp
Finally
.Sq action
is the action you want bound to the specified macro key. The available actions you can bind to macros are:
.\" {{{3 Available macros list
.Bl -tag -width 4n -offset 4n
.It Ic Dummy
Clear an existing keyboard shortcut
.\" ------------------------------------------------------------
.It Ic Esc Ar str
Send the escape sequence
.Ar str
to
.Nm .
.\" ------------------------------------------------------------
.It Ic Str Ar str
Send the string
.Ar str
to the child process.
.\" ------------------------------------------------------------
.It Ic Exec Ar command
Executes
.Ar command
asynchronously. The command run without any controlling shell or TTY. This is generally used to launch X11 programs (e.g. open the selected text in firefox). If you want a command run in a new tab, see the
.Ic NewTab
macro).
.Pp
The argument
.Ar command
is word split exactly as described in the
.Fl blc
option (thus for instance beginning it with 
.Sq \&!
will pass it to
.Cd /bin/sh -c
for word splitting and execution). However keep in mind that like all macro arguments,
.Ar command
is first
.Sq Sy \e
interpolated. Thus if on the rare occasion you want
.Sq \e\ 
to be part of
.Ar command ,
then you will have to do something like
.Sq \e\e\e\e\e\e\ 
and not
.Sq \e\e\e\ 
as you would with the argument of
.Fl blc .
.\" ------------------------------------------------------------
.It Ic NewTab Oo Ar -N Oc Oo Ar \*qtitle\*q Oc Op Oo ! Oc Ns Ar command
Open a new tab.
.Ar N
specifies the profile number. If omitted, profile 0 is used. If only
.Sq -
(with no number) is specified, then the profile of the current active tab is used (i.e. this can be used to duplicate the current tab).
.Ar title
is specified (needs to be double quoted), use that for the tab title. If
.Ar command
is specified, execute that command in the new tab (instead of the one specified by the resource file, or the shell).
.Pp
.Ar command
is word split as described in the
.Ic Exec
macro. However if command begins with an
.So ! Sc
then run a shell first, and execute the command in the shell as if the user had typed
.Ar command
at the shell prompt. If instead you want
.Ar command
to be passed to
.Cd /bin/sh -c
for word splitting and execution, then begin
.Ar command
with
.Sq \e! .
.\" ------------------------------------------------------------
.It Ic Close Op Ar N
Close a tab. If no argument is specified, close all tabs and exit. If
.Ar N
is 0, close the active tab. Otherwise close the
.Ar N Ns th tab .
.\" ------------------------------------------------------------
.It Ic GotoTab Op Ar N
Goto tab. If
.Ar N
is omitted or 0, then go to the previous active tab. Otherwise go to the
.Ar N Ns th
tab. If
.Ar N
begins with a
.Sq +
or
.Sq -
then
.Ar N
is relative to the current tab.
.\" ------------------------------------------------------------
.It Ic MoveTab Ar N
Move active tab to position
.Ar N .
If
.Ar N
begins with a
.Sq +
or
.Sq -
then
.Ar N
is relative to the current tab.
.\" ------------------------------------------------------------
.It Ic Scroll Ar amount
Scroll the active tab by
.Ar amount
lines (negative values mean scroll backward). If
.Ar amount
ends with
.Sq p
then scroll
.Ar amount
pages instead of lines.
.\" ------------------------------------------------------------
.It Ic Copy
Copy selection into clipboard (not implemented).
.\" ------------------------------------------------------------
.It Ic Paste Op Ar selection-buffer
Paste selection into active tab. The value
.Ar selection-buffer 
specifies the name of the buffer to be pasted. If not specified the first used buffer in the order PRIMARY, SECONDARY and CLIPBOARD  will be used.
.\" ------------------------------------------------------------
.It Ic PasteFile Ar filename
Paste the content of the file specified by 
.Ar filename
to the currently active tab. This can be used to input text-snippets to a shell
or any other terminal based program (i.e. somthing like a bash-profile
or sequence of administration commands).
.\" ------------------------------------------------------------
.It Ic MonitorTab Ar [ACTIVITY|INACTIVITY|AUTO]
Monitor the current tab-window for  
.Ar ACTIVITY
or
.Ar INACTIVITY
or automatically detect the type of monitoring using the 
.Ar AUTO
option. The amount time which is used to detect the type of monitoring or tab-inactivity
can be specified by the
.Ic monitorTimeout
option. The detection of activity or inactivity is signaled by highlighting the tab of the event and ringing
the system bell. Additionally it is possible to execute a dedicated command using the
.Ic monitorCommand
option.
.\" ------------------------------------------------------------
.It Ic ToggleSubwin Op Oo Ar + Ns | Ns Ar - Oc Ns Op Ar b Ns | Ns Ar m Ns | Ns Ar s Ns | Ns Ar t
Toggle visibility of sub-windows. If the argument begins with a
.Sq +
the subwindow is shown. If it begins with a
.Sq -
the subwindow is hidden. Otherwise it is toggled. The letters
.Sq Ar b ,
.Sq Ar m ,
.Sq Ar s
and
.Sq Ar t
represent the tabbar buttons, menubar, scrollbar and tabbar respectively. NOTE: Currently you can only toggle one subwindow at a time.
.\" ------------------------------------------------------------
.It Ic ResizeFont Oo Ar + Ns | Ns Ar - Oc Ns Ar N
Resize the font. With Xft,
.Ar N
represents the size increment of the xft font. Without Xft,
.Ar N
represents the index of the X11 fonts specified by the
.Cm font Ns Ar N
resources.
.\" ------------------------------------------------------------
.It Ic ToggleVeryBold
Toggle use of bold font for colored text.
.\" ------------------------------------------------------------
.It Ic ToggleTransparency
Toggle pseudo transparency.
.\" ------------------------------------------------------------
.It Ic ToggleBroadcast Op Ar status
If
.Ar status
is omitted or
.Sq -1 ,
then input broadcasting to all tabs is toggled. If it is
.Sq 1 ,
input broadcasting is enabled. If it is
.Sq 0 ,
it is disabled.
.\" ------------------------------------------------------------
.It Ic ToggleHold Op Ar mask
If
.Ar mask
is not specified, then just close all tabs who's child processes have exited. (This is almost compatible with the behaviour of
.Nm
0.5.1 and earlier). If
.Ar mask
is specified, then change the hold status of the current tab.
.Ar mask
must begin with
.Sq Sy + ,
.Sq Sy - ,
or
.Sq Sy \&!
and be followed by a bit mask (as in the
.Ic holdExit
option).
.Sq Sy +
will add bits to the
.Ic holdExit
option for this tab,
.Sq Sy -
will subtract, and
.Sq Sy \&!
will toggle. Remember that if the lowest bit of the current tabs
.Ic holdExit
option is set, then the tab will always be held open and everything else will be ignored.
.\" ------------------------------------------------------------
.It Ic ToggleFullscreen
Toggle between full screen and regular mode. Also enable
.Fl Fl smoothResize
to get true full screen. This will only work if you are running an EWMH compatible window manager (e.g. Fvwm / OpenBox / KDE / Gnome).
.\" ------------------------------------------------------------
.It Ic Raise
Raise the
.Nm
window.
.\" ------------------------------------------------------------
.It Ic SetTitle
Set title of active tab to selection. (The selection must be owned by
.Nm )
.\" ------------------------------------------------------------
.It Ic UseFifo Ar status
Enable or disable using a
.Xr fifo 1
to listen for macros on (see the
.Ic useFifo
option). The argument
.Ar status
should be
.Sy 0 , 1 , -1
to disable, enable or toggle respectively.
.\" ------------------------------------------------------------
.It Ic PrintScreen Oo Fl psn Oc Op Ar command
Dump screen to printer (or
.Ar command ) .
If
.Fl p
is specified, then the output is pretty printed (i.e. escape sequences are used to get the same color in the output as on your screen). If
.Fl s
is specified, then the entire scroll back is printed (instead of just the current screen). If
.Fl n
is specified, then every screen line is terminated with a newline char (by default screen lines that wrap to the next line are not terminated with a newline). Finally, if command is specified it is used as the printer pipe (if not the value of
.Ic printPipe
or the compiled in default is used).
.\" ------------------------------------------------------------
.It Ic SaveConfig Op Ar filename
Save config to file. If no filename is specified, save to
.Pa ~/.mrxvtrc.save .
.\" ------------------------------------------------------------
.It Ic ToggleMacros
Toggle the use of keyboard shortcuts. When macros are disabled (either by using this macro, or by the
.Fl dm
option), then this is the only keyboard shortcut that will work. Thus you can re-enable your keyboard shortcuts via the keyboard using this function.
.\" ------------------------------------------------------------
.El
.Pp
Additionally, the argument to any of the above macros are
.Sq Sy \e
and
.Sq Sy %
interpolated as follows:
.Pp
.Bl -tag -compact -offset 4n -width 8n
.It Sy \ea
Bell
.It Sy \eb
Backspace
.It Sy \eE , \ee
Escape
.It Sy \en
Newline
.It Sy \er
Carriage return
.It Sy \et
Tab
.It Sy \e Ns Ar ddd
Char with octal ASCII code
.Ar ddd .
.It Sy ^@ , ^A .. ^Z .. ^_ , ^?
Control-@, Control-A ...
.Pp
.It Sy %G
Global (static) tab number.
.It Sy %p
PID of child process in current tab.
.It Sy \&%P
PID of
.Nm
.It Sy %n
Tab number.
.It Sy % Ns Sy N
Expands to
.Sq normally
if the process exited normally (e.g. by calling
.Xr exit 1 )
or
.Sq abnormally
otherwise. (Note this is independent of the exit status).
.It Sy %s
Text selected in the
.Nm
window.
.It Sy %S
If the process in this tab is dead, then it expands to the exit status of the child process. Otherwise left unchanged.
.It Sy %t
Tab title.
.It Sy \&%T
Total number of tabs created in
.Nm
lifetime.
.El
.Ed
.Ss Mouse shortcuts \"{{{2
.Bd -filled
.Bl -tag -width 4n
.It Changing tab titles
This mouse shortcut can be used to dynamically change the tab title as follows: Select text in the terminal window. Then middle click on a tab to change the tab's title. If you middle click on the tabbar background, then the title of the active tab is changed.
.It Tab list menu
By default, if you right click on the tab bar, or control-left-click on the terminal window, a popup menu with a list of currently open tabs pops up. The actual menu popped up can be customized as described under the section
.Sx MENUS .
.It Popup menus
If you Control-click on the terminal window (with any mouse button), it pops up a menu. The actual menu popped up can be customized as described under the section
.Sx MENUS .
.It Moving tabs
Click and drag a tab to some other location on the tab-bar to move it.
.El
.Ed
.\"}}}
.
.
.Sh ESCAPE SEQUENCES \"{{{1
.
.
.Bd -filled
You have several escape sequences to control
.Nm .
All default
.Xr rxvt 1
escape sequences are supported by
.Nm .
A few extra escape sequences have been added to improve DEC compatibility, and allow interaction with extra
.Nm
features (e.g. tabs). The supported escape sequences are listed in the file
.Pa mrxvt_seq.txt
included in the distribution.
.Pp
For omissions in the documentation, and a more complete reference to escape sequences you should look at the file
.Pa ctlseqs.txt
that comes with the xterm package,
.Xr console_codes 4
and the original rxvt documentation in the file
.Pa rxvtRef.txt .
.Pp
For basic interaction with
.Nm
(e.g. changing the tab title etc.) you should also look at the programs
.Pa share/scripts/settitle.c
and
.Pa share/scripts/mrxvtset.pl
that are supplied with the
.Nm
distribution.
.Ed
.
.
.Sh ENVIRONMENT \"{{{1
.
.
.Bd -filled
.Bl -tag -width 4n
.It Ev COLORFGBG
Set to the terminal foreground and background colors.
.It Ev COLORTERM
Sets to the terminal sub-name that indicates its color.
.It Ev DISPLAY
Used (and set) to the X display bieng used.
.It Ev PATH_ENV
Path to look for menu / background files (see
.Fl path
option).
.It Ev TERM
Set to the terminal name in the window you have created.
.It Ev MRXVT_TABTITLE
Set to the initial tab title of each terminal. Notice that its value will not be altered if the user uses a shortcut or escape sequence to change the tab title. The user must modify it manually after doing that.
.It Ev WINDOWID
Set to the X window id number of the mrxvt window.
.El
.Ed
.
.
.Sh FILES \"{{{1
.
.
.Bd -filled
The actual pathnames given may differ on your system.
.Bl -tag -width 4n
.It Pa default.menu
The default menu file loaded at startup (searched for in your
.Fl path ) .
.It Pa ~/mrxvt
Directory in which to look for user menu and image files.
.It Pa ~/.mrxvtrc
This is the default configuration file (since 0.3.9). If present, resources read from this file override existing resources.
.It Pa ~/.Xdefaults
(OBSOLETE) This was the default configuration file (before 0.3.9). If present, resources read from this file override existing resources.
.It Pa ~/.Xresources
(OBSOLETE) If both
.Pa .mrxvtrc
and
.Pa .Xdefaults
are not found, try this one.
.It Pa /etc/mrxvt
System wide directory in which to look for user menu and image files.
.It Pa /etc/mrxvt/default.menu
Default menu file read on startup.
.It Pa /etc/mrxvt/mrxvtrc
System wide configuration file. (By default this file only defines the default keyboard macros)
.It Pa /etc/utmp
System file for login records.
.It Pa /usr/lib/X11/rgb.txt 
Color names.
.It Pa /usr/X11R6/lib/X11/app-defaults/XTerm
(OBSOLETE) If enable xgetdefaults at compiled time, this is the first configuration file read. 
.El
.Ed
.
.
.Sh BUGS \"{{{1
.
.
.Ss "Reporting bugs"
.Bd -filled
Please report bugs using the sourceforge bug tracker system at
.Pp
.Bd -centered
.Ad http://sourceforge.net/projects/materm
.Ed
.Pp
Alternately you can send your bug report to the mrxvt developer mailing list at
.Pp
.Bd -centered
.Mt materm-devel@lists.sourceforge.net
.Ed
.Pp
Be sure you give us enough details to reproduce the bug ourselves, and check to see if your bug still exists in the current CVS version.
.Ed
.Ss "Known bugs"
.Bd -filled
.Bl -dash -compact -width 2
.It
Tabs don't work properly when running under Xnest.
.It
Transparency and tinting are global, not specific to a terminal.
.It
The transparentForce option does not work well with all window managers (e.g. OpenBox).
.El
.Ed
.
.
.Sh SEE ALSO \"{{{1
.
.
.Bd -filled
.Xr rxvt 1 ,
.Xr xterm 1 ,
.Xr resize 1 ,
.Pa mrxvt_seq.txt ,
.Ar Xterm control sequences
(this is the file
.Pa ctlseqs.ms
or
.Pa ctlseqs.txt ) ,
.Xr console_codes 4
.Pp
.Bd -centered
.Ad http://materm.sourceforge.net
.Ed
.Ed
.
.
.Sh AUTHORS \"{{{1
.
.
.An "Terminator" < Ns Mt jimmyzhou@users.sourceforge.net Ns >
.An "Gautam Iyer" < Ns Mt gi1242@users.sourceforge.net Ns >
.An "Marc Schoechlin" < Ns Mt mschoechlin@users.sourceforge.net Ns >
.
.