User Commands mrxvt(1)
NAME
mrxvt - A tabbed VT102 terminal emulator for X Window System
SYNOPSIS
mrxvt [options] [-e cmd]
DESCRIPTION
The mrxvt program is a terminal emulator for X Window Sys-
tem. It provides Tn DEC VT102 compatible terminals for pro-
grams that cannot use the window system directly.
mrxvt is based on 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, mrxvt
aims to be light, fast, flexible and desktop independent,
thus KDE or GNOME are not required.
The primary features of mrxvt include (but are not limited
to) multiple tabs, dynamically changeable tab titles, cus-
tomisable 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 and logging.
The default mrxvt behaviour can be set using the resource
configuration file ~/.mrxvtrc. For backward compatibility,
if ~/.mrxvtrc is not found, mrxvt tries to load configura-
tion settings from the files ~/.Xdefaults or ~/.Xresources.
Alternately, you can specify which config file to load using
the -cf command line option.
OPTIONS
This section describes the commandline options mrxvt
accepts. To disable an option, prefix it with an `]' instead
of a `-' Most options can be set from your ~/.mrxvtrc file
using the option name listed in brackets as [optionname.]
The option name can also be used as a "long option" from the
command line (i.e. by prefixing it with `--' or `]' as
appropriate. For example mrxvt -tr -shade 85 ]trt is the
same as mrxvt --transparent --shading 85 ]transparentTabbar
which is the same as putting the lines
Mrxvt.transparent: True Mrxvt.shading: 85
Mrxvt.transparentTabbar: False in your ~/.mrxvtrc.
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 rxvt(1) and xterm(1) manpages.
SunOS 5.10 Last change: mrxvt-0.5.3 1
User Commands mrxvt(1)
Terminal name and display options
-display-d displayname
X display name, the X server to contact
-geometry-g geometry
geometry at startup [geometry]
-ic file[;geometry]
application icon file. [appIcon] start iconic [iconic]
-in name
Icon name for window [iconName]
-into WinID
If given an X window identifier, mrxvt will reparent
its top-level shell widget to that window. This is
used to embed mrxvt within other applications.
-name name
Client instance, icon, and title strings [clientName.]
-title string
title name of the window [title]
-tn termname
The type of terminal mrxvt should emulate. The value of
the TERM environment variable is set to this value for
all child processes launched by Note that rxvt and most
rxvt clones including Ns, have slightly different ter-
minal capabilities than those of xterm(1). Thus Ns will
not always work properly with the terminal set to
xterm, and we recommend setting this value to rxvt
instead. However some systems have incorrect (or even
missing) terminfo(1) or termcap(1) entries for the ter-
minal 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 xterm and
hope everything works properly. [termName]
Transparency related options
-o %d
Translucent window (true transparent) background opa-
city degree. %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. [opa-
city]
-od %d
Translucent window opacity degree increase/decrease
interval. %d is an integer between 0 and 100 [opaci-
tyDegree] Enable / disable background pseudo-
SunOS 5.10 Last change: mrxvt-0.5.3 2
User Commands mrxvt(1)
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 XROTPMAPID atom). Some programs that will do this
are Esetroot(1), feh(1), fvwm-root(1) with the `--
retain-pixmap' option, or KDE. Note: To use your pre-
cious backgroundFade, tinting or shading options, you
MUST set the desktop wallpaper in an Esetroot way.
[transparent] 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 transparent option). Background changes made by
FvwmBacker, xsetbg (xli) or Esetroot compatible pro-
grams, will be automatically detected. However changes
made by xv(1), xsetroot(1) or other non-Esetroot compa-
tible programs will not be detected. If you're hell
bent on non-Esetroot compatible programs to set your
background, then do something like xsetroot -solid
"#202040" && fvwm-root -d Note: To use your precious
backgroundFade, tinting or shading options, you MUST
set the desktop wallpaper in an Esetroot way. [tran-
sparentForce] Enable / disable pseudo-transparent menu-
bar. Pseudo-transparency must be turned on. [tran-
sparentMenubar] Enable / disable pseudo-transparent
scrollbar. Pseudo-transparency must be turned on.
[transparentScrollbar] Enable / disable pseudo-
transparent tabbar. Pseudo-transparency must be turned
on. [transparentTabbar]
Background image related options
-mbpixmap file[;geometry]
Menubar background image. Pseudo-transparency must be
turned off. [menubarPixmap]
-pixmap file[;geometry]
Background image for all terminals if not set individu-
ally. Pseudo-transparency must be turned off. [Pixmap]
-sbpixmap file[;geometry]
Scrollbar background image. Pseudo transparency must be
turned off. [scrollbarPixmap]
-tbpixmap file[;geometry]
Tabbar background image. Pseudo transparency must be
turned off. [tabbarPixmap] Apply tabbar background
image to tabs. [tabUsePixmap]
Scrolling related options
scroll one page when press mouse wheel button [mouseWheel-
ScrollPage]
-sa mode
SunOS 5.10 Last change: mrxvt-0.5.3 3
User Commands mrxvt(1)
Scrollbar alignment ( top bottom ) [scrollbarAlign]
Hide / show scrollbar [scrollBar]
-sbt width
Scrollbar thickness/width [scrollbarThickness] Inhibit
scrolling on tty output. [scrollTtyOutputInhibit]
scroll-on-keypress [scrollTtyKeypress]
-sl n
The number of scrolled lines to save (for all tabs) if
not set individually. The maximal number of saved lines
is 65535. [saveLines] Scrollbar on right [scrollbar-
Right]
-ss mode
Scrollbar style. mode should be one of plain, xterm ,
rxvt , next or sgi. [scrollbarStyle] Draw floating
scrollbar (i.e. without a trough). [scrollbarFloating]
Scroll synchronusly with buffer. Normally Ns does not
keep the screen completely up to date while scrolling.
This allows Ns to run faster when network latencies are
very high and is typically useful when running across a
very large internet or many gateways. [scrollWith-
Buffer]
Color related options
-bg color
Background color [background]
-bd color
enable X session management [sessionMgt]
Long options
The following options do not have a ``short'' form. If these
options are to be used on the command line, they must be
prefixed with a `Em' -- (or `Em' ] for boolean options).
They can of course be used in the Ns configuration file.
answerBackString string
Specify the reply Ns sends to the shell when an ENQ
(control-E) character is passed through. It may contain
escape values as described in the entry on keysym fol-
lowing.
backspaceKey string
The string to send when the backspace key is pressed.
If set to DEC or unset it will send Delete (code 127)
or, if shifted, Backspace (code 8) - which can be
reversed with the appropriate DEC private mode escape
sequence.
bgRefreshInterval delay
SunOS 5.10 Last change: mrxvt-0.5.3 4
User Commands mrxvt(1)
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.
boldFontN font
Specifies bold font to use along with fontset N.
boldColors TrueFalse
If false, the bold primary colors (0 -- 7) will be ren-
dered using the brighter analogues (8--15) in a regular
font. If true a bold font will be used. See also very-
Bright.
colorN color
Use the specified colour for the colour value N, where
0-7 corresponds to low-intensity (normal) colours and
8-15 corresponds to high-intensity colours.
colorBD color
Color to use to display bold text. If unspecified, the
text will be displayed using a bold font / overstrike.
colorRV color
Color to use to display reverse video text. If unspeci-
fied, the text will be displayed as reverse video.
colorUL color
Color to use to display underlined text. If unspeci-
fied, the text will be displayed as underlined.
cursorColor2 color
Second color of cursor.
cutChars 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 con-
taining all letters (both upper and lower case), digits
and punctuation you find in urls.
deleteKey string
The string to send when the delete key (not the keypad
delete key) is pressed. If unset it will send the
sequence traditionally associated with the Execute key.
focusDelay msec
The time interval (in mili-seconds) to wait after
SunOS 5.10 Last change: mrxvt-0.5.3 5
User Commands mrxvt(1)
getting / losing focus, before fading the colors and
changing the background color as specified by the -fade
and -ufbg options. Set it to 0 if you want your colors
faded immediately on focus change events.
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).
fontN font
Specify the alternative font n. ncan be 1, 2, 3, 4 or
5.
greektogglekey keysym
Key to toggle into greek keyboard mapping. See
README.greek for details.
highlightColor color
Color to use for selection. If not specified, reverse
video is used. (Note blinking text is also displayed
with this color).
mapAlert TrueFalse
If true, de-iconifies the window when a bell is
received.
mfontn font
Specify alternative multiple character font n.
pointerBlankDelay delay
Delay (ms) to blank pointer after.
printPipe cmd
Specify a command pipe for vt100 printer.
refreshLimit N
This option and skipPages are to be used to replace the
`jump' scroll behaviour of other terminal emulators
(and previous version of ). Generally when data is
available from a tab, ) 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 N characters, then
we request a screen refresh (which takes a while, espe-
cially if you use Xft with anti aliasing). If we obtain
more than N characters from the tab, then we delay the
screen refresh until the tab eventually has either N or
fewer characters of output, or the tab has (cumula-
tively) produced at least skipPages of data.
SunOS 5.10 Last change: mrxvt-0.5.3 6
User Commands mrxvt(1)
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 ) to request screen refreshes
every time the active tab has data, and effectively
disable the so called `jump' scrolling .
scrollColor color
Color of scrollbar (see also troughColor).
selectStyle mode
Set mouse selection style to old which is 2.20, oldword
which is xterm style with 2.20 old word selection, or
anything else which gives xterm style selection.
skipPages N
This option and refreshLimit are to be used to replace
the `jump' scroll behaviour of other terminal emulators
(and previous version of ). If the screen refresh is
delayed because of the refreshLimit option, then ) will
refresh the screen every N pages of output. The default
is 25. If you set it to a very large value (say
INTMAX), then ) will refresh the screen only after the
tab has stopped `flat' out scrolling.
smartResize TrueFalse
Enable / disable smart resize. When the tabbar is
shown, or font size is increased, the resize terminal
window could be partially off screen. If smartResizeis
enabled, then No tries to move the terminal window to
stay on screen.
smoothResize TrueFalse
Enable / disable smooth resize. If enabled, then the No
window is resized in pixel increments (instead of char-
acter increments). This is useful if you want a full
screen / maximized No window that covers the entire
screen (without leaving an annoying few pixel wide
strip uncovered).
troughColor
Color of scrollbar trough (see also scrollColor).
useFifo TrueFalse
If enabled, then mrxvt will create a fifo(7)Pa and
listen for macros on it. To execute macros, just write
them to this fifo. For example /bin/echo -e
"NewTab\nRaise" >> /tmp/.mrxvt-%pid creates a new tab
and raises the No window with process ID %pid. NOTE:
The meaning and syntax of this option might change in
future versions.
SunOS 5.10 Last change: mrxvt-0.5.3 7
User Commands mrxvt(1)
veryBright TrueFalse
If true, and if 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).
CONFIGURATION FILE SYNTAX
A line in the config file generally looks like this
ClassName.OptionName: Value Blank lines, and lines begin-
ning with `Em' # are ignored (comments).
The ClassName is the name specified via the -name option (by
default `Em' mrxvt ) . When No starts up, it ONLY reads
options with ClassName `Em' Mrxvt , `Em' XTerm , or the
class specified via the -name option. See
/etc/mrxvt/mrxvtrc.sample for how this feature can be used.
The OptionName is the long name of the option you want to
set. It can be any long option (listed under the Long
Options sub section), or is specified in brackets as
[optionname] alongside regular options in this man page.
Finally Value is the value of this option.
Example
The following is an example ~/.mrxvtrc file, or in a confi-
guration file you will load with -cf option at startup. You
can consult the doc/mrxvtrc.sample in the directory for more
details. 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
MENUS
The menu system is similar to rxvt's menus (see the included
file rxvtRef.txt) with a few enhancements, and a few notable
exceptions: The menus can use a proportionally spaced font
under Xft ( -xftpfn ) which is significantly less ugly than
a mono-spaced font. No supports pop-up menus. If you create
a menu named PopupButton Ns N No (where N No is 1, 2, or 3)
then that menu is popped up when you control click (with the
SunOS 5.10 Last change: mrxvt-0.5.3 8
User Commands mrxvt(1)
appropriate mouse button) on the terminal window. Addition-
ally if you right click on the Tab bar, then the menu Ic
PopupButton1 No is popped up. To create a menu containing a
list of all open tabs, create an empty menu called PopupBut-
ton Ns 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 `Switch' to tab . Menu
actions are completely different in No than the original
implementation in rxvt(1). The menu actions are exactly the
same as macro actions, and are described in the section
Defining custom shortcuts . On startup No reads the file
default.menu which contains the default menu definitions.
The file is searched for in your search path (specified by
option -path ) .
KEYBOARD AND MOUSE SHORTCUTS
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 Defining custom shortcuts .
The following key combinations are defined by default. These
are defined in the system configuration file
/etc/mrxvt/mrxvtrc, and can be disabled using the option
-nsc. See the next section for instructions on defining
your own custom keyboard shortcuts.
Gnome-terminalstyleshortcuts:
Ctrl]Shift]t
create a new tab
Ctrl]Shift]q
Close all tabs and exit
Ctrl]Shift]w
Close active tab, and do not hold it open if it exits
abnormally.
Ctrl]PgUp
activate left tab
Ctrl]PgDn
activate right tab
Meta]1
activate 1st tab
section MENUS .
Popup menus
If you Control-click on the terminal window (with any
SunOS 5.10 Last change: mrxvt-0.5.3 9
User Commands mrxvt(1)
mouse button), it pops up a menu. The actual menu
popped up can be customized as described under the sec-
tion MENUS .
Moving tabs
Click and drag a tab to some other location on the
tab-bar to move it.
ESCAPE SEQUENCES
You have several escape sequences to control All default
rxvt(1) escape sequences are supported by A few extra escape
sequences have been added to improve DEC compatibility, and
allow interaction with extra features (e.g. tabs). The sup-
ported escape sequences are listed in the file mrxvtseq.txt
included in the distribution.
For omissions in the documentation, and a more complete
reference to escape sequences you should look at the file
ctlseqs.txt that comes with the xterm package,
consolecodes(4) and the original rxvt documentation in the
file rxvtRef.txt.
For basic interaction with (e.g. changing the tab title
etc.) you should also look at the programs
share/scripts/settitle.c and share/scripts/mrxvtset.pl that
are supplied with the distribution.
ENVIRONMENT
COLORFGBG
Set to the terminal foreground and background colors.
COLORTERM
Sets to the terminal sub-name that indicates its color.
DISPLAY
Used (and set) to the X display bieng used.
PATHENV
Path to look for menu / background files (see -path
option).
TERM Set to the terminal name in the window you have
created.
MRXVTABTITLE
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.
WINDOWID
Set to the X window id number of the mrxvt window.
SunOS 5.10 Last change: mrxvt-0.5.3 10
User Commands mrxvt(1)
FILES
The actual pathnames given may differ on your system.
default.menu
The default menu file loaded at startup (searched for
in your -path ) .
~/mrxvt
Directory in which to look for user menu and image
files.
~/.mrxvtrc
This is the default configuration file (since 0.3.9).
If present, resources read from this file override
existing resources.
~/.Xdefaults
(OBSOLETE) This was the default configuration file
(before 0.3.9). If present, resources read from this
file override existing resources.
~/.Xresources
(OBSOLETE) If both .mrxvtrc and .Xdefaults are not
found, try this one.
/etc/mrxvt
System wide directory in which to look for user menu
and image files.
/etc/mrxvt/default.menu
Default menu file read on startup.
/etc/mrxvt/mrxvtrc
System wide configuration file. (By default this file
only defines the default keyboard macros)
/etc/utmp
System file for login records.
/usr/lib/X11/rgb.txt
Color names.
/usr/X11R6/lib/X11/app-defaults/XTerm
(OBSOLETE) If enable xgetdefaults at compiled time,
this is the first configuration file read.
BUGS
Reporting bugs
Please report bugs using the sourceforge bug tracker system
at
SunOS 5.10 Last change: mrxvt-0.5.3 11
User Commands mrxvt(1)
http:/sourceforge.net/projects/materm
Alternately you can send your bug report to the mrxvt
developer mailing list at
materm-devel@lists.sourceforge.net
Be sure you give us enough details to reproduce the bug our-
selves, and check to see if your bug still exists in the
current CVS version.
Known bugs
- Tabs don't work properly when running under Xnest.
- Transparency and tinting are global, not specific to a
terminal.
- The transparentForce option does not work well with all
window managers (e.g. OpenBox).
ATRIBUTES
See attributes(5) for descriptions of the following attri-
butes:
ATRIBUTE TYPE ATRIBUTE VALUE
Availability SUNWmrxvt
Interface stability Uncommitted
SEE ALSO
rxvt(1), xterm(1), resize(1), mrxvtseq.txt, Xterm control
sequences (this is the file ctlseqs.ms or ctlseqs.txt),
consolecodes(4)
http:/materm.sourceforge.net
AUTHORS
Terminator
Gautam Iyer
Marc Schoechlin"
SunOS 5.10 Last change: mrxvt-0.5.3 12
|