Pileus Git - wmpus/blob - wmpus.1

   1 .TH WMPUS 1 "June 2012" wmpus
   2 .SH NAME
   3 wmpus \- cross platform window manager
   4 .SH SYNOPSIS
   5 .B wmpus\fR [\fIOPTION\fR..]
   6 .SH DESCRIPTION
   7 wmpus is portable window manager. Currently it supports wmii like window
   8 management and includes x11 and win32 backends.
   9 .SH OPTIONS
  10 .TP
  11 .B -n\fR, \fB--no-capture\fR
  12 Do not arrange pre-existing windows
  13 .TP
  14 .B -b\fR, \fB--border\fR=\fIN\fR
  15 Draw an n pixel window border
  16 .TP
  17 .B -m\fR, \fB--margin\fR=\fIN\fR
  18 Leave an n pixel margin around windows
  19 .TP
  20 .B -i\fR, \fB--int\fR=\fIKEY=NUM\fR
  21 Set integer configuration option
  22 .TP
  23 .B -s\fR, \fB--str\fR=\fIKEY=STR\fR
  24 Set string configuration option
  25 .TP
  26 .B -h\fR, \fB--help\fR
  27 Print usage information
  28 .SH CONFIGURATION
  29 Wmpus supports a simple ini-like configuration file stored in the users home
  30 directory. Currently supported configuration options include:
  31 .SS Main section
  32 .TP
  33 .B no-capture\fR=\fI[01]\fR
  34 Do not arrange pre-existing windows. Same as \fB-n\fR
  35 .TP
  36 .B border\fR=\fIN\fR
  37 Border width in pixels to draw around windows. X11 only, default 2. Same as
  38 \fB-b\fR
  39 .TP
  40 .B margin\fR=\fIN\fR
  41 Margin in pixels between windows for wm-wmii. X11 default 0, Win32 default 15.
  42 Same as \fB-m\fR
  43 .TP
  44 .B stack\fR=\fIN\fR
  45 Height in pixels for non-focused windows when the column is set to stack layout
  46 .SH COMPILE-TIME OPTIONS
  47 The windowing system backend and window management modes can be changed at
  48 compile-time by linking in the correct object file. Supported windowing systems
  49 include X11 (sys-x11.c) and Windows (sys-win32.c). Supported window management
  50 modes include WMII like window management (wm-wmii.c) and a simple tags based
  51 virtual-desktop manager (wm-tags.c).
  52 .P
  53 In addition several pre-processor settings are available which can be set in
  54 config.mk or on the command line:
  55 .TP
  56 .B MODKEY\fR=\fIkey\fR
  57 Modifier used for window management commands, can be either \fIAlt\fR,
  58 \fICtrl\fR, \fIShift\fR, or \fIWin\fR. Default Alt
  59 .TP
  60 .B DEBUG\fR
  61 Enable various debugging functions
  62 .P
  63 .SH WMII WINDOW MANAGEMENT
  64 The wmii window management mode mimics the behavior of the \fBwmii\fR(1) window
  65 manager. By default, the \fBAlt\-\fR prefix is used for most window management
  66 commands and is used along with the h, j, k, and l keys to focused different
  67 windows.
  68 .P
  69 The \fBAlt\-Shift\-\fR prefix is used for moving windows and works similar to
  70 changing the focus. The mouse is used for resizing windows and also for
  71 changing focus.
  72 .SS Changing focus
  73 .TP
  74 .B Alt\-j
  75 Focus window \fIbelow\fR the currently focused window
  76 .TP
  77 .B Alt\-k
  78 Focus window \fIabove\fR the currently focused window
  79 .TP
  80 .B Alt\-h
  81 Focus column to the \fIleft\fR of the currently focused column
  82 .TP
  83 .B Alt\-l
  84 Focus column to the \fIright\fR of the currently focused column
  85 .SS Moving windows around
  86 .TP
  87 .B Alt\-Shift\-j
  88 Move the currently focused window \fIdown\fR
  89 .TP
  90 .B Alt\-Shift\-k
  91 Move the currently focused window \fIup\fR
  92 .TP
  93 .B Alt\-Shift\-h
  94 Move the currently focused window to the \fIleft\fR
  95 .TP
  96 .B Alt\-Shift\-l
  97 Move the currently focused window to the \fIright\fR
  98 .SS Column layouts
  99 .TP
 100 .B Alt\-d
 101 Switch the current column to \fIsplit\fR layout
 102 .TP
 103 .B Alt\-s
 104 Switch the current to \fIstack\fR layout
 105 .TP
 106 .B Alt\-m
 107 Switch the current to \fImaximized\fR layout
 108 .SS Tagging windows
 109 .TP
 110 .B Alt\-[0..n]
 111 Switch to tag n
 112 .TP
 113 .B Alt\-Shift\-[0..n]
 114 Move the currently focused window to tag n
 115 .SS Floating windows
 116 .TP
 117 .B Alt-Space
 118 Toggle focus between the tiling and floating layers
 119 .TP
 120 .B Alt-Shift-Space
 121 Move the currently focused window between the tiling and floating layers
 122 .SS Other commands
 123 .TP
 124 .B Alt-f
 125 Toggle fullscreen for the focused window
 126 .TP
 127 .B Alt-Shift-c
 128 Close the currently focused window
 129 .TP
 130 .B Alt-Shift-q
 131 Restore all hidden windows and quit wmpus
 132 .TP
 133 .B Alt-F5
 134 Refresh the window layout (useful for debugging)
 135 .TP
 136 .B Alt-F6
 137 Dump a ASCII representation the window layout to standard output (useful for
 138 debugging)
 139 .SS Mouse commands
 140 .TP
 141 .B Pointer
 142 Moving the mouse over a window focuses that window
 143 .TP
 144 .B Button1
 145 Click in a floating window brings it to the top
 146 .TP
 147 .B Alt-Button1
 148 Click and drag moves a floating window under the cursor
 149 .TP
 150 .B Alt-Button3, Alt-Shift-Button1
 151 Click and drag resizes the window under the cursor
 152 .SH X11 BACKEND
 153 The X11 backend draws a small 2px border around each window. The border for the
 154 currently focused window is set to a lighter color than the rest.
 155 .SH WIN32 BACKEND
 156 The Win32 backend uses the existing window borders and title bars. It also
 157 leaves a narrow space between the windows so that they look more natural in a
 158 Windows environment.
 159 .SH FILES
 160 .TP
 161 ~/.wmpus
 162 The wmpus configuration file
 163 .SH SEE ALSO
 164 .BR wmii (1),
 165 .BR dwm (1),
 166 .BR dzen (1)
 167 .SH BUGS
 168 Many