1
0
mirror of https://github.com/SpaceVim/SpaceVim.git synced 2025-01-24 09:40:06 +08:00
SpaceVim/docs/layers/shell.md

71 lines
1.9 KiB
Markdown
Raw Normal View History

2017-07-28 05:22:12 +08:00
---
title: "SpaceVim shell layer"
2017-12-02 23:23:58 +08:00
description: "This layer provide shell support in SpaceVim"
2017-07-28 05:22:12 +08:00
---
2018-06-23 14:37:41 +08:00
# [Available Layers](../) >> shell
2017-07-28 05:22:12 +08:00
<!-- vim-markdown-toc GFM -->
2017-12-02 23:23:58 +08:00
- [Description](#description)
- [Install](#install)
- [Configuration](#configuration)
- [Default shell](#default-shell)
- [Default shell position and height](#default-shell-position-and-height)
- [Key bindings](#key-bindings)
2017-07-28 05:22:12 +08:00
<!-- 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"
```
2017-07-28 05:22:12 +08:00
## 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
2017-07-28 05:22:12 +08:00
The default shell is quickly accessible via a the default shortcut key `SPC '`.
### Default shell position and height
2019-01-07 21:15:22 +08:00
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.
2017-07-28 05:22:12 +08:00
```toml
[[layers]]
name = "shell"
default_position = "top"
default_height = 30
2017-07-28 05:22:12 +08:00
```
## 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 |