Xming

Xmingrc Manual

Name

       Xmingrc - Xming X Server Resource Configuration File

Description

       Xming  is an X Server for Microsoft Windows that can be optionally con-
       figured with the Xmingrc file.  A system-wide configuration file should
       be  placed  in  the  install directory, a per-user file could be put in
       their %HOME% directory (which defaults to %USERPROFILE%).   The system-
       wide file  is only read  if the per-user file  does not exist  or it is
       badly formed.

       With the Xmingrc configuration file it is possible to do the following:

       *  To include items into the menu associated with the Xming icon  which
       is  in  the Microsoft Windows notification area.  This functions in all
       modes that have a notification area icon.

       *  To include  items  into  the  menu  which  is  associated  with  the
       Microsoft  Windows window that -multiwindow produces for each top-level
       X window.  That can be done both for the generic case and for  particu-
       lar programs.

       *  To change the icon that is associated to the  Microsoft Windows win-
       dow that -multiwindow produces for  each  top-level  X window.   Again,
       that can be done both for the generic case and for particular programs.
       The new icons associated should be Microsoft Windows format icons.

       *  To change the style that is associated to the Microsoft Windows win-
       dow that -multiwindow produces for  each  top-level  X window.   Again,
       that can be done both for the generic case and for particular programs.

       *  To change the  taskbar button  properties  of the  Microsoft Windows
       window that -multiwindow produces for each  top-level  X window. Again,
       that can be done both for the generic case and for particular programs.

File format

       KEYWORDS  are case insensitive,  but in this document  they are written
       completely capitalized and bold. Character "|" denotes "or".

       Comments are legal pretty much anywhere you can  have  an  end-of-line;
       they begin with "#" or "//" and go to the end-of-line.

       Quote marks in strings are optional unless the string has included spa-
       ces or could be parsed, ambiguously, as a misplaced keyword.

       There are 5 kinds of instructions: Miscellaneous, Menu, Icon, Style and
       Taskbar.

Miscellaneous instructions
       DEBUG String
               The String is printed to the Xming.n.log file, where n  is  the
               display-number of the X server.

       SILENTEXIT
               The SILENTEXIT keyword, which takes no parameters, bypasses the
               Exit Xming? dialog from displaying if no clients are connected.

       FORCEEXIT
               The FORCEEXIT keyword, which takes no parameters,  bypasses the
               Exit Xming? dialog from displaying always.  Unsaved client work
               may be lost but it is useful if you want no dialogs with Xming.

Menu instructions
       MENU Menu_Name {
                 Menu_Item_Line
                 Menu_Item_Line
                 ...
                 }
               This instruction defines a menu and assigns a Menu_Name to it.

            Menu_Item_Line are lines of any of the following types:

               Item_Label EXEC Command    //with no Command Processor console

               Item_Label EXECD Command   //with a Command Processor console

               Item_Label MENU Menu_Name  //MENU{} can  contain other MENU(s),
                                          //but a Menu_Name must never recurse

               Item_Label ALWAYSONTOP     //sets the window to which the  menu
                                          //is associated to display above all
                                          //others

               Item_Label FINDER   //run the XDMCP host finder

               Item_Label RELOAD   //causes  the  Xmingrc file to be  reloaded
                                   //and icons and menus regenerated

               Item_Label VIEWLOG  //run an Xming log file viewer

               SEPARATOR           //draw a line to separate Menu_Item_Line(s)

            Notes on the structure of Menu_Item_Line(s):

               The Item_Label is the string that is written in the menu  item.
               A & before an Item_Label character makes it act as a 'hot key'.

               Command  is a string with the command that will be created as a
               process with or without a parent Command Processor console.
               Try 'Item_Label EXECD Command' first and if you get an unwanted
               console, or the flash of one, use EXEC instead.
               A string "%display%" appearing in the Command will be  replaced
               with  the proper display variable (i.e. 127.0.0.1:<display-num-
               ber>.0).  This should rarely be needed as the process %DISPLAY%
               variable is also  set correctly.  Other   environment  variable
               strings are not honoured.

       ROOTMENU Menu_Name
               Includes the items in the indicated menu into the menu  associ-
               ated with Xming that appears in the notification area.

       DEFAULTSYSMENU Menu_Name ATSTART|ATEND
               Includes  the items in the indicated menu into the menu associ-
               ated with generic top-level  X windows  in  -multiwindow  mode.
               The keywords ATSTART or ATEND indicate if such items  should be
               included at the start or at the end of the menu.

       SYSMENU {
                 Class|Name Menu_Name ATSTART|ATEND
                 ...
                 }
               Associates a specific menu to a specified  window class or name
               in -multiwindow mode. The keywords ATSTART or ATEND indicate if
               such items should be included at the start or at the end of the
               menu.

