mirror of
https://github.com/xmonad/xmonad.git
synced 2025-08-01 04:31:53 -07:00
GenerateManpage: greatly simplify the code
We can take advantage of modern Pandoc features to move information like the release date, the man page section, etc. into the markdown source rather than having to insert that data during the rendering process. The only thing that remains to be figured out by this tool is the set of known key bindings.
This commit is contained in:
Peter Simons
284
man/xmonad.1
284
man/xmonad.1
@@ -1,10 +1,10 @@
|
||||
.TH xmonad 1 "5 July 2018" xmonad-0.13 "xmonad manual".\" Automatically generated by Pandoc 2.2.1
|
||||
.\" Automatically generated by Pandoc 2.2.1
|
||||
.\"
|
||||
.TH "" "" "" "" ""
|
||||
.TH "XMONAD" "1" "20 August 2018" "Tiling Window Manager" ""
|
||||
.hy
|
||||
.SH Name
|
||||
.PP
|
||||
xmonad \- a tiling window manager
|
||||
xmonad \- Tiling Window Manager
|
||||
.SH Description
|
||||
.PP
|
||||
\f[I]xmonad\f[] is a minimalist tiling window manager for X, written in
|
||||
@@ -41,7 +41,7 @@ A benefit of this is that the code is simple to understand, and easy to
|
||||
modify.
|
||||
.SH Usage
|
||||
.PP
|
||||
\f[I]xmonad\f[] places each window into a "workspace".
|
||||
\f[I]xmonad\f[] places each window into a \[lq]workspace\[rq].
|
||||
Each workspace can have any number of windows, which you can cycle
|
||||
though with mod\-j and mod\-k.
|
||||
Windows are either displayed full screen, tiled horizontally, or tiled
|
||||
@@ -66,84 +66,190 @@ and visible workspaces are swapped.
|
||||
.PP
|
||||
xmonad has several flags which you may pass to the executable.
|
||||
These flags are:
|
||||
.TP
|
||||
.B \[en]recompile
|
||||
Recompiles your configuration in \f[I]~/.xmonad/xmonad.hs\f[]
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B \[en]restart
|
||||
Causes the currently running \f[I]xmonad\f[] process to restart
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B \[en]replace
|
||||
Replace the current window manager with xmonad
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B \[en]version
|
||||
Display version of \f[I]xmonad\f[]
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B \[en]verbose\-version
|
||||
Display detailed version of \f[I]xmonad\f[]
|
||||
.RS
|
||||
.RE
|
||||
.PP
|
||||
\-\-recompile : Recompiles your configuration in
|
||||
\f[I]~/.xmonad/xmonad.hs\f[]
|
||||
.PP
|
||||
\-\-restart : Causes the currently running \f[I]xmonad\f[] process to
|
||||
restart
|
||||
.PP
|
||||
\-\-replace : Replace the current window manager with xmonad
|
||||
.PP
|
||||
\-\-version : Display version of \f[I]xmonad\f[]
|
||||
.PP
|
||||
\-\-verbose\-version : Display detailed version of \f[I]xmonad\f[]
|
||||
.SS Default keyboard bindings
|
||||
.PP
|
||||
mod\-shift\-return : Launch terminal
|
||||
.PP
|
||||
mod\-p : Launch dmenu
|
||||
.PP
|
||||
mod\-shift\-p : Launch gmrun
|
||||
.PP
|
||||
mod\-shift\-c : Close the focused window
|
||||
.PP
|
||||
mod\-space : Rotate through the available layout algorithms
|
||||
.PP
|
||||
mod\-shift\-space : Reset the layouts on the current workspace to
|
||||
default
|
||||
.PP
|
||||
mod\-n : Resize viewed windows to the correct size
|
||||
.PP
|
||||
mod\-tab : Move focus to the next window
|
||||
.PP
|
||||
mod\-shift\-tab : Move focus to the previous window
|
||||
.PP
|
||||
mod\-j : Move focus to the next window
|
||||
.PP
|
||||
mod\-k : Move focus to the previous window
|
||||
.PP
|
||||
mod\-m : Move focus to the master window
|
||||
.PP
|
||||
mod\-return : Swap the focused window and the master window
|
||||
.PP
|
||||
mod\-shift\-j : Swap the focused window with the next window
|
||||
.PP
|
||||
mod\-shift\-k : Swap the focused window with the previous window
|
||||
.PP
|
||||
mod\-h : Shrink the master area
|
||||
.PP
|
||||
mod\-l : Expand the master area
|
||||
.PP
|
||||
mod\-t : Push window back into tiling
|
||||
.PP
|
||||
mod\-comma : Increment the number of windows in the master area
|
||||
.PP
|
||||
mod\-period : Deincrement the number of windows in the master area
|
||||
.PP
|
||||
mod\-shift\-q : Quit xmonad
|
||||
.PP
|
||||
mod\-q : Restart xmonad
|
||||
.PP
|
||||
mod\-shift\-slash : Run xmessage with a summary of the default
|
||||
keybindings (useful for beginners)
|
||||
.PP
|
||||
mod\-question : Run xmessage with a summary of the default keybindings
|
||||
(useful for beginners)
|
||||
.PP
|
||||
mod\-[1..9] : Switch to workspace N
|
||||
.PP
|
||||
mod\-shift\-[1..9] : Move client to workspace N
|
||||
.PP
|
||||
mod\-{w,e,r} : Switch to physical/Xinerama screens 1, 2, or 3
|
||||
.PP
|
||||
mod\-shift\-{w,e,r} : Move client to screen 1, 2, or 3
|
||||
.PP
|
||||
mod\-button1 : Set the window to floating mode and move by dragging
|
||||
.PP
|
||||
mod\-button2 : Raise the window to the top of the stack
|
||||
.PP
|
||||
mod\-button3 : Set the window to floating mode and resize by dragging
|
||||
##Default keyboard bindings
|
||||
.TP
|
||||
.B mod\-shift\-return
|
||||
Launch terminal
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B mod\-p
|
||||
Launch dmenu
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B mod\-shift\-p
|
||||
Launch gmrun
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B mod\-shift\-c
|
||||
Close the focused window
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B mod\-space
|
||||
Rotate through the available layout algorithms
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B mod\-shift\-space
|
||||
Reset the layouts on the current workspace to default
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B mod\-n
|
||||
Resize viewed windows to the correct size
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B mod\-tab
|
||||
Move focus to the next window
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B mod\-shift\-tab
|
||||
Move focus to the previous window
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B mod\-j
|
||||
Move focus to the next window
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B mod\-k
|
||||
Move focus to the previous window
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B mod\-m
|
||||
Move focus to the master window
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B mod\-return
|
||||
Swap the focused window and the master window
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B mod\-shift\-j
|
||||
Swap the focused window with the next window
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B mod\-shift\-k
|
||||
Swap the focused window with the previous window
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B mod\-h
|
||||
Shrink the master area
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B mod\-l
|
||||
Expand the master area
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B mod\-t
|
||||
Push window back into tiling
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B mod\-comma
|
||||
Increment the number of windows in the master area
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B mod\-period
|
||||
Deincrement the number of windows in the master area
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B mod\-shift\-q
|
||||
Quit xmonad
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B mod\-q
|
||||
Restart xmonad
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B mod\-shift\-slash
|
||||
Run xmessage with a summary of the default keybindings (useful for
|
||||
beginners)
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B mod\-question
|
||||
Run xmessage with a summary of the default keybindings (useful for
|
||||
beginners)
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B mod\-[1..9]
|
||||
Switch to workspace N
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B mod\-shift\-[1..9]
|
||||
Move client to workspace N
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B mod\-{w,e,r}
|
||||
Switch to physical/Xinerama screens 1, 2, or 3
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B mod\-shift\-{w,e,r}
|
||||
Move client to screen 1, 2, or 3
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B mod\-button1
|
||||
Set the window to floating mode and move by dragging
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B mod\-button2
|
||||
Raise the window to the top of the stack
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B mod\-button3
|
||||
Set the window to floating mode and resize by dragging
|
||||
.RS
|
||||
.RE
|
||||
.SH Examples
|
||||
.PP
|
||||
To use xmonad as your window manager add to your \f[I]~/.xinitrc\f[]
|
||||
@@ -159,19 +265,25 @@ mod\-q.
|
||||
.PP
|
||||
You can find many extensions to the core feature set in the xmonad\-
|
||||
contrib package, available through your package manager or from
|
||||
[xmonad.org].
|
||||
xmonad.org (http://xmonad.org).
|
||||
.SS Modular Configuration
|
||||
.PP
|
||||
As of \f[I]xmonad\-0.9\f[], any additional Haskell modules may be placed
|
||||
in \f[I]~/.xmonad/lib/\f[] are available in GHC\[aq]s searchpath.
|
||||
in \f[I]~/.xmonad/lib/\f[] are available in GHC's searchpath.
|
||||
Hierarchical modules are supported: for example, the file
|
||||
\f[I]~/.xmonad/lib/XMonad/Stack/MyAdditions.hs\f[] could contain:
|
||||
.PP
|
||||
\f[C]haskell\ module\ XMonad.Stack.MyAdditions\ (function1)\ where\ \ \ function1\ =\ error\ "function1:\ Not\ implemented\ yet!"\f[]
|
||||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
module\ XMonad.Stack.MyAdditions\ (function1)\ where
|
||||
\ \ function1\ =\ error\ "function1:\ Not\ implemented\ yet!"
|
||||
\f[]
|
||||
.fi
|
||||
.PP
|
||||
Your xmonad.hs may then import XMonad.Stack.MyAdditions as if that
|
||||
module was contained within xmonad or xmonad\-contrib.
|
||||
.SH Bugs
|
||||
.PP
|
||||
Probably.
|
||||
If you find any, please report them to the [bugtracker]
|
||||
If you find any, please report them to the
|
||||
bugtracker (https://github.com/xmonad/xmonad/issues)
|
||||
|
||||
Reference in New Issue
Block a user