You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+24-24Lines changed: 24 additions & 24 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -39,16 +39,16 @@
39
39
40
40
# Intro
41
41
tmux-powerline is a tmux <atitle="Tmux Plugin Manager"href="https://github.com/tmux-plugins/tpm">tpm</a> plugin that gives you a slick and hackable powerline status bar consisting of segments. It's easily extensible with custom segments and themes.
42
-
The plugin itself is implemented purely in bash thus minimizing system requirements. However you can make segments in any language you want (with a shell wrapper).
42
+
The plugin itself is implemented purely in bash, thus minimizing system requirements. However, you can make segments in any language you want (with a shell wrapper).
43
43
44
44
Some examples of segments available that you can add to your tmux status bar are (full list [here](https://github.com/erikw/tmux-powerline/tree/main/segments)):
45
45
* LAN & WAN IP addresses
46
46
* Now Playing for MPD, Spotify (GNU/Linux native or wine, macOS), iTunes (macOS), Rhythmbox, Banshee, MOC, Audacious, Rdio (macOS), cmus, Pithos and Last.fm (last scrobbled track).
47
47
* New mail count for GMail, Maildir, mbox, mailcheck, and Apple Mail
48
48
* GNU/Linux and macOS battery status (uses [richo/dotfiles/bin/battery](https://github.com/richoH/dotfiles/blob/master/bin/battery))
49
-
* Weather in Celsius, Fahrenheit and Kelvin using Yahoo Weather
50
-
* System load, cpu usage and uptime
51
-
* Git, SVN and Mercurial branch in CWD
49
+
* Weather in Celsius, Fahrenheit, and Kelvin using Yahoo Weather
50
+
* System load, CPU usage, and uptime
51
+
* Git, SVN, and Mercurial branch in CWD
52
52
* Date and time
53
53
* Hostname
54
54
* tmux info
@@ -65,21 +65,21 @@ Some examples of segments available that you can add to your tmux status bar are
65
65
66
66
**left-status**
67
67
68
-
Current tmux session, window and pane, hostname and LAN & WAN IP address.
68
+
Current tmux session, window, pane, hostname, and LAN & WAN IP address.
69
69
70
70

71
71
72
72
**right-status**
73
73
74
-
New mails, now playing, average load, weather, date and time.
74
+
New mails, now playing, average load, weather, date, and time.
75
75
76
76

77
77
78
-
Now I've read my inbox so the mail segment disappears!
78
+
Now I've read my inbox, thus the mail segment disappears!
79
79
80
80

81
81
82
-
After pausing the music there's no need for showing the Now Playing segment anymore. Also the weather has become much nicer!
82
+
After pausing the music, there's no need to show the Now Playing segment anymore. Also, the weather has become much nicer!
83
83
84
84

85
85
@@ -92,13 +92,13 @@ Laptop mode: a battery segment.
92
92

93
93
94
94
# Co-Maintainer
95
-
[@xx4h](https://github.com/xx4h) is helping out developing, maintaining and managing this project!
95
+
[@xx4h](https://github.com/xx4h) is helping out with developing, maintaining, and managing this project!
96
96
97
97
# Requirements
98
98
Requirements for the lib to work are:
99
99
*`tmux -V` >= 2.9
100
100
*`bash --version` >= 3.2 (Does not have to be your default shell.)
101
-
* Nerd Font. Follow instructions at [Font Installation](https://github.com/ryanoasis/nerd-fonts?tab=readme-ov-file#font-installation). However you can use other substitute symbols as well; see `config.sh`.
101
+
* Nerd Font. Follow instructions at [Font Installation](https://github.com/ryanoasis/nerd-fonts?tab=readme-ov-file#font-installation). However, you can use other substitute symbols as well; see `config.sh`.
102
102
103
103
## Segment Requirements
104
104
Some segments have their own requirements. If you enable them in your theme, make sure all requirements are met for those.
@@ -131,18 +131,18 @@ Some segments have their own requirements. If you enable them in your theme, mak
131
131
4. Continue to the [Configuration](#configuration) section below.
132
132
133
133
> [!NOTE]
134
-
> Note that tpm plugins should be at the bottom of you `tmux.conf`. This plugin will then override some tmux settings like `status-left`, `status-right` etc. If you had already set those in your tmux config, it is a good opportunity to remove or comment those out.
134
+
> Note that tpm plugins should be at the bottom of your `tmux.conf`. This plugin will then override some tmux settings like `status-left`, `status-right`, etc. If you had already set those in your tmux config, it is a good opportunity to remove or comment them out.
135
135
> Take a look at [main.tmux](https://github.com/erikw/tmux-powerline/blob/main/main.tmux) for exactly which settings are overridden.
136
136
137
137
138
138
# Configuration
139
-
tmux-powerline stores the custom config, themes and segments at `$XDG_CONFIG_HOME/tmux-powerline/`.
139
+
tmux-powerline stores the custom config, themes, and segments at `$XDG_CONFIG_HOME/tmux-powerline/`.
140
140
141
141
To make the following example easier, let's assume the following:
142
142
* `$XDG_CONFIG_HOME` has the default value of `~/.config`
143
143
* tmux-powerline was installed to the XDG path `~/.config/tmux/plugins/tmux-powerline`
144
144
145
-
Adapt the commands below if your paths differs from this.
145
+
Adapt the commands below if your paths differ from this.
Go through the default config and adjust to your needs!
155
+
Go through the default config and adjust it to your needs!
156
156
157
157
## Custom Theme
158
-
The theme is specified by setting the environment variable `$TMUX_POWERLINE_THEME` in the config file above. It will use a default theme and you probably want to use your own. The default config have set the custom theme path to be `~/.config/tmux-powerline/themes/`.
158
+
The theme is specified by setting the environment variable `$TMUX_POWERLINE_THEME` in the config file above. It will use a default theme, and you probably want to use your own. The default config has set the custom theme path to be `~/.config/tmux-powerline/themes/`.
159
159
160
160
Make a copy of the default theme and make your own, say `my-theme`:
161
161
```shell
@@ -183,17 +183,17 @@ Also see [How to make a segment](#how-to-make-a-segment) below for more details.
183
183
184
184
185
185
# Debugging
186
-
Some segments might not work on your system for various reasons such as missing programs or different versions not having the same options. To find out which segment is not working it may help to enable the debug setting in `~/.config/tmux-powerline/config.sh`.
186
+
Some segments might not work on your system for various reasons, such as missing programs or different versions not having the same options. To find out which segment is not working, it may help to enable the debug setting in `~/.config/tmux-powerline/config.sh`.
187
187
188
188
Next step would be to enable the error logging in general or even with a scope, see `TMUX_POWERLINE_ERROR_LOGS_ENABLED` and `TMUX_POWERLINE_ERROR_LOGS_SCOPES` in your config.
189
189
190
-
However this may not be enough to determine the error so you can inspect all executed bash commands (will be a long output) by doing
190
+
However, this may not be enough to determine the error, so you can inspect all executed bash commands (will be a long output) by doing
191
191
192
192
```shell
193
193
bash -x powerline.sh (left|right)
194
194
```
195
195
196
-
To debug smaller portions of code, say if you think the problem lies in a specific segment, insert these lines at the top and bottom of the relevant code portions e.g. inside a function:
196
+
To debug smaller portions of code, say if you think the problem lies in a specific segment, insert these lines at the top and bottom of the relevant code portions e.g., inside a function:
197
197
198
198
```bash
199
199
set -x
@@ -212,21 +212,21 @@ tail -f /tmp/tmux-powerline.log # or follow output like this.
212
212
213
213
You can also enable the debug mode in your config file. Look for the `TMUX_POWERLINE_DEBUG_MODE_ENABLED` environment variable and set it to `true`.
214
214
215
-
If you can not solve the problems you can post an [issue](https://github.com/erikw/tmux-powerline/issues?state=open) and be sure to include relevant information about your system and script output (from bash -x) and/or screenshots if needed.
215
+
If you can not solve the problems, you can post an [issue](https://github.com/erikw/tmux-powerline/issues?state=open) and be sure to include relevant information about your system and script output (from bash -x) and/or screenshots if needed.
216
216
Be sure to search in the [resolved issues](https://github.com/erikw/tmux-powerline/issues?page=1&state=closed) section for similar problems you're experiencing before posting.
217
217
218
218
219
219
220
220
## Common Problems
221
221
### Nothing is Displayed
222
-
You have edited `~/.tmux.conf` but no powerline is displayed. This might be because tmux is not aware of the changes so you have to restart your tmux session or reloaded that file by typing this on the command-line (or in tmux command mode with `prefix :`)
222
+
You have edited `~/.tmux.conf`, but no powerline is displayed. This might be because tmux is not aware of the changes, so you have to restart your tmux session or reload that file by typing this on the commandline (or in tmux command mode with `prefix :`)
223
223
224
224
```shell
225
225
tmux source-file ~/.tmux.conf
226
226
```
227
227
228
228
### Multiple lines in bash or no powerline in Zsh using iTerm (macOS)
229
-
If your tmux looks like [this](https://github.com/erikw/tmux-powerline/issues/125) then you may have to in iTerm uncheck [Unicode East Asian Ambiguous characters are wide] in Preferences -> Settings -> Advanced.
229
+
If your tmux looks like [this](https://github.com/erikw/tmux-powerline/issues/125), then you may have to, in iTerm, uncheck [Unicode East Asian Ambiguous characters are wide] in Preferences -> Settings -> Advanced.
230
230
231
231
232
232
# Hacking (Development)
@@ -236,10 +236,10 @@ If your tmux looks like [this](https://github.com/erikw/tmux-powerline/issues/12
236
236
This project can only gain positively from contributions. Fork today and make your own enhancements and segments to share back!
237
237
238
238
## Codespaces Devcontainer
239
-
You can fork this project and then start coding right away with GitHub Codespaces as this project is set up to install all development dependencies and install tmux-powerline on the devcontainer. See [devcontainer.json](.devcontainer/devcontainer.json) and [devcontainer_postCreateCommand.sh](scripts/devcontainer_postCreateCommand.sh). After starting the devcontainer, just type `tmux` in the terminal and you should see a working tmux-powerline already to start playing with.
239
+
You can fork this project and then start coding right away with GitHub Codespaces, as this project is set up to install all development dependencies and install tmux-powerline on the devcontainer. See [devcontainer.json](.devcontainer/devcontainer.json) and [devcontainer_postCreateCommand.sh](scripts/devcontainer_postCreateCommand.sh). After starting the devcontainer, just type `tmux` in the terminal, and you should see a working tmux-powerline already to start playing with.
240
240
241
241
> [!IMPORTANT]
242
-
> If you have set up your own dotfiles to be installed with GitHub Codespaces, and there was some tmux config files installed from your dotfiles to the devcontainer, then you might have to run this script to wipe your config in favour of the setup provided by this repo's initialization:
242
+
> If you have set up your own dotfiles to be installed with GitHub Codespaces, and there were some tmux config files installed from your dotfiles to the devcontainer, then you might have to run this script to wipe your config in favour of the setup provided by this repo's initialization:
243
243
>
244
244
> ```shell
245
245
> ./scripts/devcontainer_postCreateCommand.sh
@@ -262,4 +262,4 @@ git commit -am "Bump version to $ver" && git tag $ver && git push --atomic origi
262
262
263
263
# More Tmux Plugins
264
264
I have another tmux plugin that might interest you:
265
-
*[tmux-dark-notify](https://github.com/erikw/tmux-dark-notify) - A plugin that make tmux's theme follow macOS dark/light mode.
265
+
*[tmux-dark-notify](https://github.com/erikw/tmux-dark-notify) - A plugin that makes tmux's theme follow macOS dark/light mode.
0 commit comments