Skip to content

Commit 42e91ec

Browse files
committed
docs(api): Document LIBTMUX_TMUX_FORMAT_SEPARATOR
Introduced initially via #343 as TMUX_SEPERATOR but later renamed to LIBTMUX_TMUX_FORMAT_SEPARATOR.
1 parent 4db343b commit 42e91ec

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

docs/api.md

+14
Original file line numberDiff line numberDiff line change
@@ -188,3 +188,17 @@
188188
```{eval-rst}
189189
.. autoclass:: libtmux.test.EnvironmentVarGuard
190190
```
191+
192+
## Environmental variables
193+
194+
### tmux format separator
195+
196+
```{versionadded} 0.11.0b0
197+
198+
```
199+
200+
`LIBTMUX_TMUX_FORMAT_SEPARATOR` can be used to override the default string used
201+
to split `tmux(1)`'s formatting information.
202+
203+
If you find any compatibility problems with the default, or better yet find a string copacetic
204+
many environments and tmux releases, note it at https://github.com/tmux-python/libtmux/discussions/355.

0 commit comments

Comments
 (0)