xorg-server-1.4/hw/xwin/XWinrc.man

   1 .TH XWIN 5 __vendorversion__
   2
   3
   4 .SH NAME
   5 XWinrc\- XWin Server Resource Configuration File.
   6
   7
   8 .SH DESCRIPTION
   9 The X Server for the X Window System on the Cygwin/X environment
  10 running on Microsoft Windows, \fIXWin\fP can be optionally configured
  11 with the \fIXWinrc\fP file.  A system-wide configuration file should
  12 be placed in \fI/usr/X11R6/lib/X11/system.XWinrc\fP, a per-user file
  13 should be put at \fI$HOME/.XWinrc\fP.  The \fIsystem.XWinrc\fP file is
  14 read only if no \fI$HOME/.XWinrc\fP exist.
  15 .PP
  16 With the \fI.XWinrc\fP configuration file it is possible to do the
  17 following:
  18 .PP
  19 1- To include items into the menu associated with the \fIXWin\fP icon
  20 which is in the \fIWindows\fP system tray.  This feature functions in
  21 all XWin modes that have such tray icon.
  22 .PP
  23 2- To include items into the menu which is associated with the
  24 \fIWindows\fP window that \fIXWin -multiwindow\fP produces for each
  25 top-level X-window.  That can be done both for the generic case and
  26 for particular programs.
  27 .PP
  28 3- To change the icon that is associated to the \fIWindows\fP window
  29 that \fIXWin -multiwindow\fP produces for each top-level X-window.
  30 Again, that can be done both for the generic case and for particular
  31 programs.  The new icons associated should be \fIWindows\fP format
  32 icons \fI.ico\fP.
  33
  34
  35 .SH FILE FORMAT
  36 .B Keywords
  37 are case insensitive, but in this document they will be written
  38 completely capitalized.
  39 .PP
  40 .B Comments
  41 are legal pretty much anywhere you can have an end-of-line; they
  42 begin with "#" or "//" and go to the end-of-line.
  43 .PP
  44 Quote marks in strings are optional unless the string has included spaces.
  45 .PP
  46 There are three kinds of instructions: miscellaneous, menu, and icon.
  47
  48
  49 .SH Miscellaneous instruction
  50 .TP 8
  51 .B DEBUG \fIString\fP
  52 The \fIString\fP is printed to the XWin.log file.
  53
  54 .TP 8
  55 .B TRAYICON \fIicon-specifier\fB
  56 The \fBTRAYICON\fP keyword changes the icon \fIXWin\fP displays in the
  57 system tray area.
  58
  59 .TP 8
  60 .B SILENTEXIT
  61 The \fBSILENTEXIT\fP keyword, which takes no parameters, disables the
  62 exit confirmation dialog.
  63
  64
  65 .SH Menu instructions
  66 .TP 8
  67 .B MENU \fIMenu_Name\fP {
  68 .br
  69 .B       \fIMenu_Item_Line\fP
  70 .br
  71 .B       \fIMenu_Item_Line\fP
  72 .br
  73 .B        \fI...\fP
  74 .br
  75 .B }
  76 .br
  77 This instruction defines a menu and asigns a \fIMenu_Name\fP to it.
  78 \fIMenu_Item_Line\fP are lines  of any of the following types:
  79 .TP 8
  80 .B \t SEPARATOR
  81 .TP 8
  82 .B  \t \fIItem_Label\fP  EXEC \fICommand\fP
  83 .TP 8
  84 .B \t \fIItem_Label\fP  MENU \fIpreviously-defined-menu-name\fP
  85 .TP 8
  86 .B \t \fIItem_Label\fP  ALWAYSONTOP
  87 .TP 8
  88 .B \t \fIItem_Label\fP  RELOAD
  89 .br
  90 The \fIItem_Label\fP is the string that is written in the menu item.
  91 .br
  92 \fICommand\fP is a string with the command that will be executed by /bin/sh.
  93 Here paths should be \fICYGWIN\fP style (e.g. /usr/local/bin/myprogram).
  94 A string "%display%" appearing in the \fICommand\fP will be replaced
  95 with the proper display variable (i.e. 127.0.0.1:<display>.0).
  96 .br
  97 \fBALWAYSONTOP\fP sets the window to which the menu is associated to
  98 display above all others.
  99 .br
 100 \fBRELOAD\fP causes the XWinrc file to be reloaded and icons and menus
 101 regenerated.
 102 .TP 8
 103 .B ROOTMENU \fIpreviously-defined-menu-name\fP
 104 Includes the items in the indicated menu into the menu associated with
 105 \fIXWin\fP that appears in the system tray.
 106 .TP 8
 107 .B DEFAULTSYSMENU \fIpreviously-defined-menu-name\fP ATSTART|ATEND
 108 Includes the items in the indicated menu into the menu associated with
 109 generic top-level X-Windows in the \fIXWin\fP \fImultiwindow\fP mode.  The
 110 keywords \fBATSTART\fP and \fBATEND\fP indicate if such items should be
 111 included at the start or at the end of the menu.
 112 .TP 8
 113 .B SYSMENU {
 114   \fIclass-or-name-of-window\fP \fIdefined-menu-name\fP \fBATSTART|ATEND\fP
 115 .br
 116   \fI...\fP
 117 .br
 118   \fB}\fP
 119 .br
 120 Associates a specific menu to a specific WM_CLASS or WM_NAME.
 121
 122
 123 .SH Icon Instructions
 124 When specifying an \fIicon-file\fP in the following commands several different formats are allowed:
 125 .br
 126 \fB"NAME.ICO"\fP\fI of an .ico format file\fP
 127 .br
 128 \t \t ("cygwin.ico", "apple.ico")
 129 .br
 130 \fB"NAME.DLL,nn"\fP\fI of a .DLL and icon index\fP
 131 .br
 132 \t \t ("c:\\windows\\system32\\shell32.dll,4" is the default folder icon)
 133 .br
 134 \fB",nn"\fP\fI index into XWin.EXE internal ICON resources\fP
 135 .br
 136 \t \t (",101" is the 1st icon inside \fIXWin.EXE\fP)
 137 .TP 8
 138 .B ICONDIRECTORY \fIWindows-path-to-icon-directory\fP
 139 Defines the default directory to search for \ficon-file\fP files.
 140 It should be a \fIWindows\fP style path (e.g. C:\\cygwin\\usr\\local\\icons).
 141 .TP 8
 142 .B DEFAULTICON \fIicon-file\fP
 143 Defines a replacement for the standard X icon for applications without
 144 specified icons.
 145 .TP 8
 146 .B ICONS {
 147 .br
 148  \fIclass-or-name-of-window\fP \fIicon-file\fP
 149 .br
 150   \fI...\fP
 151 .br
 152   \fB}\fP
 153 .br
 154 Defines icon replacements windows matching the specified window class or names.
 155 If multiple name or class matches occur for a window, only the first one
 156 will be used.
 157
 158
 159 .SH EXAMPLE
 160 .TP 8
 161 This example adds an Xterm menu item to the system tray icon
 162 \fBMENU systray {
 163 .br
 164 \t xterm  EXEC "xterm -display %display% -sb -sl 999"
 165 .br
 166 \t SEPARATOR
 167 .br
 168 }
 169 .br
 170 ROOTMENU systray
 171 \fP
 172
 173
 174 .SH "SEE ALSO"
 175  XWin(1)
 176
 177
 178 .SH AUTHOR
 179 The XWinrc feature of XWin was written primarily by Earle F. Philhower
 180 III.