mirror of
https://github.com/xmonad/xmonad.git
synced 2025-05-19 00:20:22 -07:00
491 lines
15 KiB
HTML
491 lines
15 KiB
HTML
<!DOCTYPE html>
|
||
<html xmlns="http://www.w3.org/1999/xhtml" lang="" xml:lang="">
|
||
<head>
|
||
<meta charset="utf-8" />
|
||
<meta name="generator" content="pandoc" />
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" />
|
||
<meta name="author" content="" />
|
||
<meta name="dcterms.date" content="2021-10-27" />
|
||
<title>XMONAD(1) Tiling Window Manager</title>
|
||
<style>
|
||
html {
|
||
color: #1a1a1a;
|
||
background-color: #fdfdfd;
|
||
}
|
||
body {
|
||
margin: 0 auto;
|
||
max-width: 36em;
|
||
padding-left: 50px;
|
||
padding-right: 50px;
|
||
padding-top: 50px;
|
||
padding-bottom: 50px;
|
||
hyphens: auto;
|
||
overflow-wrap: break-word;
|
||
text-rendering: optimizeLegibility;
|
||
font-kerning: normal;
|
||
}
|
||
@media (max-width: 600px) {
|
||
body {
|
||
font-size: 0.9em;
|
||
padding: 12px;
|
||
}
|
||
h1 {
|
||
font-size: 1.8em;
|
||
}
|
||
}
|
||
@media print {
|
||
html {
|
||
background-color: white;
|
||
}
|
||
body {
|
||
background-color: transparent;
|
||
color: black;
|
||
font-size: 12pt;
|
||
}
|
||
p, h2, h3 {
|
||
orphans: 3;
|
||
widows: 3;
|
||
}
|
||
h2, h3, h4 {
|
||
page-break-after: avoid;
|
||
}
|
||
}
|
||
p {
|
||
margin: 1em 0;
|
||
}
|
||
a {
|
||
color: #1a1a1a;
|
||
}
|
||
a:visited {
|
||
color: #1a1a1a;
|
||
}
|
||
img {
|
||
max-width: 100%;
|
||
}
|
||
h1, h2, h3, h4, h5, h6 {
|
||
margin-top: 1.4em;
|
||
}
|
||
h5, h6 {
|
||
font-size: 1em;
|
||
font-style: italic;
|
||
}
|
||
h6 {
|
||
font-weight: normal;
|
||
}
|
||
ol, ul {
|
||
padding-left: 1.7em;
|
||
margin-top: 1em;
|
||
}
|
||
li > ol, li > ul {
|
||
margin-top: 0;
|
||
}
|
||
blockquote {
|
||
margin: 1em 0 1em 1.7em;
|
||
padding-left: 1em;
|
||
border-left: 2px solid #e6e6e6;
|
||
color: #606060;
|
||
}
|
||
code {
|
||
font-family: Menlo, Monaco, Consolas, 'Lucida Console', monospace;
|
||
font-size: 85%;
|
||
margin: 0;
|
||
hyphens: manual;
|
||
}
|
||
pre {
|
||
margin: 1em 0;
|
||
overflow: auto;
|
||
}
|
||
pre code {
|
||
padding: 0;
|
||
overflow: visible;
|
||
overflow-wrap: normal;
|
||
}
|
||
.sourceCode {
|
||
background-color: transparent;
|
||
overflow: visible;
|
||
}
|
||
hr {
|
||
background-color: #1a1a1a;
|
||
border: none;
|
||
height: 1px;
|
||
margin: 1em 0;
|
||
}
|
||
table {
|
||
margin: 1em 0;
|
||
border-collapse: collapse;
|
||
width: 100%;
|
||
overflow-x: auto;
|
||
display: block;
|
||
font-variant-numeric: lining-nums tabular-nums;
|
||
}
|
||
table caption {
|
||
margin-bottom: 0.75em;
|
||
}
|
||
tbody {
|
||
margin-top: 0.5em;
|
||
border-top: 1px solid #1a1a1a;
|
||
border-bottom: 1px solid #1a1a1a;
|
||
}
|
||
th {
|
||
border-top: 1px solid #1a1a1a;
|
||
padding: 0.25em 0.5em 0.25em 0.5em;
|
||
}
|
||
td {
|
||
padding: 0.125em 0.5em 0.25em 0.5em;
|
||
}
|
||
header {
|
||
margin-bottom: 4em;
|
||
text-align: center;
|
||
}
|
||
#TOC li {
|
||
list-style: none;
|
||
}
|
||
#TOC ul {
|
||
padding-left: 1.3em;
|
||
}
|
||
#TOC > ul {
|
||
padding-left: 0;
|
||
}
|
||
#TOC a:not(:hover) {
|
||
text-decoration: none;
|
||
}
|
||
code{white-space: pre-wrap;}
|
||
span.smallcaps{font-variant: small-caps;}
|
||
div.columns{display: flex; gap: min(4vw, 1.5em);}
|
||
div.column{flex: auto; overflow-x: auto;}
|
||
div.hanging-indent{margin-left: 1.5em; text-indent: -1.5em;}
|
||
/* The extra [class] is a hack that increases specificity enough to
|
||
override a similar rule in reveal.js */
|
||
ul.task-list[class]{list-style: none;}
|
||
ul.task-list li input[type="checkbox"] {
|
||
font-size: inherit;
|
||
width: 0.8em;
|
||
margin: 0 0.8em 0.2em -1.6em;
|
||
vertical-align: middle;
|
||
}
|
||
.display.math{display: block; text-align: center; margin: 0.5rem auto;}
|
||
/* CSS for syntax highlighting */
|
||
pre > code.sourceCode { white-space: pre; position: relative; }
|
||
pre > code.sourceCode > span { line-height: 1.25; }
|
||
pre > code.sourceCode > span:empty { height: 1.2em; }
|
||
.sourceCode { overflow: visible; }
|
||
code.sourceCode > span { color: inherit; text-decoration: inherit; }
|
||
div.sourceCode { margin: 1em 0; }
|
||
pre.sourceCode { margin: 0; }
|
||
@media screen {
|
||
div.sourceCode { overflow: auto; }
|
||
}
|
||
@media print {
|
||
pre > code.sourceCode { white-space: pre-wrap; }
|
||
pre > code.sourceCode > span { text-indent: -5em; padding-left: 5em; }
|
||
}
|
||
pre.numberSource code
|
||
{ counter-reset: source-line 0; }
|
||
pre.numberSource code > span
|
||
{ position: relative; left: -4em; counter-increment: source-line; }
|
||
pre.numberSource code > span > a:first-child::before
|
||
{ content: counter(source-line);
|
||
position: relative; left: -1em; text-align: right; vertical-align: baseline;
|
||
border: none; display: inline-block;
|
||
-webkit-touch-callout: none; -webkit-user-select: none;
|
||
-khtml-user-select: none; -moz-user-select: none;
|
||
-ms-user-select: none; user-select: none;
|
||
padding: 0 4px; width: 4em;
|
||
color: #aaaaaa;
|
||
}
|
||
pre.numberSource { margin-left: 3em; border-left: 1px solid #aaaaaa; padding-left: 4px; }
|
||
div.sourceCode
|
||
{ }
|
||
@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.at { color: #7d9029; } /* Attribute */
|
||
code span.bn { color: #40a070; } /* BaseN */
|
||
code span.bu { color: #008000; } /* BuiltIn */
|
||
code span.cf { color: #007020; font-weight: bold; } /* ControlFlow */
|
||
code span.ch { color: #4070a0; } /* Char */
|
||
code span.cn { color: #880000; } /* Constant */
|
||
code span.co { color: #60a0b0; font-style: italic; } /* Comment */
|
||
code span.cv { color: #60a0b0; font-weight: bold; font-style: italic; } /* CommentVar */
|
||
code span.do { color: #ba2121; font-style: italic; } /* Documentation */
|
||
code span.dt { color: #902000; } /* DataType */
|
||
code span.dv { color: #40a070; } /* DecVal */
|
||
code span.er { color: #ff0000; font-weight: bold; } /* Error */
|
||
code span.ex { } /* Extension */
|
||
code span.fl { color: #40a070; } /* Float */
|
||
code span.fu { color: #06287e; } /* Function */
|
||
code span.im { color: #008000; font-weight: bold; } /* Import */
|
||
code span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Information */
|
||
code span.kw { color: #007020; font-weight: bold; } /* Keyword */
|
||
code span.op { color: #666666; } /* Operator */
|
||
code span.ot { color: #007020; } /* Other */
|
||
code span.pp { color: #bc7a00; } /* Preprocessor */
|
||
code span.sc { color: #4070a0; } /* SpecialChar */
|
||
code span.ss { color: #bb6688; } /* SpecialString */
|
||
code span.st { color: #4070a0; } /* String */
|
||
code span.va { color: #19177c; } /* Variable */
|
||
code span.vs { color: #4070a0; } /* VerbatimString */
|
||
code span.wa { color: #60a0b0; font-weight: bold; font-style: italic; } /* Warning */
|
||
</style>
|
||
</head>
|
||
<body>
|
||
<header id="title-block-header">
|
||
<h1 class="title">XMONAD(1) Tiling Window Manager</h1>
|
||
<p class="author"></p>
|
||
<p class="date">27 October 2021</p>
|
||
</header>
|
||
<nav id="TOC" role="doc-toc">
|
||
<ul>
|
||
<li><a href="#name" id="toc-name">Name</a></li>
|
||
<li><a href="#description" id="toc-description">Description</a></li>
|
||
<li><a href="#usage" id="toc-usage">Usage</a>
|
||
<ul>
|
||
<li><a href="#flags" id="toc-flags">Flags</a></li>
|
||
<li><a href="#default-keyboard-bindings"
|
||
id="toc-default-keyboard-bindings">Default keyboard bindings</a></li>
|
||
</ul></li>
|
||
<li><a href="#examples" id="toc-examples">Examples</a></li>
|
||
<li><a href="#customization" id="toc-customization">Customization</a>
|
||
<ul>
|
||
<li><a href="#modular-configuration"
|
||
id="toc-modular-configuration">Modular Configuration</a></li>
|
||
</ul></li>
|
||
<li><a href="#bugs" id="toc-bugs">Bugs</a></li>
|
||
</ul>
|
||
</nav>
|
||
<h1 id="name">Name</h1>
|
||
<p>xmonad - Tiling Window Manager</p>
|
||
<h1 id="description">Description</h1>
|
||
<p><em>xmonad</em> is a minimalist tiling window manager for X, written
|
||
in Haskell. Windows are managed using automatic layout algorithms, which
|
||
can be dynamically reconfigured. At any time windows are arranged so as
|
||
to maximize the use of screen real estate. All features of the window
|
||
manager are accessible purely from the keyboard: a mouse is entirely
|
||
optional. <em>xmonad</em> is configured in Haskell, and custom layout
|
||
algorithms may be implemented by the user in config files. A principle
|
||
of <em>xmonad</em> is predictability: the user should know in advance
|
||
precisely the window arrangement that will result from any action.</p>
|
||
<p>By default, <em>xmonad</em> provides three layout algorithms: tall,
|
||
wide and fullscreen. In tall or wide mode, windows are tiled and
|
||
arranged to prevent overlap and maximize screen use. Sets of windows are
|
||
grouped together on virtual screens, and each screen retains its own
|
||
layout, which may be reconfigured dynamically. Multiple physical
|
||
monitors are supported via Xinerama, allowing simultaneous display of a
|
||
number of screens.</p>
|
||
<p>By utilizing the expressivity of a modern functional language with a
|
||
rich static type system, <em>xmonad</em> provides a complete, featureful
|
||
window manager in less than 1200 lines of code, with an emphasis on
|
||
correctness and robustness. Internal properties of the window manager
|
||
are checked using a combination of static guarantees provided by the
|
||
type system, and type-based automated testing. A benefit of this is that
|
||
the code is simple to understand, and easy to modify.</p>
|
||
<h1 id="usage">Usage</h1>
|
||
<p><em>xmonad</em> places each window into a “workspace”. 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 vertically. You can toggle the layout mode with mod-space,
|
||
which will cycle through the available modes.</p>
|
||
<p>You can switch to workspace N with mod-N. For example, to switch to
|
||
workspace 5, you would press mod-5. Similarly, you can move the current
|
||
window to another workspace with mod-shift-N.</p>
|
||
<p>When running with multiple monitors (Xinerama), each screen has
|
||
exactly 1 workspace visible. mod-{w,e,r} switch the focus between
|
||
screens, while shift-mod-{w,e,r} move the current window to that screen.
|
||
When <em>xmonad</em> starts, workspace 1 is on screen 1, workspace 2 is
|
||
on screen 2, etc. When switching workspaces to one that is already
|
||
visible, the current and visible workspaces are swapped.</p>
|
||
<h2 id="flags">Flags</h2>
|
||
<p>xmonad has several flags which you may pass to the executable. These
|
||
flags are:</p>
|
||
<dl>
|
||
<dt>–recompile</dt>
|
||
<dd>
|
||
Recompiles your <em>xmonad.hs</em> configuration
|
||
</dd>
|
||
<dt>–restart</dt>
|
||
<dd>
|
||
Causes the currently running <em>xmonad</em> process to restart
|
||
</dd>
|
||
<dt>–replace</dt>
|
||
<dd>
|
||
Replace the current window manager with xmonad
|
||
</dd>
|
||
<dt>–version</dt>
|
||
<dd>
|
||
Display version of <em>xmonad</em>
|
||
</dd>
|
||
<dt>–verbose-version</dt>
|
||
<dd>
|
||
Display detailed version of <em>xmonad</em>
|
||
</dd>
|
||
</dl>
|
||
<h2 id="default-keyboard-bindings">Default keyboard bindings</h2>
|
||
<dl>
|
||
<dt>mod-shift-return</dt>
|
||
<dd>
|
||
Launch terminal
|
||
</dd>
|
||
<dt>mod-p</dt>
|
||
<dd>
|
||
Launch dmenu
|
||
</dd>
|
||
<dt>mod-shift-p</dt>
|
||
<dd>
|
||
Launch gmrun
|
||
</dd>
|
||
<dt>mod-shift-c</dt>
|
||
<dd>
|
||
Close the focused window
|
||
</dd>
|
||
<dt>mod-space</dt>
|
||
<dd>
|
||
Rotate through the available layout algorithms
|
||
</dd>
|
||
<dt>mod-shift-space</dt>
|
||
<dd>
|
||
Reset the layouts on the current workspace to default
|
||
</dd>
|
||
<dt>mod-n</dt>
|
||
<dd>
|
||
Resize viewed windows to the correct size
|
||
</dd>
|
||
<dt>mod-tab</dt>
|
||
<dd>
|
||
Move focus to the next window
|
||
</dd>
|
||
<dt>mod-shift-tab</dt>
|
||
<dd>
|
||
Move focus to the previous window
|
||
</dd>
|
||
<dt>mod-j</dt>
|
||
<dd>
|
||
Move focus to the next window
|
||
</dd>
|
||
<dt>mod-k</dt>
|
||
<dd>
|
||
Move focus to the previous window
|
||
</dd>
|
||
<dt>mod-m</dt>
|
||
<dd>
|
||
Move focus to the master window
|
||
</dd>
|
||
<dt>mod-return</dt>
|
||
<dd>
|
||
Swap the focused window and the master window
|
||
</dd>
|
||
<dt>mod-shift-j</dt>
|
||
<dd>
|
||
Swap the focused window with the next window
|
||
</dd>
|
||
<dt>mod-shift-k</dt>
|
||
<dd>
|
||
Swap the focused window with the previous window
|
||
</dd>
|
||
<dt>mod-h</dt>
|
||
<dd>
|
||
Shrink the master area
|
||
</dd>
|
||
<dt>mod-l</dt>
|
||
<dd>
|
||
Expand the master area
|
||
</dd>
|
||
<dt>mod-t</dt>
|
||
<dd>
|
||
Push window back into tiling
|
||
</dd>
|
||
<dt>mod-comma</dt>
|
||
<dd>
|
||
Increment the number of windows in the master area
|
||
</dd>
|
||
<dt>mod-period</dt>
|
||
<dd>
|
||
Deincrement the number of windows in the master area
|
||
</dd>
|
||
<dt>mod-shift-q</dt>
|
||
<dd>
|
||
Quit xmonad
|
||
</dd>
|
||
<dt>mod-q</dt>
|
||
<dd>
|
||
Restart xmonad
|
||
</dd>
|
||
<dt>mod-shift-slash</dt>
|
||
<dd>
|
||
Run xmessage with a summary of the default keybindings (useful for
|
||
beginners)
|
||
</dd>
|
||
<dt>mod-question</dt>
|
||
<dd>
|
||
Run xmessage with a summary of the default keybindings (useful for
|
||
beginners)
|
||
</dd>
|
||
<dt>mod-[1..9]</dt>
|
||
<dd>
|
||
Switch to workspace N
|
||
</dd>
|
||
<dt>mod-shift-[1..9]</dt>
|
||
<dd>
|
||
Move client to workspace N
|
||
</dd>
|
||
<dt>mod-{w,e,r}</dt>
|
||
<dd>
|
||
Switch to physical/Xinerama screens 1, 2, or 3
|
||
</dd>
|
||
<dt>mod-shift-{w,e,r}</dt>
|
||
<dd>
|
||
Move client to screen 1, 2, or 3
|
||
</dd>
|
||
<dt>mod-button1</dt>
|
||
<dd>
|
||
Set the window to floating mode and move by dragging
|
||
</dd>
|
||
<dt>mod-button2</dt>
|
||
<dd>
|
||
Raise the window to the top of the stack
|
||
</dd>
|
||
<dt>mod-button3</dt>
|
||
<dd>
|
||
Set the window to floating mode and resize by dragging
|
||
</dd>
|
||
</dl>
|
||
<h1 id="examples">Examples</h1>
|
||
<p>To use xmonad as your window manager add to your <em>~/.xinitrc</em>
|
||
file:</p>
|
||
<blockquote>
|
||
<p>exec xmonad</p>
|
||
</blockquote>
|
||
<h1 id="customization">Customization</h1>
|
||
<p>xmonad is customized in your <em>xmonad.hs</em>, and then restarted
|
||
with mod-q. You can choose where your configuration file lives by</p>
|
||
<ol type="1">
|
||
<li>Setting <code>XMONAD_DATA_DIR,</code>
|
||
<code>XMONAD_CONFIG_DIR</code>, and <code>XMONAD_CACHE_DIR</code>;
|
||
<em>xmonad.hs</em> is then expected to be in
|
||
<code>XMONAD_CONFIG_DIR</code>.</li>
|
||
<li>Creating <em>xmonad.hs</em> in <em>~/.xmonad</em>.</li>
|
||
<li>Creating <em>xmonad.hs</em> in <code>XDG_CONFIG_HOME</code>. Note
|
||
that, in this case, xmonad will use <code>XDG_DATA_HOME</code> and
|
||
<code>XDG_CACHE_HOME</code> for its data and cache directory
|
||
respectively.</li>
|
||
</ol>
|
||
<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>
|
||
<p>As of <em>xmonad-0.9</em>, any additional Haskell modules may be
|
||
placed in <em>~/.xmonad/lib/</em> are available in GHC’s 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"><span id="cb1-1"><a href="#cb1-1" aria-hidden="true" tabindex="-1"></a><span class="kw">module</span> <span class="dt">XMonad.Stack.MyAdditions</span> (function1) <span class="kw">where</span></span>
|
||
<span id="cb1-2"><a href="#cb1-2" aria-hidden="true" tabindex="-1"></a> function1 <span class="ot">=</span> <span class="fu">error</span> <span class="st">"function1: Not implemented yet!"</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>
|
||
<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>
|
||
</body>
|
||
</html>
|