1 '\" te

     2 .TH mrxvt 1 mrxvt\-0.5.3 

     3 .SH NAME

     4 \fBmrxvt\fP

     5 \- A tabbed VT102 terminal emulator for X Window System

     6 .SH SYNOPSIS

     7 .br

     8 \fBmrxvt\fP

     9 [options]

    10 [\fB\-e\fP \fIcmd\fP]

    11 .SH DESCRIPTION

    12 

    13 The

    14 \fBmrxvt\fP

    15 program is a terminal emulator for X Window System. It provides

    16 Tn DEC VT102

    17 compatible terminals for programs that cannot use the window system directly.

    18 

    19 \fBmrxvt\fP

    20 is based on

    21 \fBrxvt\fP(1)

    22 version 2.7.11 CVS, and features most of functionality

    23 of rxvt, with a few major enhancements (namely multiple tabs, and transparency). Like rxvt,

    24 \fBmrxvt\fP

    25 aims to be light, fast, flexible and desktop independent, thus KDE or GNOME are not required.

    26 

    27 The primary features of

    28 \fBmrxvt\fP

    29 include (but are not limited to) multiple tabs, dynamically changeable tab titles, customisable 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.

    30 

    31 The default

    32 \fBmrxvt\fP

    33 behaviour can be set using the resource configuration file

    34 \fI~/.mrxvtrc\fP.

    35 For backward compatibility, if

    36 \fI~/.mrxvtrc\fP

    37 is not found,

    38 \fBmrxvt\fP

    39 tries to load configuration settings from the files

    40 \fI~/.Xdefaults\fP

    41 or

    42 \fI~/.Xresources\fP.

    43 Alternately, you can specify which config file to load using the

    44 \fB\-cf\fP

    45 command line option.

    46 .SH OPTIONS

    47 

    48 This section describes the commandline options

    49 \fBmrxvt\fP

    50 accepts. To disable an option, prefix it with an

    51 `\fI+\fP'

    52 instead of a

    53 `\fI-\fP'

    54 Most options can be set from your

    55 \fI~/.mrxvtrc\fP

    56 file using the option name listed in brackets as

    57 [\fBoption_name\fP.]

    58 The option name can also be used as a "long option" from the command line (i.e. by prefixing it with 

    59 `\fI--\fP'

    60 or

    61 `\fI++\fP'

    62 as appropriate. For example

    63 mrxvt -tr -shade 85 +trt

    64 is the same as

    65 mrxvt --transparent --shading 85 ++transparentTabbar

    66 which is the same as putting the lines

    67 Mrxvt.transparent:		True

    68 Mrxvt.shading:			85

    69 Mrxvt.transparentTabbar:	False

    70 in your

    71 \fI~/.mrxvtrc\fP.

    72 

    73 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

    74 \fBrxvt\fP(1)

    75 and

    76 \fBxterm\fP(1)

    77 manpages.

    78 .SS Terminal name and display options

    79 

    80 .TP

    81 \fB\-display\fP|\fB\-d\fP \fIdisplayname\fP

    82 X display name, the X server to contact

    83 .TP

    84 \fB\-geometry\fP|\fB\-g\fP \fIgeometry\fP

    85 geometry at startup

    86 [\fBgeometry\fP]

    87 .TP

    88 \fB\-ic\fP \fIfile\fP[;\fIgeometry\fP]

    89 application icon file.

    90 [appIcon]

    91 start iconic

    92 [\fBiconic\fP]

    93 .TP

    94 \fB\-in\fP \fIname\fP

    95 Icon name for window

    96 [\fBiconName\fP]

    97 .TP

    98 \fB\-into\fP \fIWinID\fP

    99 If given an X window identifier,

   100 \fBmrxvt\fP

   101 will reparent its top-level shell widget to that window.

   102 This is used to embed

   103 \fBmrxvt\fP

   104 within other applications.

   105 .TP

   106 \fB\-name\fP \fIname\fP

   107 Client instance, icon, and title strings

   108 [\fBclientName\fP.]

   109 .TP

   110 \fB\-title\fP \fIstring\fP

   111 title name of the window

   112 [\fBtitle\fP]

   113 .TP

   114 \fB\-tn\fP \fItermname\fP

   115 The type of terminal

   116 \fBmrxvt\fP

   117 should emulate. The value of the TERM environment variable is set to this value for all child processes launched by

   118 \fB.\fP

   119 Note that rxvt and most rxvt clones including 

   120 \fBNs\fP,

   121 have slightly different terminal capabilities than those of xterm(1). Thus

   122 \fBNs\fP

   123 will not always work properly with the terminal set to

   124 \fIxterm\fP,

   125 and we recommend setting this value to

   126 \fIrxvt\fP

   127 instead. However some systems have incorrect (or even missing) terminfo(1) or termcap(1) entries for the terminal

   128 \fIrxvt\fP.

   129 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

   130 \fIxterm\fP

   131 and hope everything works properly.

   132 [\fBtermName\fP]

   133 .SS Transparency related options

   134 

   135 .TP

   136 \fB\-o\fP \fI%d\fP

   137 Translucent window (true transparent) background opacity degree.

   138 \fI%d\fP

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

   140 [\fBopacity\fP]

   141 .TP

   142 \fB\-od\fP %d

   143 Translucent window opacity degree increase/decrease interval.

   144 \fI%d\fP

   145 is an integer between 0 and 100

   146 [\fBopacityDegree\fP]

   147 Enable / disable background pseudo-transparency. To use this feature you must set your desktop wallpaper using an Esetroot compatible program ( i.e. a program that publishes the wallpaper using the

   148 Tn _XROOTPMAP_ID

   149 atom). Some programs that will do this are

   150 \fBEsetroot\fP(1),

   151 \fBfeh\fP(1),

   152 \fBfvwm-root\fP(1)

   153 with the

   154 `\fB--retain-pixmap\fP'

   155 option, or KDE. Note: To use your precious

   156 \fBbackgroundFade\fP, tinting

   157 or

   158 \fBshading\fP

   159 options, you MUST set the desktop wallpaper in an Esetroot way.

   160 [\fBtransparent\fP]

   161 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

   162 \fBtransparent\fP

   163 option). Background changes made by FvwmBacker, xsetbg (xli) or Esetroot compatible programs, will be automatically detected. However changes made by

   164 \fBxv\fP(1),

   165 \fBxsetroot\fP(1)

   166 or other non-Esetroot compatible programs will not be detected. If you're hell bent on non-Esetroot compatible programs to set your background, then do something like

   167 xsetroot -solid "#202040" && fvwm-root -d

   168 Note: To use your precious

   169 \fBbackgroundFade\fP, tinting

   170 or

   171 \fBshading\fP

   172 options, you MUST set the desktop wallpaper in an Esetroot way.

   173 [\fBtransparentForce\fP]

   174 Enable / disable pseudo-transparent menubar. Pseudo-transparency must be turned on.

   175 [\fBtransparentMenubar\fP]

   176 Enable / disable pseudo-transparent scrollbar. Pseudo-transparency must be turned on.

   177 [\fBtransparentScrollbar\fP]

   178 Enable / disable pseudo-transparent tabbar. Pseudo-transparency must be turned on.

   179 [\fBtransparentTabbar\fP]

   180 .SS Background image related options

   181 

   182 .TP

   183 \fB\-mbpixmap\fP \fIfile\fP[;\fIgeometry\fP]

   184 Menubar background image. Pseudo-transparency must be turned off.

   185 [\fBmenubarPixmap\fP]

   186 .TP

   187 \fB\-pixmap\fP \fIfile\fP[;\fIgeometry\fP]

   188 Background image for all terminals if not set individually. Pseudo-transparency must be turned off.

   189 [\fBPixmap\fP]

   190 .TP

   191 \fB\-sbpixmap\fP \fIfile\fP[;\fIgeometry\fP]

   192 Scrollbar background image. Pseudo transparency must be turned off.

   193 [\fBscrollbarPixmap\fP]

   194 .TP

   195 \fB\-tbpixmap\fP \fIfile\fP[;\fIgeometry\fP]

   196 Tabbar background image. Pseudo transparency must be turned off.

   197 [\fBtabbarPixmap\fP]

   198 Apply tabbar background image to tabs.

   199 [\fBtabUsePixmap\fP]

   200 .SS Scrolling related options

   201 

   202 scroll one page when press mouse wheel button

   203 [\fBmouseWheelScrollPage\fP]

   204 .TP

   205 \fB\-sa\fP \fImode\fP

   206 Scrollbar alignment (

   207 \fItop\fP | \fIbottom\fP )

   208 [\fBscrollbarAlign\fP]

   209 Hide / show scrollbar

   210 [\fBscrollBar\fP]

   211 .TP

   212 \fB\-sbt\fP \fIwidth\fP

   213 Scrollbar thickness/width

   214 [\fBscrollbarThickness\fP]

   215 Inhibit scrolling on tty output.

   216 [\fBscrollTtyOutputInhibit\fP]

   217 scroll-on-keypress

   218 [\fBscrollTtyKeypress\fP]

   219 .TP

   220 \fB\-sl\fP \fIn\fP

   221 The number of scrolled lines to save (for all tabs) if not set individually. The maximal number of saved lines is 65535.

   222 [\fBsaveLines\fP]

   223 Scrollbar on right

   224 [\fBscrollbarRight\fP]

   225 .TP

   226 \fB\-ss\fP \fImode\fP

   227 Scrollbar style.

   228 \fImode\fP

   229 should be one of

   230 \fIplain\fP, xterm , rxvt , next

   231 or

   232 \fIsgi\fP.

   233 [\fBscrollbarStyle\fP]

   234 Draw floating scrollbar (i.e. without a trough).

   235 [\fBscrollbarFloating\fP]

   236 Scroll synchronusly with buffer. Normally

   237 \fBNs\fP

   238 does not keep the screen completely up to date while scrolling. This allows

   239 \fBNs\fP

   240 to run faster when network latencies are very high and is typically useful when running across a very large internet or many gateways.

   241 [\fBscrollWithBuffer\fP]

   242 .SS Color related options

   243 

   244 .TP

   245 \fB\-bg\fP \fIcolor\fP

   246 Background color

   247 [\fBbackground\fP]

   248 .TP

   249 \fB\-bd\fP \fIcolor\fP

   250 enable X session management

   251 [\fBsessionMgt\fP]

   252 .SS Long options

   253 

   254 The following options do not have a

   255 ``short''

   256 form. If these options are to be used on the command line, they must be prefixed with a

   257 `Em' --

   258 (or

   259 `Em' ++

   260 for boolean options). They can of course be used in the

   261 \fBNs\fP

   262 configuration file.

   263 .TP

   264 \fBanswerBackString\fP \fIstring\fP

   265 Specify the reply

   266 \fBNs\fP

   267 sends to the shell when an ENQ (control-E) character is passed through. It may contain escape values as described in the entry on

   268 \fBkeysym\fP

   269 following.

   270 .TP

   271 \fBbackspaceKey\fP \fIstring\fP

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

   273 .TP

   274 \fBbgRefreshInterval\fP \fIdelay\fP

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

   276 .TP

   277 \fBboldFont\fP\fIN\fP \fIfont\fP

   278 Specifies bold font to use along with fontset

   279 \fIN\fP.

   280 .TP

   281 \fBboldColors\fP \fITrue\fP|\fIFalse\fP

   282 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

   283 \fBveryBright\fP.

   284 .TP

   285 \fBcolor\fP\fIN\fP \fIcolor\fP

   286 Use the specified colour for the colour value

   287 \fIN\fP,

   288 where 0-7 corresponds to low-intensity (normal) colours and 8-15 corresponds to high-intensity colours.

   289 .TP

   290 \fBcolorBD\fP \fIcolor\fP

   291 Color to use to display bold text. If unspecified, the text will be displayed using a bold font / overstrike.

   292 .TP

   293 \fBcolorRV\fP \fIcolor\fP

   294 Color to use to display reverse video text. If unspecified, the text will be displayed as reverse video.

   295 .TP

   296 \fBcolorUL\fP \fIcolor\fP

   297 Color to use to display underlined text. If unspecified, the text will be displayed as underlined.

   298 .TP

   299 \fBcursorColor2\fP \fIcolor\fP

   300 Second color of cursor.

   301 .TP

   302 \fBcutChars\fP \fIstring\fP

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

   304 .TP

   305 \fBdeleteKey\fP \fIstring\fP

   306 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

   307 .B Execute

   308 key.

   309 .TP

   310 \fBfocusDelay\fP \fImsec\fP

   311 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

   312 \fB\-fade\fP

   313 and

   314 \fB\-ufbg\fP

   315 options. Set it to 0 if you want your colors faded immediately on focus change events.

   316 

   317 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).

   318 .TP

   319 \fBfont\fP\fIN\fP \fIfont\fP

   320 Specify the alternative font

   321 \fIn\fP. ncan be 1, 2, 3, 4 or 5.

   322 .TP

   323 \fBgreektoggle_key\fP \fIkeysym\fP

   324 Key to toggle into greek keyboard mapping. See

   325 \fIREADME.greek\fP

   326 for details.

   327 .TP

   328 \fBhighlightColor\fP \fIcolor\fP

   329 Color to use for selection. If not specified, reverse video is used. (Note blinking text is also displayed with this color).

   330 .TP

   331 \fBmapAlert\fP \fITrue\fP|\fIFalse\fP

   332 If true, de-iconifies the window when a bell is received.

   333 .TP

   334 \fBmfont\fP\fIn\fP font

   335 Specify alternative multiple character font

   336 \fIn\fP.

   337 .TP

   338 \fBpointerBlankDelay\fP \fIdelay\fP

   339 Delay (ms) to blank pointer after.

   340 .TP

   341 \fBprintPipe\fP \fIcmd\fP

   342 Specify a command pipe for vt100 printer.

   343 .TP

   344 \fBrefreshLimit\fP \fIN\fP

   345 This option and

   346 \fBskipPages\fP

   347 are to be used to replace the

   348 `jump' scroll

   349 behaviour of other terminal emulators (and previous version of

   350 \fB)\fP.

   351 Generally when data is available from a tab,

   352 \fB)\fP

   353 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

   354 \fIN\fP

   355 characters, then we request a screen refresh (which takes a while, especially if you use Xft with anti aliasing). If we obtain more than

   356 \fIN\fP

   357 characters from the tab, then we delay the screen refresh until the tab eventually has either

   358 \fIN\fP

   359 or fewer characters of output, or the tab has (cumulatively) produced at least

   360 \fBskipPages\fP

   361 of data.

   362 

   363 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

   364 \fB)\fP

   365 to request screen refreshes every time the active tab has data, and effectively disable the so called

   366 `jump' scrolling .

   367 .TP

   368 \fBscrollColor\fP \fIcolor\fP

   369 Color of scrollbar (see also

   370 \fBtroughColor\fP).

   371 .TP

   372 \fBselectStyle\fP \fImode\fP

   373 Set mouse selection style to

   374 \fBold\fP

   375 which is 2.20,

   376 \fBoldword\fP

   377 which is xterm style with 2.20 old word selection, or anything else which gives xterm style selection.

   378 .TP

   379 \fBskipPages\fP \fIN\fP

   380 This option and

   381 \fBrefreshLimit\fP

   382 are to be used to replace the

   383 `jump' scroll

   384 behaviour of other terminal emulators (and previous version of

   385 \fB)\fP.

   386 If the screen refresh is delayed because of the

   387 \fBrefreshLimit\fP

   388 option, then

   389 \fB)\fP

   390 will refresh the screen every

   391 \fIN\fP

   392 pages of output. The default is 25. If you set it to a very large value (say INT_MAX), then

   393 \fB)\fP

   394 will refresh the screen only after the tab has stopped

   395 `flat' out

   396 scrolling.

   397 .TP

   398 \fBsmartResize\fP \fITrue\fP|\fIFalse\fP

   399 Enable / disable smart resize. When the tabbar is shown, or font size is increased, the resize terminal window could be partially off screen. If

   400 \fBsmartResize\fPis enabled, then \fBNo\fP tries to move the terminal window to stay on screen.

   401 .TP

   402 \fBsmoothResize\fP \fITrue\fP|\fIFalse\fP

   403 Enable / disable smooth resize. If enabled, then the \fBNo\fP window is resized in pixel increments (instead of character increments). This is useful if you want a full screen / maximized \fBNo\fP window that covers the entire screen (without leaving an annoying few pixel wide strip uncovered).

   404 .TP

   405 \fBtroughColor\fP

   406 Color of scrollbar trough (see also

   407 \fBscrollColor\fP).

   408 .TP

   409 \fBuseFifo\fP \fITrue\fP|\fIFalse\fP

   410 If enabled, then mrxvt will create a

   411 \fBfifo\fP(7)Pa

   412 and listen for macros on it. To execute macros, just write them to this fifo. For example

   413 /bin/echo -e "NewTab\enRaise" >> /tmp/.mrxvt-%pid

   414 creates a new tab and raises the

   415 \fBNo\fP

   416 window with process ID

   417 .IR %pid .

   418 .B NOTE:

   419 The meaning and syntax of this option might change in future versions.

   420 .TP

   421 \fBveryBright\fP \fITrue\fP|\fIFalse\fP

   422 If true, and if

   423 \fBboldColors\fP

   424 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).

   425 .SH CONFIGURATION FILE SYNTAX

   426 

   427 A line in the config file generally looks like this

   428 ClassName.OptionName:	Value

   429 Blank lines, and lines beginning with

   430 `Em' #

   431 are ignored (comments).

   432 

   433 The ClassName is the name specified via the

   434 \fB\-name\fP

   435 option (by default

   436 `Em' mrxvt ) .

   437 When

   438 \fBNo\fP

   439 starts up, it ONLY reads options with ClassName

   440 `Em' Mrxvt ,

   441 `Em' XTerm ,

   442 or the class specified via the

   443 \fB\-name\fP

   444 option. See

   445 \fI/etc/mrxvt/mrxvtrc.sample\fP

   446 for how this feature can be used.

   447 

   448 The OptionName is the long name of the option you want to set. It can be any long option (listed under the

   449 .B "Long Options"

   450 sub section), or is specified in brackets as

   451 [\fBoption_name\fP]

   452 alongside regular options in this man page. Finally Value is the value of this option.

   453 

   454 .SS Example

   455 

   456 The following is an example

   457 \fI~/.mrxvtrc\fP

   458 file, or in a configuration file you will load with 

   459 \fB\-cf\fP

   460 option at startup. You can consult the

   461 \fIdoc/mrxvtrc.sample\fP

   462 in the directory for more details.

   463 Mrxvt.profile0.tabTitle:        term1

   464 Mrxvt.profile1.tabTitle:        term2

   465 Mrxvt.profile2.tabTitle:        term3

   466 Mrxvt.profile0.saveLines:       600

   467 Mrxvt.profile1.saveLines:       600

   468 Mrxvt.profile2.saveLines:       600

   469 # Mrxvt.profile0.Pixmap:        /home/images/vt0bg.xpm

   470 # Mrxvt.profile1.Pixmap:        /home/images/vt1bg.xpm

   471 # Mrxvt.profile2.Pixmap:        /home/images/vt2bg.xpm

   472 Mrxvt.scrollbarStyle:           next

   473 Mrxvt.initTermNumber:           3

   474 Mrxvt.transparent:              True

   475 Mrxvt.transparentScrollbar:     True

   476 Mrxvt.transparentTabbar:        False

   477 Mrxvt.transparentMenubar:       False

   478 Mrxvt.tintColor:                #ffffff

   479 Mrxvt.shading:                  85

   480 Mrxvt.foreground:               white

   481 Mrxvt.background:               black

   482 .SH MENUS

   483 

   484 The menu system is similar to rxvt's menus (see the included file

   485 \fIrxvtRef.txt\fP)

   486 with a few enhancements, and a few notable exceptions:

   487 The menus can use a proportionally spaced font under Xft (

   488 \fB\-xftpfn\fP )

   489 which is significantly less ugly than a mono-spaced font.

   490 \fBNo\fP

   491 supports pop-up menus. If you create a menu named

   492 \fBPopupButton Ns \fIN\fP No (where \fIN\fP 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.\fP

   493 To create a menu containing a list of all open tabs, create an empty menu called

   494 \fBPopupButton Ns \fIN\fP\fP

   495 (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

   496 `Switch' to tab .

   497 Menu actions are completely different in

   498 \fBNo\fP

   499 than the original implementation in

   500 \fBrxvt\fP(1).

   501 The menu actions are exactly the same as macro actions, and are described in the section

   502 .B "Defining custom shortcuts" .

   503 On startup

   504 \fBNo\fP

   505 reads the file

   506 \fIdefault.menu\fP

   507 which contains the default menu definitions. The file is searched for in your search path (specified by option

   508 \fB\-path\fP ) .

   509 .SH KEYBOARD AND MOUSE SHORTCUTS

   510 

   511 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

   512 .B "Defining custom shortcuts" .

   513 

   514 The following key combinations are defined by default. These are defined in the system configuration file

   515 \fI/etc/mrxvt/mrxvtrc\fP,

   516 and can be disabled using the option

   517 \fB\-nsc\fP.

   518 See the next section for instructions on defining your own custom keyboard shortcuts.

   519 

   520 .IR Gnome-terminal style shortcuts:

   521 .TP

   522 Ctrl+Shift+t

   523 create a new tab

   524 .TP

   525 Ctrl+Shift+q

   526 Close all tabs and exit

   527 .TP

   528 Ctrl+Shift+w

   529 Close active tab, and do not hold it open if it exits abnormally.

   530 .TP

   531 Ctrl+PgUp

   532 activate left tab

   533 .TP

   534 Ctrl+PgDn

   535 activate right tab

   536 .TP

   537 Meta+1

   538 activate 1st tab

   539 .TP

   540 ...

   541 .TP

   542 Meta+0

   543 activate 10th tab

   544 .TP

   545 Ctrl+equal

   546 increase font size (next font)

   547 .TP

   548 Ctrl+Shift+plus

   549 increase font size by 2

   550 .TP

   551 Ctrl+minus

   552 decrease font size (previous font)

   553 .TP

   554 Ctrl+Shift+underscore

   555 decrease font size by 2

   556 

   557 .IR Konsole style default shortcuts:

   558 .TP

   559 Ctrl+Shift+Left

   560 move active tab to left

   561 .TP

   562 Ctrl+Shift+Right:

   563 active tab to right

   564 .TP

   565 Shift+Left

   566 Activate left tab (Primary only)

   567 .TP

   568 Shift+Right

   569 Activate right tab (Primary only)

   570 .TP

   571 Ctrl+Shift+n

   572 Create a new tab with the same profile as the current tab.

   573 

   574 .IR Vi style default shortcuts:

   575 .TP

   576 Ctrl+Shift+h

   577 activate left tab

   578 .TP

   579 Ctrl+Shift+l

   580 activate right tab

   581 

   582 .IR Screen style default shortcuts:

   583 .TP

   584 Ctrl+Shift+p

   585 activate previous active tab

   586 

   587 .IR Mrxvt default shortcuts:

   588 .TP

   589 Ctrl+Shift+1

   590 Move tab to 1st position

   591 .TP

   592 ...

   593 .TP

   594 Ctrl+Shift+0

   595 Move tab to 10th position

   596 .TP

   597 Ctrl+Tab

   598 activate previous active tab

   599 .TP

   600 Ctrl+Shift+less_than

   601 Move active tab left

   602 .TP

   603 Ctrl+Shift+greater_than

   604 Move active tab right

   605 .TP

   606 Ctrl+Shift+o

   607 Change opacity of terminal to make it more transparent.

   608 .TP

   609 Ctrl+Shift+u

   610 Change opacity of terminal to make it less transparent.

   611 .TP

   612 Ctrl+Shift+j

   613 Change shading of terminal to make it more transparent.

   614 .TP

   615 Ctrl+Shift+k

   616 Change shading of terminal to make it less transparent.

   617 .TP

   618 Ctrl+Shift+r

   619 Toggle psdudo-transparency

   620 .TP

   621 Ctrl+Shift+i

   622 Hide/show tabbar

   623 .TP

   624 Ctrl+Shift+s

   625 Hide/show scrollbar

   626 .TP

   627 Ctrl+Shift+m

   628 Hide/show menubar

   629 .TP

   630 Ctrl+Shift+a

   631 Hide/show tabbar buttons

   632 .TP

   633 Ctrl+Shift+b

   634 Toggle very bold font

   635 .TP

   636 Ctrl+Shift+c

   637 Open a

   638 \fBNo\fP

   639 console in a new tab, and enable the

   640 \fBuseFifo\fP

   641 option if necessary. Anything typed in this console will be executed as a macro. On clean exit the

   642 \fBuseFifo\fP

   643 option will be disabled.

   644 .TP

   645 Ctrl+Shift+d

   646 Toggle input broadcasting (unbound by default)

   647 .TP

   648 Ctrl+Shift+e

   649 Toggle holding exited tab

   650 .TP

   651 Ctrl+Shift+f

   652 Toggle full screen mode

   653 .TP

   654 Ctrl+Shift+x

   655 Save current configuration

   656 .TP

   657 Shift+Del

   658 Set title of active tab to selection.

   659 .TP

   660 Shift+Insert

   661 Paste X selection into active tab.

   662 .TP

   663 Ctrl+Shift+v

   664 Paste X selection into active tab.

   665 .TP

   666 Shift+Up

   667 Scroll up one line (Primary screen only)

   668 .TP

   669 Shift+Dn

   670 scroll down one line (Primary screen only)

   671 .TP

   672 Shift+PgUp

   673 scroll up one page (Primary screen only)

   674 .TP

   675 Shift+PgDn

   676 scroll down one page (Primary screen only)

   677 .TP

   678 Shift+Home

   679 Scroll to beginning of scroll-back buffer (Primary screen only)

   680 .TP

   681 Shift+End

   682 Scroll to end of scroll-back buffer (Primary screen only)

   683 .TP

   684 Shift+KeypadPlus

   685 Increase font size

   686 .TP

   687 Shift+KeypadMinus

   688 Decrease font size

   689 .TP

   690 Ctrl+Shift+F1

   691 Open

   692 \fBNo\fP

   693 man page in a new tab.

   694 .TP

   695 Ctrl+Shift+F12

   696 Enable / disable all keyboard macros (except this one of course).

   697 

   698 NOTE: The 

   699 `hotkey'

   700 mechanism used in versions 0.4.2 and earlier is now obsolete. It has been replaced by the

   701 `macro'

   702 functionality (described below) as of version 0.5.0.

   703 

   704 You can define your own keyboard shortcuts in your configuration file by using the following syntax:

   705 Mrxvt.macro.[modifiers+]keyname:         action

   706 Here

   707 `modifiers'

   708 is a

   709 `+'

   710 separated list of modifiers

   711 `Em' Ctrl ,

   712 `Em' Alt ,

   713 `Em' Meta ,

   714 `Em' Shift .

   715 `Em' Primary .

   716 and

   717 `Em' Add .

   718 The first four refer to the respective modifier keys.

   719 `Em' Primary

   720 tells

   721 \fBNo\fP

   722 to make the macro available ONLY when the primary screen is displayed (e.g.

   723 `Em' Primary

   724 macros will not be effective when you are running

   725 \fBvim\fP(1),

   726 but will be effective when you are at the shell prompt). Finally

   727 `Em' Add

   728 tells

   729 \fBNo\fP

   730 to add the macro action to any previous action associated to that particular key. For instance

   731 Mrxvt.macro.Primary+Shift+Return:	Esc \eec

   732 Mrxvt.macro.Primary+Add+Shift+Return:	Str ^M

   733 will define the macro

   734 `Shift+Return'

   735 to first send the escape sequence

   736 `\eec'

   737 to

   738 \fBNo\fP

   739 (which has the effect of clearing the scroll back buffer) and then send

   740 `Ctrl-M'

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

   742 

   743 If the

   744 `Em' Add

   745 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).

   746 

   747 `keyname'

   748 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

   749 \fI/usr/include/X11/keysymdef.h\fP.

   750 

   751 In case you want to unbind a default keyboard macro, just bind the appropriate key to the function

   752 `Ic' Dummy .

   753 For example

   754 Mrxvt.macro.Ctrl+Shift+t:	Dummy

   755 will disable the default keyboard shortcut

   756 `Ctrl+Shift+t'.

   757 If you want to disable all keyboard macros, use the option

   758 `Fl' dm

   759 (which can also be accessed via a pop-up menu). The default keyboard macros are defined in the system configuration file

   760 \fI/etc/mrxvt/mrxvtrc\fP

   761 so if you only want to disable all default shortcuts keys, don't read the system configuration file by using the 

   762 \fB\-nsc\fP

   763 option.

   764 

   765 Notice that keyboard shortcuts definitions are incompatible with X Windows own resource parsing API, i.e., XGetDefaults. So, to enable the keyboard shortcuts, you will need to enable resources but disable xgetdefault when you configure

   766 \fBNs\fP.

   767 

   768 Finally

   769 `action'

   770 is the action you want bound to the specified macro key. The available actions you can bind to macros are:

   771 .TP

   772 \fBDummy\fP

   773 Clear an existing keyboard shortcut

   774 .TP

   775 \fBEsc \fIstr\fP\fP

   776 Send the escape sequence

   777 \fIstr\fP

   778 to

   779 \fB.\fP

   780 .TP

   781 \fBStr \fIstr\fP\fP

   782 Send the string

   783 \fIstr\fP

   784 to the child process.

   785 .TP

   786 \fBExec \fIcommand\fP\fP

   787 Executes

   788 \fIcommand\fP

   789 asynchronously. The command run without any controlling shell or TTY. This is generally used to launch X11 programs (e.g. open the selected text in firefox). If you want a command run in a new tab, see the

   790 \fBNewTab\fP

   791 macro).

   792 

   793 The argument

   794 \fIcommand\fP

   795 is word split exactly as described in the

   796 \fB\-blc\fP

   797 option (thus for instance beginning it with 

   798 `\&!'

   799 will pass it to

   800 Cd /bin/sh -c

   801 for word splitting and execution). However keep in mind that like all macro arguments,

   802 \fIcommand\fP

   803 is first

   804 `Sy' \e

   805 interpolated. Thus if on the rare occasion you want

   806 `\e\'

   807 to be part of

   808 \fIcommand\fP,

   809 then you will have to do something like

   810 `\e\e\e\e\e\e\'

   811 and not

   812 `\e\e\e\'

   813 as you would with the argument of

   814 \fB\-blc\fP.

   815 .TP

   816 \fBNewTab Oo \fI-N\fP Oc Oo \fI\*qtitle\*q\fP Oc [Oo ! Oc Ns \fIcommand]\fP\fP

   817 Open a new tab.

   818 \fIN\fP

   819 specifies the profile number. If omitted, profile 0 is used. If only

   820 `-'

   821 (with no number) is specified, then the profile of the current active tab is used (i.e. this can be used to duplicate the current tab).

   822 \fItitle\fP

   823 is specified (needs to be double quoted), use that for the tab title. If

   824 \fIcommand\fP

   825 is specified, execute that command in the new tab (instead of the one specified by the resource file, or the shell).

   826 

   827 \fIcommand\fP

   828 is word split as described in the

   829 \fBExec\fP

   830 macro. However if command begins with an

   831 So ! Sc

   832 then run a shell first, and execute the command in the shell as if the user had typed

   833 \fIcommand\fP

   834 at the shell prompt. If instead you want

   835 \fIcommand\fP

   836 to be passed to

   837 Cd /bin/sh -c

   838 for word splitting and execution, then begin

   839 \fIcommand\fP

   840 with

   841 `\e!'.

   842 .TP

   843 \fBClose [\fIN]\fP\fP

   844 Close a tab. If no argument is specified, close all tabs and exit. If

   845 \fIN\fP

   846 is 0, close the active tab. Otherwise close the

   847 \fIN\fPth tab .

   848 .TP

   849 \fBGotoTab [\fIN]\fP\fP

   850 Goto tab. If

   851 \fIN\fP

   852 is ommited or 0, then goto the previous active tab. Otherwise goto the

   853 \fIN\fPth

   854 tab. If

   855 \fIN\fP

   856 begins with a

   857 `+'

   858 or

   859 `-'

   860 then

   861 \fIN\fP

   862 is relative to the current tab.

   863 .TP

   864 \fBMoveTab \fIN\fP\fP

   865 Move active tab to position

   866 \fIN\fP.

   867 If

   868 \fIN\fP

   869 begins with a

   870 `+'

   871 or

   872 `-'

   873 then

   874 \fIN\fP

   875 is relative to the current tab.

   876 .TP

   877 \fBScroll \fIamount\fP\fP

   878 Scroll the active tab by

   879 \fIamount\fP

   880 lines (negative values mean scroll backward). If

   881 \fIamount\fP

   882 ends with

   883 `p'

   884 then scroll

   885 \fIamount\fP

   886 pages instead of lines.

   887 .TP

   888 \fBCopy\fP

   889 Copy selection into clipboard (not implemented).

   890 .TP

   891 \fBPaste\fP

   892 Pasete selection into active tab.

   893 .TP

   894 \fBToggleSubwin [Oo \fI+\fP Ns | Ns \fI-\fP Oc Ns [\fIb\fP Ns | Ns \fIm\fP Ns | Ns \fIs\fP Ns | Ns \fIt]]\fP\fP

   895 Toggle visibility of sub-windows. If the argument begins with a

   896 `+'

   897 the subwindow is shown. If it begins with a

   898 `-'

   899 the subwindow is hidden. Otherwise it is toggled. The letters

   900 `Ar' b ,

   901 `Ar' m ,

   902 `Ar' s

   903 and

   904 `Ar' t

   905 represent the tabbar buttons, menubar, scrollbar and tabbar respectively. NOTE: Currently you can only toggle one subwindow at a time.

   906 .TP

   907 \fBResizeFont Oo \fI+\fP Ns | Ns \fI-\fP Oc Ns \fIN\fP\fP

   908 Resize the font. With Xft,

   909 \fIN\fP

   910 represents the size increment of the xft font. Without Xft,

   911 \fIN\fP

   912 represents the index of the X11 fonts specified by the

   913 \fBfont\fP\fIN\fP

   914 resources.

   915 .TP

   916 \fBToggleVeryBold\fP

   917 Toggle use of bold font for colored text.

   918 .TP

   919 \fBToggleTransparency\fP

   920 Toggle pseudo transparency.

   921 .TP

   922 \fBToggleBroadcast\fP

   923 Toggle broadcasting of input to all tabs.

   924 .TP

   925 \fBToggleHold [\fImask]\fP\fP

   926 If

   927 \fImask\fP

   928 is not specified, then just close all tabs who's child processes have exited. (This is almost compatible with the behaviour of

   929 \fB.\fP

   930 0.5.1 and earlier). If

   931 \fImask\fP

   932 is specified, then change the hold status of the current tab.

   933 \fImask\fP

   934 must begin with

   935 `Sy' + ,

   936 `Sy' - ,

   937 or

   938 `Sy' \&!

   939 and be followed by a bit mask (as in the

   940 \fBholdExit\fP

   941 option).

   942 `Sy' +

   943 will add bits to the

   944 \fBholdExit\fP

   945 option for this tab,

   946 `Sy' -

   947 will subtract, and

   948 `Sy' \&!

   949 will toggle. Remember that if the lowest bit of the current tabs

   950 \fBholdExit\fP

   951 option is set, then the tab will always be held open and everything else will be ignored.

   952 .TP

   953 \fBToggleFullscreen\fP

   954 Toggle between full screen and regular mode. Also enable

   955 \fB\-Fl\fP smoothResize

   956 to get true full screen. This will only work if you are running an EWMH compatible window manager (e.g. Fvwm / OpenBox / KDE / Gnome).

   957 .TP

   958 \fBRaise\fP

   959 Raise the

   960 \fB.\fP

   961 window.

   962 .TP

   963 \fBSetTitle\fP

   964 Set title of active tab to selection. (The selection must be owned by

   965 \fB)\fP

   966 .TP

   967 \fBUseFifo \fIstatus\fP\fP

   968 Enable or disable using a

   969 \fBfifo\fP(1)

   970 to listen for macros on (see the

   971 \fBuseFifo\fP

   972 option). The argument

   973 \fIstatus\fP

   974 should be

   975 .B 0 , 1 , -1

   976 to disable, enable or toggle respectively.

   977 .TP

   978 \fBPrintScreen Oo Fl psn Oc [\fIcommand]\fP\fP

   979 Dump screen to printer (or

   980 \fIcommand\fP ) .

   981 If

   982 \fB\-p\fP

   983 is specified, then the output is pretty printed (i.e. escape sequences are used to get the same color in the output as on your screen). If

   984 \fB\-s\fP

   985 is specified, then the entire scroll back is printed (instead of just the current screen). If

   986 \fB\-n\fP

   987 is specified, then every screen line is terminated with a newline char (by default screen lines that wrap to the next line are not terminated with a newline). Finally, if command is specified it is used as the printer pipe (if not the value of

   988 \fBprintPipe\fP

   989 or the compiled in default is used).

   990 .TP

   991 \fBSaveConfig [\fIfilename]\fP\fP

   992 Save config to file. If no filename is specified, save to

   993 \fI~/.mrxvtrc.save\fP.

   994 .TP

   995 \fBToggleMacros\fP

   996 Toggle the use of keyboard shortcuts. When macros are disabled (either by using this macro, or by the

   997 \fB\-dm\fP

   998 option), then this is the only keyboard shortcut that will work. Thus you can re-enable your keyboard shortcuts via the keyboard using this function.

   999 

  1000 Additionally, the argument to any of the above macros are

  1001 `Sy' \e

  1002 and

  1003 `Sy' %

  1004 interpolated as follows:

  1005 

  1006 .TP

  1007 .B \ea

  1008 Bell

  1009 .TP

  1010 .B \eb

  1011 Backspace

  1012 .TP

  1013 .B \eE , \ee

  1014 Escape

  1015 .TP

  1016 .B \en

  1017 Newline

  1018 .TP

  1019 .B \er

  1020 Carriage return

  1021 .TP

  1022 .B \et

  1023 Tab

  1024 .TP

  1025 .B \e Ns Ar ddd

  1026 Char with octal ASCII code

  1027 \fIddd\fP.

  1028 .TP

  1029 .B ^@ , ^A .. ^Z .. ^_ , ^?

  1030 Control-@, Control-A ...

  1031 

  1032 .TP

  1033 .B %G

  1034 Global (static) tab number.

  1035 .TP

  1036 .B %p

  1037 PID of child process in current tab.

  1038 .TP

  1039 .B \&%P

  1040 PID of

  1041 \fB)\fP

  1042 .TP

  1043 .B %n

  1044 Tab number.

  1045 .TP

  1046 .B % Ns Sy N

  1047 Expands to

  1048 `normally'

  1049 if the process exited normally (e.g. by calling

  1050 \fBexit\fP(1))

  1051 or

  1052 `abnormally'

  1053 otherwise. (Note this is independent of the exit status).

  1054 .TP

  1055 .B %s

  1056 Text selected in the

  1057 \fB)\fP

  1058 window.

  1059 .TP

  1060 .B %S

  1061 If the process in this tab is dead, then it expands to the exit status of the child process. Otherwise left unchanged.

  1062 .TP

  1063 .B %t

  1064 Tab title.

  1065 .TP

  1066 .B \&%T

  1067 Total number of tabs created in

  1068 \fB)\fP

  1069 lifetime.

  1070 

  1071 .TP

  1072 Changing tab titles

  1073 This mouse shortcut can be used to dynamically change the tab title as follows: Select text in the terminal window. Then middle click on a tab to change the tab's title. If you middle click on the tabbar background, then the title of the active tab is changed.

  1074 .TP

  1075 Tab list menu

  1076 By default, if you right click on the tab bar, or control-left-click on the terminal window, a popup menu with a list of currently open tabs pops up. The actual menu popped up can be customized as described under the section

  1077 .B MENUS .

  1078 .TP

  1079 Popup menus

  1080 If you Control-click on the terminal window (with any mouse button), it pops up a menu. The actual menu popped up can be customized as described under the section

  1081 .B MENUS .

  1082 .TP

  1083 Moving tabs

  1084 Click and drag a tab to some other location on the tab-bar to move it.

  1085 .SH ESCAPE SEQUENCES

  1086 

  1087 You have several escape sequences to control

  1088 \fB.\fP

  1089 All default

  1090 \fBrxvt\fP(1)

  1091 escape sequences are supported by

  1092 \fB.\fP

  1093 A few extra escape sequences have been added to improve DEC compatibility, and allow interaction with extra

  1094 \fB.\fP

  1095 features (e.g. tabs). The supported escape sequences are listed in the file

  1096 \fImrxvt_seq.txt\fP

  1097 included in the distribution.

  1098 

  1099 For omissions in the documentation, and a more complete reference to escape sequences you should look at the file

  1100 \fIctlseqs.txt\fP

  1101 that comes with the xterm package,

  1102 \fBconsole_codes\fP(4)

  1103 and the original rxvt documentation in the file

  1104 \fIrxvtRef.txt\fP.

  1105 

  1106 For basic interaction with

  1107 \fB.\fP

  1108 (e.g. changing the tab title etc.) you should also look at the programs

  1109 \fIshare/scripts/settitle.c\fP

  1110 and

  1111 \fIshare/scripts/mrxvtset.pl\fP

  1112 that are supplied with the

  1113 \fB.\fP

  1114 distribution.

  1115 .SH ENVIRONMENT

  1116 

  1117 .TP

  1118 .B COLORFGBG

  1119 Set to the terminal foreground and background colors.

  1120 .TP

  1121 .B COLORTERM

  1122 Sets to the terminal sub-name that indicates its color.

  1123 .TP

  1124 .B DISPLAY

  1125 Used (and set) to the X display bieng used.

  1126 .TP

  1127 .B PATH_ENV

  1128 Path to look for menu / background files (see

  1129 \fB\-path\fP

  1130 option).

  1131 .TP

  1132 .B TERM

  1133 Set to the terminal name in the window you have created.

  1134 .TP

  1135 .B MRXVT_TABTITLE