jay-compositor 1.13.0

The Jay compositor
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97

# Status Bar

Jay includes a built-in bar that displays workspace tabs, status text, tray
icons (via [wl-tray-bridge](https://github.com/mahkoh/wl-tray-bridge)), and a
clock. The status text is provided by an external program that you configure
in the `[status]` table.

## Configuring a Status Program

The `[status]` table has three fields:

`format`
: Message format: `plain`, `pango`, or `i3bar`. Optional.

`exec`
: How to start the program (string, array, or table). Required.

`i3bar-separator`
: Separator between i3bar components (default `" | "`). Optional.

### Format

`plain`
: Plain text output

`pango`
: Output containing Pango markup

`i3bar`
: JSON output in i3bar protocol format

### Exec

The `exec` field accepts the same forms used elsewhere in the configuration:

- **String** -- the program name: `exec = "i3status"`
- **Array** -- program and arguments: `exec = ["i3status", "-c", "~/.config/i3status/config"]`
- **Table** -- full control over program, arguments, and environment (see the
  spec for details)

## Example: i3status

[i3status](https://i3wm.org/i3status/) is a popular status line generator.

```toml
[status]
format = "i3bar"
exec = "i3status"
```

> [!NOTE]
> i3status defaults to plain-text output. You must explicitly configure it to
> use i3bar format by adding `output_format = "i3bar"` to your
> `~/.config/i3status/config`:
>
> ```
> general {
>     output_format = "i3bar"
> }
> ```

## Example: Custom Script

A simple shell script that prints the date every second:

```toml
[status]
format = "plain"
exec = { shell = "while true; do date '+%Y-%m-%d %H:%M:%S'; sleep 1; done" }
```

## Changing the Status Program at Runtime

The `set-status` action lets you switch the status program from a shortcut.
Omit the `status` field to reset the status text to empty.

```toml
[shortcuts]
# Switch to i3status
alt-F10 = {
    type = "set-status",
    status = {
        format = "i3bar",
        exec = "i3status",
    },
}

# Clear the status text
alt-F11 = { type = "set-status" }
```

## Bar Appearance

The bar's visual appearance (height, background color, text color, position, and
font) is configured in the `[theme]` table. See the
[Theme & Appearance](theme.md) chapter for details. The bar can be shown or
hidden with the `show-bar` top-level setting or the `toggle-bar` action.