man: Update

This commit is contained in:
github-actions 2022-12-01 11:57:12 +00:00
parent 1d1c012cb9
commit c1670303c0
2 changed files with 126 additions and 124 deletions

View File

@ -1,10 +1,10 @@
.\" Automatically generated by Pandoc 2.5 .\" Automatically generated by Pandoc 2.9.2.1
.\" .\"
.TH "XMONAD" "1" "27 October 2021" "Tiling Window Manager" "" .TH "XMONAD" "1" "27 October 2021" "Tiling Window Manager" ""
.hy .hy
.SH Name .SH Name
.PP .PP
xmonad \- Tiling Window Manager xmonad - Tiling Window Manager
.SH Description .SH Description
.PP .PP
\f[I]xmonad\f[R] is a minimalist tiling window manager for X, written in \f[I]xmonad\f[R] is a minimalist tiling window manager for X, written in
@ -36,27 +36,27 @@ featureful window manager in less than 1200 lines of code, with an
emphasis on correctness and robustness. emphasis on correctness and robustness.
Internal properties of the window manager are checked using a Internal properties of the window manager are checked using a
combination of static guarantees provided by the type system, and combination of static guarantees provided by the type system, and
type\-based automated testing. type-based automated testing.
A benefit of this is that the code is simple to understand, and easy to A benefit of this is that the code is simple to understand, and easy to
modify. modify.
.SH Usage .SH Usage
.PP .PP
\f[I]xmonad\f[R] places each window into a \[lq]workspace\[rq]. \f[I]xmonad\f[R] places each window into a \[lq]workspace\[rq].
Each workspace can have any number of windows, which you can cycle Each workspace can have any number of windows, which you can cycle
though with mod\-j and mod\-k. though with mod-j and mod-k.
Windows are either displayed full screen, tiled horizontally, or tiled Windows are either displayed full screen, tiled horizontally, or tiled
vertically. vertically.
You can toggle the layout mode with mod\-space, which will cycle through You can toggle the layout mode with mod-space, which will cycle through
the available modes. the available modes.
.PP .PP
You can switch to workspace N with mod\-N. You can switch to workspace N with mod-N.
For example, to switch to workspace 5, you would press mod\-5. For example, to switch to workspace 5, you would press mod-5.
Similarly, you can move the current window to another workspace with Similarly, you can move the current window to another workspace with
mod\-shift\-N. mod-shift-N.
.PP .PP
When running with multiple monitors (Xinerama), each screen has exactly When running with multiple monitors (Xinerama), each screen has exactly
1 workspace visible. 1 workspace visible.
mod\-{w,e,r} switch the focus between screens, while shift\-mod\-{w,e,r} mod-{w,e,r} switch the focus between screens, while shift-mod-{w,e,r}
move the current window to that screen. move the current window to that screen.
When \f[I]xmonad\f[R] starts, workspace 1 is on screen 1, workspace 2 is When \f[I]xmonad\f[R] starts, workspace 1 is on screen 1, workspace 2 is
on screen 2, etc. on screen 2, etc.
@ -67,115 +67,115 @@ and visible workspaces are swapped.
xmonad has several flags which you may pass to the executable. xmonad has several flags which you may pass to the executable.
These flags are: These flags are:
.TP .TP
.B \[en]recompile \[en]recompile
Recompiles your \f[I]xmonad.hs\f[R] configuration Recompiles your \f[I]xmonad.hs\f[R] configuration
.TP .TP
.B \[en]restart \[en]restart
Causes the currently running \f[I]xmonad\f[R] process to restart Causes the currently running \f[I]xmonad\f[R] process to restart
.TP .TP
.B \[en]replace \[en]replace
Replace the current window manager with xmonad Replace the current window manager with xmonad
.TP .TP
.B \[en]version \[en]version
Display version of \f[I]xmonad\f[R] Display version of \f[I]xmonad\f[R]
.TP .TP
.B \[en]verbose\-version \[en]verbose-version
Display detailed version of \f[I]xmonad\f[R] Display detailed version of \f[I]xmonad\f[R]
.SS Default keyboard bindings .SS Default keyboard bindings
.TP .TP
.B mod\-shift\-return mod-shift-return
Launch terminal Launch terminal
.TP .TP
.B mod\-p mod-p
Launch dmenu Launch dmenu
.TP .TP
.B mod\-shift\-p mod-shift-p
Launch gmrun Launch gmrun
.TP .TP
.B mod\-shift\-c mod-shift-c
Close the focused window Close the focused window
.TP .TP
.B mod\-space mod-space
Rotate through the available layout algorithms Rotate through the available layout algorithms
.TP .TP
.B mod\-shift\-space mod-shift-space
Reset the layouts on the current workspace to default Reset the layouts on the current workspace to default
.TP .TP
.B mod\-n mod-n
Resize viewed windows to the correct size Resize viewed windows to the correct size
.TP .TP
.B mod\-tab mod-tab
Move focus to the next window Move focus to the next window
.TP .TP
.B mod\-shift\-tab mod-shift-tab
Move focus to the previous window Move focus to the previous window
.TP .TP
.B mod\-j mod-j
Move focus to the next window Move focus to the next window
.TP .TP
.B mod\-k mod-k
Move focus to the previous window Move focus to the previous window
.TP .TP
.B mod\-m mod-m
Move focus to the master window Move focus to the master window
.TP .TP
.B mod\-return mod-return
Swap the focused window and the master window Swap the focused window and the master window
.TP .TP
.B mod\-shift\-j mod-shift-j
Swap the focused window with the next window Swap the focused window with the next window
.TP .TP
.B mod\-shift\-k mod-shift-k
Swap the focused window with the previous window Swap the focused window with the previous window
.TP .TP
.B mod\-h mod-h
Shrink the master area Shrink the master area
.TP .TP
.B mod\-l mod-l
Expand the master area Expand the master area
.TP .TP
.B mod\-t mod-t
Push window back into tiling Push window back into tiling
.TP .TP
.B mod\-comma mod-comma
Increment the number of windows in the master area Increment the number of windows in the master area
.TP .TP
.B mod\-period mod-period
Deincrement the number of windows in the master area Deincrement the number of windows in the master area
.TP .TP
.B mod\-shift\-q mod-shift-q
Quit xmonad Quit xmonad
.TP .TP
.B mod\-q mod-q
Restart xmonad Restart xmonad
.TP .TP
.B mod\-shift\-slash mod-shift-slash
Run xmessage with a summary of the default keybindings (useful for Run xmessage with a summary of the default keybindings (useful for
beginners) beginners)
.TP .TP
.B mod\-question mod-question
Run xmessage with a summary of the default keybindings (useful for Run xmessage with a summary of the default keybindings (useful for
beginners) beginners)
.TP .TP
.B mod\-[1..9] mod-[1..9]
Switch to workspace N Switch to workspace N
.TP .TP
.B mod\-shift\-[1..9] mod-shift-[1..9]
Move client to workspace N Move client to workspace N
.TP .TP
.B mod\-{w,e,r} mod-{w,e,r}
Switch to physical/Xinerama screens 1, 2, or 3 Switch to physical/Xinerama screens 1, 2, or 3
.TP .TP
.B mod\-shift\-{w,e,r} mod-shift-{w,e,r}
Move client to screen 1, 2, or 3 Move client to screen 1, 2, or 3
.TP .TP
.B mod\-button1 mod-button1
Set the window to floating mode and move by dragging Set the window to floating mode and move by dragging
.TP .TP
.B mod\-button2 mod-button2
Raise the window to the top of the stack Raise the window to the top of the stack
.TP .TP
.B mod\-button3 mod-button3
Set the window to floating mode and resize by dragging Set the window to floating mode and resize by dragging
.SH Examples .SH Examples
.PP .PP
@ -188,7 +188,7 @@ exec xmonad
.SH Customization .SH Customization
.PP .PP
xmonad is customized in your \f[I]xmonad.hs\f[R], and then restarted xmonad is customized in your \f[I]xmonad.hs\f[R], and then restarted
with mod\-q. with mod-q.
You can choose where your configuration file lives by You can choose where your configuration file lives by
.IP "1." 3 .IP "1." 3
Setting \f[C]XMONAD_DATA_DIR,\f[R] \f[C]XMONAD_CONFIG_DIR\f[R], and Setting \f[C]XMONAD_DATA_DIR,\f[R] \f[C]XMONAD_CONFIG_DIR\f[R], and
@ -201,14 +201,13 @@ Creating \f[I]xmonad.hs\f[R] in \f[C]XDG_CONFIG_HOME\f[R].
Note that, in this case, xmonad will use \f[C]XDG_DATA_HOME\f[R] and Note that, in this case, xmonad will use \f[C]XDG_DATA_HOME\f[R] and
\f[C]XDG_CACHE_HOME\f[R] for its data and cache directory respectively. \f[C]XDG_CACHE_HOME\f[R] for its data and cache directory respectively.
.PP .PP
You can find many extensions to the core feature set in the xmonad\- You can find many extensions to the core feature set in the xmonad-
contrib package, available through your package manager or from contrib package, available through your package manager or from
xmonad.org (https://xmonad.org). xmonad.org (https://xmonad.org).
.SS Modular Configuration .SS Modular Configuration
.PP .PP
As of \f[I]xmonad\-0.9\f[R], any additional Haskell modules may be As of \f[I]xmonad-0.9\f[R], any additional Haskell modules may be placed
placed in \f[I]\[ti]/.xmonad/lib/\f[R] are available in GHC\[cq]s in \f[I]\[ti]/.xmonad/lib/\f[R] are available in GHC\[cq]s searchpath.
searchpath.
Hierarchical modules are supported: for example, the file Hierarchical modules are supported: for example, the file
\f[I]\[ti]/.xmonad/lib/XMonad/Stack/MyAdditions.hs\f[R] could contain: \f[I]\[ti]/.xmonad/lib/XMonad/Stack/MyAdditions.hs\f[R] could contain:
.IP .IP
@ -220,7 +219,7 @@ module XMonad.Stack.MyAdditions (function1) where
.fi .fi
.PP .PP
Your xmonad.hs may then import XMonad.Stack.MyAdditions as if that Your xmonad.hs may then import XMonad.Stack.MyAdditions as if that
module was contained within xmonad or xmonad\-contrib. module was contained within xmonad or xmonad-contrib.
.SH Bugs .SH Bugs
.PP .PP
Probably. Probably.

View File

@ -7,74 +7,75 @@
<meta name="author" content="" /> <meta name="author" content="" />
<meta name="dcterms.date" content="2021-10-27" /> <meta name="dcterms.date" content="2021-10-27" />
<title>XMONAD(1) Tiling Window Manager</title> <title>XMONAD(1) Tiling Window Manager</title>
<style type="text/css"> <style>
code{white-space: pre-wrap;} code{white-space: pre-wrap;}
span.smallcaps{font-variant: small-caps;} span.smallcaps{font-variant: small-caps;}
span.underline{text-decoration: underline;} span.underline{text-decoration: underline;}
div.column{display: inline-block; vertical-align: top; width: 50%;} div.column{display: inline-block; vertical-align: top; width: 50%;}
</style> div.hanging-indent{margin-left: 1.5em; text-indent: -1.5em;}
<style type="text/css"> ul.task-list{list-style: none;}
a.sourceLine { display: inline-block; line-height: 1.25; } pre > code.sourceCode { white-space: pre; position: relative; }
a.sourceLine { pointer-events: none; color: inherit; text-decoration: inherit; } pre > code.sourceCode > span { display: inline-block; line-height: 1.25; }
a.sourceLine:empty { height: 1.2em; } pre > code.sourceCode > span:empty { height: 1.2em; }
.sourceCode { overflow: visible; } code.sourceCode > span { color: inherit; text-decoration: inherit; }
code.sourceCode { white-space: pre; position: relative; } div.sourceCode { margin: 1em 0; }
div.sourceCode { margin: 1em 0; } pre.sourceCode { margin: 0; }
pre.sourceCode { margin: 0; } @media screen {
@media screen { div.sourceCode { overflow: auto; }
div.sourceCode { overflow: auto; } }
} @media print {
@media print { pre > code.sourceCode { white-space: pre-wrap; }
code.sourceCode { white-space: pre-wrap; } pre > code.sourceCode > span { text-indent: -5em; padding-left: 5em; }
a.sourceLine { text-indent: -1em; padding-left: 1em; } }
} pre.numberSource code
pre.numberSource a.sourceLine { counter-reset: source-line 0; }
{ position: relative; left: -4em; } pre.numberSource code > span
pre.numberSource a.sourceLine::before { position: relative; left: -4em; counter-increment: source-line; }
{ content: attr(title); pre.numberSource code > span > a:first-child::before
position: relative; left: -1em; text-align: right; vertical-align: baseline; { content: counter(source-line);
border: none; pointer-events: all; display: inline-block; position: relative; left: -1em; text-align: right; vertical-align: baseline;
-webkit-touch-callout: none; -webkit-user-select: none; border: none; display: inline-block;
-khtml-user-select: none; -moz-user-select: none; -webkit-touch-callout: none; -webkit-user-select: none;
-ms-user-select: none; user-select: none; -khtml-user-select: none; -moz-user-select: none;
padding: 0 4px; width: 4em; -ms-user-select: none; user-select: none;
color: #aaaaaa; padding: 0 4px; width: 4em;
} color: #aaaaaa;
pre.numberSource { margin-left: 3em; border-left: 1px solid #aaaaaa; padding-left: 4px; } }
div.sourceCode pre.numberSource { margin-left: 3em; border-left: 1px solid #aaaaaa; padding-left: 4px; }
{ } div.sourceCode
@media screen { { }
a.sourceLine::before { text-decoration: underline; } @media screen {
} pre > code.sourceCode > span > a:first-child::before { text-decoration: underline; }
code span.al { color: #ff0000; font-weight: bold; } /* Alert */ }
code span.an { color: #60a0b0; font-weight: bold; font-style: italic; } /* Annotation */ code span.al { color: #ff0000; font-weight: bold; } /* Alert */
code span.at { color: #7d9029; } /* Attribute */ code span.an { color: #60a0b0; font-weight: bold; font-style: italic; } /* Annotation */
code span.bn { color: #40a070; } /* BaseN */ code span.at { color: #7d9029; } /* Attribute */
code span.bu { } /* BuiltIn */ code span.bn { color: #40a070; } /* BaseN */
code span.cf { color: #007020; font-weight: bold; } /* ControlFlow */ code span.bu { } /* BuiltIn */
code span.ch { color: #4070a0; } /* Char */ code span.cf { color: #007020; font-weight: bold; } /* ControlFlow */
code span.cn { color: #880000; } /* Constant */ code span.ch { color: #4070a0; } /* Char */
code span.co { color: #60a0b0; font-style: italic; } /* Comment */ code span.cn { color: #880000; } /* Constant */
code span.cv { color: #60a0b0; font-weight: bold; font-style: italic; } /* CommentVar */ code span.co { color: #60a0b0; font-style: italic; } /* Comment */
code span.do { color: #ba2121; font-style: italic; } /* Documentation */ code span.cv { color: #60a0b0; font-weight: bold; font-style: italic; } /* CommentVar */
code span.dt { color: #902000; } /* DataType */ code span.do { color: #ba2121; font-style: italic; } /* Documentation */
code span.dv { color: #40a070; } /* DecVal */ code span.dt { color: #902000; } /* DataType */
code span.er { color: #ff0000; font-weight: bold; } /* Error */ code span.dv { color: #40a070; } /* DecVal */
code span.ex { } /* Extension */ code span.er { color: #ff0000; font-weight: bold; } /* Error */
code span.fl { color: #40a070; } /* Float */ code span.ex { } /* Extension */
code span.fu { color: #06287e; } /* Function */ code span.fl { color: #40a070; } /* Float */
code span.im { } /* Import */ code span.fu { color: #06287e; } /* Function */
code span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Information */ code span.im { } /* Import */
code span.kw { color: #007020; font-weight: bold; } /* Keyword */ code span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Information */
code span.op { color: #666666; } /* Operator */ code span.kw { color: #007020; font-weight: bold; } /* Keyword */
code span.ot { color: #007020; } /* Other */ code span.op { color: #666666; } /* Operator */
code span.pp { color: #bc7a00; } /* Preprocessor */ code span.ot { color: #007020; } /* Other */
code span.sc { color: #4070a0; } /* SpecialChar */ code span.pp { color: #bc7a00; } /* Preprocessor */
code span.ss { color: #bb6688; } /* SpecialString */ code span.sc { color: #4070a0; } /* SpecialChar */
code span.st { color: #4070a0; } /* String */ code span.ss { color: #bb6688; } /* SpecialString */
code span.va { color: #19177c; } /* Variable */ code span.st { color: #4070a0; } /* String */
code span.vs { color: #4070a0; } /* VerbatimString */ code span.va { color: #19177c; } /* Variable */
code span.wa { color: #60a0b0; font-weight: bold; font-style: italic; } /* Warning */ code span.vs { color: #4070a0; } /* VerbatimString */
code span.wa { color: #60a0b0; font-weight: bold; font-style: italic; } /* Warning */
</style> </style>
</head> </head>
<body> <body>
@ -83,16 +84,18 @@ code span.wa { color: #60a0b0; font-weight: bold; font-style: italic; } /* Warni
<p class="author"></p> <p class="author"></p>
<p class="date">27 October 2021</p> <p class="date">27 October 2021</p>
</header> </header>
<nav id="TOC"> <nav id="TOC" role="doc-toc">
<ul> <ul>
<li><a href="#name">Name</a></li> <li><a href="#name">Name</a></li>
<li><a href="#description">Description</a></li> <li><a href="#description">Description</a></li>
<li><a href="#usage">Usage</a><ul> <li><a href="#usage">Usage</a>
<ul>
<li><a href="#flags">Flags</a></li> <li><a href="#flags">Flags</a></li>
<li><a href="#default-keyboard-bindings">Default keyboard bindings</a></li> <li><a href="#default-keyboard-bindings">Default keyboard bindings</a></li>
</ul></li> </ul></li>
<li><a href="#examples">Examples</a></li> <li><a href="#examples">Examples</a></li>
<li><a href="#customization">Customization</a><ul> <li><a href="#customization">Customization</a>
<ul>
<li><a href="#modular-configuration">Modular Configuration</a></li> <li><a href="#modular-configuration">Modular Configuration</a></li>
</ul></li> </ul></li>
<li><a href="#bugs">Bugs</a></li> <li><a href="#bugs">Bugs</a></li>
@ -238,8 +241,8 @@ code span.wa { color: #60a0b0; font-weight: bold; font-style: italic; } /* Warni
<p>You can find many extensions to the core feature set in the xmonad- contrib package, available through your package manager or from <a href="https://xmonad.org">xmonad.org</a>.</p> <p>You can find many extensions to the core feature set in the xmonad- contrib package, available through your package manager or from <a href="https://xmonad.org">xmonad.org</a>.</p>
<h2 id="modular-configuration">Modular Configuration</h2> <h2 id="modular-configuration">Modular Configuration</h2>
<p>As of <em>xmonad-0.9</em>, any additional Haskell modules may be placed in <em>~/.xmonad/lib/</em> are available in GHCs searchpath. Hierarchical modules are supported: for example, the file <em>~/.xmonad/lib/XMonad/Stack/MyAdditions.hs</em> could contain:</p> <p>As of <em>xmonad-0.9</em>, any additional Haskell modules may be placed in <em>~/.xmonad/lib/</em> are available in GHCs searchpath. Hierarchical modules are supported: for example, the file <em>~/.xmonad/lib/XMonad/Stack/MyAdditions.hs</em> could contain:</p>
<div class="sourceCode" id="cb1"><pre class="sourceCode haskell"><code class="sourceCode haskell"><a class="sourceLine" id="cb1-1" title="1"><span class="kw">module</span> <span class="dt">XMonad.Stack.MyAdditions</span> (function1) <span class="kw">where</span></a> <div class="sourceCode" id="cb1"><pre class="sourceCode haskell"><code class="sourceCode haskell"><span id="cb1-1"><a href="#cb1-1" aria-hidden="true"></a><span class="kw">module</span> <span class="dt">XMonad.Stack.MyAdditions</span> (function1) <span class="kw">where</span></span>
<a class="sourceLine" id="cb1-2" title="2"> function1 <span class="ot">=</span> <span class="fu">error</span> <span class="st">&quot;function1: Not implemented yet!&quot;</span></a></code></pre></div> <span id="cb1-2"><a href="#cb1-2" aria-hidden="true"></a> function1 <span class="ot">=</span> <span class="fu">error</span> <span class="st">&quot;function1: Not implemented yet!&quot;</span></span></code></pre></div>
<p>Your xmonad.hs may then import XMonad.Stack.MyAdditions as if that module was contained within xmonad or xmonad-contrib.</p> <p>Your xmonad.hs may then import XMonad.Stack.MyAdditions as if that module was contained within xmonad or xmonad-contrib.</p>
<h1 id="bugs">Bugs</h1> <h1 id="bugs">Bugs</h1>
<p>Probably. If you find any, please report them to the <a href="https://github.com/xmonad/xmonad/issues">bugtracker</a></p> <p>Probably. If you find any, please report them to the <a href="https://github.com/xmonad/xmonad/issues">bugtracker</a></p>