mirror of
https://github.com/SpaceVim/SpaceVim.git
synced 2025-02-09 17:00:05 +08:00
5ee5c57c8d
* Make SPC ' do not close terminal * Use q to hide shell instead of close terminal * Update documentation * Clear the cmdline when toggle shell windows * Add func to close vimfiler * Close terminal before close vimfiler * Cache shell default project root * Fix shell config * Fix default shell buffer nr * Fix ctrl+d in windows cmd
71 lines
1.9 KiB
Markdown
71 lines
1.9 KiB
Markdown
---
|
|
title: "SpaceVim shell layer"
|
|
description: "This layer provide shell support in SpaceVim"
|
|
---
|
|
|
|
# [Available Layers](../) >> shell
|
|
|
|
<!-- vim-markdown-toc GFM -->
|
|
|
|
- [Description](#description)
|
|
- [Install](#install)
|
|
- [Configuration](#configuration)
|
|
- [Default shell](#default-shell)
|
|
- [Default shell position and height](#default-shell-position-and-height)
|
|
- [Key bindings](#key-bindings)
|
|
|
|
<!-- vim-markdown-toc -->
|
|
|
|
## Description
|
|
|
|
This layer provide shell support in SpaceVim.
|
|
|
|
## Install
|
|
|
|
To use this configuration layer, add following snippet to your custom configuration file.
|
|
|
|
```toml
|
|
[[layers]]
|
|
name = "shell"
|
|
```
|
|
|
|
## Configuration
|
|
|
|
### Default shell
|
|
|
|
Vim support these kinds of shell:
|
|
|
|
To define the default shell you can set the layer variable `default_shell` to the following variables:
|
|
|
|
- terminal
|
|
- VimShell
|
|
|
|
The default shell is quickly accessible via a the default shortcut key `SPC '`.
|
|
|
|
### Default shell position and height
|
|
|
|
It is possible to choose where the shell should pop up by setting the
|
|
variable `default_position` to either `top`, `bottom`, `left`, `right`, or
|
|
`full`. Default value is `top`. It is also possible to set the default height
|
|
in percents with the variable `default_height`. Default value is 30.
|
|
|
|
```toml
|
|
[[layers]]
|
|
name = "shell"
|
|
default_position = "top"
|
|
default_height = 30
|
|
```
|
|
|
|
## Key bindings
|
|
|
|
| Key Binding | Description |
|
|
| ----------- | ---------------------------------------- |
|
|
| `SPC '` | Open or switch to the terminal windows |
|
|
| `Ctrl-d` | Close terminal windows in terminal mode |
|
|
| `q` | Hide terminal windows in Normal mode |
|
|
| `<Esc>` | Switch to Normal mode from terminal mode |
|
|
| `Ctrl-h` | Switch to the windows on the left |
|
|
| `Ctrl-j` | Switch to the windows below |
|
|
| `Ctrl-k` | Switch to the windows on the top |
|
|
| `Ctrl-l` | Switch to the windows on the right |
|