Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fabi1cazenave/suckless.vim
Tiling window management that sucks less. Inpired by wmii and i3.
https://github.com/fabi1cazenave/suckless.vim
awesomewm i3wm neovim plugin tiling vim wmii
Last synced: 6 days ago
JSON representation
Tiling window management that sucks less. Inpired by wmii and i3.
- Host: GitHub
- URL: https://github.com/fabi1cazenave/suckless.vim
- Owner: fabi1cazenave
- License: mit
- Created: 2010-11-07T22:09:55.000Z (almost 14 years ago)
- Default Branch: master
- Last Pushed: 2021-01-12T01:53:11.000Z (over 3 years ago)
- Last Synced: 2024-09-17T21:26:24.986Z (15 days ago)
- Topics: awesomewm, i3wm, neovim, plugin, tiling, vim, wmii
- Language: Vim script
- Homepage:
- Size: 40 KB
- Stars: 58
- Watchers: 4
- Forks: 10
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
suckless.vim
================================================================================
Tiling window management that sucks less — see .
Inspired by [wmii†][1] / [dwm][2] / [i3][3] / [awesome][4].
[1]: https://code.google.com/archive/p/wmii/
[2]: https://dwm.suckless.org/
[3]: https://i3wm.org/
[4]: https://awesomewm.org/
Instructions
--------------------------------------------------------------------------------
The idea behind this plugin is to make it easy to organize Vim windows in columns, like a tiling window manager would do. Three tiling modes are supported:
* **divided** (default): in each column, all windows share the available vertical space;
* **stacked**: in each column, the active window is maximized vertically and all other windows are collapsed (height = one row);
* **fullscreen**: the active window is maximized (max height & width), all other windows are collapsed horizontally and vertically.
For the window management, all shortcuts use the Alt (Meta) key by default:
Alt+[sdf] ⇒ tiling mode selection: [s]tacked, [d]ivided, [f]ullscreen
Alt+[hjkl] ⇒ select adjacent window
Shift+Alt+[hjkl] ⇒ move current window
Ctrl+Alt+[hjkl] ⇒ resize current window
Alt+[oO] ⇒ create new window (horizontal/vertical split)
Alt+w ⇒ close window
Tabs are used as “views” and are controlled with the `` key by default:
[123456789] ⇒ select tab [1..9]
t[123456789] ⇒ move current window to tab [1..9]
T[123456789] ⇒ copy current window to tab [1..9]
Keyboard Mappings
--------------------------------------------------------------------------------
The default keyboard mappings can be customized with a global variable:
```vim
let g:suckless_mappings = {
\ '' : 'SetTilingMode("[sdf]")' ,
\ '' : 'SelectWindow("[hjkl]")' ,
\ '' : 'MoveWindow("[hjkl]")' ,
\ '' : 'ResizeWindow("[hjkl]")' ,
\ '' : 'CreateWindow("[sv]")' ,
\ '' : 'CloseWindow()' ,
\ '[123456789]' : 'SelectTab([123456789])',
\ 't[123456789]' : 'MoveWindowToTab([123456789])',
\ 'T[123456789]' : 'CopyWindowToTab([123456789])',
\}
```
If you want to match [i3][3]’s mapping, I’d recommend [modifying your i3 configuration][5] to use `hjkl` in i3 — but you could also tweak your Vim mappings to match i3’s default mappings (which use `jkl;` instead of `hjkl`) and use Alt instead of `` for tab-related commands:
[5]: https://github.com/fabi1cazenave/dotFiles/blob/master/config/i3/config
```vim
let g:suckless_mappings = {
\ '' : 'SetTilingMode("[sdf]")' ,
\ '' : 'SelectWindow("[hjkl]")' ,
\ '' : 'MoveWindow("[hjkl]")' ,
\ '' : 'ResizeWindow("[hjkl]")' ,
\ '' : 'CreateWindow("[sv]")' ,
\ '' : 'CloseWindow()' ,
\ '': 'SelectTab([123456789])',
\ '': 'MoveWindowToTab([123456789])',
\ '': 'CopyWindowToTab([123456789])',
\}
```
If the Alt key is not a good option for you, you can do the following to use the `` key instead:
```vim
let g:suckless_mappings = {
\ '[sdf]' : 'SetTilingMode("[sdf]")' ,
\ '[hjkl]' : 'SelectWindow("[hjkl]")' ,
\ '[HJKL]' : 'MoveWindow("[hjkl]")' ,
\'' : 'ResizeWindow("[hjkl]")' ,
\ '[oO]' : 'CreateWindow("[sv]")' ,
\ 'w' : 'CloseWindow()' ,
\ '[123456789]' : 'SelectTab([123456789])',
\ 't[123456789]' : 'MoveWindowToTab([123456789])',
\ 'T[123456789]' : 'CopyWindowToTab([123456789])',
\}
let mapleader = "\" " best Leader key ever
```
Meta/Alt Caveats
--------------------------------------------------------------------------------
By default, this plugin relies on the Alt key. This works fine with Neovim but unfortunately, there are some caveats with Vim:
* either Vim modifies the 8th bit of the current character, i.e. Altj outputs an `ê` — that’s what gVim does;
* or an Esc is sent along with the key, i.e. Altj becomes Escj — that’s what happens with most terminal emulators.
*suckless.vim* should handle this properly, but in case your Alt shortcuts are not detected you can define the `g:MetaSendsEscape` variable explicitly:
```vim
let g:MetaSendsEscape = 0 " use this if Alt-j outputs an 'ê' on your terminal Vim
let g:MetaSendsEscape = 1 " use this if Alt shortcuts don't work on gVim / MacVim
```
On MacOSX, the Alt key might not be enabled in your terminal by default. On MacVim, you’ll have to set the ``macmeta`` pref to enable Option keys as "Meta" (MacVim ≥ 7.3 required); and if you want to keep *one* Option key, [this patch](https://gist.github.com/666875) can help.
Settings
--------------------------------------------------------------------------------
### Terminal Windows
All Alt-* shortcuts can be used on terminal windows in insert mode if the following is set:
```vim
let g:suckless_tmap = 1
```
Requires Neovim or Vim 8 with `:terminal` support.
### New Splits
To be more consistent with most tiling window managers (wmii, i3, awesome…) these settings are recommended:
```vim
set splitbelow
set splitright
```
### Tab Line & Label
This plugin modifies the tab labels to show:
* the tab number between brackets, with a `*` sign if a buffer in this tab is modified;
* the current buffer name, with a trailing `+` sign if modified.
To leave tabs unchanged (in the terminal and in the GUI, respectively), use:
```vim
let g:suckless_tabline = 0
let g:suckless_guitablabel = 0
```
### Window Resizing
```vim
let g:suckless_min_width = 24 " minimum window width
let g:suckless_inc_width = 4 " width increment
let g:suckless_inc_height = 2 " height increment
```
### Wrap-Around Modes
```vim
let g:suckless_wrap_around_jk = 1 " wrap in current column (wmii-like)
let g:suckless_wrap_around_hl = 1 " wrap in current tab (wmii-like)
```
Related Plugin
--------------------------------------------------------------------------------
[TermOpen][6] can be used to spawn terminals and TUI apps within Vim / Neovim like you would do in a tiling WM desktop. This can turn [Neovim-Qt][7] into a good substitute for [i3][3] / [awesome][4] users when working on non-Linux systems.
FWIW, this is how I emulate [my i3 configuration][5] in Neovim:
```vim
Plug 'fabi1cazenave/suckless.vim' " vim-plug FTW
Plug 'fabi1cazenave/termopen.vim'
set splitbelow
set splitright
let g:suckless_tmap = 1
nmap :call TermOpen()
nmap :call TermOpenRanger()
```
Note that mapping AltReturn and AltBackspace can be tricky with Vim, and even trickier with gVim. No problem with Neovim though.
[6]: https://github.com/fabi1cazenave/termopen.vim
[7]: https://github.com/equalsraf/neovim-qt