News Migration Tutorial Objects herbstluftwm(1) herbstclient(1)

OBJECTS

The state of herbstluftwm can interactively be introspected and modified via the object system. Similarly to a file system, the objects are organized in a tree whose root object has the following entries:

autostart:

  • string global_path = globalAutostart: Path of the system-wide autostart, used as a fallback.

  • int last_status = 0: the exit status of the last autostart run. if the autostart is still running, then this status corresponds to the exit status of the previous autostart invocation.

  • string path = autostartFromCmdLine: Custom path to the user’s autostart path. If it is empty, then the autostart in $XDG_CONFIG_HOME or $HOME is used.

  • uint pid = 0: the process id of the last autostart invocation. Even if the autostart is not running anymore, its pid is still present here.

  • bool running = false: whether the autostart process (with pid) is still running.

clients:

The managed windows. For every (managed) window id there is an entry here.

  • dragged: the object of a client which is currently dragged by the mouse, if any. See the documentation of the mousebind command for examples. For attributes and children, see clients.focus

  • focus: the focused client (only exists if a client is focused). a managed window

    • string class: the class of it (second entry in WM_CLASS)

    • Rectangle content_geometry: the geometry of the application content, that is, not taking the decoration into account. Also, this is the last window geometry that was reported to the client application.

    • bool decorated = true: whether window border and title are drawn

    • Rectangle decoration_geometry: the geometry of the client, taking the window decoration into account. The position is the global window position, that is, relative to the top left corner of the entire screen

    • bool ewmhnotify = true: if the client is told about its state via ewmh

    • bool ewmhrequests = true: if ewmh requests are permitted for this client

    • bool floating = false: whether this client is set as a (single-window) floating client. If set, the client is floated above the tiled clients.

    • bool floating_effectively = false: whether this client is in the floating state currently. This is the case if the client’s tag is set to floating mode or if the client itself is set as floating. Its value is also indicated via the X11 properties HLWM_FLOATING_WINDOW and HLWM_TILING_WINDOW.

    • Rectangle floating_geometry = 0: the geometry of the client content if the client is in floating mode. The position is relative to the monitor and does not take the window decoration into account.

    • bool fullscreen = false: whether this client covers all other windows and panels on its monitor.

    • string instance: the instance of it (first entry in WM_CLASS)

    • regex keymask = "": A regular expression that is matched against the string representation of all key bindings (as they are printed by list_keybinds). While this client is focused, only bindings that match the expression will be active. Any other bindings will be disabled. The default keymask is an empty string (), which does not disable any keybinding.

    • regex keys_inactive = "": A regular expression that describes which keybindings are inactive while the client is focused. If a key combination is pressed and its string representation (as given by list_keybinds) matches the regex, then the key press is propagated to the client.

    • bool minimized = false: whether this client is minimized (also called iconified).

    • int pgid = -1

    • int pid = -1: the process id of it (-1 if unset).

    • bool pseudotile = false: if activated, the client always has its floating window size, even if it is in tiling mode.

    • bool sizehints_floating = true: if sizehints for this client should be respected in floating mode

    • bool sizehints_tiling = false: if sizehints for this client should be respected in tiling mode

    • string tag: the name of the tag it’s currently on.

    • string title = "": its window title

    • bool urgent = false: the urgency state (also known as: demands attention). The focused client can not be urgent.

    • bool visible = visible_already: whether this client is rendered currently

    • string winid = "": its window id (as a hexadecimal number with 0x prefix)

    • parent_frame: the frame contaning this client if the client is tiled. For attributes and children, see tags.focus.tiling.root

monitors:

Every monitor is a rectangular part of the screen on which a tag is shown. These monitors may or may not match the actual outputs. This has an entry INDEX for each monitor with index INDEX.

  • uint count

  • by-name: This has an entry name for every object with the given name. If an object has an empty name then it is not listed here.

  • focus: the focused monitor. The monitor is a rectangular part on the screen that holds precisely one tag at a time. The pad attributes reserve space on the monitor’s edge for panels, so this space (given in number of pixels) is never occupied by tiled clients.

    • Rectangle content_geometry: the inner geometry of the monitor, i.e. the geometry with the pads deducted from all sides. This is the area floating and tiled client windows are placed.

    • Rectangle geometry = rect_: the outer geometry of the monitor

    • uint index = 0: the monitor’s index (starts at index 0)

    • bool lock_tag = false: if activated, then it it is not possible to switch this monitor to a different tag.

    • string name = "": the monitor’s name (can be empty)

    • int pad_down = 0: space for panels at the monitor’s lower edge

    • int pad_left = 0: space for panels at the monitor’s left edge

    • int pad_right = 0: space for panels at the monitor’s right edge

    • int pad_up = 0: space for panels at the monitor’s upper edge

    • string tag: the name of the tag viewed here

