Skip to content

Commit a4d8d48

Browse files
committed
docs(configuration): stub out top-level config
1 parent b244b12 commit a4d8d48

File tree

1 file changed

+42
-0
lines changed

1 file changed

+42
-0
lines changed

docs/configuration/top-level.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
(top-level)=
2+
(top-level-config)=
3+
4+
# Top-level configuration
5+
6+
## `session_name`
7+
8+
Used for:
9+
10+
- tmux session name
11+
- checking for existing sessions
12+
13+
Notes:
14+
15+
- May differ from the config filename
16+
17+
e.g. _apple.yaml_:
18+
19+
```yaml
20+
session_name: banana
21+
windows:
22+
- panes:
23+
-
24+
```
25+
26+
Load detached:
27+
28+
```console
29+
$ tmuxp load ./apple.yaml -d
30+
```
31+
32+
Above:
33+
34+
- tmuxp loads a file named _apple.yaml_ from a current directory
35+
- tmuxp built a tmux session called _banana_.
36+
- `-d` means _detached_, loading in background
37+
38+
```console
39+
$ tmux attach -t banana
40+
```
41+
42+
Above: Use `tmux` directly to attach _banana_.

0 commit comments

Comments
 (0)