hw/xwin/man/XWinrc.man

   1 .TH XWIN __filemansuffix__ __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
  13 __sysconfdir__/X11/system.XWinrc\fP, a per-user file
  14 should be put at \fI$HOME/.XWinrc\fP.  The \fIsystem.XWinrc\fP file is
  15 read only if no \fI$HOME/.XWinrc\fP exist.
  16 .PP
  17 With the \fI.XWinrc\fP configuration file it is possible to do the
  18 following:
  19 .PP
  20 1- To include items into the menu associated with the \fIXWin\fP icon
  21 which is in the \fIWindows\fP system tray.  This feature functions in
  22 all XWin modes that have such tray icon.
  23 .PP
  24 2- To include items into the menu which is associated with the
  25 \fIWindows\fP window that \fIXWin -multiwindow\fP produces for each
  26 top-level X-window.  That can be done both for the generic case and
  27 for particular programs.
  28 .PP
  29 3- To change the icon that is associated to the \fIWindows\fP window
  30 that \fIXWin -multiwindow\fP produces for each top-level X-window.
  31 Again, that can be done both for the generic case and for particular
  32 programs.  The new icons associated should be \fIWindows\fP format
  33 icons \fI.ico\fP.
  34 .PP
  35 4- To change the style that is associated to the \fIWindows\fP window
  36 that \fI-multiwindow\fP produces for  each  top-level  X window.   Again,
  37 that can be done both for the generic case and for particular programs.
  38
  39
  40 .SH FILE FORMAT
  41 .B Keywords
  42 are case insensitive, but in this document they will be written
  43 completely capitalized.
  44 .PP
  45 .B Comments
  46 are legal pretty much anywhere you can have an end-of-line; they
  47 begin with "#" or "//" and go to the end-of-line.
  48 .PP
  49 Quote marks in strings are optional unless the string has included spaces,
  50 or could be parsed, ambiguously, as a misplaced keyword.
  51 .PP
  52 There are four kinds of instructions: miscellaneous, menu, icon and style.
  53
  54
  55 .SH Miscellaneous instruction
  56 .TP 8
  57 .B DEBUG \fIString\fP
  58 The \fIString\fP is printed to the XWin log file.
  59
  60 .TP 8
  61 .B TRAYICON \fIicon-specifier\fB
  62 The \fBTRAYICON\fP keyword changes the icon \fIXWin\fP displays in the
  63 system tray area.
  64
  65 .TP 8
  66 .B SILENTEXIT
  67 The \fBSILENTEXIT\fP keyword, which takes no parameters, disables the
  68 exit confirmation dialog if no clients are connected.
  69
  70 .TP 8
  71 .B FORCEEXIT
  72 The \fBFORCEEXIT\fP keyword, which takes no parameters, disables the
  73 exit confirmation dialog always.  Unsaved client work may be lost but
  74 this may be useful if you want no dialogs.
  75
  76 .SH Menu instructions
  77 .TP 8
  78 .B MENU \fIMenu_Name\fP {
  79 .br
  80 .B       \fIMenu_Item_Line\fP
  81 .br
  82 .B       \fIMenu_Item_Line\fP
  83 .br
  84 .B        \fI...\fP
  85 .br
  86 .B }
  87 .br
  88 This instruction defines a menu and asigns a \fIMenu_Name\fP to it.
  89 \fIMenu_Item_Line\fP are lines  of any of the following types:
  90 .TP 8
  91 .B SEPARATOR
  92 .TP 8
  93 .B \fIItem_Label\fP  EXEC \fICommand\fP
  94 .TP 8
  95 .B \fIItem_Label\fP  MENU \fIpreviously-defined-menu-name\fP
  96 .TP 8
  97 .B \fIItem_Label\fP  ALWAYSONTOP
  98 .TP 8
  99 .B \fIItem_Label\fP  RELOAD
 100 .br
 101 The \fIItem_Label\fP is the string that is written in the menu item.
 102 .br
 103 \fICommand\fP is a string with the command that will be executed by /bin/sh.
 104 Here paths should be \fICYGWIN\fP style (e.g. /usr/local/bin/myprogram).
 105 A string "%display%" appearing in the \fICommand\fP will be replaced
 106 with the proper display variable (i.e. 127.0.0.1:<display>.0).
 107 .br
 108 \fBALWAYSONTOP\fP sets the window to which the menu is associated to
 109 display above all others.
 110 .br
 111 \fBRELOAD\fP causes the XWinrc file to be reloaded and icons and menus
 112 regenerated.
 113 .TP 8
 114 .B ROOTMENU \fIpreviously-defined-menu-name\fP
 115 Includes the items in the indicated menu into the menu associated with
 116 \fIXWin\fP that appears in the system tray.
 117 .TP 8
 118 .B DEFAULTSYSMENU \fIpreviously-defined-menu-name\fP ATSTART|ATEND
 119 Includes the items in the indicated menu into the menu associated with
 120 generic top-level X-Windows in the \fIXWin\fP \fImultiwindow\fP mode.  The
 121 keywords \fBATSTART\fP and \fBATEND\fP indicate if such items should be
 122 included at the start or at the end of the menu.
 123 .TP 8
 124 .B SYSMENU {
 125   \fIclass-or-name-of-window\fP \fIdefined-menu-name\fP \fBATSTART|ATEND\fP
 126 .br
 127   \fI...\fP
 128 .br
 129   \fB}\fP
 130 .br
 131 Associates a specific menu to a specified window class or name
 132 in \fI-multiwindow\fP mode. The keywords ATSTART or ATEND indicate if
 133 such items should be included at the start or at the end of the menu.
 134
 135
 136 .SH Icon Instructions
 137 When specifying an \fIicon-file\fP in the following commands several different formats are allowed:
 138 .br
 139 \fB"NAME.ICO"\fP\fI of an .ico format file\fP
 140 .br
 141 \t \t ("cygwin.ico", "apple.ico")
 142 .br
 143 \fB"NAME.DLL,nn"\fP\fI of a .DLL and icon index\fP
 144 .br
 145 \t \t ("c:\\windows\\system32\\shell32.dll,4" is the default folder icon)
 146 .br
 147 \fB",nnn"\fP\fI index into XWin.EXE internal ICON resources\fP
 148 .br
 149 \t \t (",101" is the 1st icon inside \fIXWin.EXE\fP)
 150 .TP 8
 151 .B ICONDIRECTORY \fIWindows-path-to-icon-directory\fP
 152 Defines the default directory to search for \ficon-file\fP files.
 153 It should be a \fIWindows\fP style path (e.g. C:\\cygwin\\usr\\local\\icons).
 154 .TP 8
 155 .B DEFAULTICON \fIicon-file\fP
 156 Defines a replacement for the standard X icon for applications without
 157 specified icons.
 158 .TP 8
 159 .B ICONS {
 160 .br
 161  \fIclass-or-name-of-window\fP \fIicon-file\fP
 162 .br
 163   \fI...\fP
 164 .br
 165   \fB}\fP
 166 .br
 167 Defines icon replacements windows matching the specified window class or names.
 168 If multiple name or class matches occur for a window, only the first one
 169 will be used.
 170
 171 .SH Style Instructions
 172 .TP 8
 173 .B STYLES {
 174 \fIclass-or-name-of-window\fP \fIstyle-keyword-1\fP \fIstyle-keyword-2\fP
 175 .br
 176   \fI...\fP
 177 .br
 178 \fB}\fP
 179
 180 Associates specific styles to a specified window class or name
 181 in \fI-multiwindow\fP mode.  If multiple class or name matches occur,
 182 for a window, only the first one will be used.
 183
 184 The style keywords indicate the following:
 185
 186 \fIstyle-keyword-1\fP
 187
 188 \fBTOPMOST\fP
 189 .br
 190 Open the class or name above all NOTOPMOST Microsoft Windows
 191 .br
 192 \fBMAXIMIZE\fP
 193 .br
 194 Start the class or name fullscreen.
 195 .br
 196 \fBMINIMIZE\fP
 197 .br
 198 Start the class or name iconic.
 199 .br
 200 \fBBOTTOM\fP
 201 .br
 202 Open the class or name below all Windows windows.
 203 .br
 204
 205 \fIstyle-keyword-2\fP
 206
 207 \fBNOTITLE\fP
 208 .br
 209 No Windows title bar, for the class or name.
 210 .br
 211 \fBOUTLINE\fP
 212 .br
 213 No Windows title bar and just a thin-line border, for the class or name.
 214 .br
 215 \fBNOFRAME\fP
 216 .br
 217 No Windows title bar or border, for the class or name.
 218
 219 One keyword in \fIstyle-keyword-1\fP can be used with one keyword in \fIstyle-keyword-2\fP,
 220 or any keyword can be used singly.
 221
 222
 223 .SH EXAMPLE
 224 .TP 8
 225 This example adds an Xterm menu item to the system tray icon
 226 \fBMENU systray {
 227 .br
 228 \t xterm  EXEC "xterm -display %display% -sb -sl 999"
 229 .br
 230 \t SEPARATOR
 231 .br
 232 }
 233 .br
 234 ROOTMENU systray
 235 \fP
 236
 237 .TP 8
 238 This example makes an oclock window frameless in \fI-multiwindow\fP mode
 239 \fBSTYLES {
 240 .br
 241 \t oclock NOFRAME
 242 .br
 243 }
 244
 245
 246
 247 .SH "SEE ALSO"
 248  XWin(1)
 249
 250
 251 .SH AUTHOR
 252 The XWinrc feature of XWin was written primarily by Earle F. Philhower
 253 III.  Extended for style configuration by Colin Harrison.