marwind

package module
v0.3.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 22, 2020 License: MIT Imports: 3 Imported by: 0

README

Marwind WM

Marwind is a simple X11 tiling window manager written in Go. It was inspired by the i3 window manager and the acme editor for Plan 9 and aims to combine the good parts of both for the best experience.

Important! The project is under active development and is not stable. Use at your own risk.

Goals

  • Sane defaults. It should be possible to install the WM and be immediately productive without spending hours on configuration
  • Keyboard-driven without sacrificing the mouse. Marwind is focused on the keyboard not unlike most tiling managers, however mouse also has its place. Common actions - such as moving, resizing, or closing windows - should be possible using either of the input methods
  • Dynamically reconfigurable. Provide standard HTTP / gRPC endpoints for on-the-fly configuration, without the need to reload the entire WM. These endpoints will also serve as points of communication with external applications.
  • Clean code and documentation

Limitations

This is a list of features that are planned but still missing in the software:

  • There are no tests and no documentation yet
  • No window decorations (e.g. title bars)
  • No multi-monitor support
  • No mouse support
  • No floating windows
  • No configuration available

Installation

From source

With Go environment set up and the repository cloned, it's enough to run:

make

The compiled binaries will be located in the bin directory. The window manager can be started using:

./bin/marwm

Documentation

Index

Constants

This section is empty.

Variables

View Source
var Config = wm.Config{
	InnerGap:                4,
	OuterGap:                4,
	Shell:                   "/bin/sh",
	LauncherCommand:         "rofi -show drun",
	TerminalCommand:         "alacritty",
	BorderWidth:             0,
	BorderColor:             0xffa1d1cf,
	TitleBarHeight:          18,
	TitleBarBgColor:         0xffa1d1cf,
	TitleBarFontColorActive: 0xff000000,
	TitleBarFontSize:        12,
	Keybindings: map[xproto.Keysym]string{

		keysym.XF86MonBrightnessDown: "light -U 5",
		keysym.XF86MonBrightnessUp:   "light -A 5",

		keysym.XF86AudioMute:        "pactl set-sink-mute @DEFAULT_SINK@ toggle",
		keysym.XF86AudioLowerVolume: "pactl set-sink-volume @DEFAULT_SINK@ -5%",
		keysym.XF86AudioRaiseVolume: "pactl set-sink-volume @DEFAULT_SINK@ +5%",
	},
}

Functions

This section is empty.

Types

This section is empty.

Directories

Path Synopsis
cmd

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL