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