diff --git a/CHANGES.md b/CHANGES.md index 6715c44..7e6f741 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -15,6 +15,20 @@ * Compatibility with GHC 9.0 + * Improve handling of XDG directories. + + 1. If all three of xmonad's environment variables (`XMONAD_DATA_DIR,` + `XMONAD_CONFIG_DIR`, and `XMONAD_CACHE_DIR`) are set, use them. + 2. If there is a build script called `build` (see [here](https://github.com/xmonad/xmonad-testing/tree/master/build-scripts) for usage + examples) or configuration `xmonad.hs` in `~/.xmonad`, set all three + directories to `~/.xmonad`. + 3. Otherwise, use the `xmonad` directory in `XDG_DATA_HOME`, + `XDG_CONFIG_HOME`, and `XDG_CACHE_HOME` (or their respective + fallbacks). These directories are created if necessary. + + In the cases of 1. and 3., the build script or executable is + expected to be in the config dir. + ## 0.15 (September 30, 2018) * Reimplement `sendMessage` to deal properly with windowset changes made diff --git a/CONFIG b/CONFIG index f83292b..8dce8e7 100644 --- a/CONFIG +++ b/CONFIG @@ -4,8 +4,13 @@ xmonad is configured by creating and editing the file: ~/.xmonad/xmonad.hs -xmonad then uses settings from this file as arguments to the window manager, -on startup. For a complete example of possible settings, see the file: +xmonad then uses settings from this file as arguments to the window +manager, on startup. It is also possible to use alternative paths for +your configuration file; for that, consult + + man xmonad + +For a complete example of possible settings see the file: man/xmonad.hs diff --git a/man/xmonad.1 b/man/xmonad.1 index 3ec791f..04af000 100644 --- a/man/xmonad.1 +++ b/man/xmonad.1 @@ -1,13 +1,13 @@ -.\" Automatically generated by Pandoc 2.2.1 +.\" Automatically generated by Pandoc 2.11.3.1 .\" .TH "XMONAD" "1" "30 September 2018" "Tiling Window Manager" "" .hy .SH Name .PP -xmonad \- Tiling Window Manager +xmonad - Tiling Window Manager .SH Description .PP -\f[I]xmonad\f[] 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 Haskell. Windows are managed using automatic layout algorithms, which can be dynamically reconfigured. @@ -15,14 +15,14 @@ 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. -\f[I]xmonad\f[] is configured in Haskell, and custom layout algorithms +\f[I]xmonad\f[R] is configured in Haskell, and custom layout algorithms may be implemented by the user in config files. -A principle of \f[I]xmonad\f[] is predictability: the user should know +A principle of \f[I]xmonad\f[R] is predictability: the user should know in advance precisely the window arrangement that will result from any action. .PP -By default, \f[I]xmonad\f[] provides three layout algorithms: tall, wide -and fullscreen. +By default, \f[I]xmonad\f[R] 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 @@ -31,34 +31,34 @@ Multiple physical monitors are supported via Xinerama, allowing simultaneous display of a number of screens. .PP By utilizing the expressivity of a modern functional language with a -rich static type system, \f[I]xmonad\f[] provides a complete, featureful -window manager in less than 1200 lines of code, with an emphasis on -correctness and robustness. +rich static type system, \f[I]xmonad\f[R] 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. +type-based automated testing. 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 \[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 -though with mod\-j and mod\-k. +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 +You can toggle the layout mode with mod-space, which will cycle through the available modes. .PP -You can switch to workspace N with mod\-N. -For example, to switch to workspace 5, you would press mod\-5. +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. +mod-shift-N. .PP 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} +mod-{w,e,r} switch the focus between screens, while shift-mod-{w,e,r} move the current window to that screen. -When \f[I]xmonad\f[] 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. When switching workspaces to one that is already visible, the current and visible workspaces are swapped. @@ -67,221 +67,159 @@ and visible workspaces are swapped. 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 +\[en]recompile +Recompiles your \f[I]xmonad.hs\f[R] configuration .TP -.B \[en]restart -Causes the currently running \f[I]xmonad\f[] process to restart -.RS -.RE +\[en]restart +Causes the currently running \f[I]xmonad\f[R] process to restart .TP -.B \[en]replace +\[en]replace Replace the current window manager with xmonad -.RS -.RE .TP -.B \[en]version -Display version of \f[I]xmonad\f[] -.RS -.RE +\[en]version +Display version of \f[I]xmonad\f[R] .TP -.B \[en]verbose\-version -Display detailed version of \f[I]xmonad\f[] -.RS -.RE -.PP -##Default keyboard bindings +\[en]verbose-version +Display detailed version of \f[I]xmonad\f[R] +.SS Default keyboard bindings .TP -.B mod\-shift\-return +mod-shift-return Launch terminal -.RS -.RE .TP -.B mod\-p +mod-p Launch dmenu -.RS -.RE .TP -.B mod\-shift\-p +mod-shift-p Launch gmrun -.RS -.RE .TP -.B mod\-shift\-c +mod-shift-c Close the focused window -.RS -.RE .TP -.B mod\-space +mod-space Rotate through the available layout algorithms -.RS -.RE .TP -.B mod\-shift\-space +mod-shift-space Reset the layouts on the current workspace to default -.RS -.RE .TP -.B mod\-n +mod-n Resize viewed windows to the correct size -.RS -.RE .TP -.B mod\-tab +mod-tab Move focus to the next window -.RS -.RE .TP -.B mod\-shift\-tab +mod-shift-tab Move focus to the previous window -.RS -.RE .TP -.B mod\-j +mod-j Move focus to the next window -.RS -.RE .TP -.B mod\-k +mod-k Move focus to the previous window -.RS -.RE .TP -.B mod\-m +mod-m Move focus to the master window -.RS -.RE .TP -.B mod\-return +mod-return Swap the focused window and the master window -.RS -.RE .TP -.B mod\-shift\-j +mod-shift-j Swap the focused window with the next window -.RS -.RE .TP -.B mod\-shift\-k +mod-shift-k Swap the focused window with the previous window -.RS -.RE .TP -.B mod\-h +mod-h Shrink the master area -.RS -.RE .TP -.B mod\-l +mod-l Expand the master area -.RS -.RE .TP -.B mod\-t +mod-t Push window back into tiling -.RS -.RE .TP -.B mod\-comma +mod-comma Increment the number of windows in the master area -.RS -.RE .TP -.B mod\-period +mod-period Deincrement the number of windows in the master area -.RS -.RE .TP -.B mod\-shift\-q +mod-shift-q Quit xmonad -.RS -.RE .TP -.B mod\-q +mod-q Restart xmonad -.RS -.RE .TP -.B mod\-shift\-slash +mod-shift-slash Run xmessage with a summary of the default keybindings (useful for beginners) -.RS -.RE .TP -.B mod\-question +mod-question Run xmessage with a summary of the default keybindings (useful for beginners) -.RS -.RE .TP -.B mod\-[1..9] +mod-[1..9] Switch to workspace N -.RS -.RE .TP -.B mod\-shift\-[1..9] +mod-shift-[1..9] Move client to workspace N -.RS -.RE .TP -.B mod\-{w,e,r} +mod-{w,e,r} Switch to physical/Xinerama screens 1, 2, or 3 -.RS -.RE .TP -.B mod\-shift\-{w,e,r} +mod-shift-{w,e,r} Move client to screen 1, 2, or 3 -.RS -.RE .TP -.B mod\-button1 +mod-button1 Set the window to floating mode and move by dragging -.RS -.RE .TP -.B mod\-button2 +mod-button2 Raise the window to the top of the stack -.RS -.RE .TP -.B mod\-button3 +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[] -file: +To use xmonad as your window manager add to your +\f[I]\[ti]/.xinitrc\f[R] file: .RS .PP exec xmonad .RE .SH Customization .PP -xmonad is customized in ~/.xmonad/xmonad.hs, and then restarted with -mod\-q. +xmonad is customized in your \f[I]xmonad.hs\f[R], and then restarted +with mod-q. +You can choose where your configuration file lives by +.IP "1." 3 +Setting \f[C]XMONAD_DATA_DIR,\f[R] \f[C]XMONAD_CONFIG_DIR\f[R], and +\f[C]XMONAD_CACHE_DIR\f[R]; \f[I]xmonad.hs\f[R] is then expected to be +in \f[C]XMONAD_CONFIG_DIR\f[R]. +.IP "2." 3 +Creating \f[I]xmonad.hs\f[R] in \f[I]\[ti]/.xmonad\f[R]. +.IP "3." 3 +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 +\f[C]XDG_CACHE_HOME\f[R] for its data and cache directory respectively. .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 -xmonad.org (http://xmonad.org). +xmonad.org (https://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's searchpath. +As of \f[I]xmonad-0.9\f[R], any additional Haskell modules may be placed +in \f[I]\[ti]/.xmonad/lib/\f[R] are available in GHC\[cq]s searchpath. Hierarchical modules are supported: for example, the file -\f[I]~/.xmonad/lib/XMonad/Stack/MyAdditions.hs\f[] could contain: +\f[I]\[ti]/.xmonad/lib/XMonad/Stack/MyAdditions.hs\f[R] could contain: .IP .nf \f[C] -module\ XMonad.Stack.MyAdditions\ (function1)\ where -\ \ function1\ =\ error\ "function1:\ Not\ implemented\ yet!" -\f[] +module XMonad.Stack.MyAdditions (function1) where + function1 = error \[dq]function1: Not implemented yet!\[dq] +\f[R] .fi .PP 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 .PP Probably. diff --git a/man/xmonad.1.html b/man/xmonad.1.html index 1d2f071..0da9ee1 100644 --- a/man/xmonad.1.html +++ b/man/xmonad.1.html @@ -7,94 +7,230 @@ XMONAD(1) Tiling Window Manager - - -
+

XMONAD(1) Tiling Window Manager

30 September 2018

-