documentation changes

This commit is contained in:
Luke Smith 2020-03-31 08:52:28 -04:00
parent 4947ecce95
commit a72eace034
No known key found for this signature in database
GPG key ID: 4C50B54A911F6252

149
dwm.1
View file

@ -1,21 +1,16 @@
.TH DWM 1 dwm\-VERSION .TH DWM 1 dwm\-VERSION
.SH NAME .SH NAME
dwm \- dynamic window manager dwm \- dynamic window manager (Luke Smith <https://lukesmith.xyz>'s build)
.SH SYNOPSIS .SH SYNOPSIS
.B dwm .B dwm
.RB [ \-v ] .RB [ \-v ]
.SH DESCRIPTION .SH DESCRIPTION
dwm is a dynamic window manager for X. It manages windows in tiled, monocle dwm is a dynamic window manager for X.
and floating layouts. Either layout can be applied dynamically, optimising the
environment for the application in use and the task performed.
.P .P
In tiled layouts windows are managed in a master and stacking area. The master dwm "orders" windows based on recency and primacy, while dwm layouts may
area on the left contains one window by default, and the stacking area on the change, the most recent "master" window is shown in the most prominent
right contains all other windows. The number of master area windows can be position. There are bindings for cycling through and promoting windows to the
adjusted from zero to an arbitrary number. In monocle layout all windows are master position.
maximised to the screen size. In floating layout windows can be resized and
moved freely. Dialog windows are always managed floating, regardless of the
layout applied.
.P .P
Windows are grouped by tags. Each window can be tagged with one or multiple Windows are grouped by tags. Each window can be tagged with one or multiple
tags. Selecting certain tags displays all windows with these tags. tags. Selecting certain tags displays all windows with these tags.
@ -30,6 +25,15 @@ top left corner. The tags which are applied to one or more windows are
indicated with an empty square in the top left corner. indicated with an empty square in the top left corner.
.P .P
dwm draws a small border around windows to indicate the focus state. dwm draws a small border around windows to indicate the focus state.
.P
.I
libxft-bgra
should be installed for this build of dwm. Arch users may install it via the
AUR. Color characters and emoji are inabled, but these will cause crashes
without the fix
.I
libxft-bgra
offers.
.SH OPTIONS .SH OPTIONS
.TP .TP
.B \-v .B \-v
@ -42,115 +46,106 @@ is read and displayed in the status text area. It can be set with the
.BR xsetroot (1) .BR xsetroot (1)
command. command.
.TP .TP
.B Button1 .B Left click
click on a tag label to display all windows with that tag, click on the layout click on a tag label to display all windows with that tag, click on the layout
label toggles between tiled and floating layout. label toggles between tiled and floating layout.
.TP .TP
.B Button3 .B Right click
click on a tag label adds/removes all windows with that tag to/from the view. click on a tag label adds/removes all windows with that tag to/from the view.
.TP .TP
.B Mod1\-Button1 .B Super\-Left click
click on a tag label applies that tag to the focused window. click on a tag label applies that tag to the focused window.
.TP .TP
.B Mod1\-Button3 .B Super\-Right click
click on a tag label adds/removes that tag to/from the focused window. click on a tag label adds/removes that tag to/from the focused window.
.SS Keyboard commands .SS Keyboard commands
.TP .TP
.B Mod1\-Shift\-Return .B Super\-Return
Start Start terminal,
.BR st(1). .BR st(1).
.TP .TP
.B Mod1\-p .B Super\-d
Spawn Spawn
.BR dmenu(1) .BR dmenu(1)
for launching other programs. for launching other programs.
.TP .TP
.B Mod1\-, .B Super\-b
Focus previous screen, if any.
.TP
.B Mod1\-.
Focus next screen, if any.
.TP
.B Mod1\-Shift\-,
Send focused window to previous screen, if any.
.TP
.B Mod1\-Shift\-.
Send focused window to next screen, if any.
.TP
.B Mod1\-b
Toggles bar on and off. Toggles bar on and off.
.TP .TP
.B Mod1\-t .B Super\-q
Sets tiled layout.
.TP
.B Mod1\-f
Sets floating layout.
.TP
.B Mod1\-m
Sets monocle layout.
.TP
.B Mod1\-space
Toggles between current and previous layout.
.TP
.B Mod1\-j
Focus next window.
.TP
.B Mod1\-k
Focus previous window.
.TP
.B Mod1\-i
Increase number of windows in master area.
.TP
.B Mod1\-d
Decrease number of windows in master area.
.TP
.B Mod1\-l
Increase master area size.
.TP
.B Mod1\-h
Decrease master area size.
.TP
.B Mod1\-Return
Zooms/cycles focused window to/from master area (tiled layouts only).
.TP
.B Mod1\-Shift\-c
Close focused window. Close focused window.
.TP .TP
.B Mod1\-Shift\-space .B Super\-t
Sets tiled layout.
.TP
.B Super\-f
Toggle fullscreen window.
.TP
.B Super\-y
Sets Fibonacci spiral layout.
.TP
.B Super\-u
Sets centered master layout.
.TP
.B Super\-i
Sets floating centered master layout.
.TP
.B Super\-space
Zooms/cycles focused window to/from master area (tiled layouts only).
.TP
.B Super\-j/k
Focus next/previous window.
.TP
.B Super\-Shift\-j/k
Move selected window down/up in stack.
.TP
.B Super\-o
Increase number of windows in master area.
.TP
.B Super\-Shift\-o
Decrease number of windows in master area.
.TP
.B Super\-l
Increase master area size.
.TP
.B Super\-h
Decrease master area size.
.TP
.B Super\-Shift\-space
Toggle focused window between tiled and floating state. Toggle focused window between tiled and floating state.
.TP .TP
.B Mod1\-Tab .B Super\-Tab
Toggles to the previously selected tags. Toggles to the previously selected tags.
.TP .TP
.B Mod1\-Shift\-[1..n] .B Super\-Shift\-[1..n]
Apply nth tag to focused window. Apply nth tag to focused window.
.TP .TP
.B Mod1\-Shift\-0 .B Super\-Shift\-0
Apply all tags to focused window. Apply all tags to focused window.
.TP .TP
.B Mod1\-Control\-Shift\-[1..n] .B Super\-Control\-Shift\-[1..n]
Add/remove nth tag to/from focused window. Add/remove nth tag to/from focused window.
.TP .TP
.B Mod1\-[1..n] .B Super\-[1..n]
View all windows with nth tag. View all windows with nth tag.
.TP .TP
.B Mod1\-0 .B Super\-0
View all windows with any tag. View all windows with any tag.
.TP .TP
.B Mod1\-Control\-[1..n] .B Super\-Control\-[1..n]
Add/remove all windows with nth tag to/from the view. Add/remove all windows with nth tag to/from the view.
.TP .TP
.B Mod1\-Shift\-q .B Super\-Shift\-q
Quit dwm. Quit dwm.
.SS Mouse commands .SS Mouse commands
.TP .TP
.B Mod1\-Button1 .B Super\-Left click
Move focused window while dragging. Tiled windows will be toggled to the floating state. Move focused window while dragging. Tiled windows will be toggled to the floating state.
.TP .TP
.B Mod1\-Button2 .B Super\-Middle click
Toggles focused window between floating and tiled state. Toggles focused window between floating and tiled state.
.TP .TP
.B Mod1\-Button3 .B Super\-Right click
Resize focused window while dragging. Tiled windows will be toggled to the floating state. Resize focused window while dragging. Tiled windows will be toggled to the floating state.
.SH CUSTOMIZATION .SH CUSTOMIZATION
dwm is customized by creating a custom config.h and (re)compiling the source dwm is customized by creating a custom config.h and (re)compiling the source