NAME

argen - task-oriented tiling window manager.

SYNOPSIS

argen [options]

river -c argen

DESCRIPTION

argen is a task-oriented tiling window manager designed for keyboard + IPC workflows. It is based on the river(1) wayland compositor.

Usually, argen is run within river, either by adding it to river's init file or directly with river -c argen.

CONCEPTS

Contexts are task environments that replace traditional workspaces. They are identified by name so they can be fuzzy-searched rather than remembered by position. Each context spans all connected outputs and holds a set of windows, which are each assigned to one output.

Windows can be attached to multiple contexts, allowing shared windows to appear in any context without switching.

Every output on each context has its own ordered list of windows. A layout decides how to display that list. See the LAYOUTS section below for the available layouts, and argenctl(1) LAYOUT ACTIONS to switch or configure.

Windows also belong to a column: a group of adjacent windows in the list that share screen space vertically. Windows can be merged into columns or split apart. This is only relevant for column-based layouts and ignored by others. See argenctl(1) WINDOW ACTIONS for column-altering commands.

LAYOUTS

stacktile

This layout is inspired and called after the river-classic layout generator. It has up to three tiles. If there are more than three windows in the layout, they are stacked in the third tile. An overlay indicator helps the user to orientate themselves when cycling/ordering windows within the third tile.

-------------
|     |  2  |
|  1  |-----|
|     |  3  |
-------------

monocle

Only one full-size window is visible at a time. An overlay indicator helps to keep an overview over windows in the layout.

-------------
|           |
|           |
|           |
-------------

columns

Windows are arranged in columns of adjustable width.

-------------
|   |   |   |
|---|   |   |
|   |   |   |
-------------

scrolling

Windows are arranged in columns of adjustable width, laid out along an infinite, horizontally scrolling strip.

-------------


    |   |
----|   |


    |   |
-------------

OPTIONS

-h, --help

Print a help message and exit.

--version

Print the version number and exit.

CONFIGURATION

All configuration and control happens at runtime through a custom IPC protocol and the argenctl(1) CLI utility.

On startup, argen runs an executable file, checking the following locations in order:

$ARGEN_INIT_PATH
$XDG_CONFIG_HOME/argen/init
$HOME/.config/argen/init

Usually this executable is a shell script invoking argenctl(1) to configure argen, create bindings, start programs such as a status bar, or perform other configuration.

DEFAULT KEY BINDINGS

The following key binding is set in normal mode by default. It can be overridden or disabled by the user.

Control+Alt+Delete

Exit the river compositor and end the Wayland session.

ENVIRONMENT

ARGEN_INIT_PATH

Path to init executable. See the CONFIGURATION section above.

ARGEN_LOG_LEVEL

Set the log level to error, warning, info, or debug.

WAYLAND_DISPLAY

Used to connect to the Wayland socket. It is set automatically by river. If argen is started outside of river, it must be set explicitly by the user.