panels:

For every panel window, there is an entry with the panel’s window id here.

  • uint count

  • 0xWindowID: a panel is an unmanaged window that reserves space at the edge of the monitor it is on. The space depends on the _NET_WM_STRUT defined by the panel. If it is however not defined explicitly, then the amount of reserved space is inferred from the window geometry.

    • string class: the window class (second entry of WM_CLASS)

    • Rectangle geometry: the size and position of the window

    • string instance: the window instance (first entry of WM_CLASS)

    • WindowID winid = winid: the ID of the panel window

settings:

Settings configure the general behaviour of herbstluftwm and can be controlled via the set, get and toggle commands. The settings. object has an attribute for each setting. Many settings are wrappers around attributes and only remain for compatibility.

  • bool always_show_frame = false: DEPRECATED, use show_frame_decorations instead. Setting this corresponds to focused in show_frame_decorations.

  • bool auto_detect_monitors = false: If set, detect_monitors is automatically executed every time a monitor is connected, disconnected or resized.

  • bool auto_detect_panels = true: If set, EWMH panels are automatically detected and reserve space at the side of the monitors they are on (via pad attributes of each monitor). This setting is activated per default.

  • bool default_direction_external_only = false: This setting controls the behaviour of focus and shift if no -e or -i argument is given. If set, then focus and shift changes the focused frame even if there are other clients in this frame in the specified DIRECTION. Else, a client within current frame is selected if it is in the specified DIRECTION.

  • LayoutAlgorithm default_frame_layout = vertical: Name of the layout algorithm, which is used if a new frame is created (on a new tag or by a non-trivial split). See above for the list of layout algorithms.

  • string ellipsis = …: string to append when window or tab titles are shortened to fit in the available space.

  • bool focus_crosses_monitor_boundaries = true: If set, commands focus and shift cross monitor boundaries. If there is no client in the direction given to focus, then the monitor in the specified direction is focused. Similarly, if shift cannot move a window within a tag, the window is moved to the neighbour monitor in the desired direction.

  • bool focus_follows_mouse = false: If set and a window is focused by mouse cursor, this window is focused (this feature is also known as sloppy focus). If unset, you need to click to change the window focus by mouse.

    If another window is hidden by the focus change (e.g. when having pseudotiled windows in the max layout) then an extra click is required to change the focus.

  • bool focus_stealing_prevention = true: If set, only pagers and taskbars are allowed to change the focus. If unset, all applications can request a focus change.

  • int frame_active_opacity = 100: Focused frame opacity in percent. Requires a running compositing manager to take actual effect.

  • color frame_bg_active_color = black: The fill color of a focused frame.

  • color frame_bg_normal_color = black: The fill color of an unfocused frame (It is only visible if non-focused frames are configured to be visible, see show_frame_decorations).

  • bool frame_bg_transparent = false: If set, the background of frames are transparent. That means a rectangle is cut out from the inner such that only the frame border and a stripe of width frame_transparent_width can be seen. Use frame_active_opacity and frame_normal_opacity for real transparency.

  • color frame_border_active_color = red: The border color of a focused frame.

  • color frame_border_inner_color = black: The color of the inner border of a frame.

  • int frame_border_inner_width = 0: The width of the inner border of a frame. Must be less than frame_border_width, since it does not add to the frame border width but is a part of it.

  • color frame_border_normal_color = blue: The border color of an unfocused frame.

  • int frame_border_width = 2: Border width of a frame.

  • int frame_gap = 5: The gap between frames in the tiling mode.

  • int frame_normal_opacity = 100: Unfocused frame opacity in percent. Requires a running compositing manager to take actual effect.

  • int frame_padding = 0: The padding within a frame in the tiling mode, i.e. the space between the border of a frame and the windows within it.

  • int frame_transparent_width = 0: Specifies the width of the remaining frame colored with frame_bg_active_color if frame_bg_transparent is set.

  • bool gapless_grid = true: This setting affects the size of the last client in a frame that is arranged by grid layout. If set, then the last client always fills the gap within this frame. If unset, then the last client has the same size as all other clients in this frame.

  • bool hide_covered_windows = false: If activated, windows are explicitly hidden when they are covered by another window in a frame with max layout. This only has a visible effect if a compositor is used. If activated, shadows do not stack up and transparent windows show the wallpaper behind them instead of the other clients in the max layout.

  • uint monitors_locked = 0: If greater than 0, then the clients on all monitors aren’t moved or resized anymore. If it is set to 0, then the arranging of monitors is enabled again, and all monitors are rearranged if their content has changed in the meantime. You should not change this setting manually due to concurrency issues; use the commands lock and unlock instead.

  • int mouse_recenter_gap = 0: Specifies the gap around a monitor. If the monitor is selected and the mouse position would be restored into this gap, it is set to the center of the monitor. This is useful, when the monitor was left via mouse movement, but is reselected by keyboard. If the gap is 0 (default), the mouse is never recentered.

  • int pseudotile_center_threshold = 10: If greater than 0, it specifies the least distance between a centered pseudotile window and the border of the frame or tile it is assigned to. If this distance is lower than pseudotile_center_threshold, it is aligned to the top left of the client’s tile.

  • bool raise_on_click = true: If set, a window is raised if it is clicked. The value of this setting is only noticed in floating mode.

  • bool raise_on_focus = false: If set, a window is raised if it is focused. The value of this setting is only used in floating mode.

  • bool raise_on_focus_temporarily = false: If set, a window is raised temporarily if it is focused on its tag. Temporarily in this case means that the window will return to its previous stacking position if another window is focused.

  • ShowFrameDecorations show_frame_decorations = focused_if_multiple: This controls, which frame decorations are shown at all.

    • none shows no frame decorations at all,

    • nonempty shows decorations of frames that have client windows,

    • if_multiple shows decorations on the tags with at least two frames,

    • if_empty shows decorations of frames that have no client windows,

    • focused shows the decoration of focused and nonempty frames,

    • focused_if_multiple shows decorations of focused and non-empty frames on tags with at least two frames.

  • SmartFrameSurroundings smart_frame_surroundings = off: If set to hide_all, frame borders and gaps will be removed when there is no ambiguity regarding the focused frame. If set to hide_gaps, only frame gaps will be removed when there is no ambiguity regarding the focused frame. Turn off to always show frame borders and gaps.

  • bool smart_window_surroundings = false: If set, window borders and gaps will be removed and minimal when there’s no ambiguity regarding the focused window. This minimal window decoration can be configured by the theme.minimal object.

  • int snap_distance = 10: If a client is dragged in floating mode, then it snaps to neighbour clients if the distance between them is smaller than snap_distance.

  • int snap_gap = 5: Specifies the remaining gap if a dragged client snaps to an edge in floating mode. If snap_gap is set to 0, no gap will remain.

  • bool swap_monitors_to_get_tag = true: If set: If you want to view a tag, that already is viewed on another monitor, then the monitor contents will be swapped and you see the wanted tag on the focused monitor. If not set, the other monitor is focused if it shows the desired tag.

  • bool tabbed_max = true: if activated, multiple windows in a frame with the max layout algorithm are drawn as tabs.

  • string tree_style = "*| +`--.": It contains the chars that are used to print a nice ascii tree. It must contain at least 8 characters. e.g. X|:#+*-. produces a tree like:

    X-.
      #-. child 0
      | #-* child 00
      | +-* child 01
      +-. child 1
      : #-* child 10
      : +-* child 11

    Useful values for tree_style are: ╾│ ├└╼─┐ or -| |'--. or ╾│ ├╰╼─╮.

  • bool update_dragged_clients = false: If set, a client's window content is resized immediately during resizing it with the mouse. If unset, the client's content is resized after the mouse button is released.

  • bool verbose = false: If set, verbose output is logged to herbstluftwm’s stderr. The default value is controlled by the --verbose command line flag.

  • color window_border_active_color: Border color of a focused window.

    Warning: This only exists for compatibility reasons; it is only an alias for the attribute theme.active.color.

  • color window_border_inner_color: Color of the inner border of a window. Warning: This only exists for compatibility reasons; it is only an alias for the attribute theme.inner_color.

  • int window_border_inner_width: The width of the inner border of a window. Must be less than window_border_width, since it does not add to the window border width but is a part of it.

    Warning: This only exists for compatibility reasons; it is only an alias for the attribute theme.inner_width.

  • color window_border_normal_color: Border color of an unfocused window.

    Warning: This only exists for compatibility reasons; it is only an alias for the attribute theme.normal.color.

  • color window_border_urgent_color: Border color of an unfocused but urgent window.

    Warning: This only exists for compatibility reasons; it is only an alias for the attribute theme.urgent.color.

  • int window_border_width: Border width of a window.

    Warning: This only exists for compatibility reasons; it is only an alias for the attribute theme.border_width.

  • int window_gap = 0: The gap between windows within one frame in the tiling mode.

  • string wmname = herbstluftwm: It controls the value of the _NET_WM_NAME property on the root window, which specifies the name of the running window manager. The value of this setting is not updated if the actual _NET_WM_NAME property on the root window is changed externally. Example usage:

    • cycle_value wmname herbstluftwm LG3D

