Update documentation for dwm

This commit is contained in:
Alexis Jhon Gaspar 2023-09-09 22:11:53 +08:00
parent acc9225059
commit c318385181

265
dwm/dwm.1
View file

@ -177,3 +177,268 @@ XToolkit/XAWT backend can recognize) or when using OpenJDK setting the environme
.BR _JAVA_AWT_WM_NONREPARENTING=1 .
.SH BUGS
Send all bug reports with a patch to hackers@suckless.org.
.SH NAME
.PP
dwm - dynamic window manager
.SH SYNOPSIS
.PP
\f[B]dwm\f[R] [\f[B]-v\f[R]]
.SH DESCRIPTION
.PP
dwm is a dynamic window manager for X.
It manages windows in tiled, monocle and floating layouts.
Either layout can be applied dynamically, optimising the environment for
the application in use and the task performed.
.PP
In tiled layouts windows are managed in a master and stacking area.
The master area on the left contains one window by default, and the
stacking area on the right contains all other windows.
The number of master area windows can be adjusted from zero to an
arbitrary number.
In monocle layout all windows are 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.
.PP
Windows are grouped by tags.
Each window can be tagged with one or multiple tags.
Selecting certain tags displays all windows with these tags.
.PP
Each screen contains a small status bar which displays all available
tags, the layout, the title of the focused window, and the text read
from the root window name property, if the screen is focused.
A floating window is indicated with an empty square and a maximised
floating window is indicated with a filled square before the windows
title.
The selected tags are indicated with a different color.
The tags of the focused window are indicated with a filled square in the
top left corner.
The tags which are applied to one or more windows are indicated with an
empty square in the top left corner.
.PP
dwm draws a small border around windows to indicate the focus state.
.SH OPTIONS
.TP
\f[B]-v\f[R]
prints version information to stderr, then exits.
.SH USAGE
.SS Status bar
.TP
\f[B]X root window name\f[R]
is read and displayed in the status text area.
It can be set with the \f[B]xsetroot\f[R](1) command.
.TP
\f[B]Button1\f[R]
click on a tag label to display all windows with that tag, click on the
layout label toggles between tiled and floating layout.
.TP
\f[B]Button3\f[R]
click on a tag label adds/removes all windows with that tag to/from the
view.
.TP
\f[B]Mod1-Button1\f[R]
click on a tag label applies that tag to the focused window.
.TP
\f[B]Mod1-Button3\f[R]
click on a tag label adds/removes that tag to/from the focused window.
.SS Keyboard commands
.TP
\f[B]Mod1-Shift-Return\f[R]
Start \f[B]st(1).\f[R]
.TP
\f[B]Mod1-Shift-t\f[R]
Start \f[B]st(1)\f[R] via \f[B]tabbed(1).\f[R]
.TP
\f[B]Mod4-s\f[R]
Spawn \f[B]spmenu(1)\f[R] for launching other programs.
.TP
\f[B]Mod4-Shift-s\f[R]
Spawn \f[B]spmenu(1)\f[R] for launching specific programs (mimics
\f[B]dmenu(1)\f[R] behavior).
.TP
\f[B]Mod4-Mod1-s\f[R]
Spawn \f[B]dmenu(1)\f[R] if \f[B]spmenu(1)\f[R] isn\[cq]t installed or
if preferred.
.TP
\f[B]Mod4-Print\f[R]
Screenshot dwm via \f[B]maim(1)\f[R], saving it to \[ti]/Pictures.
.TP
\f[B]Mod4-Shift-Print\f[R]
Screenshot with the ability to copy it on the clipboard, via the
screenshot-spmenu script for \f[B]spmenu(1).\f[R]
.TP
\f[B]Mod4-Mod1-Print\f[R]
Partial screenshot via the screenshot-spmenu script for
\f[B]spmenu(1).\f[R]
.TP
\f[B]Mod4-v\f[R]
View clipboard contents using the clipmenu-spmenu script for
\f[B]spmenu(1).\f[R]
.TP
\f[B]Mod4-p\f[R]
Search 1337x via the pirokit-spmenu script for \f[B]spmenu(1).\f[R]
.TP
\f[B]Mod4-w\f[R]
Set the wallpaper using xwallpaper via the wallpaper-spmenu script for
\f[B]spmenu(1).\f[R]
.TP
\f[B]Mod4-e\f[R]
Launch a file manager (by default, Dolphin).
.TP
\f[B]Mod1-Shift-i\f[R]
Launch a browser (by default, Firefox).
.TP
\f[B]Mod1-n\f[R]
Switch to the next tag, if any.
.TP
\f[B]Mod1-b\f[R]
Switch to the previous tag, if any.
.TP
\f[B]Mod1-,\f[R]
Focus previous screen, if any.
.TP
\f[B]Mod1-.\f[R]
Focus next screen, if any.
.TP
\f[B]Mod1-Shift-,\f[R]
Send focused window to previous screen, if any.
.TP
\f[B]Mod1-Shift-.\f[R]
Send focused window to next screen, if any.
.TP
\f[B]Mod1-Shift-b\f[R]
Toggles bar on and off.
.TP
\f[B]Mod1-t\f[R]
Sets tiled layout.
.TP
\f[B]Mod1-f\f[R]
Sets floating layout.
.TP
\f[B]Mod1-m\f[R]
Sets monocle layout.
.TP
\f[B]Mod1-g\f[R]
Sets grid layout.
.TP
\f[B]Mod1-Shift-d\f[R]
Sets horizontal grid layout.
.TP
\f[B]Mod-Shift-g\f[R]
Sets gapless grid layout.
.TP
\f[B]Mod1-space\f[R]
Toggles between current and previous layout.
.TP
\f[B]Mod1-j\f[R]
Focus next window.
.TP
\f[B]Mod1-k\f[R]
Focus previous window.
.TP
\f[B]Mod1-i\f[R]
Increase number of windows in master area.
.TP
\f[B]Mod1-d\f[R]
Decrease number of windows in master area.
.TP
\f[B]Mod1-l\f[R]
Increase master area size.
.TP
\f[B]Mod1-h\f[R]
Decrease master area size.
.TP
\f[B]Mod1-Return\f[R]
Zooms/cycles focused window to/from master area (tiled layouts only).
.TP
\f[B]Mod1-Shift-x\f[R]
Close focused window.
.TP
\f[B]Mod1-Shift-f\f[R]
Toggle fullscreen for focused window.
.TP
\f[B]Mod1-Shift-space\f[R]
Toggle focused window between tiled and floating state.
.TP
\f[B]Mod1-q\f[R]
Toggles to the previously selected tags.
.TP
\f[B]Mod1-Shift-[1..n]\f[R]
Apply nth tag to focused window.
.TP
\f[B]Mod1-Shift-0\f[R]
Apply all tags to focused window.
.TP
\f[B]Mod1-Control-Shift-[1..n]\f[R]
Add/remove nth tag to/from focused window.
.TP
\f[B]Mod1-[1..n]\f[R]
View all windows with nth tag.
.TP
\f[B]Mod1-0\f[R]
View all windows with any tag.
.TP
\f[B]Mod1-Control-[1..n]\f[R]
Add/remove all windows with nth tag to/from the view.
.TP
\f[B]Mod1-Tab\f[R]
Switch between active windows.
.TP
\f[B]Ctrl-Shift-s\f[R]
Show hidden windows.
.TP
\f[B]Ctrl-Shift-h\f[R]
Hide windows.
.TP
\f[B]Mod1-Shift-j\f[R]
Focus to next hidden window.
.TP
\f[B]Mod1-Shift-k\f[R]
Focus to previous hidden window.
.TP
\f[B]Mod1-Shift-q\f[R]
Quit dwm.
.SS Mouse commands
.TP
\f[B]Mod1-Button1\f[R]
Move focused window while dragging.
Tiled windows will be toggled to the floating state.
.TP
\f[B]Mod1-Button2\f[R]
Toggles focused window between floating and tiled state.
.TP
\f[B]Mod1-Button3\f[R]
Resize focused window while dragging.
Tiled windows will be toggled to the floating state.
.TP
\f[B]Button1-󰕰 Start\f[R]
Spawn \f[B]spmenu(1)\f[R] for launching other programs.
.TP
\f[B]Button1-(program)\f[R]
Show/hide a window.
.SH CUSTOMIZATION
.PP
dwm is customized by creating a custom config.h and (re)compiling the
source code.
This keeps it fast, secure and simple.
.SH SEE ALSO
.PP
\f[B]dmenu\f[R](1), \f[B]st\f[R](1), \f[B]spmenu(1)\f[R]
.SH ISSUES
.PP
Java applications which use the XToolkit/XAWT backend may draw grey
windows only.
The XToolkit/XAWT backend breaks ICCCM-compliance in recent JDK 1.5 and
early JDK 1.6 versions, because it assumes a reparenting window manager.
Possible workarounds are using JDK 1.4 (which doesn\[aq]t contain the
XToolkit/XAWT backend) or setting the environment variable
\f[B]AWT_TOOLKIT=MToolkit\f[R] (to use the older Motif backend instead)
or running \f[B]xprop -root -f _NET_WM_NAME 32a -set _NET_WM_NAME
LG3D\f[R] or \f[B]wmname LG3D\f[R] (to pretend that a non-reparenting
window manager is running that the XToolkit/XAWT backend can recognize)
or when using OpenJDK setting the environment variable
\f[B]_JAVA_AWT_WM_NONREPARENTING=1\f[R].
.SH BUGS
.PP
Send all bug reports with a patch to hackers\[at]suckless.org,
lucas0021a\[at]outlook.com, via GitHub, GitLab or BitBucket.