twin/xmonad
1
0
Fork 0
mirror of https://github.com/xmonad/xmonad.git synced 2025-05-19 08:30:21 -07:00
Code Issues Packages Projects Releases Wiki Activity

GenerateManpage: greatly simplify the code

Browse Source 
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 2018-08-20 11:35:31 +02:00
parent 98f39eabc1
commit 886a0d4041
5 changed files with 480 additions and 234 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

284
man/xmonad.1
View File

@ -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)

269
man/xmonad.1.html
View File

@ -4,96 +4,241 @@
<meta charset="utf-8" />
<meta name="generator" content="pandoc" />
<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" />
<title>Untitled</title>
<meta name="author" content="" />
<meta name="dcterms.date" content="2018-08-20" />
<title>XMONAD(1) Tiling Window Manager</title>
<style type="text/css">
code{white-space: pre-wrap;}
span.smallcaps{font-variant: small-caps;}
span.underline{text-decoration: underline;}
div.column{display: inline-block; vertical-align: top; width: 50%;}
</style>
<style type="text/css">
a.sourceLine { display: inline-block; line-height: 1.25; }
a.sourceLine { pointer-events: none; color: inherit; text-decoration: inherit; }
a.sourceLine:empty { height: 1.2em; }
.sourceCode { overflow: visible; }
code.sourceCode { white-space: pre; position: relative; }
div.sourceCode { margin: 1em 0; }
pre.sourceCode { margin: 0; }
@media screen {
div.sourceCode { overflow: auto; }
}
@media print {
code.sourceCode { white-space: pre-wrap; }
a.sourceLine { text-indent: -1em; padding-left: 1em; }
}
pre.numberSource a.sourceLine
{ position: relative; left: -4em; }
pre.numberSource a.sourceLine::before
{ content: attr(data-line-number);
position: relative; left: -1em; text-align: right; vertical-align: baseline;
border: none; pointer-events: all; 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 {
a.sourceLine::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 { } /* 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 { } /* 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>
<!--[if lt IE 9]>
<script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
<![endif]-->
</head>
<body>
<h1>xmonad-0.13</h1><p>Section: xmonad manual (1)<br/>Updated: 5 July 2018</p><hr/>
<header>
<h1 class="title">XMONAD(1) Tiling Window Manager</h1>
<p class="author"></p>
<p class="date">20 August 2018</p>
</header>
<nav id="TOC">
<ul>
<li><a>Name</a></li>
<li><a>Description</a></li>
<li><a>Usage</a><ul>
<li><a>Flags</a></li>
<li><a>Default keyboard bindings</a></li>
<li><a href="#name">Name</a></li>
<li><a href="#description">Description</a></li>
<li><a href="#usage">Usage</a><ul>
<li><a href="#flags">Flags</a></li>
</ul></li>
<li><a>Examples</a></li>
<li><a>Customization</a><ul>
<li><a>Modular Configuration</a></li>
<li><a href="#examples">Examples</a></li>
<li><a href="#customization">Customization</a><ul>
<li><a href="#modular-configuration">Modular Configuration</a></li>
</ul></li>
<li><a>Bugs</a></li>
<li><a href="#bugs">Bugs</a></li>
</ul>
</nav>
<h1>Name</h1>
<p>xmonad - a tiling window manager</p>
<h1>Description</h1>
<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>Usage</h1>
<p><em>xmonad</em> places each window into a &quot;workspace&quot;. 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>
<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>Flags</h2>
<h2 id="flags">Flags</h2>
<p>xmonad has several flags which you may pass to the executable. These flags are:</p>
<p>--recompile : Recompiles your configuration in <em>~/.xmonad/xmonad.hs</em></p>
<p>--restart : Causes the currently running <em>xmonad</em> process to restart</p>
<p>--replace : Replace the current window manager with xmonad</p>
<p>--version : Display version of <em>xmonad</em></p>
<p>--verbose-version : Display detailed version of <em>xmonad</em></p>
<h2>Default keyboard bindings</h2>
<p>mod-shift-return : Launch terminal</p>
<p>mod-p : Launch dmenu</p>
<p>mod-shift-p : Launch gmrun</p>
<p>mod-shift-c : Close the focused window</p>
<p>mod-space : Rotate through the available layout algorithms</p>
<p>mod-shift-space : Reset the layouts on the current workspace to default</p>
<p>mod-n : Resize viewed windows to the correct size</p>
<p>mod-tab : Move focus to the next window</p>
<p>mod-shift-tab : Move focus to the previous window</p>
<p>mod-j : Move focus to the next window</p>
<p>mod-k : Move focus to the previous window</p>
<p>mod-m : Move focus to the master window</p>
<p>mod-return : Swap the focused window and the master window</p>
<p>mod-shift-j : Swap the focused window with the next window</p>
<p>mod-shift-k : Swap the focused window with the previous window</p>
<p>mod-h : Shrink the master area</p>
<p>mod-l : Expand the master area</p>
<p>mod-t : Push window back into tiling</p>
<p>mod-comma : Increment the number of windows in the master area</p>
<p>mod-period : Deincrement the number of windows in the master area</p>
<p>mod-shift-q : Quit xmonad</p>
<p>mod-q : Restart xmonad</p>
<p>mod-shift-slash : Run xmessage with a summary of the default keybindings (useful for beginners)</p>
<p>mod-question : Run xmessage with a summary of the default keybindings (useful for beginners)</p>
<p>mod-[1..9] : Switch to workspace N</p>
<p>mod-shift-[1..9] : Move client to workspace N</p>
<p>mod-{w,e,r} : Switch to physical/Xinerama screens 1, 2, or 3</p>
<p>mod-shift-{w,e,r} : Move client to screen 1, 2, or 3</p>
<p>mod-button1 : Set the window to floating mode and move by dragging</p>
<p>mod-button2 : Raise the window to the top of the stack</p>
<p>mod-button3 : Set the window to floating mode and resize by dragging</p>
<h1>Examples</h1>
<dl>
<dt>–recompile</dt>
<dd>Recompiles your configuration in <em>~/.xmonad/xmonad.hs</em>
</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>
<p>##Default keyboard bindings</p>
<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>Customization</h1>
<h1 id="customization">Customization</h1>
<p>xmonad is customized in ~/.xmonad/xmonad.hs, and then restarted with mod-q.</p>
<p>You can find many extensions to the core feature set in the xmonad- contrib package, available through your package manager or from [xmonad.org].</p>
<h2>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>
<p><code>haskell module XMonad.Stack.MyAdditions (function1) where function1 = error &quot;function1: Not implemented yet!&quot;</code></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="http://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"><a class="sourceLine" id="cb1-1" data-line-number="1"><span class="kw">module</span> <span class="dt">XMonad.Stack.MyAdditions</span> (function1) <span class="kw">where</span></a>
<a class="sourceLine" id="cb1-2" data-line-number="2"> function1 <span class="fu">=</span> error <span class="st">&quot;function1: Not implemented yet!&quot;</span></a></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>Bugs</h1>
<p>Probably. If you find any, please report them to the [bugtracker]</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>

9
man/xmonad.1.markdown
View File

@ -1,5 +1,10 @@
% XMONAD(1) Tiling Window Manager
%
% 20 August 2018
# Name
xmonad - a tiling window manager
xmonad - Tiling Window Manager
# Description
@ -48,6 +53,7 @@ switching workspaces to one that is already visible, the current and
visible workspaces are swapped.
## Flags
xmonad has several flags which you may pass to the executable.
These flags are:
@ -71,6 +77,7 @@ These flags are:
___KEYBINDINGS___
# Examples
To use xmonad as your window manager add to your _~/.xinitrc_ file:
> exec xmonad

134
util/GenerateManpage.hs
View File

@ -1,84 +1,30 @@
{-# LANGUAGE FlexibleContexts #-}
-- Generates a in-memory version of "man/xmonad.1.markdown" that has the list
-- of known key-bindings is inserted automatically from "Config.hs". That
-- document is then rendered with Pandoc as "man/xmonad.1" and
-- "man/xmonad.1.html".
--
-- Unlike the rest of xmonad, this file is released under the GNU General
-- Public License version 2 or later.
--
-- Generates man/xmonad.1 from man/xmonad.1.in by filling the list of
-- keybindings with values scraped from Config.hs
--
-- Uses cabal to grab the xmonad version from xmonad.cabal
--
-- Uses pandoc to convert the "xmonad.1.markdown" to "xmonad.1"
--
-- Format for the docstrings in Config.hs takes the following form:
--
-- -- mod-x %! Frob the whatsit
--
-- "Frob the whatsit" will be used as the description for keybinding "mod-x"
--
-- If the keybinding name is omitted, it will try to guess from the rest of the
-- line. For example:
--
-- [ ((modMask .|. shiftMask, xK_Return), spawn "xterm") -- %! Launch an xterm
--
-- Here, mod-shift-return will be used as the keybinding name.
import Control.Monad
import Control.Applicative
import Text.Regex.Posix
import Control.Monad.IO.Class (liftIO)
import Data.Char
import Data.List
import Control.Monad.IO.Class (liftIO)
import qualified Data.Text as T
import qualified Data.Text.IO as TIO
import Text.Pandoc
import Text.Regex.Posix
import Distribution.PackageDescription.Parse
import Distribution.Verbosity
import Distribution.Package
import Distribution.PackageDescription
import Text.PrettyPrint.HughesPJ
import Distribution.Text
import Text.Pandoc -- works with 2.1
releaseDate = "5 July 2018"
trim :: String -> String
trim = reverse . dropWhile isSpace . reverse . dropWhile isSpace
guessKeys line = concat $ intersperse "-" (modifiers ++ [map toLower key])
where modifiers = map (!!1) (line =~ "(mod|shift|control)Mask")
(_, _, _, [key]) = line =~ "xK_([_[:alnum:]]+)" :: (String, String, String, [String])
binding :: [String] -> (String, String)
binding [ _, bindingLine, "", desc ] = (guessKeys bindingLine, desc)
binding [ _, _, keyCombo, desc ] = (keyCombo, desc)
allBindings :: String -> [(String, String)]
allBindings xs = map (binding . map trim) (xs =~ "(.*)--(.*)%!(.*)")
-- FIXME: What escaping should we be doing on these strings?
markdownDefn :: (String, String) -> String
markdownDefn (key, desc) = key ++ "\n: " ++ desc
replace :: Eq a => a -> a -> [a] -> [a]
replace x y = map (\a -> if a == x then y else a)
-- rawSystem "pandoc" ["--read=markdown","--write=man","man/xmonad.1.markdown"]
main :: IO ()
main = do
releaseName <- (show . disp . package . packageDescription)
`liftM`readPackageDescription normal "xmonad.cabal"
keybindings <- (intercalate "\n\n" . map markdownDefn . allBindings)
`liftM` readFile "./src/XMonad/Config.hs"
let manHeader = T.pack .
unwords
$ [".TH xmonad 1","\""++releaseDate++"\"",releaseName,"\"xmonad manual\""]
keybindings <- guessBindings
markdownSource <- readFile "./man/xmonad.1.markdown"
runIOorExplode $ do
parsed <- readMarkdown def
parsed <- readMarkdown (def { readerStandalone = True, readerExtensions = pandocExtensions })
. T.pack
. unlines
. replace "___KEYBINDINGS___" keybindings
@ -87,18 +33,56 @@ main = do
manTemplate <- getDefaultTemplate "man"
manBody <- writeMan def { writerTemplate = Just manTemplate } parsed
liftIO $ TIO.writeFile "./man/xmonad.1" $ T.append manHeader manBody
liftIO $ TIO.writeFile "./man/xmonad.1" $ manBody
liftIO $ putStrLn "Documentation created: man/xmonad.1"
htmltemplate <- getDefaultTemplate "html"
htmlBody <- writeHtml5String def
{ writerVariables =
[("include-before"
,"<h1>"++releaseName++"</h1>"++
"<p>Section: xmonad manual (1)<br/>"++
"Updated: "++releaseDate++"</p>"++
"<hr/>")]
, writerTemplate = Just htmltemplate
, writerTableOfContents = True } parsed
{ writerTemplate = Just htmltemplate
, writerTableOfContents = True }
parsed
liftIO $ TIO.writeFile "./man/xmonad.1.html" htmlBody
liftIO $ putStrLn "Documentation created: man/xmonad.1.html"
-- | The format for the docstrings in "Config.hs" takes the following form:
--
-- @
-- -- mod-x %! Frob the whatsit
-- @
--
-- "Frob the whatsit" will be used as the description for keybinding "mod-x".--
-- If the name of the key binding is omitted, the function tries to guess it
-- from the rest of the line. For example:
--
-- @
-- [ ((modMask .|. shiftMask, xK_Return), spawn "xterm") -- %! Launch an xterm
-- @
--
-- Here, "mod-shift-return" will be used as the key binding name.
guessBindings :: IO String
guessBindings = do
buf <- readFile "./src/XMonad/Config.hs"
return (intercalate "\n\n" (map markdownDefn (allBindings buf)))
allBindings :: String -> [(String, String)]
allBindings xs = map (binding . map trim) (xs =~ "(.*)--(.*)%!(.*)")
binding :: [String] -> (String, String)
binding [ _, bindingLine, "", desc ] = (guessKeys bindingLine, desc)
binding [ _, _, keyCombo, desc ] = (keyCombo, desc)
guessKeys :: String -> String
guessKeys line = concat $ intersperse "-" (modifiers ++ [map toLower key])
where modifiers = map (!!1) (line =~ "(mod|shift|control)Mask")
(_, _, _, [key]) = line =~ "xK_([_[:alnum:]]+)" :: (String, String, String, [String])
-- FIXME: What escaping should we be doing on these strings?
markdownDefn :: (String, String) -> String
markdownDefn (key, desc) = key ++ "\n: " ++ desc
replace :: Eq a => a -> a -> [a] -> [a]
replace x y = map (\a -> if a == x then y else a)
trim :: String -> String
trim = reverse . dropWhile isSpace . reverse . dropWhile isSpace

2
xmonad.cabal
View File

@ -98,9 +98,7 @@ executable generatemanpage
hs-source-dirs: util
if flag(generatemanpage)
build-depends: base,
Cabal == 2.0.*,
pandoc >= 2,
pretty,
regex-posix,
text
else