tags:

The tags (or virtual desktops or workspaces). This contains an entry index for each tag with the given index.

  • uint count

  • by-name: For attributes and children, see monitors.by-name

  • focus: the object of the focused tag, equivalently, the tag on the focused monitor.

    • bool at_end = false: all tags with this property activated will be kept at the end of the tag list. Usually, this property is set for special purpose tags like scratchpads.

    • int client_count: the number of clients on this tag

    • int curframe_wcount: number of clients in the selected frame

    • int curframe_windex: index of the focused client in the selected frame

    • bool floating = false: if the entire tag is set to floating mode

    • bool floating_focused = false: if the floating layer is focused (otherwise the tiling layer is)

    • int frame_count: the number of frames on this tag

    • uint index = 0: index of this tag (the first index is 0)

    • string name = name_: name of the tag (must be non-empty)

    • int urgent_count: the number of urgent clients on this tag

    • bool visible = false: if this tag is shown on some monitor

    • focused_client: For attributes and children, see clients.focus

    • tiling:

      • focused_frame: The focused frame (leaf) in this frame tree. For attributes and children, see tags.focus.tiling.root

      • root can be a frame leaf.

        • LayoutAlgorithm algorithm

        • int client_count

        • Rectangle content_geometry: the geometry of the frame’s contents, i.e. of the area filled by child frames or client windows.

        • string index: A string containing only 0 and 1 that describes the position of the frame in the tree. The empty string denotes the root frame. Appending 0 (respectively 1) to a frame index yields the frame index of the first (respectively second) subtree.

        • int selection

      • root can be a frame split.

        • Rectangle content_geometry: the geometry of the frame’s contents, i.e. of the area filled by child frames or client windows.

        • decimal fraction

        • string index: A string containing only 0 and 1 that describes the position of the frame in the tree. The empty string denotes the root frame. Appending 0 (respectively 1) to a frame index yields the frame index of the first (respectively second) subtree.

        • int selection

        • SplitAlign split_type

        • 0 can be a frame leaf. For attributes and children, see tags.focus.tiling.root

        • 0 can be a frame split. For attributes and children, see tags.focus.tiling.root

        • 1 can be a frame leaf. For attributes and children, see tags.focus.tiling.root

        • 1 can be a frame split. For attributes and children, see tags.focus.tiling.root

theme:

inner_color/inner_width
      ╻        outer_color/outer_width
      │                  ╻
      │                  │
┌────╴│╶─────────────────┷─────┐ ⎫ border_width
│     │      color             │ ⎬ + title_height + title_depth
│  ┌──┷─────────────────────┐  │ ⎭ + padding_top
│  │====================....│  │
│  │== window content ==....│  │
│  │====================..╾──────── background_color
│  │........................│  │
│  └────────────────────────┘  │ ⎱ border_width +
└──────────────────────────────┘ ⎰ padding_bottom

Setting an attribute of the theme object just propagates the value to the respective attribute of the tiling and the floating object. If the title area is divided into tabs, then the not selected tabs can be styled using the tab_… attributes. If these attributes are empty, then the colors are taken from the theme of the client to which the tab refers to.

  • color background_color = black: color behind window contents visible on resize

  • uint border_width = 0: the base width of the border

  • color color = black: the basic background color of the border

  • color inner_color = black: color of the inner border

  • uint inner_width = 0: width of the border around the clients content

  • CssFile::Ptr name: the absolute path to a css theme file. if this is empty, then the theme is specified by the attributes.

  • color outer_color = black: color of the outer border

  • uint outer_width = 0: width of an border close to the edge

  • uint padding_bottom = 0: additional border width on the bottom

  • uint padding_left = 0: additional border width on the left

  • uint padding_right = 0: additional border width on the right

  • uint padding_top = 0: additional border width on the top

  • string reset: writing this resets all attributes to a default value

  • CssSource style_override: additional css source to overwrite parts of the theme. All rules here have higher precedence than all rules in the theme

  • MaybeColor tab_color = Inherit: if non-empty, the color of non-urgent and unfocused tabs

  • MaybeColor tab_outer_color = Inherit: if non-empty, the outer border color of non-urgent and unfocused tabs; if empty, the colors are taken from the tab’sclient decoration settings.

  • MaybeULong tab_outer_width = Inherit: if non-empty, the outer border width of non-urgent and unfocused tabs

  • MaybeColor tab_title_color = Inherit: if non-empty, the title color of non-urgent and unfocused tabs

  • bool tight_decoration = false: specifies whether the size hints also affect the window decoration or only the window contents of tiled clients (requires enabled sizehints_tiling)

  • TextAlign title_align = left: the horizontal alignment of the title within the tab or title bar. The value is one of: left, center, right

  • color title_color = black

  • MaybeInt title_depth = 0: the space below the baseline of the window title, or '' for an automatic calculation based on the font.

  • font title_font = fixed

  • MaybeULong title_height = 0: the space above the baseline of the window title, or '' for an automatic calculation based on the font.

  • TitleWhen title_when = always: when to show the window title: always, never, if the the client is in a tabbed scenario like a max frame (one_tab), if there are multiple_tabs to be shown.

  • active: configures the decoration of the focused client.

    • color background_color = black: color behind window contents visible on resize

    • uint border_width = 0: the base width of the border

    • color color = black: the basic background color of the border

    • color inner_color = black: color of the inner border

    • uint inner_width = 0: width of the border around the clients content

    • color outer_color = black: color of the outer border

    • uint outer_width = 0: width of an border close to the edge

    • uint padding_bottom = 0: additional border width on the bottom

    • uint padding_left = 0: additional border width on the left

    • uint padding_right = 0: additional border width on the right

    • uint padding_top = 0: additional border width on the top

    • string reset: writing this resets all attributes to a default value

    • MaybeColor tab_color = Inherit: if non-empty, the color of non-urgent and unfocused tabs

    • MaybeColor tab_outer_color = Inherit: if non-empty, the outer border color of non-urgent and unfocused tabs; if empty, the colors are taken from the tab’sclient decoration settings.

    • MaybeULong tab_outer_width = Inherit: if non-empty, the outer border width of non-urgent and unfocused tabs

    • MaybeColor tab_title_color = Inherit: if non-empty, the title color of non-urgent and unfocused tabs

    • bool tight_decoration = false: specifies whether the size hints also affect the window decoration or only the window contents of tiled clients (requires enabled sizehints_tiling)

    • TextAlign title_align = left: the horizontal alignment of the title within the tab or title bar. The value is one of: left, center, right

    • color title_color = black

    • MaybeInt title_depth = 0: the space below the baseline of the window title, or '' for an automatic calculation based on the font.

    • font title_font = fixed

    • MaybeULong title_height = 0: the space above the baseline of the window title, or '' for an automatic calculation based on the font.

    • TitleWhen title_when = always: when to show the window title: always, never, if the the client is in a tabbed scenario like a max frame (one_tab), if there are multiple_tabs to be shown.

  • floating: behaves analogously to tiling.

    • color background_color = black: color behind window contents visible on resize

    • uint border_width = 0: the base width of the border

    • color color = black: the basic background color of the border

    • color inner_color = black: color of the inner border

    • uint inner_width = 0: width of the border around the clients content

    • color outer_color = black: color of the outer border

    • uint outer_width = 0: width of an border close to the edge

    • uint padding_bottom = 0: additional border width on the bottom

    • uint padding_left = 0: additional border width on the left

    • uint padding_right = 0: additional border width on the right

    • uint padding_top = 0: additional border width on the top

    • string reset: writing this resets all attributes to a default value

    • MaybeColor tab_color = Inherit: if non-empty, the color of non-urgent and unfocused tabs

    • MaybeColor tab_outer_color = Inherit: if non-empty, the outer border color of non-urgent and unfocused tabs; if empty, the colors are taken from the tab’sclient decoration settings.

    • MaybeULong tab_outer_width = Inherit: if non-empty, the outer border width of non-urgent and unfocused tabs

    • MaybeColor tab_title_color = Inherit: if non-empty, the title color of non-urgent and unfocused tabs

    • bool tight_decoration = false: specifies whether the size hints also affect the window decoration or only the window contents of tiled clients (requires enabled sizehints_tiling)

    • TextAlign title_align = left: the horizontal alignment of the title within the tab or title bar. The value is one of: left, center, right

    • color title_color = black

    • MaybeInt title_depth = 0: the space below the baseline of the window title, or '' for an automatic calculation based on the font.

    • font title_font = fixed

    • MaybeULong title_height = 0: the space above the baseline of the window title, or '' for an automatic calculation based on the font.

    • TitleWhen title_when = always: when to show the window title: always, never, if the the client is in a tabbed scenario like a max frame (one_tab), if there are multiple_tabs to be shown.

    • active: configures the decoration of the focused client. For attributes and children, see theme.active

    • normal: the default decoration scheme for clients. For attributes and children, see theme.active

    • urgent: configures the decoration of urgent clients. For attributes and children, see theme.active

  • fullscreen: configures clients in fullscreen state. For attributes and children, see theme.floating

  • minimal: configures clients with minimal decorations triggered by smart_window_surroundings. For attributes and children, see theme.floating

  • normal: the default decoration scheme for clients. For attributes and children, see theme.active

  • tiling: configures the decoration of tiled clients, setting one of its attributes propagates the respective attribute of the active, normal and urgent child objects. For attributes and children, see theme.floating

  • urgent: configures the decoration of urgent clients. For attributes and children, see theme.active

types:

This lists the types that are used for attributes and command arguments.

  • bool: Type representing boolean values, i.e. an on or off state, with aliases true and false. When writing to a boolean value, one can also specify toggle in order to alter its value.

    • string fullname: the full and unique name of this type

    • string shortname: A short (one-character long) name of this type which is used in the output of the attr command

  • color: Type representing colors. A color can be defined in one of the following formats:

    1. #RRGGBB where R, G, B are hexidecimal digits (0-9, A-F), and RR, GG, BB represent the values for red, green, blue.

    2. #RRGGBBAA represents a color with alpha-value AA. The alpha value 00 is fully transparent and FF is fully opaque/intransparent.

    3. a common color name like red, blue, orange, etc. For attributes and children, see types.bool

  • decimal: Fixed precision decimal numbers, e.g. 0.34. For attributes and children, see types.bool

  • font: A font specification (font family with modifiers regarding size, weight, etc.) in one of the following formats:

    • Fontconfig description. This supports antialiased fonts, for example:

      • Dejavu Sans:pixelsize=12

      • Bitstream Vera Sans:size=12:bold

    • X logical font description (XLFD), as provided by the xfontsel tool. No antialiasing is supported here, but this is usually superior for bitmap fonts. For example:

      • -*-fixed-medium-r-*-*-13-*-*-*-*-*-*-* for a standard bitmap font available on most systems. For attributes and children, see types.bool

  • int: Type representing signed integers. When overwriting an integer, you can increase or decrease its value relatively by writing +=N or -=N where N is an integer. So for example, writing +=3 to an attribute increases its value by 3. For attributes and children, see types.bool

  • names: A fixed set of names, depending on the context, e.g. names of layout algorithms or the split type of a non-leaf frame (which is only horizontal or vertical). For attributes and children, see types.bool

  • rectangle: A rectangle on the screen consisting of a size and the position on the screen. The format is WxH+X+Y where W is the width, H is the height, and X and Y are the coordinates of the top left corner of the rectangle: X is the number of pixels to the left screen edge and Y is the number of pixels to the top screen edge. (if X or Y is negative, then the + turns into -). For example: 800x600+800+0 or 400x200-10+30. For attributes and children, see types.bool

  • regex: A POSIX extended regular expression. Note that when passing a regex on the command line, additional quoting can be necessary. For explanations and examples, see section 9.4.6 of the documentation: https://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap09.html#tag_09_04_06. For attributes and children, see types.bool

  • string: Type representing normal text. For attributes and children, see types.bool

  • uint: Type representing unsigned (i.e. non-negative) integers. When overwriting an integer, you can increase or decrease its value relatively by writing +=N or -=N where N is an integer. For attributes and children, see types.bool

  • windowid: The window id is the number of a window. This can be a managed window (i.e. client) or an unmanaged window (e.g. a panel, a menu, or a desktop window). The default format is 0xHEX where HEX is a hexadecimal number (digits 0-9 and a-f) but it can also be specified in the decimal system (base 10), or as an octal number (with prefix 0 and base 8). When a window id is printed, it is always printed in the 0xHEX format and without any leading zeroes. For attributes and children, see types.bool

watchers:

  • uint count: the number of attributes that are watched