Skip to content

Commit 87283a2

Browse files
committed
Add more thorough documentation for external integration
This is the first step in adding easier support for external statusline integrations. In the future we can add more examples for programs such as zellij, WM statuslines, etc... These docs always should go into separate files so that the main documentation doesn't get bloated. We could also think about adding an extra configuration variable that can toggle between some popular external statusline examples.
1 parent b7877e0 commit 87283a2

File tree

3 files changed

+41
-1
lines changed

3 files changed

+41
-1
lines changed

doc/tags

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,10 @@ tpipeline#update() tpipeline.txt /*tpipeline#update()*
2222
tpipeline-api tpipeline.txt /*tpipeline-api*
2323
tpipeline-configure tpipeline.txt /*tpipeline-configure*
2424
tpipeline-contents tpipeline.txt /*tpipeline-contents*
25+
tpipeline-external tpipeline-external.txt /*tpipeline-external*
26+
tpipeline-external-examples tpipeline-external.txt /*tpipeline-external-examples*
27+
tpipeline-external-introduction tpipeline-external.txt /*tpipeline-external-introduction*
28+
tpipeline-external.txt tpipeline-external.txt /*tpipeline-external.txt*
2529
tpipeline-introduction tpipeline.txt /*tpipeline-introduction*
2630
tpipeline-kitty tpipeline-kitty.txt /*tpipeline-kitty*
2731
tpipeline-kitty-configure tpipeline-kitty.txt /*tpipeline-kitty-configure*

doc/tpipeline-external.txt

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
*tpipeline-external.txt* External statusline integration
2+
*tpipeline-external*
3+
4+
5+
Introduction |tpipeline-external-introduction|
6+
Examples |tpipeline-external-examples|
7+
8+
==============================================================================
9+
INTRODUCTION *tpipeline-external-introduction*
10+
11+
This plugin is not limited to embedding the statusline in tmux only. The
12+
statusline can be embedded in arbitrary external programs. The
13+
|g:tpipeline_refreshcmd| option already allows running arbitrary commands to
14+
trigger the update of an external statusline.
15+
16+
Depending on the external program, some integration needs to be done on that
17+
side as well. There exists full documentation for some external programs in
18+
|tpipeline-external-examples|.
19+
20+
------------------------------------------------------------------------------
21+
EXAMPLES *tpipeline-external-examples*
22+
23+
The following list contains documentation for examples of embedding the
24+
statusline in some popular external programs that are not tmux:
25+
26+
Kitty statusline |tpipeline-kitty|
27+
Embeds the vim statusline in the Kitty terminal emulator
28+
statusline.
29+
30+
==============================================================================
31+
vim:tw=78:sw=4:ts=8:ft=help:norl:noet:

doc/tpipeline.txt

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,9 @@ get a total of two extra lines of buffer content available.
1919
This plugin also comes with its own statusline that you can use independently
2020
of the tmux functionality.
2121

22+
Embedding the statusline is not just limited to tmux but can be made to work
23+
with arbitrary other programs, see |tpipeline-external|.
24+
2225
------------------------------------------------------------------------------
2326
TMUX INTEGRATION *tpipeline-tmux*
2427

@@ -126,8 +129,10 @@ CONFIGURATION *tpipeline-configure*
126129
If you want to run an external command every time the
127130
statusline changes, you can provide a shell command with this
128131
variable.
132+
The provided command is run from a separate process and never
133+
blocks vim.
129134
This can be used for external statusline integrations
130-
different from tmux.
135+
different from tmux, see |tpipeline-external|.
131136

132137
g:tpipeline_clearstl *g:tpipeline_clearstl*
133138
If you want this plugin to clear the vim internal statusline

0 commit comments

Comments
 (0)