Icon instructions
       When specifying an Icon_File in the following commands three  different
       formats are allowed:
       "NAME.ICO"
               Name of a regular Windows .ico format file
               e.g. "X.ico", "apple.ico"
       "NAME.EXE,n"|"NAME.DLL,n"|"NAME.ICO,n"
               Name and icon index into a Windows executable, DLL or icon file
               where n = 0 is the first icon in a file
               e.g. "C:\Windows\System32\shell32.dll,4" is the folder icon
       ",nnn" 
               Index into Xming.exe's internal icon resources
               e.g. ",101" is the first (and currently only) icon in Xming.exe

       ICONDIRECTORY Icon_Directory
               Defines  the  default  directory to search for Icon_File files.
               It should be a Microsoft Windows style path  (e.g. C:\Windows\-
               System32\).  This will not be prepended  if you specify a fully
               qualified path to the file containing the icon.

       TRAYICON Icon_File
               The  TRAYICON  keyword  changes  the icon Xming displays in the
               notification area.

       DEFAULTICON Icon_File
               Defines  a replacement for the standard X icon for applications
               without specified icons.

       ICONS {
                 Class|Name Icon_File
                 ...
                 }
               Defines  icon  replacements for windows matching the  specified
               window class or name in -multiwindow mode. If multiple class or
               name matches occur,  for a window,  only the first one  will be
               used.

Style instructions
       STYLES {
                 Class|Name style-keyword-1 style-keyword-2
                 ...
                 }
               Associates  specific styles to a specified window class or name
               in -multiwindow mode.  If multiple class or name matches occur,
               for a window, only the first one will be used.  Styles override
               any equivalent window manager hints.

               The style keywords indicate the following:

               style-keyword-1

               TOPMOST
               Open the class or name above all NOTOPMOST Windows windows.

               MAXIMIZE
               Start the class or name fullscreen.

               MINIMIZE
               Start the class or name iconic.

               BOTTOM
               Open the class or name below all Windows windows.

               style-keyword-2

               NOTITLE
               No Windows title bar, for the class or name.

               OUTLINE
               No Windows title bar and just a thin-line border, for the class
               or name.

               NOFRAME
               No Windows title bar or border, for the class or name.

               One keyword in style-keyword-1 can be used with one keyword  in
               style-keyword-2, or any keyword can be used singly.

Taskbar instructions
       TASKBAR {
                 Class|Name taskbar-keyword
                 ...
                 }
               Associates taskbar properties  to a  specified window class  or
               name in -multiwindow mode.   If multiple  class or name matches
               occur, for a window, only the first one will be used.

               The taskbar keywords indicate the following:

               NOTAB
               Open the window class or name without a taskbar button.
               To prevent a window becoming  unmanageable  its minimize button
               is also disabled.

               NEWTAB (useful in Windows 7, Server 2008 R2 or later)
               Open the window class or name with unique taskbar buttons.
               Normally related windows are grouped in one taskbar button when
               "Taskbar  buttons:  Always combine,  hide labels"  is  set   in
               Windows "Taskbar and Start Menu Properties".

Examples

       Adding an oclock menu item to Xming's notification area icon
               MENU systray {
                "Analog Clock" EXEC oclock
                SEPARATOR
               }
               ROOTMENU systray

       and now altered to add the XDMCP host finder and Command Processor
               MENU apps {
                "&Old Menu" MENU systray
                "Host &Finder" FINDER
                "&Command Processor" EXECD cmd.exe
               }
               ROOTMENU apps

       Making an oclock window frameless in -multiwindow mode
               STYLES {
                oclock NOFRAME
               }

       Screenshots of this example...
                 Custom X toolbar icon menu.            Custom X toolbar icon menu.

Authors

       The Xmingrc feature was written by Earle F. Philhower III and
       extended in many ways by Colin Harrison.

Table of contents

  1. Name
  2. Description
  3. File format
  4. Examples
  5. Authors
Creative Commons License
The [WWW]Xming website, documentation and images are licensed under a
[WWW]Creative Commons Attribution-NonCommercial-ShareAlike 2.0 UK: England & Wales License.
Copyright © 2005-2014 Colin Harrison All Rights Reserved