doc/wmaker.in

   1 .\" Hey, Emacs!  This is an -*- nroff -*- source file.
   2 .TH "Window Maker" 1 "February 2015"
   3 .SH NAME
   4 wmaker \- X11 window manager with a NEXTSTEP look
   5 .SH SYNOPSIS
   6 .B wmaker
   7 .I "[-options]"
   8 .SH "DESCRIPTION"
   9 Window Maker is a X11 window manager with a NEXTSTEP look. It tries to
  10 emulate NeXT's look as much as possible, but it deviates from it as
  11 necessary.
  12 .SH "OPTIONS"
  13 .TP
  14 .BI \-display " host:display.screen"
  15 specify display to use.
  16 On multiheaded machines, Window Maker will automatically manage all screens.
  17 If you want Window Maker to manage only a specific screen, you must supply
  18 the screen number you want to have managed with the
  19 .B \-display
  20 command line argument. For example, if you want Window Maker to manage only
  21 screen 1, start it as:
  22 .EX
  23 wmaker -display :0.1
  24 .EE
  25 .TP
  26 .B \-\-dont\-restore
  27 do not restore saved session
  28 .TP
  29 .B \-\-global_defaults_path
  30 print the path where the files for the default configuration are installed and exit
  31 .TP
  32 .B \-\-help
  33 print the list of command line options supported, one per line, and exit
  34 .TP
  35 .BI \-\-locale " locale"
  36 specify the locale (i18n language) to use; Window Maker will also set the variable
  37 .B LANG
  38 which will be inherited by all applications started from Window Maker
  39 .TP
  40 .B \-\-no\-autolaunch
  41 do not launch at start-up the applications that were marked in the configuration as autolanched
  42 .TP
  43 .B \-\-no\-clip
  44 do not show the workspace Clip
  45 .TP
  46 .B \-\-no\-dock
  47 do not show the application Dock
  48 .TP
  49 .B \-\-no\-drawer
  50 disable the Drawers in the Dock
  51 @!HAVE_INOTIFY@.TP
  52 @!HAVE_INOTIFY@.B \-\-no\-polling
  53 @!HAVE_INOTIFY@disable the periodic check on the configuration file to reload it automatically
  54 @USE_ICCCM_WMREPLACE@.TP
  55 @USE_ICCCM_WMREPLACE@.B \-\-replace
  56 @USE_ICCCM_WMREPLACE@ask the currently running window manager to let Window Maker take his place
  57 .TP
  58 .B \-\-static
  59 do not update or save automatically the configuration
  60 .TP
  61 .B \-\-version
  62 display Window Maker's version number and exit
  63 .TP
  64 .B \-\-visual\-id
  65 specify the ID of the visual to use; see
  66 .BR xdpyinfo (1)
  67 for a list of visuals available in your display
  68 .PP
  69 .SH FILES
  70 .TP
  71 .B ~/GNUstep/Defaults/WindowMaker
  72 general Window Maker defaults.
  73 .TP
  74 .B ~/GNUstep/Defaults/WMState
  75 information about the Dock and Clip. DON'T edit this while running
  76 Window Maker. It will be overwritten.
  77 .TP
  78 .B ~/GNUstep/Defaults/WMRootMenu
  79 Contains the name of the file to read the root menu from or the
  80 menu itself, in property list format.
  81 .TP
  82 .B ~/GNUstep/Defaults/WMWindowAttributes
  83 Attributes for different application classes and instances. Use the
  84 Attribute Editor (right drag the application's title bar, select
  85 Attributes) instead of modifying this file directly. There are just a
  86 few options not available using the Attributes Editor.
  87 .TP
  88 .B @pkgconfdir@/
  89 All the above-mentioned files are READ from here if not found except
  90 for WMState, which is COPIED from here. No matter where they are read
  91 from, if it's necessary to write configuration changes back into this
  92 files, user's files will be written to.
  93 .TP
  94 .B ~/GNUstep/Library/WindowMaker/autostart
  95 This script is automatically executed when Window Maker is started.
  96 .TP
  97 .B ~/GNUstep/Library/WindowMaker/exitscript
  98 This script is automatically executed immediately before Window Maker is
  99 exited.
 100 .B Note:
 101 If you need to run something that requires the X server to be running
 102 from this script, make sure you do not use the
 103 .I SHUTDOWN
 104 command from the root menu to exit Window Maker. Otherwise, the X server
 105 might be shut down before the script is executed.
 106 .TP
 107 .B ~/GNUstep/Library/WindowMaker/
 108 The menu file indicated in WMRootMenu is looked for here...
 109 .TP
 110 .B @pkgdatadir@/
 111 and here, in that order. Unless, the indicated path is an absolute path.
 112 .TP
 113 .B ~/GNUstep/Library/WindowMaker/Pixmaps/
 114 Window Maker looks for \fBpixmaps\fP here
 115 .TP
 116 .B ~/GNUstep/Library/Icons/
 117 Window Maker looks for \fBicons\fP here
 118 .TP
 119 .B ~/GNUstep/Library/WindowMaker/Backgrounds/
 120 Window Maker looks for backgrounds here
 121 .TP
 122 .B ~/GNUstep/Library/WindowMaker/Styles/
 123 Window Maker looks for style files here (not true... it looks like it
 124 does, but you have to specify the full path anyway, it's just a place
 125 to keep things nicely ordered)
 126 .TP
 127 .B ~/GNUstep/Library/WindowMaker/Themes/
 128 Window Maker looks for theme files here (ibid)
 129 .TP
 130 .B @pkgdatadir@/Pixmaps/
 131 System-wide (Window Maker-specific) pixmaps are located here
 132 .TP
 133 .B @pkgdatadir@/Styles/
 134 System wide styles are here
 135 .TP
 136 .B @pkgdatadir@/Themes/
 137 Guess... ;-)
 138 .SH ENVIRONMENT
 139 .IP WMAKER_USER_ROOT
 140 specifies the initial path for the Defaults directory. "Defaults/" is
 141 appended to this variable to determine the actual location of the
 142 databases. If the variable is not set, it defaults to "~/GNUstep"
 143 .IP GNUSTEP_USER_APPS
 144 specifies the location of the user's GNUstep Apps directory. If this
 145 variable is empty, it defaults to ~/GNUstep/Applications.
 146 .IP GNUSTEP_LOCAL_APPS
 147 specifies the location of the system-wide \fBlocal\fP GNUstep Apps
 148 directory (this is useful, for example, in those cases where the
 149 system-wide location is really a network wide location). If this
 150 variable is empty, it defaults to /usr/local/GNUstep/Local/Applications.
 151 .IP GNUSTEP_SYSTEM_APPS
 152 specifies the location of the system-wide GNUstep Apps directory. If this
 153 variable is empty, it defaults to /usr/GNUstep/System/Applications.
 154 .SH SEE ALSO
 155 The Window Maker User Guide
 156 .PP
 157 The Window Maker FAQ
 158 .PP
 159 .BR WPrefs (1),
 160 .BR X (7),
 161 .BR wxcopy (1),
 162 .BR wxpaste (1),
 163 .BR geticonset (1),
 164 .BR seticons (1),
 165 .BR getstyle (1),
 166 .BR setstyle (1),
 167 .BR wmsetbg (1),
 168 .BR wmgenmenu (1),
 169 .BR wmmenugen (1),
 170 .BR wdread (1),
 171 .BR wdwrite (1)
 172 .SH AUTHOR
 173 Window Maker was written by Alfredo K. Kojima <kojima@windowmaker.info>,
 174 Dan Pascu <dan@windowmaker.info> with contributions from many people around
 175 the Internet.
 176 .PP
 177 This manual page was created by Marcelo E. Magallon, <mmagallo@debian.org>
 178 and is maintained by the Window Maker team.