mrxvt.1

multi-tabed terminal based on rxvt

.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 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 any integer between 0 and the compiled in maximum (default 5). The profile number 0 is special, and contains default settings which are used for all profiles where this option is not set (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 ) .
.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