Difference between revisions of "Alopex"

From ArchWiki
Jump to: navigation, search
m (Make tables prettier)
(Name Change to Alopex)
Line 8: Line 8:
 
{{Article summary end}}
 
{{Article summary end}}
 
{{DISPLAYTITLE:Alopex}}
 
{{DISPLAYTITLE:Alopex}}
{{Note|Due to the name change, the links—in this document and upstream—for Alopex (formerly, TTWM) have not yet all been updated. Over the next week or so, the transition should be complete, and the links on this page will be edited to reflect the name change.}}
+
[https://github.com/TrilbyWhite/alopex Alopex] (formerly, TTWM) is a minimal tiling window manager combining concepts or elements from {{AUR|tinywm}}, [[dwm]], and [[i3|i3wm]]. Inspiration has also been drawn from other great tilers like [[monsterwm]]. It manages windows using tiling, horizontal or vertical stacking layouts with transient floating and fullscreen modes.
  
[https://github.com/TrilbyWhite/ttwm/ TTWM] is a minimal tiling window manager combining concepts or elements from {{AUR|tinywm}}, [[dwm]], and [[i3|i3wm]]. Inspiration has also been drawn from other great tilers like [[monsterwm]]. It manages windows using tiling, horizontal or vertical stacking layouts with transient floating and fullscreen modes.
+
{{Note|TTWM 1.0 can still be installed using {{AUR|ttwm}}.}}
 
+
TTWM is currently available in the [[AUR]] in two versions, {{AUR|ttwm}} and {{AUR|ttwm-git}}. The first is the final stable build of TTWM 1.0, whereas the "-git" version is the development branch of TTWM 2.0. This page refers almost entirely to {{AUR|ttwm-git}} and TTWM 2.0. More information on TTWM 1.0 can be found [http://trilbywhite.github.com/ttwm/ upstream].
+
  
 
==Installation==
 
==Installation==
  
Installing TTWM, from the AUR, is as simple as fetching the PKGBUILD and running the following:
+
Installing {{AUR|alopex-git}}, from the [[AUR]], is as simple as fetching the PKGBUILD and running the following:
 
  $ makepkg -si
 
  $ makepkg -si
  
{{Tip|As configuration is done at compile-time, modifications (such as customized keybindings or colorschemes) can be achieved by moving a copy of {{ic|config.h}} (from upstream) to {{ic|$HOME/.ttwm_config.h}} or {{ic|$XDG_CONFIG_HOME/ttwm/config.h}} and editing it to reflect any user preferences. See [[#Configuration]]}}
+
{{Tip|As configuration is done at compile-time, modifications (such as customized keybindings or colorschemes) can be achieved by moving a copy of {{ic|config.h}} (from upstream) to {{ic|$HOME/.alopex_config.h}} or {{ic|$XDG_CONFIG_HOME/alopex/config.h}} and editing it to reflect any user preferences. See [[#Configuration]]}}
  
 
==Basic usage==
 
==Basic usage==
By Default, TTWM tracks the following four modifier masks:
+
By Default, Alopex tracks the following four modifier masks:
 
{| class="wikitable" border="1" style="text-align:center"
 
{| class="wikitable" border="1" style="text-align:center"
 
! scope="col" | Reference
 
! scope="col" | Reference
Line 42: Line 40:
  
 
===Launching programs===
 
===Launching programs===
[[dmenu|Dmenu]] is a useful addon to TTWM. As opposed to list-style or drop-down menus, dmenu is a type-to-complete program launcher. It is the recommended launcher for TTWM, and the default configuration maps running dmenu to {{Keypress|Mod1}} + {{Keypress|p}}.
+
[[dmenu|Dmenu]] is a useful addon to Alopex. As opposed to list-style or drop-down menus, dmenu is a type-to-complete program launcher. It is the recommended launcher for Alopex, and the default configuration maps running dmenu to {{Keypress|Mod1}} + {{Keypress|p}}.
  
{{Note|The creator of TTWM has also made a very small, light-weight alternative to [[dmenu]] called [https://bbs.archlinux.org/viewtopic.php?id=160182 interrobang]. It can be installed easily using {{AUR|interrobang-git}}. To replace dmenu with interrobang, read on how to customize keybindings in [[#Custom Configuration]].}}
+
{{Note|The creator of Alopex has also made a very small, light-weight alternative to [[dmenu]] called [https://bbs.archlinux.org/viewtopic.php?id=160182 interrobang]. It can be installed easily using {{AUR|interrobang-git}}. To replace dmenu with interrobang, read on how to customize keybindings in [[#Custom Configuration]].}}
  
 
===Using tags===
 
===Using tags===
Line 65: Line 63:
 
|-
 
|-
 
|}
 
|}
{{Note|As with [[dwm]], TTWM makes a distinction between tags and views (workspaces). By default, TTWM has six tags enabled and two views available. You can switch between the two views using {{Keypress|Mod2}} + {{Keypress|Tab}}. To better understand the difference and how you can arrange your workflow to utilize the difference, [http://www.wongdev.com/blog/2013/01/24/dwm-tags-are-not-workspaces/ this article] (written for dwm) may be helpful.}}
+
{{Note|As with [[dwm]], Alopex makes a distinction between tags and views (workspaces). By default, Alopex has six tags enabled and two views available. You can switch between the two views using {{Keypress|Mod2}} + {{Keypress|Tab}}. To better understand the difference and how you can arrange your workflow to utilize the difference, [http://www.wongdev.com/blog/2013/01/24/dwm-tags-are-not-workspaces/ this article] (written for dwm) may be helpful.}}
  
 
{{Tip|It is possible to customize how tags are labeled using a custom {{ic|config.h}} and {{ic|icons.h}}. See [[#Customizing Tags]].}}
 
{{Tip|It is possible to customize how tags are labeled using a custom {{ic|config.h}} and {{ic|icons.h}}. See [[#Customizing Tags]].}}
  
 
===Window layouts===
 
===Window layouts===
TTWM has three rule-based layouts complimented by transient fullscreen and floating modes: Vertical and Horizontal Stacking and "Monocle" (Full screen with statusbar tabs). By default, TTWM will run using the Vertical Stacking layout. Cycling through all three layouts can be done by pressing {{Keypress|Mod1}} + {{Keypress|space}}. You can select each mode more directly with the following shortcuts:
+
Alopex has three rule-based layouts complimented by transient fullscreen and floating modes: Vertical and Horizontal Stacking and "Monocle" (Full screen with statusbar tabs). By default, the vertical stacking layout will be used. Cycling through all three layouts can be done by pressing {{Keypress|Mod1}} + {{Keypress|space}}. You can select each mode more directly with the following shortcuts:
 
{| class="wikitable" border="1" style="text-align:center"
 
{| class="wikitable" border="1" style="text-align:center"
 
! scope="col" | Mode
 
! scope="col" | Mode
Line 93: Line 91:
  
 
===Exiting===
 
===Exiting===
Cleanly killing a window can be done by pressing {{Keypress|Mod2}} + {{Keypress|F4}}. Cleanly exiting TTWM can be done by pressing {{Keypress|Mod1}} + {{Keypress|Mod4}} + {{Keypress|Q}}.
+
Cleanly killing a window can be done by pressing {{Keypress|Mod2}} + {{Keypress|F4}}. Cleanly exiting Alopex can be done by pressing {{Keypress|Mod1}} + {{Keypress|Mod4}} + {{Keypress|Q}}.
  
 
==Extended Usage==
 
==Extended Usage==
 
===Custom Configuration===  
 
===Custom Configuration===  
As mentioned previously, TTWM is almost entirely configured at compile-time via the editing of its source files, primarily {{ic|config.h}} and {{ic|icons.h}}. The upstream configuration provides sane defaults, but configuration per user-preference is easy to achieve.
+
As mentioned previously, Alopex is almost entirely configured at compile-time via the editing of its source files, primarily {{ic|config.h}} and {{ic|icons.h}}. The upstream configuration provides sane defaults, but configuration per user-preference is easy to achieve.
  
As mentioned in [[#Installation]], {{AUR|ttwm-git}} will check for {{ic|$HOME/.ttwm_config.h}} and {{ic|$XDG_CONFIG_HOME/ttwm/config.h}}, and, if either exists, use them to replace the default {{ic|config.h}} before commencing the build. After using {{Pkg|makepkg}} to grab the source, simply copy the {{ic|config.h}} to either {{ic|$HOME/.ttwm_config.h}} or {{ic|$XDG_CONFIG_HOME/ttwm/config.h}} and make your modifications.
+
As mentioned in [[#Installation]], {{AUR|alopex-git}} will check for {{ic|$HOME/.alopex_config.h}} and {{ic|$XDG_CONFIG_HOME/alopex/config.h}}, and, if either exists, use them to replace the default {{ic|config.h}} before commencing the build. After using {{Pkg|makepkg}} to grab the source, simply copy the {{ic|config.h}} to either {{ic|$HOME/.alopex_config.h}} or {{ic|$XDG_CONFIG_HOME/alopex/config.h}} and make your modifications.
  
 
Once the desired modifications have been made, return to the package directory and compile/install:
 
Once the desired modifications have been made, return to the package directory and compile/install:
Line 105: Line 103:
 
{{Tip|If you have already compiled, you may need to use the {{ic|f}} switch to force a recompile}}
 
{{Tip|If you have already compiled, you may need to use the {{ic|f}} switch to force a recompile}}
  
Assuming the configuration changes were valid, the customized TTWM will have been compiled and installed. If problems were encountered, review the output for specific information.
+
Assuming the configuration changes were valid, the customized Alopex will have been compiled and installed. If problems were encountered, review the output for specific information.
  
For any changes to take effect, it will be necessary to (re)start TTWM.
+
For any changes to take effect, it will be necessary to (re)start Alopex.
  
 
====Custom Keybindings====
 
====Custom Keybindings====
Line 124: Line 122:
  
 
====Configuration Options====
 
====Configuration Options====
Aside from custom keybinds, TTWM offers various configuration options which can be modified in a custom {{ic|config.h}} to help you fine-tune your TTWM setup. Below is an abridged list of available configuration options and explanations of their settings:
+
Aside from custom keybinds, Alopex offers various configuration options which can be modified in a custom {{ic|config.h}} to help you fine-tune your setup. Below is an abridged list of available configuration options and explanations of their settings:
 
{| class="wikitable" border="1" style="text-align:center"
 
{| class="wikitable" border="1" style="text-align:center"
 
! scope="col" | Option
 
! scope="col" | Option
Line 157: Line 155:
  
 
====Customizing Tags====
 
====Customizing Tags====
It is possible, using the {{ic|tagcons}} array, to customize how tags appear on the statusbar. By default, all of the default tags are named {{ic|one}} through {{ic|six}}. Using the {{ic|tagcons}} array, you can have them appear with any combination of a prefix, an icon and a suffix. You can add, or customize tag appearances using the following syntax:
+
It is possible, using the {{ic|tagcons}} array, to customize how tags appear on the statusbar. By default, the default tags are named {{ic|one}} through {{ic|six}}. Using the {{ic|tagcons}} array, you can have them appear with any combination of a prefix, an icon and a suffix. You can add, or customize tag appearances using the following syntax:
 
  static const Tagcon tagcons=[] = {
 
  static const Tagcon tagcons=[] = {
     { "prefix,  #,  "suffix" },
+
     { "prefix",  #,  "suffix" },
 
  };
 
  };
 
With this syntax {{ic|#}} refers to the position of the icon in the array at the bottom of {{ic|icons.h}}; {{ic|"prefix"}} and {{ic|"suffix"}} refer to the labels of text given to the tag before and after the icon, respectively. If you do not want the tag to appear with an icon, replace {{ic|#}} with {{ic|NO_ICON}} or {{ic|-1}}. If you would rather a tag appear without any label, replace {{ic|"prefix"}} and {{ic|"suffix"}} with {{ic|NULL}}. The order each tag appears on the bar depends on the order in which they appear in the {{ic|tagcons}} array.
 
With this syntax {{ic|#}} refers to the position of the icon in the array at the bottom of {{ic|icons.h}}; {{ic|"prefix"}} and {{ic|"suffix"}} refer to the labels of text given to the tag before and after the icon, respectively. If you do not want the tag to appear with an icon, replace {{ic|#}} with {{ic|NO_ICON}} or {{ic|-1}}. If you would rather a tag appear without any label, replace {{ic|"prefix"}} and {{ic|"suffix"}} with {{ic|NULL}}. The order each tag appears on the bar depends on the order in which they appear in the {{ic|tagcons}} array.
Line 165: Line 163:
  
 
===Statusbar===
 
===Statusbar===
By passing a script or program as an argument to TTWM, it can create a minimalistic statusbar. To avoid a [https://bbs.archlinux.org/viewtopic.php?pid=1237677#p1237677 CPU race], TTWM provides a default statusbar script if none is passed to it. This default script displays only a simple clock. For a more powerful statusbar, you can either write a script (or your own small program) or use a statusbar program such as conky.
+
By passing a script or program as an argument to Alopex, it can create a minimalistic statusbar. To avoid a [https://bbs.archlinux.org/viewtopic.php?pid=1237677#p1237677 CPU race], Alopex provides a default statusbar script if none is passed to it. This default script displays only a simple clock. For a more powerful statusbar, you can either write a script (or your own small program) or use a statusbar program such as conky.
If the script (or program) you use takes arguments itself, remember to quote the whole statusbar argument. For example, the following commands would start TTWM with a script or conky (respectively):
+
If the script (or program) you use takes arguments itself, remember to quote the whole statusbar argument. For example, the following commands would start Alopex with a script or conky (respectively):
  $ xinit /usr/bin/ttwm "/home/username/script.sh -args"
+
  $ xinit /usr/bin/alopex "/home/username/script.sh -args"
  
  $ xinit /usr/bin/ttwm "conky -c /path/to/conkyrc"
+
  $ xinit /usr/bin/alopex "conky -c /path/to/conkyrc"
  
To colorize parts (or all) of the output of the script, you can use {#RRGGBB}. "#RRGGBB" is a standard hex color code and using these in brackets will colorize everything on the statusbar following it until another color code is passed.
+
To colorize parts (or all) of the output of the script, you can use {{ic|{#RRGGBB} }}. "#RRGGBB" is a standard hex color code and using these in brackets will colorize everything on the statusbar following it until another color code is passed.
  
 
====Custom Icons====
 
====Custom Icons====
As with {{ic|config.h}}, TTWM supports custom iconsets using a customized {{ic|icons.h}} which should be placed at {{ic|$HOME/.ttwm_icons.h}} or {{ic|$XDG_CONFIG_HOME/ttwm/icons.h}}.
+
As with {{ic|config.h}}, Alopex supports custom iconsets using a customized {{ic|icons.h}} which should be placed at {{ic|$HOME/.alopex_icons.h}} or {{ic|$XDG_CONFIG_HOME/alopex/icons.h}}.
  
Icons, similar to the bracketed color codes, are referenced in the statusbar script or program using {i X} where "X" is the number of the icon. View the default {{ic|icons.h}} to see which icons are available and what their value for X is (it is determined by the order in which each icon appears in the array at the bottom of the file). To enable TTWM to use icons, the following line must be included in the custom {{ic|config.h}}:
+
Icons, similar to the bracketed color codes, are referenced in the statusbar script or program using {{ic|{i X} }} where "X" is the number of the icon. View the default {{ic|icons.h}} to see which icons are available and what their value for X is (it is determined by the order in which each icon appears in the array at the bottom of the file). To enable Alopex to use icons, the following line must be included in the custom {{ic|config.h}}:
 
  #include icons.h
 
  #include icons.h
Because these icons are sourced at compile-time, any customization of the icon-set will require the user to recompile, reinstall and restart TTWM.
+
Because these icons are sourced at compile-time, any customization of the icon-set will require the user to recompile, reinstall and restart Alopex.
  
 
===Multi-Monitor Support===
 
===Multi-Monitor Support===
TTWM has experimental support for up to 16 external monitors using xrandr. Though auto-detection of external montiors is not yet supported, it is planned for version 2.1. Unlike with the internal monitor, TTWM handles windows with slightly different rulesets on external monitors. Each window is assigned a monitor number (in addition to tags/flags and other info).  If the monitor number is higher than the number of available monitors, the window is placed on the highest numbered monitor, otherwise it is placed on the monitor matching its number. See the documentation on the [https://bbs.archlinux.org/viewtopic.php?pid=1247509#p1247509 BBS], and in {{ic|config.h}} for more details.
+
Alopex has experimental support for up to 16 external monitors using xrandr. Though auto-detection of external montiors is not yet supported, it is planned for version 2.1. Unlike with the internal monitor, Alopex handles windows with slightly different rulesets on external monitors. Each window is assigned a monitor number (in addition to tags/flags and other info).  If the monitor number is higher than the number of available monitors, the window is placed on the highest numbered monitor, otherwise it is placed on the monitor matching its number. See the documentation on the [https://bbs.archlinux.org/viewtopic.php?pid=1247509#p1247509 BBS], and in {{ic|config.h}} for more details.
  
 
===Window Rules===
 
===Window Rules===
TTWM also has the ability to define limited window rules based on the {{ic|WM_NAME}} and {{ic|WM_CLASS}} strings from [[X11]]. You can modify, or add to, these rules by editing the {{ic|rules}} array in {{ic|config.h}} using the following syntax:
+
Alopex also has the ability to define limited window rules based on the {{ic|WM_NAME}} and {{ic|WM_CLASS}} strings from [[X11]]. You can modify, or add to, these rules by editing the {{ic|rules}} array in {{ic|config.h}} using the following syntax:
 
  static Rule rules[] = {
 
  static Rule rules[] = {
 
     { "name",  "class",  tags,  flags },
 
     { "name",  "class",  tags,  flags },
 
  }
 
  }
You can replace either {{ic|"name"}} or {{ic|"class"}} with {{ic|NULL}} to ignore those values in a given rule. If both are specified, then the rule will only apply if both conditions are met. To determine what values you should use for {{ic|"name"}} or {{ic|"class"}}, you can use {{Pkg|xorg-xprop}}. The value you give for {{ic|tags}} allows you to specify what tags a window will be given by default when it opens. If you wish not to affect this behavior, use {{ic|0}} in place of {{ic|tags}}. Finally, the {{ic|flags}} value allows you to specify special properties to be given to the window (e.g., force floating mode). If you wish to not affect this behavior, you can replace {{ic|flags}} with {{ic|0}}. More documentation regarding TTWM's window rules can be found on the [https://bbs.archlinux.org/viewtopic.php?pid=1255305#p1255305 BBS].
+
You can replace either {{ic|"name"}} or {{ic|"class"}} with {{ic|NULL}} to ignore those values in a given rule. If both are specified, then the rule will only apply if both conditions are met. To determine what values you should use for {{ic|"name"}} or {{ic|"class"}}, you can use {{Pkg|xorg-xprop}}. The value you give for {{ic|tags}} allows you to specify what tags a window will be given by default when it opens. If you wish not to affect this behavior, use {{ic|0}} in place of {{ic|tags}}. Finally, the {{ic|flags}} value allows you to specify special properties to be given to the window (e.g., force floating mode). If you wish to not affect this behavior, you can replace {{ic|flags}} with {{ic|0}}. More documentation regarding Alopex's window rules can be found on the [https://bbs.archlinux.org/viewtopic.php?pid=1255305#p1255305 BBS].
  
 
==See also==
 
==See also==
* [http://trilbywhite.github.com/ttwm/ TTWM's official website] (Refers to 1.0)
+
* [http://trilbywhite.github.com/ttwm/ TTWM 1.0's official website]
* [https://github.com/TrilbyWhite/ttwm TTWM's Sourcecode on GitHub]
+
* [https://github.com/TrilbyWhite/alopex Alopex Sourcecode on GitHub]
 
* [[dmenu]] - Simple application launcher from the developers of dwm
 
* [[dmenu]] - Simple application launcher from the developers of dwm
* The [https://bbs.archlinux.org/viewtopic.php?id=146889 TTWM thread] on the forums
+
* The [https://bbs.archlinux.org/viewtopic.php?id=146889 Alopex thread] on the forums
 
* The [https://bbs.archlinux.org/viewtopic.php?id=160182 Interrobang thread] on the forums
 
* The [https://bbs.archlinux.org/viewtopic.php?id=160182 Interrobang thread] on the forums

Revision as of 18:00, 22 April 2013

Template:Article summary start Template:Article summary text Template:Article summary heading Template:Article summary wiki Template:Article summary wiki Template:Article summary wiki Template:Article summary end

Alopex (formerly, TTWM) is a minimal tiling window manager combining concepts or elements from tinywmAUR, dwm, and i3wm. Inspiration has also been drawn from other great tilers like monsterwm. It manages windows using tiling, horizontal or vertical stacking layouts with transient floating and fullscreen modes.

Note: TTWM 1.0 can still be installed using ttwmAUR.

Installation

Installing alopex-gitAUR, from the AUR, is as simple as fetching the PKGBUILD and running the following:

$ makepkg -si
Tip: As configuration is done at compile-time, modifications (such as customized keybindings or colorschemes) can be achieved by moving a copy of config.h (from upstream) to $HOME/.alopex_config.h or $XDG_CONFIG_HOME/alopex/config.h and editing it to reflect any user preferences. See #Configuration

Basic usage

By Default, Alopex tracks the following four modifier masks:

Reference Key
Template:Keypress "Super"
Template:Keypress "Alternate"
Template:Keypress "Control"
Template:Keypress "Shift"

Launching programs

Dmenu is a useful addon to Alopex. As opposed to list-style or drop-down menus, dmenu is a type-to-complete program launcher. It is the recommended launcher for Alopex, and the default configuration maps running dmenu to Template:Keypress + Template:Keypress.

Note: The creator of Alopex has also made a very small, light-weight alternative to dmenu called interrobang. It can be installed easily using interrobang-gitAUR. To replace dmenu with interrobang, read on how to customize keybindings in #Custom Configuration.

Using tags

To move or assign a window to a given tag, the intended window must first be focused. This can be accomplished by using Template:Keypress + Template:Keypress and/or Template:Keypress + Template:Keypress.

Action Keybind
View Tag "x" Template:Keypress + Template:Keypress
Move to Tag "x" Template:Keypress + Template:Keypress + Template:Keypress
Assign to Tag "x" Template:Keypress + Template:Keypress + Template:Keypress
Toggle Visibility of Tag "x" Template:Keypress + Template:Keypress + Template:Keypress
Note: As with dwm, Alopex makes a distinction between tags and views (workspaces). By default, Alopex has six tags enabled and two views available. You can switch between the two views using Template:Keypress + Template:Keypress. To better understand the difference and how you can arrange your workflow to utilize the difference, this article (written for dwm) may be helpful.
Tip: It is possible to customize how tags are labeled using a custom config.h and icons.h. See #Customizing Tags.

Window layouts

Alopex has three rule-based layouts complimented by transient fullscreen and floating modes: Vertical and Horizontal Stacking and "Monocle" (Full screen with statusbar tabs). By default, the vertical stacking layout will be used. Cycling through all three layouts can be done by pressing Template:Keypress + Template:Keypress. You can select each mode more directly with the following shortcuts:

Mode Keybind Windows visible Arrangement
V-Stack (rstack) Template:Keypress + Template:Keypress + Template:Keypress 3 Master on left, stack on right
H-Stack (bstack) Template:Keypress + Template:Keypress + Template:Keypress 3 Master on top, stack on bottom
Monocle Template:Keypress + Template:Keypress + Template:Keypress 1 Variable sized tabs for each window

Using the stackcount option, you can specify how many windows you would like to be visible in the stack. You can also use Template:Keypress + Template:Keypress and Template:Keypress + Template:Keypress to dynamically increment and decrement the number of visible windows in the stack (respectively). Furthermore, using Template:Keypress + Template:Keypress will keep all open windows visible.

Tip: You can toggle a window to and from Fullscreen mode by pressing Template:Keypress + Template:Keypress, and, similarly, you can toggle floating mode by pressing Template:Keypress + Template:Keypress + Template:Keypress.

Exiting

Cleanly killing a window can be done by pressing Template:Keypress + Template:Keypress. Cleanly exiting Alopex can be done by pressing Template:Keypress + Template:Keypress + Template:Keypress.

Extended Usage

Custom Configuration

As mentioned previously, Alopex is almost entirely configured at compile-time via the editing of its source files, primarily config.h and icons.h. The upstream configuration provides sane defaults, but configuration per user-preference is easy to achieve.

As mentioned in #Installation, alopex-gitAUR will check for $HOME/.alopex_config.h and $XDG_CONFIG_HOME/alopex/config.h, and, if either exists, use them to replace the default config.h before commencing the build. After using makepkg to grab the source, simply copy the config.h to either $HOME/.alopex_config.h or $XDG_CONFIG_HOME/alopex/config.h and make your modifications.

Once the desired modifications have been made, return to the package directory and compile/install:

$ makepkg -si
Tip: If you have already compiled, you may need to use the f switch to force a recompile

Assuming the configuration changes were valid, the customized Alopex will have been compiled and installed. If problems were encountered, review the output for specific information.

For any changes to take effect, it will be necessary to (re)start Alopex.

Custom Keybindings

One of the main customizations that must be made in a custom config.h is the use of custom keybindings. To map a custom keybinding, add the necessary lines to the keys array using the following syntax:

{ MODKEY, <key>, spawn, CMD("program") },
Tip: To map a single key to a function (that is, without a modifier key), use 0 for MODKEY.

<key> can either be a hex keycode (e.g., 0x68) or an X keysym (e.g., XK_h). You can check for keycodes and keysyms by using xorg-xev. If you would like to use the XF86 keysyms (for instance, for media keys), you can do so, but you must have the following line uncommented in your config.h:

#include <X11/XF86keysym.h>

You can also define special functions for more complex commands by using #define:

#define FUNCTION "program -switches --options arguments"

which could then be mapped to a keybind using CMD(FUNCTION) in the above syntax.

Note: Using #define FUNCTION, you do not quote FUNCTION in the keybinding declaration.

Configuration Options

Aside from custom keybinds, Alopex offers various configuration options which can be modified in a custom config.h to help you fine-tune your setup. Below is an abridged list of available configuration options and explanations of their settings:

Option Possible Values Function
borderwidth 0, 1, 2, etc. Sets the size of a border to be drawn around the focused window
tilegap 0, 1, 2, etc. Sets the size of a gap to be left between windows
win_min 0, 1, 2, etc. Sets the smallest allowed width and height of a window
focusfollowmouse True or False If "True," hovering the mouse over a window will shift focus to that window
showbar True or False Enables or disables the statusbar
topbar True or False If "True," the statusbar is displayed on the top of the screen. If "False," on bottom
tilebias 0, 1, 2, etc. Determine how much larger (in pixels) the master section is than the stack (0 divides them equally)
attachmode 0, 1 or 2 Determines where to place new windows (0 == master section, 1 == top of the stack, 2 == bottom of the stack)

Customizing Tags

It is possible, using the tagcons array, to customize how tags appear on the statusbar. By default, the default tags are named one through six. Using the tagcons array, you can have them appear with any combination of a prefix, an icon and a suffix. You can add, or customize tag appearances using the following syntax:

static const Tagcon tagcons=[] = {
   { "prefix",   #,   "suffix" },
};

With this syntax # refers to the position of the icon in the array at the bottom of icons.h; "prefix" and "suffix" refer to the labels of text given to the tag before and after the icon, respectively. If you do not want the tag to appear with an icon, replace # with NO_ICON or -1. If you would rather a tag appear without any label, replace "prefix" and "suffix" with NULL. The order each tag appears on the bar depends on the order in which they appear in the tagcons array.

Note: NULL should appear without quotes, whereas text prefixes and suffixes must be quoted.

Statusbar

By passing a script or program as an argument to Alopex, it can create a minimalistic statusbar. To avoid a CPU race, Alopex provides a default statusbar script if none is passed to it. This default script displays only a simple clock. For a more powerful statusbar, you can either write a script (or your own small program) or use a statusbar program such as conky. If the script (or program) you use takes arguments itself, remember to quote the whole statusbar argument. For example, the following commands would start Alopex with a script or conky (respectively):

$ xinit /usr/bin/alopex "/home/username/script.sh -args"
$ xinit /usr/bin/alopex "conky -c /path/to/conkyrc"

To colorize parts (or all) of the output of the script, you can use {#RRGGBB} . "#RRGGBB" is a standard hex color code and using these in brackets will colorize everything on the statusbar following it until another color code is passed.

Custom Icons

As with config.h, Alopex supports custom iconsets using a customized icons.h which should be placed at $HOME/.alopex_icons.h or $XDG_CONFIG_HOME/alopex/icons.h.

Icons, similar to the bracketed color codes, are referenced in the statusbar script or program using {i X} where "X" is the number of the icon. View the default icons.h to see which icons are available and what their value for X is (it is determined by the order in which each icon appears in the array at the bottom of the file). To enable Alopex to use icons, the following line must be included in the custom config.h:

#include icons.h

Because these icons are sourced at compile-time, any customization of the icon-set will require the user to recompile, reinstall and restart Alopex.

Multi-Monitor Support

Alopex has experimental support for up to 16 external monitors using xrandr. Though auto-detection of external montiors is not yet supported, it is planned for version 2.1. Unlike with the internal monitor, Alopex handles windows with slightly different rulesets on external monitors. Each window is assigned a monitor number (in addition to tags/flags and other info). If the monitor number is higher than the number of available monitors, the window is placed on the highest numbered monitor, otherwise it is placed on the monitor matching its number. See the documentation on the BBS, and in config.h for more details.

Window Rules

Alopex also has the ability to define limited window rules based on the WM_NAME and WM_CLASS strings from X11. You can modify, or add to, these rules by editing the rules array in config.h using the following syntax:

static Rule rules[] = {
   { "name",   "class",  tags,   flags },
}

You can replace either "name" or "class" with NULL to ignore those values in a given rule. If both are specified, then the rule will only apply if both conditions are met. To determine what values you should use for "name" or "class", you can use xorg-xprop. The value you give for tags allows you to specify what tags a window will be given by default when it opens. If you wish not to affect this behavior, use 0 in place of tags. Finally, the flags value allows you to specify special properties to be given to the window (e.g., force floating mode). If you wish to not affect this behavior, you can replace flags with 0. More documentation regarding Alopex's window rules can be found on the BBS.

See also