XWinrc.man (7253B)
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-specifier\fP in the following commands several different formats are allowed: 138 .PP 139 .IP \fI"NAME.ICO"\fP 16 140 filename of an .ico format file 141 .br 142 (e.g. "cygwin.ico", "apple.ico", "C:\\icons\\cheese.ico", "/usr/share/icons/moon.ico") 143 .IP \fI"NAME.DLL,nnn"\fP 16 144 filename of a DLL with an index into its ICON resources 145 .br 146 (e.g. "c:\\windows\\system32\\shell32.dll,4", the default folder icon, 147 "/usr/bin/cygicons-0.dll,10", the hippo icon) 148 .IP \fI",nnn"\fP 16 149 index into the XWin executable's internal ICON resources 150 .br 151 (e.g. ",101" is the 1st icon in \fIXWin\fP) 152 .TP 8 153 .B ICONDIRECTORY \fIWindows-path-to-icon-directory\fP 154 Defines the default directory for the file when an \fIicon-specifier\fP doesn't 155 contain an absolute path. 156 It should be a \fIWindows\fP style path (e.g. C:\\cygwin\\usr\\local\\icons). 157 .TP 8 158 .B DEFAULTICON \fIicon-specifier\fP 159 Defines a replacement for the standard X icon for applications without 160 specified icons. 161 .TP 8 162 .B ICONS { 163 .br 164 \fIclass-or-name-of-window\fP \fIicon-specifier\fP 165 .br 166 \fI...\fP 167 .br 168 \fB}\fP 169 .br 170 Defines icon replacements windows matching the specified window class or names. 171 If multiple name or class matches occur for a window, only the first one 172 will be used. 173 174 .SH Style Instructions 175 .TP 8 176 .B STYLES { 177 \fIclass-or-name-of-window\fP \fIstyle-keyword-1\fP \fIstyle-keyword-2\fP 178 .br 179 \fI...\fP 180 .br 181 \fB}\fP 182 183 Associates specific styles to a specified window class or name 184 in \fI-multiwindow\fP mode. If multiple class or name matches occur, 185 for a window, only the first one will be used. 186 187 The style keywords indicate the following: 188 189 \fIstyle-keyword-1\fP 190 191 \fBTOPMOST\fP 192 .br 193 Open the class or name above all NOTOPMOST Microsoft Windows 194 .br 195 \fBMAXIMIZE\fP 196 .br 197 Start the class or name fullscreen. 198 .br 199 \fBMINIMIZE\fP 200 .br 201 Start the class or name iconic. 202 .br 203 \fBBOTTOM\fP 204 .br 205 Open the class or name below all Windows windows. 206 .br 207 208 \fIstyle-keyword-2\fP 209 210 \fBNOTITLE\fP 211 .br 212 No Windows title bar, for the class or name. 213 .br 214 \fBOUTLINE\fP 215 .br 216 No Windows title bar and just a thin-line border, for the class or name. 217 .br 218 \fBNOFRAME\fP 219 .br 220 No Windows title bar or border, for the class or name. 221 222 One keyword in \fIstyle-keyword-1\fP can be used with one keyword in \fIstyle-keyword-2\fP, 223 or any keyword can be used singly. 224 225 226 .SH EXAMPLE 227 .TP 8 228 This example adds an Xterm menu item to the system tray icon 229 \fBMENU systray { 230 .br 231 \t xterm EXEC "xterm -display %display% -sb -sl 999" 232 .br 233 \t SEPARATOR 234 .br 235 } 236 .br 237 ROOTMENU systray 238 \fP 239 240 .TP 8 241 This example makes an oclock window frameless in \fI-multiwindow\fP mode 242 \fBSTYLES { 243 .br 244 \t oclock NOFRAME 245 .br 246 } 247 248 249 250 .SH "SEE ALSO" 251 XWin(1) 252 253 254 .SH AUTHOR 255 The XWinrc feature of XWin was written primarily by Earle F. Philhower 256 III. Extended for style configuration by Colin Harrison.