1mrxvt(1) BSD General Commands Manual mrxvt(1)
2
4 mrxvt — A tabbed VT102 terminal emulator for X Window System
5
7 mrxvt [options] [-e cmd]
8
10 The mrxvt program is a terminal emulator for X Window System. It provides
11 DEC VT102 compatible terminals for programs that cannot use the window
12 system directly.
13 mrxvt is based on rxvt(1) version 2.7.11 CVS, and features most of func‐
15 tionality of rxvt, with a few major enhancements (namely multiple tabs,
16 and transparency). Like rxvt, mrxvt aims to be light, fast, flexible and
17 desktop independent, thus KDE or GNOME are not required.
18 The primary features of mrxvt include (but are not limited to) multiple
20 tabs, dynamically changeable tab titles, customisable command for each
21 tab, input broadcasting, true translucent window, fast pseudo trans‐
22 parency with tinting, user supplied background images (XPM, JPEG, PNG),
23 off-focus fading, text shadow, multiple style (NeXT, Rxvt, Xterm, SGI,
24 Plain) scrollbars, XIM, multi-language support (Chinese, Korean, Japa‐
25 nese), freetype font and logging.
26 The default mrxvt behaviour can be set using the resource configuration
28 file ~/.mrxvtrc. For backward compatibility, if ~/.mrxvtrc is not found,
29 mrxvt tries to load configuration settings from the files ~/.Xdefaults or
30 ~/.Xresources. Alternately, you can specify which config file to load
31 using the -cf command line option.
32
34 This section describes the commandline options mrxvt accepts. To disable
35 an option, prefix it with an ‘+’ instead of a ‘-’ Most options can be set
36 from your ~/.mrxvtrc file using the option name listed in brackets as
37 [option_name]. The option name can also be used as a "long option" from
38 the command line (i.e. by prefixing it with ‘--’ or ‘++’ as appropriate.
39 For example
40 mrxvt -tr -shade 85 +trt
42 is the same as
44 mrxvt --transparent --shading 85 ++transparentTabbar
46 which is the same as putting the lines
48 Mrxvt.transparent: True
50 Mrxvt.shading: 85
51 Mrxvt.transparentTabbar: False
52 in your ~/.mrxvtrc.
54 All options are case sensitive. Some options are similar to those of
56 other terminals, so if you find the explanation given here insufficient,
57 we strongly recommend you look in the rxvt(1) and xterm(1) manpages.
58 Terminal name and display options
60 -display|-d displayname
61 X display name, the X server to contact
62 -geometry|-g geometry
64 geometry at startup [geometry]
65 -ic file[;geometry]
67 application icon file. [appIcon]
68 -iconic|+iconic
70 start iconic [iconic]
71 -in name
73 Icon name for window [iconName]
74 -into WinID
76 If given an X window identifier, mrxvt will reparent its top-level
77 shell widget to that window. This is used to embed mrxvt within
78 other applications.
79 -name name
81 Client instance, icon, and title strings [clientName].
82 -title string
84 title name of the window [title]
85 -tn termname
87 The type of terminal mrxvt should emulate. The value of the TERM
88 environment variable is set to this value for all child processes
89 launched by mrxvt. Note that rxvt and most rxvt clones including
90 mrxvt, have slightly different terminal capabilities than those of
91 xterm(1). Thus mrxvt will not always work properly with the termi‐
92 nal set to xterm, and we recommend setting this value to rxvt
93 instead. However some systems have incorrect (or even missing) ter‐
94 minfo(1) or termcap(1) entries for the terminal rxvt. If you expe‐
95 rience problems with this, the ideal solution would be to correct
96 your systems termcap and terminfo entries. If you are unable to do
97 that, then you can try setting your terminal to xterm and hope
98 everything works properly. [termName]
99 Transparency related options
101 -o %d
102 Translucent window (true transparent) background opacity degree.
103 %d is an integer between 0 and 100. This option needs translucent
104 support by the X server, e.g., Xorg 6.8, and overrides the pseudo-
105 transparency. [opacity]
106 -od -%d
108 Translucent window opacity degree increase/decrease interval. %d
109 is an integer between 0 and 100 [opacityDegree]
110 -tr|+tr
112 Enable / disable background pseudo-transparency. To use this fea‐
113 ture you must set your desktop wallpaper using an Esetroot compati‐
114 ble program ( i.e. a program that publishes the wallpaper using the
115 _XROOTPMAP_ID atom). Some programs that will do this are
116 Esetroot(1), feh(1), fvwm-root(1) with the ‘--retain-pixmap’
117 option, or KDE. Note: To use your precious backgroundFade, tinting
118 or shading options, you MUST set the desktop wallpaper in an Eset‐
119 root way. [transparent]
120 -trf|+trf
122 If you choose NOT to set the background in an Esetroot compatible
123 way, then you can still have transparency using this option. (You
124 must also enable the transparent option). Background changes made
125 by FvwmBacker, xsetbg (xli) or Esetroot compatible programs, will
126 be automatically detected. However changes made by xv(1),
127 xsetroot(1) or other non-Esetroot compatible programs will not be
128 detected. If you're hell bent on non-Esetroot compatible programs
129 to set your background, then do something like
130 xsetroot -solid "#202040" && fvwm-root -d
132 Note: To use your precious backgroundFade, tinting or shading
134 options, you MUST set the desktop wallpaper in an Esetroot way.
135 [transparentForce]
136 -trm|+trm
138 Enable / disable pseudo-transparent menubar. Pseudo-transparency
139 must be turned on. [transparentMenubar]
140 -trs|+trs
142 Enable / disable pseudo-transparent scrollbar. Pseudo-transparency
143 must be turned on. [transparentScrollbar]
144 -trt|+trt
146 Enable / disable pseudo-transparent tabbar. Pseudo-transparency
147 must be turned on. [transparentTabbar]
148 Background image related options
150 -mbpixmap file[;geometry]
151 Menubar background image. Pseudo-transparency must be turned off.
152 [menubarPixmap]
153 -pixmap file[;geometry]
155 Background image for all terminals if not set individually. Pseudo-
156 transparency must be turned off. [Pixmap]
157 -sbpixmap file[;geometry]
159 Scrollbar background image. Pseudo transparency must be turned off.
160 [scrollbarPixmap]
161 -tbpixmap file[;geometry]
163 Tabbar background image. Pseudo transparency must be turned off.
164 [tabbarPixmap]
165 -tupixmap|+tupixmap
167 Apply tabbar background image to tabs. [tabUsePixmap]
168 Scrolling related options
170 -mp|+mp
171 scroll one page when press mouse wheel button
172 [mouseWheelScrollPage]
173 -sa mode
175 Scrollbar alignment ( top | bottom) [scrollbarAlign]
176 -sb|+sb
178 Hide / show scrollbar [scrollBar]
179 -sbt width
181 Scrollbar thickness/width [scrollbarThickness]
182 -si|+si
184 Inhibit scrolling on tty output. [scrollTtyOutputInhibit]
185 -sk|+sk
187 scroll-on-keypress [scrollTtyKeypress]
188 -sl n
190 The number of scrolled lines to save (for all tabs) if not set
191 individually. The maximal number of saved lines is 65535.
192 [saveLines]
193 -sr|+sr
195 Scrollbar on right [scrollbarRight]
196 -ss mode
198 Scrollbar style. mode should be one of plain, xterm, rxvt, next or
199 sgi. [scrollbarStyle]
200 -st|+st
202 Draw floating scrollbar (i.e. without a trough).
203 [scrollbarFloating]
204 -sw|+sw
206 Scroll synchronusly with buffer. Normally mrxvt does not keep the
207 screen completely up to date while scrolling. This allows mrxvt to
208 run faster when network latencies are very high and is typically
209 useful when running across a very large internet or many gateways.
210 [scrollWithBuffer]
211 Color related options
213 -bg color
214 Background color [background]
215 -bd color
217 Border color [borderColor]
218 -bgfade %d
220 (Obsolete) Make colors %d darker for background image or pseudo-
221 transparent background. %d is an integer between 0 and 100. This
222 is like tinting the background with black. This option is obsolete,
223 and you should use the tint and shade options instead.
224 [backgroundFade]
225 -bgtype type
227 Transformation type for background pixmap (not implemented yet)
228 -cr color
230 color of cursor [cursorColor]
231 -fade %d
233 Make colors %d darker when mrxvt looses focus. %d is an integer
234 between 0 and 100 [fading]
235 -fg color
237 Foreground color. [foreground]
238 -itabbg color
240 Background color of inactive tabs and tabbar. [itabBackground]
241 -itabfg color
243 Foreground color of inactive tabs. [itabForeground]
244 -pr color
246 color of pointer [pointerColor]
247 -shade %d
249 Shade background to %d degree when tinting the background. %d is
250 an integer between 0 and 100. You must also define a color using
251 the tint option. When compiled with XRender support, the tabbar,
252 menubar and scroll bar are tinted with their respective background
253 colors for pseudo-transparent terminals. [shading]
254 -tabbg color
256 background color of active tab. [tabBackground]
257 -tabfg color
259 Foreground color of tabbar [tabForeground]
260 -tint color
262 Color tinted on background image or pseudo-transparent background.
263 This works differently depending on the tint type: With XRender
264 (when compiled with --enable-xrender), color is the color you want
265 to tint your background to. The brighter the color, the less trans‐
266 parent it will be (regardless of the shade degree specified by
267 -shade). For example, if you want your background tinted black,
268 set color to ‘#000000’, however if you want a white tinted trans‐
269 parent background, set color to some level of grey (e.g.
270 ‘#808080’) but NOT to ‘#ffffff’.
271 When compiled without XRender support, color works like a color
273 mask. Thus if you want a black tinted background, set color to
274 ‘#ffffff’.
275 The shade degree (using -shade) must be defined as well.
277 [tintColor]
278 -tinttype type
280 Function applied for background tinting (not implemented yet).
281 -ts color
283 color of text shadow [textShadow]
284 -tsm mode
286 Text shadow mode, specify shadow position of text: left | right |
287 top | bottom | topleft | topright | botleft | botright | none.
288 [textShadowMode]
289 -txttype -type
291 Function applied for text drawing (not implemented yet)
292 -ufbg color
294 Default background color when the terminal window looses focus.
295 [ufBackground]
296 Font related options
298 -fb fontname
299 bold text X11 font name [boldFont]
300 -fm fontname
302 multichar text X11 font name [mfont]
303 -fn fontname
305 normal text X11 font name [font]
306 -xft|+xft
308 Use freetype font instead of X11 font. This option controls all
309 other freetype font related options. [xft]
310 -xftaa|+xftaa
312 Enable / disable antialiasing of freetype font. This makes font
313 look much nicer, but significantly slows down the rendering speed.
314 The -xft option must be enabled. [xftAntialias]
315 -xftah|+xftah
317 Enable / disable autohint of freetype font. The -xft option must be
318 enabled [xftAutoHint]
319 -xftfm fontname
321 Multichar text freetype font family. The -xft option must be
322 enabled [xftmFont]
323 -xftfn fontname
325 Normal text freetype font family. The -xft option must be enabled
326 [xftFont]
327 -xftga|+xftga
329 Enable / disable global advance of freetype font. The -xft option
330 must be enabled [xftGlobalAdvance]
331 -xftht|+xftht
333 Enable / disable hinting of freetype font. The -xft option must be
334 enabled [xftHinting]
335 -xftmsz size
337 Freetype multichar font size in pixels. The -xft option must be
338 enabled. [xftmSize]
339 -xftnfm|+xftnfm
341 Do not load freetype mfont, but use freetype font instead. This can
342 avoid a large line space if the size of font and mfont are very
343 different. The -xft option must be enabled [xftNomFont]
344 -xftpfn font
346 Specify a proportionally spaced font to use for drawing tab-titles.
347 If set, the tab bar behaves like Firefox's tab-bar: All tabs have
348 the same width, and the widths are shrunk / expanded to keep the
349 number of tabs specified by minVisibleTabs visible. The active tab
350 title is drawn in a bold font. (Your colors are still used).
351 [xftPFont]
352 -xftrgb style
354 Freetype font sub-pixel order: rgb | bgr | vrgb | vbgr | none. The
355 -xft option must be enabled. [xftRGBA]
356 -xftslow|+xftslow
358 Display freetype multichar string in slow mode for better display
359 effect. The xft option must be enabled. [xftSlowOutput]
360 -xftst style
362 Freetype font slant: roman | italic | oblique. The -xft option
363 must be enabled. [xftSlant]
364 -xftsz number
366 Freetype font size in pixel. The -xft option must be enabled
367 [xftSize]
368 -xftBwd style
370 Freetype bold font weight: light | medium | demibold | bold |
371 black. The -xft option must be enabled. [xftBoldWeight]
372 -xftwd style
374 Freetype font width: ultracondensed | condensed | normal | expanded
375 | ultraexpanded. The -xft option must be enabled. [xftWidth]
376 -xftwt style
378 Freetype font weight: light | medium | demibold | bold | black.
379 The -xft option must be enabled. [xftWeight]
380 Tabs and command related options
382 -aht Automatically hide or show the tab bar depending on the number of
383 tabs. On startup, the tabbar is shown only if there are more than
384 one tabs present. If there is only one tab, and a new one is cre‐
385 ated, then the tabbar is shown. If there are two tabs and one is
386 closed, then the tabbar is hidden. A keyboard shortcut used at any
387 time to hide / show the tabbar. [autohideTabbar]
388 -at|+at
390 Run command specified with -e on all tabs (by default the command
391 specified by -e is only used for the first tab opened). This causes
392 the profile option command to be ignored. However a command speci‐
393 fied via the NewTab macro is honored. [cmdAllTabs]
394 -bt|+bt
396 Show tabbar at bottom. [bottomTabbar]
397 -e [arguments ...]
399 Specifies the program (and its command line arguments) to be run in
400 the mrxvt window. By default this command is only run initially,
401 and all tabs created after startup will run the default shell (or
402 program supplied by -profile%d). This behaviour can be overridden
403 with the -at option. [command]
404 -hb|+hb
406 Hide buttons in the tabbar. [hideButtons]
407 -het string
409 Message to display in tabs after the child process exits. (This
410 string is escape and percent interpolated). [holdExitText]
411 -heT string
413 Set the title of tabs to string after the process in the tab exits.
414 (This string is escape and percent interpolated). [holdExitTitle]
415 -hold mask
417 Hold the tab open after the child process in it exits. mask is the
418 mask of flags which control weather the tab will be held open based
419 on the exit status of the child process. If the lowest bit (0x01)
420 of mask is set, then the tab will always be held open after the
421 child exits. If the next bit (0x02) is set, then the tab will only
422 be held open if the child exits abnormally (e.g. via abort(1)). If
423 the third bit (0x04) is set, then the tab will be held open if the
424 child exits with non-zero status.
425 NOTE: In previous versions of mrxvt this was a boolean option. For
427 backward compatibility, the value of True, On, Yes will be treated
428 as 1 and anything illegal will be treated as 0. The default is
429 0x06. [holdExit]
430 -ht|+ht
432 Hide tabbar on initialization [hideTabbar]
433 -htb|+htb
435 Highlight inactive tabs only when bell sounds. Default is to high‐
436 light inactive tabs whenever they produce output.
437 [highlightTabOnBell]
438 -ip profiles
440 profiles is a comma separated list of profiles numbers. On startup
441 mrxvt opens each of these profiles in a tab. [initProfileList]
442 -ls|+ls
444 Indicates that the shell that is started in the mrxvt window will
445 be a login shell (i.e., the first character of argv[0] will be a
446 dash, indicating to the shell that it should read the user's .login
447 or .profile). [loginShell]
448 -mtw width
450 The maximum width (in characters) of the displayed tabs. This can
451 not be larger than 40. If you use Xft, then you might want to use
452 the minVisibleTabs option instead. [maxTabWidth]
453 -mvt n
455 When using xftPFont to display tabs, keep at least n tabs visible.
456 [minVisibleTabs]
457 -profileN.option value
459 Set option to value in profile N. When a new tab is created with
460 profile N it uses all options that are set for this profile. Cur‐
461 rently the only options that can be set per profile are Pixmap,
462 background, command, foreground, saveLines, holdExit, holdExitText,
463 holdExitTitle, tabTitle and workingDirectory. Then all the set‐
464 tings from that profile number are used.
465 N can be any integer between 0 and the compiled in maximum (default
467 5). The profile number 0 is special, and contains default settings
468 which are used for all profiles where this option is not set (e.g.
469 -profile0.tt mrxvt sets the tab title to mrxvt for all profiles
470 where the tab title has not been set). In this case the -profile0.
471 can be omitted entirely (i.e. -profile0.tt is equivalent to -tt).
472 This option is intended to replace the -vt%d.xx options from mrxvt
474 version 0.5.0. The old -vt%d.xx would set options for the %dth tab.
475 This causes inconsistent behaviour when the user moves / closes
476 tabs. The behaviour of the -profile option is to set options for a
477 particular profile, and then these settings can be associated (on
478 demand) to newly created tabs. [profileN.option]
479 -ps|+ps
481 Protect tab from being closed if it is using the secondary screen,
482 for example, when the user is running vim(1) or mutt(1), this can
483 prevent the terminal from being accidentally closed.
484 [protectSecondary]
485 -sti|+sti
487 Synchronize icon name with tab title when switch to a new tab or
488 the title of the active tab changes. [syncTabIcon]
489 -stt|+stt
491 Synchronize terminal title with tab title when switch to a new tab
492 or the title of the active tab changes. [syncTabTitle]
493 -tnum N
495 OBSOLETE. Opens N tabs on startup. For backward compatibility, the
496 tabs are opened with profile 0, 1, ... N-1. [initTermNumber]
497 -tt string
499 Title of the tab [tabTitle]
500 -ut|+ut
502 Utmp inhibit. [utmpInhibit]
503 -vbf|+vbf
505 Show colored text with bold font. [veryBoldFont]
506 -wd Working directory of the child process. If non-empty, then the
508 child process is started in this directory. If set to ‘.’ then the
509 child process is run in the working directory of the current tab if
510 possible. On Linux, this is the default. (NOTE: It is not always
511 possible to find the working directory of the current tab. This
512 works fine on Linux, but causes problems on other systems [e.g.
513 OpenBSD], which is why it is only enabled by default on Linux).
514 [workingDirectory]
515 Multichar and multi-language support
517 -mcc|+mcc
518 Multichar cursor movement [multibyte_cursor]
519 -km mode
521 multichar encoding mode [multichar_encoding]
522 -im name
524 name of X Input Method (XIM) [inputMethod]
525 -pt mode
527 XIM input style: OverTheSpot|OffTheSpot|Root [preeditType]
528 -thai|+thai
530 Thai support [thai]
531 -grk mode
533 Greek keyboard mapping: iso|ibm [greek_keyboard]
534 Menu related options
536 -menu filename[;tag]
537 Menubar definition file. [menu]
538 -showmenu|+showmenu
540 show menubar [showMenu]
541 Keyboard and window related options
543 -b number
544 internal border width [internalBorder]
545 -bc|+bc
547 Display a blinking cursor. [cursorBlink]
548 -bcst|+bcst
550 Enable / disable broadcasting input to all terminals [broadcast]
551 -bci number
553 Cursor blink interval (ms) [cursorBlinkInterval]
554 -bl|+bl
556 Use a borderless window. [borderLess]
557 -blc cmd
559 Bell command instead of beeping. If cmd begins with ‘!’ then it is
560 passed to /bin/sh -c for execution. Otherwise it is split into
561 words at spaces or tabs only, and executed via execvp(3). If you
562 don't want a space or tab to cause word splitting, then precede it
563 with a ‘\’. If you want to pass ‘\ ’ as an argument, double the
564 ‘\’.
565 Note: Only backslashes (or chains of backslashes) that precede a
567 space or tab character are treated specially. That is ‘\\a’ will be
568 left untouched, however ‘\\ ’ will expand to a ‘\’ and the ‘ ’ will
569 cause a word break, and ‘\ ’ will expand to a ‘ ’ which does not
570 cause a word break. [bellCommand]
571 -bw|-w number
573 external border width [externalBorder]
574 -desktop number
576 Desktop to place the window (for gnome compatible window manager).
577 The number starts from 0, NOT 1! [desktop]
578 -dm|+dm
580 Enable / disable all keyboard macros. This functionality can be
581 toggled at runtime via a pop-up menu, or the ToggleMacros keyboard
582 shortcut. NOTE: When keyboard macros are disabled, the ToggleMacros
583 keyboard macro will still work. Thus you can re-enable your key‐
584 board macros via the keyboard using this function. [disableMacros]
585 -fs|+fs
587 Startup fullscreen. Use in conjunction with [smoothResize] to
588 really make it full screen. Requires an EWMH compatible window man‐
589 ager. [fullscreen]
590 -lk|+lk
592 Enable Linux console style Home/End keys [linuxHomeEndKey]
593 -mod mode
595 Meta modifier: alt|meta|hyper|super|mod1|...|mod5. [modifier]
596 -lsp number
598 Line space between rows [lineSpace]
599 -m|+m
601 Start maximized (requires an EWMH compatible window manager).
602 [maximized]
603 -m8|+m8
605 Enable / disable meta8 [meta8]
606 -nsc|+nsc
608 Enable / disable reading the system wide configuration file. Only
609 the default keyboard macros are defined in this file, so this
610 option can effectively disable all default keyboard shortcuts.
611 [noSysConfig]
612 -or|+or
614 Override redirect [overrideRedirect]
615 -pb|+pb
617 Pointer blank (see also pointerBlankDelay). [pointerBlank]
618 -rv|+rv
620 reverse video [reverseVideo]
621 -tcw|+tcw
623 Triple click word selection [tripleclickwords]
624 -vb|+vb
626 Visual bell [visualBell]
627 Miscellaneous options
629 -C Intercept console messages
630 -cf filename
632 X resource configuration file
633 -cfs filename
635 X resource configuration file to save the current configuration
636 [confFileSave]
637 -path path
639 Colon delimited list of directories to search for background images
640 and menu files. mrxvt first searches for the file in the current
641 directory, then in the directories specified by path, then in the
642 directories specified by the environment variable PATH_ENV and
643 finally tries in the user configuration directory ~/.mrxvt and the
644 (compiled in) system wide configuration directory /etc/mrxvt.
645 [path]
646 -sid string
648 Client identity of mrxvt for X session management [smClientID]
649 -sm|+sm
651 enable X session management [sessionMgt]
652 Long options
654 The following options do not have a “short” form. If these options are to
655 be used on the command line, they must be prefixed with a ‘--’ (or ‘++’
656 for boolean options). They can of course be used in the mrxvt configura‐
657 tion file.
658 answerBackString string
660 Specify the reply mrxvt sends to the shell when an ENQ (control-E)
661 character is passed through. It may contain escape values as
662 described in the entry on keysym following.
663 backspaceKey string
665 The string to send when the backspace key is pressed. If set to DEC
666 or unset it will send Delete (code 127) or, if shifted, Backspace
667 (code 8) - which can be reversed with the appropriate DEC private
668 mode escape sequence.
669 bgRefreshInterval delay
671 Specify the delay (ms) to wait before refreshing the background in
672 pseudo-transparency. Generally tinting and refreshing the back‐
673 ground is slow (especially with XRender), and causes lags while
674 dragging the window. This delay causes enables the window to be
675 dragged smoothly. If you have a fast system, you can reduce or dis‐
676 able this (by setting it to 0). The default value is 100ms.
677 boldFontN font
679 Specifies bold font to use along with fontset N.
680 colorN color
682 Use the specified colour for the colour value N, where 0-7 corre‐
683 sponds to low-intensity (normal) colours and 8-15 corresponds to
684 high-intensity colours.
685 colorBD color
687 Color to use to display bold text. If unspecified, the text will be
688 displayed using a bold font / overstrike.
689 colorRV color
691 Color to use to display reverse video text. If unspecified, the
692 text will be displayed as reverse video.
693 colorUL color
695 Color to use to display underlined text. If unspecified, the text
696 will be displayed as underlined.
697 cursorColor2 color
699 Second color of cursor.
700 cutChars string
702 String containing all characters to be treated as one word for dou‐
703 ble click selection. If you want double clicks to select URL's,
704 then set this to a string containing all letters (both upper and
705 lower case), digits and punctuation you find in urls.
706 deleteKey string
708 The string to send when the delete key (not the keypad delete key)
709 is pressed. If unset it will send the sequence traditionally asso‐
710 ciated with the Execute key.
711 focusDelay msec
713 The time interval (in mili-seconds) to wait after getting / losing
714 focus, before fading the colors and changing the background color
715 as specified by the -fade and -ufbg options. Set it to 0 if you
716 want your colors faded immediately on focus change events.
717 This option is there mainly to work around a bug in some window
719 managers which send focus in immediately followed by focus out
720 events when moving windows, or pressing Alt+Tab (e.g. fvwm-2.5.16).
721 fontN font
723 Specify the alternative font n. n can be 1, 2, 3, 4 or 5.
724 greektoggle_key keysym
726 Key to toggle into greek keyboard mapping. See README.greek for
727 details.
728 highlightColor color
730 Color to use for selection. If not specified, reverse video is
731 used. (Note blinking text is also displayed with this color).
732 mapAlert True|False
734 If true, de-iconifies the window when a bell is received.
735 mfontn font
737 Specify alternative multiple character font n.
738 pointerBlankDelay delay
740 Delay (ms) to blank pointer after.
741 printPipe cmd
743 Specify a command pipe for vt100 printer.
744 refreshLimit N
746 This option and skipPages are to be used to replace the ‘jump
747 scroll’ behaviour of other terminal emulators (and previous version
748 of mrxvt). Generally when data is available from a tab, mrxvt
749 reads as much of it as is available (up to our buffer size), and
750 process it. After we are done processing it (generally takes a
751 fraction of a mili-second), we look for more data from the tab. If
752 we obtain not more than N characters, then we request a screen
753 refresh (which takes a while, especially if you use Xft with anti
754 aliasing). If we obtain more than N characters from the tab, then
755 we delay the screen refresh until the tab eventually has either N
756 or fewer characters of output, or the tab has (cumulatively) pro‐
757 duced at least skipPages of data.
758 The default value is 0. On new fast machines, this is probably the
760 best. If you find screen refreshes laggy on on slow older machines,
761 then increase this value a little (say to 10). Setting it to some‐
762 thing enormous (say BUFSIZ) will cause mrxvt to request screen
763 refreshes every time the active tab has data, and effectively dis‐
764 able the so called ‘jump scrolling’.
765 scrollColor color
767 Color of scrollbar (see also troughColor).
768 selectStyle mode
770 Set mouse selection style to old which is 2.20, oldword which is
771 xterm style with 2.20 old word selection, or anything else which
772 gives xterm style selection.
773 skipPages N
775 This option and refreshLimit are to be used to replace the ‘jump
776 scroll’ behaviour of other terminal emulators (and previous version
777 of mrxvt). If the screen refresh is delayed because of the
778 refreshLimit option, then mrxvt will refresh the screen every N
779 pages of output. The default is 25. If you set it to a very large
780 value (say INT_MAX), then mrxvt will refresh the screen only after
781 the tab has stopped ‘flat out’ scrolling.
782 smartResize True|False
784 Enable / disable smart resize. When the tabbar is shown, or font
785 size is increased, the resize terminal window could be partially
786 off screen. If smartResize is enabled, then mrxvt tries to move the
787 terminal window to stay on screen.
788 smoothResize True|False
790 Enable / disable smooth resize. If enabled, then the mrxvt window
791 is resized in pixel increments (instead of character increments).
792 This is useful if you want a full screen / maximized mrxvt window
793 that covers the entire screen (without leaving an annoying few
794 pixel wide strip uncovered).
795 troughColor
797 Color of scrollbar trough (see also scrollColor).
798
800 A line in the config file generally looks like this
801 ClassName.OptionName: Value
803 Blank lines, and lines beginning with ‘#’ are ignored (comments).
805 The ClassName is the name specified via the -name option (by default
807 ‘mrxvt’). When mrxvt starts up, it ONLY reads options with ClassName
808 ‘Mrxvt’, ‘XTerm’, or the class specified via the -name option. See
809 /etc/mrxvt/mrxvtrc.sample for how this feature can be used.
810 The OptionName is the long name of the option you want to set. It can be
812 any long option (listed under the Long Options sub section), or is speci‐
813 fied in brackets as [option_name] alongside regular options in this man
814 page. Finally Value is the value of this option.
815 Example
817 The following is an example ~/.mrxvtrc file, or in a configuration file
818 you will load with -cf option at startup. You can consult the
819 doc/mrxvtrc.sample in the directory for more details.
820 Mrxvt.profile0.tabTitle: term1
822 Mrxvt.profile1.tabTitle: term2
823 Mrxvt.profile2.tabTitle: term3
824 Mrxvt.profile0.saveLines: 600
825 Mrxvt.profile1.saveLines: 600
826 Mrxvt.profile2.saveLines: 600
827 # Mrxvt.profile0.Pixmap: /home/images/vt0bg.xpm
828 # Mrxvt.profile1.Pixmap: /home/images/vt1bg.xpm
829 # Mrxvt.profile2.Pixmap: /home/images/vt2bg.xpm
830 Mrxvt.scrollbarStyle: next
831 Mrxvt.initTermNumber: 3
832 Mrxvt.transparent: True
833 Mrxvt.transparentScrollbar: True
834 Mrxvt.transparentTabbar: False
835 Mrxvt.transparentMenubar: False
836 Mrxvt.tintColor: #ffffff
837 Mrxvt.shading: 85
838 Mrxvt.foreground: white
839 Mrxvt.background: black
840
842 The menu system is similar to rxvt's menus (see the included file
843 rxvtRef.txt) with a few enhancements, and a few notable exceptions:
844 - The menus can use a proportionally spaced font under Xft ( -xftpfn)
846 which is significantly less ugly than a mono-spaced font.
847 - mrxvt supports pop-up menus. If you create a menu named PopupButtonN
849 (where N is 1, 2, or 3) then that menu is popped up when you control
850 click (with the appropriate mouse button) on the terminal window.
851 Additionally if you right click on the Tab bar, then the menu
852 PopupButton1 is popped up.
853 - To create a menu containing a list of all open tabs, create an empty
855 menu called PopupButtonN (which will be popped on control click's as
856 described above). To include a list of all open tabs as a sub menu,
857 create a sub-menu called ‘Switch to tab’.
858 - Menu actions are completely different in mrxvt than the original imple‐
860 mentation in rxvt(1). The menu actions are exactly the same as macro
861 actions, and are described in the section Defining custom shortcuts.
862 - On startup mrxvt reads the file default.menu which contains the default
864 menu definitions. The file is searched for in your search path (speci‐
865 fied by option -path).
866
868 You have several default keyboard shortcuts to ease the use of mrxvt. The
869 default gnome-terminal, Konsole, rxvt shortcuts are predefined for you.
870 You can also define your own shortcuts as described in Defining custom
871 shortcuts.
872 Default keyboard shortcuts
874 The following key combinations are defined by default. These are defined
875 in the system configuration file /etc/mrxvt/mrxvtrc, and can be disabled
876 using the option -nsc. See the next section for instructions on defining
877 your own custom keyboard shortcuts.
878 Gnome-terminal style shortcuts:
880 Ctrl+Shift+t create a new tab
881 Ctrl+Shift+q Close all tabs and exit
882 Ctrl+Shift+w Close active tab, and do not hold it open if it
883 exits abnormally.
884 Ctrl+PgUp activate left tab
885 Ctrl+PgDn activate right tab
886 Meta+1 activate 1st tab
887 ...
888 Meta+0 activate 10th tab
889 Ctrl+equal increase font size (next font)
890 Ctrl+Shift+plus increase font size by 2
891 Ctrl+minus decrease font size (previous font)
892 Ctrl+Shift+underscore
893 decrease font size by 2
894 Konsole style default shortcuts:
896 Ctrl+Shift+Left move active tab to left
897 Ctrl+Shift+Right: active tab to right
898 Shift+Left Activate left tab (Primary only)
899 Shift+Right Activate right tab (Primary only)
900 Ctrl+Shift+n Create a new tab with the same profile as the
901 current tab.
902 Vi style default shortcuts:
904 Ctrl+Shift+h activate left tab
905 Ctrl+Shift+l activate right tab
906 Screen style default shortcuts:
908 Ctrl+Shift+p activate previous active tab
909 Mrxvt default shortcuts:
911 Ctrl+Shift+1 Move tab to 1st position
912 ...
913 Ctrl+Shift+0 Move tab to 10th position
914 Ctrl+Tab activate previous active tab
915 Ctrl+Shift+less_than
916 Move active tab left
917 Ctrl+Shift+greater_than
918 Move active tab right
919 Ctrl+Shift+o Change opacity of terminal to make it more trans‐
920 parent.
921 Ctrl+Shift+u Change opacity of terminal to make it less trans‐
922 parent.
923 Ctrl+Shift+j Change shading of terminal to make it more trans‐
924 parent.
925 Ctrl+Shift+k Change shading of terminal to make it less trans‐
926 parent.
927 Ctrl+Shift+r Toggle psdudo-transparency
928 Ctrl+Shift+i Hide/show tabbar
929 Ctrl+Shift+s Hide/show scrollbar
930 Ctrl+Shift+m Hide/show menubar
931 Ctrl+Shift+a Hide/show tabbar buttons
932 Ctrl+Shift+b Toggle very bold font
933 Ctrl+Shift+d Toggle input broadcasting (unbound by default)
934 Ctrl+Shift+e Toggle holding exited tab
935 Ctrl+Shift+f Toggle full screen mode
936 Ctrl+Shift+x Save current configuration
937 Shift+Del Set title of active tab to selection.
938 Shift+Insert Paste X selection into active tab.
939 Ctrl+Shift+v Paste X selection into active tab.
940 Shift+Up Scroll up one line (Primary screen only)
941 Shift+Dn scroll down one line (Primary screen only)
942 Shift+PgUp scroll up one page (Primary screen only)
943 Shift+PgDn scroll down one page (Primary screen only)
944 Shift+Home Scroll to beginning of scroll-back buffer (Pri‐
945 mary screen only)
946 Shift+End Scroll to end of scroll-back buffer (Primary
947 screen only)
948 Shift+KeypadPlus Increase font size
949 Shift+KeypadMinus Decrease font size
950 Shift+Enter Clear the scroll back buffer, and send "Ctrl+M"
951 to the child process. When running a shell, this
952 clears the scroll back buffer and executes the
953 current command. (Primary screen only).
954 Ctrl+Shift+F1 Open mrxvt man page in a new tab.
955 Ctrl+Shift+F12 Enable / disable all keyboard macros (except this
956 one of course).
957 Defining custom shortcuts
959 NOTE: The ‘hotkey’ mechanism used in versions 0.4.2 and earlier is now
960 obsolete. It has been replaced by the ‘macro’ functionality (described
961 below) as of version 0.5.0.
962 You can define your own keyboard shortcuts in your configuration file by
964 using the following syntax:
965 Mrxvt.macro.[modifiers+]keyname: action
967 Here ‘modifiers’ is a ‘+’ separated list of modifiers ‘Ctrl’, ‘Alt’,
969 ‘Meta’, ‘Shift’. ‘Primary’. and ‘Add’. The first four refer to the
970 respective modifier keys. ‘Primary’ tells mrxvt to make the macro avail‐
971 able ONLY when the primary screen is displayed (e.g. ‘Primary’ macros
972 will not be effective when you are running vim(1), but will be effective
973 when you are at the shell prompt). Finally ‘Add’ tells mrxvt to add the
974 macro action to any previous action associated to that particular key.
975 For instance
976 Mrxvt.macro.Primary+Shift+Return: Esc \ec
978 Mrxvt.macro.Primary+Add+Shift+Return: Str ^M
979 will define the macro ‘Shift+Return’ to first send the escape sequence
981 ‘\ec’ to mrxvt (which has the effect of clearing the scroll back buffer)
982 and then send ‘Ctrl-M’ to the child process, but ONLY in the primary
983 screen. If you're running a shell, then this effectively clears the
984 scroll back buffer and executes the command.
985 If the ‘Add’ modifier is not specified, then the macro action replaces
987 any previous action (if any) associated to the specified key. It is an
988 error to add a macro to a non-existing macro. Currently one key can have
989 at most 16 actions associated to it (this might be reduced to 8 in
990 future).
991 ‘keyname’ is the name of the key you want to bind to the specified macro.
993 Non alpha numeric keys (e.g. punctuation, or cursor/keypad keys) are
994 specified by using their keyname, which you can find by xev(1), or look‐
995 ing directly in the system header file /usr/include/X11/keysymdef.h.
996 In case you want to unbind a default keyboard macro, just bind the appro‐
998 priate key to the function ‘Dummy’. For example
999 Mrxvt.macro.Ctrl+Shift+t: Dummy
1001 will disable the default keyboard shortcut ‘Ctrl+Shift+t’. If you want
1003 to disable all keyboard macros, use the option ‘-dm’ (which can also be
1004 accessed via a pop-up menu). The default keyboard macros are defined in
1005 the system configuration file /etc/mrxvt/mrxvtrc so if you only want to
1006 disable all default shortcuts keys, don't read the system configuration
1007 file by using the -nsc option.
1008 Notice that keyboard shortcuts definitions are incompatible with X Win‐
1010 dows own resource parsing API, i.e., XGetDefaults. So, to enable the key‐
1011 board shortcuts, you will need to enable resources but disable xgetde‐
1012 fault when you configure mrxvt.
1013 Finally ‘action’ is the action you want bound to the specified macro key.
1015 The available actions you can bind to macros are:
1016 Dummy
1018 Clear an existing keyboard shortcut
1019 Esc str
1021 Send the escape sequence str to mrxvt.
1022 Str str
1024 Send the string str to the child process.
1025 Exec command
1027 Executes command asynchronously. The command run without any
1028 controlling shell or TTY. This is generally used to launch X11
1029 programs (e.g. open the selected text in firefox). If you want
1030 a command run in a new tab, see the NewTab macro).
1031 The argument command is word split exactly as described in the
1033 -blc option (thus for instance beginning it with ‘!’ will pass
1034 it to /bin/sh -c for word splitting and execution). However
1035 keep in mind that like all macro arguments, command is first
1036 ‘\’ interpolated. Thus if on the rare occasion you want ‘\ ’ to
1037 be part of command, then you will have to do something like
1038 ‘\\\\\\ ’ and not ‘\\\ ’ as you would with the argument of
1039 -blc.
1040 NewTab [-N] ["title"] [[!]command]
1042 Open a new tab. N specifies the profile number. If omitted,
1043 profile 0 is used. If only ‘-’ (with no number) is specified,
1044 then the profile of the current active tab is used (i.e. this
1045 can be used to duplicate the current tab). title is specified
1046 (needs to be double quoted), use that for the tab title. If
1047 command is specified, execute that command in the new tab
1048 (instead of the one specified by the resource file, or the
1049 shell).
1050 command is word split as described in the Exec macro. However
1052 if command begins with an ‘!’ then run a shell first, and exe‐
1053 cute the command in the shell as if the user had typed command
1054 at the shell prompt. If instead you want command to be passed
1055 to /bin/sh -c for word splitting and execution, then begin
1056 command with ‘\!’.
1057 Close [N]
1059 Close a tab. If no argument is specified, close all tabs and
1060 exit. If N is 0, close the active tab. Otherwise close the Nth
1061 tab.
1062 GotoTab [N]
1064 Goto tab. If N is ommited or 0, then goto the previous active
1065 tab. Otherwise goto the Nth tab. If N begins with a ‘+’ or ‘-’
1066 then N is relative to the current tab.
1067 MoveTab N
1069 Move active tab to position N. If N begins with a ‘+’ or ‘-’
1070 then N is relative to the current tab.
1071 Scroll amount
1073 Scroll the active tab by amount lines (negative values mean
1074 scroll backward). If amount ends with ‘p’ then scroll amount
1075 pages instead of lines.
1076 Copy Copy selection into clipboard (not implemented).
1078 Paste
1080 Pasete selection into active tab.
1081 ToggleSubwin [[+|-][b|m|s|t]]
1083 Toggle visibility of sub-windows. If the argument begins with a
1084 ‘+’ the subwindow is shown. If it begins with a ‘-’ the subwin‐
1085 dow is hidden. Otherwise it is toggled. The letters ‘b’, ‘m’,
1086 ‘s’ and ‘t’ represent the tabbar buttons, menubar, scrollbar
1087 and tabbar respectively. NOTE: Currently you can only toggle
1088 one subwindow at a time.
1089 ResizeFont [+|-]N
1091 Resize the font. With Xft, N represents the size increment of
1092 the xft font. Without Xft, N represents the index of the X11
1093 fonts specified by the fontN resources.
1094 ToggleVeryBold
1096 Toggle use of bold font for colored text.
1097 ToggleTransparency
1099 Toggle pseudo transparency.
1100 ToggleBroadcast
1102 Toggle broadcasting of input to all tabs.
1103 ToggleHold [mask]
1105 If mask is not specified, then just close all tabs who's child
1106 processes have exited. (This is almost compatible with the be‐
1107 haviour of mrxvt 0.5.1 and earlier). If mask is specified, then
1108 change the hold status of the current tab. mask must begin
1109 with ‘+’, ‘-’, or ‘!’ and be followed by a bit mask (as in the
1110 holdExit option). ‘+’ will add bits to the holdExit option for
1111 this tab, ‘-’ will subtract, and ‘!’ will toggle. Remember that
1112 if the lowest bit of the current tabs holdExit option is set,
1113 then the tab will always be held open and everything else will
1114 be ignored.
1115 ToggleFullscreen
1117 Toggle between full screen and regular mode. Also enable
1118 --smoothResize to get true full screen. This will only work if
1119 you are running an EWMH compatible window manager (e.g. Fvwm /
1120 OpenBox / KDE / Gnome).
1121 SetTitle
1123 Set title of active tab to selection. (The selection must be
1124 owned by mrxvt)
1125 PrintScreen [-psn] [command]
1127 Dump screen to printer (or command). If -p is specified, then
1128 the output is pretty printed (i.e. escape sequences are used to
1129 get the same color in the output as on your screen). If -s is
1130 specified, then the entire scroll back is printed (instead of
1131 just the current screen). If -n is specified, then every screen
1132 line is terminated with a newline char (by default screen lines
1133 that wrap to the next line are not terminated with a newline).
1134 Finally, if command is specified it is used as the printer pipe
1135 (if not the value of printPipe or the compiled in default is
1136 used).
1137 SaveConfig [filename]
1139 Save config to file. If no filename is specified, save to
1140 ~/.mrxvtrc.save.
1141 ToggleMacros
1143 Toggle the use of keyboard shortcuts. When macros are disabled
1144 (either by using this macro, or by the -dm option), then this
1145 is the only keyboard shortcut that will work. Thus you can re-
1146 enable your keyboard shortcuts via the keyboard using this
1147 function.
1148 Additionally, the argument to any of the above macros are ‘\’ and ‘%’
1150 interpolated as follows:
1151 \a Bell
1153 \b Backspace
1154 \E, \e Escape
1155 \n Newline
1156 \r Carriage return
1157 \t Tab
1158 \ddd Char with octal ASCII code ddd.
1159 ^@, ^A .. ^Z .. ^_, ^?
1160 Control-@, Control-A ...
1161 %p PID of child process in current tab.
1163 %n Tab number.
1164 %N Expands to ‘normally’ if the process exited normally (e.g.
1165 by calling exit(1)) or ‘abnormally’ otherwise. (Note this
1166 is independent of the exit status).
1167 %s Text selected in the mrxvt window.
1168 %S If the process in this tab is dead, then it expands to the
1169 exit status of the child process. Otherwise left unchanged.
1170 %t Tab title.
1171 Mouse shortcuts
1173 Changing tab titles
1174 This mouse shortcut can be used to dynamically change the tab title
1175 as follows: Select text in the terminal window. Then middle click
1176 on a tab to change the tab's title. If you middle click on the tab‐
1177 bar background, then the title of the active tab is changed.
1178 Tab list menu
1180 By default, if you right click on the tab bar, or control-left-
1181 click on the terminal window, a popup menu with a list of currently
1182 open tabs pops up. The actual menu popped up can be customized as
1183 described under the section MENUS.
1184 Popup menus
1186 If you Control-click on the terminal window (with any mouse but‐
1187 ton), it pops up a menu. The actual menu popped up can be custom‐
1188 ized as described under the section MENUS.
1189 Moving tabs
1191 Click and drag a tab to some other location on the tab-bar to move
1192 it.
1193
1195 You have several escape sequences to control mrxvt. All default rxvt(1)
1196 escape sequences are supported by mrxvt. A few extra escape sequences
1197 have been added to improve DEC compatibility, and allow interaction with
1198 extra mrxvt features (e.g. tabs). The supported escape sequences are
1199 listed in the file mrxvt_seq.txt included in the distribution.
1200 For omissions in the documentation, and a more complete reference to
1202 escape sequences you should look at the file ctlseqs.txt that comes with
1203 the xterm package, console_codes(4) and the original rxvt documentation
1204 in the file rxvtRef.txt.
1205 For basic interaction with mrxvt (e.g. changing the tab title etc.) you
1207 should also look at the programs share/scripts/settitle.c and
1208 share/scripts/mrxvtset.pl that are supplied with the mrxvt distribution.
1209
1211 COLORFGBG
1212 Set to the terminal foreground and background colors.
1213 COLORTERM
1215 Sets to the terminal sub-name that indicates its color.
1216 DISPLAY
1218 Used (and set) to the X display bieng used.
1219 PATH_ENV
1221 Path to look for menu / background files (see -path option).
1222 TERM Set to the terminal name in the window you have created.
1224 MRXVT_TABTITLE
1226 Set to the initial tab title of each terminal. Notice that its
1227 value will not be altered if the user uses a shortcut or escape
1228 sequence to change the tab title. The user must modify it manually
1229 after doing that.
1230 WINDOWID
1232 Set to the X window id number of the mrxvt window.
1233
1235 The actual pathnames given may differ on your system.
1236 default.menu
1238 The default menu file loaded at startup (searched for in your
1239 -path).
1240 ~/mrxvt
1242 Directory in which to look for user menu and image files.
1243 ~/.mrxvtrc
1245 This is the default configuration file (since 0.3.9). If present,
1246 resources read from this file override existing resources.
1247 ~/.Xdefaults
1249 (OBSOLETE) This was the default configuration file (before 0.3.9).
1250 If present, resources read from this file override existing
1251 resources.
1252 ~/.Xresources
1254 (OBSOLETE) If both .mrxvtrc and .Xdefaults are not found, try this
1255 one.
1256 /etc/mrxvt
1258 System wide directory in which to look for user menu and image
1259 files.
1260 /etc/mrxvt/default.menu
1262 Default menu file read on startup.
1263 /etc/mrxvt/mrxvtrc
1265 System wide configuration file. (By default this file only defines
1266 the default keyboard macros)
1267 /etc/utmp
1269 System file for login records.
1270 /usr/lib/X11/rgb.txt
1272 Color names.
1273 /usr/X11R6/lib/X11/app-defaults/XTerm
1275 (OBSOLETE) If enable xgetdefaults at compiled time, this is the
1276 first configuration file read.
1277
1279 Reporting bugs
1280 Please report bugs using the sourceforge bug tracker system at
1281 http://sourceforge.net/projects/materm
1283 Alternately you can send your bug report to the mrxvt developer mailing
1285 list at
1286 materm-devel@lists.sourceforge.net
1288 Be sure you give us enough details to reproduce the bug ourselves, and
1290 check to see if your bug still exists in the current CVS version.
1291 Known bugs
1293 - Tabs don't work properly when running under Xnest.
1294 - Transparency and tinting are global, not specific to a terminal.
1295 - The transparentForce option does not work well with all window managers
1296 (e.g. OpenBox).
1297
1299 rxvt(1), xterm(1), resize(1), mrxvt_seq.txt, Xterm control sequences
1300 (this is the file ctlseqs.ms or ctlseqs.txt), console_codes(4)
1301 http://materm.sourceforge.net
1303
1305 Terminator <jimmyzhou@users.sourceforge.net>
1306 Gautam Iyer <gi1242@users.sourceforge.net>
1307X Version 11 January 10, 2006 X Version 11