mrxvt.1

multi-tabed terminal based on rxvt

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