docs(config): document user config
- commit
- 4fe46592597d8eea25b746de5710c35369d404b0
- author
- brice · · 2026-07-05 20:19 UTC
- parent
- 65a9160
- signature
- GPG Verified
CD88F9E564E0102646FB6077A1A07C7C7C3E349D· arch-gpg Verified for the committer email
1 file · +52 -0
M README.md +52 -0
| @@ -38,6 +38,58 @@ Ephemeral sessions get a number (`0`, `1`, `2`, ...) and die when you detach. Na | |||
| 38 | 38 | ||
| 39 | 39 | Only one client is attached to a session at a time; attaching again displaces the old client. | |
| 40 | 40 | ||
| 41 | + | ## Configuration | |
| 42 | + | ||
| 43 | + | vev reads `$XDG_CONFIG_HOME/vev/config`, or `~/.config/vev/config` when `XDG_CONFIG_HOME` is unset. The daemon reloads it while running. | |
| 44 | + | ||
| 45 | + | ```text | |
| 46 | + | # Theme: auto, dark, or light. | |
| 47 | + | theme = auto | |
| 48 | + | ||
| 49 | + | # Rebindable actions. Leave a line out to keep its built-in binding. | |
| 50 | + | open-palette = alt+space | |
| 51 | + | jump-attention = alt+a | |
| 52 | + | focus-pane-left = alt+h | |
| 53 | + | focus-pane-right = alt+l | |
| 54 | + | focus-pane-up = alt+k | |
| 55 | + | focus-pane-down = alt+j | |
| 56 | + | switch-tab-1 = alt+1 | |
| 57 | + | switch-tab-2 = alt+2 | |
| 58 | + | switch-tab-3 = alt+3 | |
| 59 | + | switch-tab-4 = alt+4 | |
| 60 | + | switch-tab-5 = alt+5 | |
| 61 | + | switch-tab-6 = alt+6 | |
| 62 | + | switch-tab-7 = alt+7 | |
| 63 | + | switch-tab-8 = alt+8 | |
| 64 | + | switch-tab-9 = alt+9 | |
| 65 | + | ||
| 66 | + | # Command palette codes: 2-3 uppercase letters or digits. | |
| 67 | + | code.new-tab = CNT | |
| 68 | + | code.new-session = CNS | |
| 69 | + | code.close-tab = CLT | |
| 70 | + | code.split-right = SPR | |
| 71 | + | code.split-left = SPL | |
| 72 | + | code.split-up = SPU | |
| 73 | + | code.split-down = SPD | |
| 74 | + | code.stack-pane = STP | |
| 75 | + | code.toggle-stack = TST | |
| 76 | + | code.close-pane = CLP | |
| 77 | + | code.focus-pane-left = FPL | |
| 78 | + | code.focus-pane-right = FPR | |
| 79 | + | code.focus-pane-up = FPU | |
| 80 | + | code.focus-pane-down = FPD | |
| 81 | + | code.next-tab = NXT | |
| 82 | + | code.previous-tab = PVT | |
| 83 | + | code.back-session = BSK | |
| 84 | + | code.forward-session = FSK | |
| 85 | + | code.session-picker = SSP | |
| 86 | + | code.visual-mode = VIS | |
| 87 | + | code.rename-session = RNS | |
| 88 | + | code.detach = DET | |
| 89 | + | ``` | |
| 90 | + | ||
| 91 | + | Key specs support `alt+<char>`, `alt+space`, and `alt+left/right/up/down`. `jump-attention` goes to the oldest tab or session asking for attention. Invalid entries are logged as warnings and skipped where possible. | |
| 92 | + | ||
| 41 | 93 | ## Remote attach | |
| 42 | 94 | ||
| 43 | 95 | ```sh | |
| @@ -38,6 +38,58 @@ Ephemeral sessions get a number (`0`, `1`, `2`, ...) and die when you detach. Na | |||||
| 38 | 38 | ||||
| 39 | Only one client is attached to a session at a time; attaching again displaces the old client. | 39 | Only one client is attached to a session at a time; attaching again displaces the old client. | ||
| 40 | 40 | ||||
| 41 | + | ## Configuration | |||
| 42 | + | ||||
| 43 | + | vev reads `$XDG_CONFIG_HOME/vev/config`, or `~/.config/vev/config` when `XDG_CONFIG_HOME` is unset. The daemon reloads it while running. | |||
| 44 | + | ||||
| 45 | + | ```text | |||
| 46 | + | # Theme: auto, dark, or light. | |||
| 47 | + | theme = auto | |||
| 48 | + | ||||
| 49 | + | # Rebindable actions. Leave a line out to keep its built-in binding. | |||
| 50 | + | open-palette = alt+space | |||
| 51 | + | jump-attention = alt+a | |||
| 52 | + | focus-pane-left = alt+h | |||
| 53 | + | focus-pane-right = alt+l | |||
| 54 | + | focus-pane-up = alt+k | |||
| 55 | + | focus-pane-down = alt+j | |||
| 56 | + | switch-tab-1 = alt+1 | |||
| 57 | + | switch-tab-2 = alt+2 | |||
| 58 | + | switch-tab-3 = alt+3 | |||
| 59 | + | switch-tab-4 = alt+4 | |||
| 60 | + | switch-tab-5 = alt+5 | |||
| 61 | + | switch-tab-6 = alt+6 | |||
| 62 | + | switch-tab-7 = alt+7 | |||
| 63 | + | switch-tab-8 = alt+8 | |||
| 64 | + | switch-tab-9 = alt+9 | |||
| 65 | + | ||||
| 66 | + | # Command palette codes: 2-3 uppercase letters or digits. | |||
| 67 | + | code.new-tab = CNT | |||
| 68 | + | code.new-session = CNS | |||
| 69 | + | code.close-tab = CLT | |||
| 70 | + | code.split-right = SPR | |||
| 71 | + | code.split-left = SPL | |||
| 72 | + | code.split-up = SPU | |||
| 73 | + | code.split-down = SPD | |||
| 74 | + | code.stack-pane = STP | |||
| 75 | + | code.toggle-stack = TST | |||
| 76 | + | code.close-pane = CLP | |||
| 77 | + | code.focus-pane-left = FPL | |||
| 78 | + | code.focus-pane-right = FPR | |||
| 79 | + | code.focus-pane-up = FPU | |||
| 80 | + | code.focus-pane-down = FPD | |||
| 81 | + | code.next-tab = NXT | |||
| 82 | + | code.previous-tab = PVT | |||
| 83 | + | code.back-session = BSK | |||
| 84 | + | code.forward-session = FSK | |||
| 85 | + | code.session-picker = SSP | |||
| 86 | + | code.visual-mode = VIS | |||
| 87 | + | code.rename-session = RNS | |||
| 88 | + | code.detach = DET | |||
| 89 | + | ``` | |||
| 90 | + | ||||
| 91 | + | Key specs support `alt+<char>`, `alt+space`, and `alt+left/right/up/down`. `jump-attention` goes to the oldest tab or session asking for attention. Invalid entries are logged as warnings and skipped where possible. | |||
| 92 | + | ||||
| 41 | ## Remote attach | 93 | ## Remote attach | ||
| 42 | 94 | ||||
| 43 | ```sh | 95 | ```sh | ||