spacemacs/layers/+vim/vinegar/README.org

81 lines
3.1 KiB
Org Mode

#+TITLE: Vinegar layer
#+TAGS: layer|vim
* Table of Contents :TOC_5_gh:noexport:
- [[#description][Description]]
- [[#features][Features:]]
- [[#install][Install]]
- [[#layer][Layer]]
- [[#reuse-dired-buffer][Reuse dired buffer]]
- [[#deactive-hide-details-mode][Deactive hide details mode]]
- [[#mouse-bindings][Mouse bindings]]
- [[#key-bindings][Key bindings]]
* Description
This layer is a port of vim-vinegar for emacs.
It is based on tpope's [[https://github.com/tpope/vim-vinegar][vinegar.vim]], simplifying =dired=
with a limited number of details and exposing the ~-~ command in all
buffers to enter dired.
** Features:
- navigation up folders with ~-~ key
- simplify dired buffer to show only file names
- better evil/vim bindings for navigation within dired buffer
- keep only one active dired buffer
- Use dired-k extension to show time / vcs related information in
single bar
- right mouse click moves up directory if in blank space or shows context menu
* Install
** Layer
To use this configuration layer add =vinegar= to the
=dotspacemacs-configuration-layers= list.
** Reuse dired buffer
To reuse dired buffers set the variable =vinegar-reuse-dired-buffer= to =t=.
#+BEGIN_SRC emacs-lisp
(setq-default dotspacemacs-configuration-layers '(
(vinegar :variables
vinegar-reuse-dired-buffer nil))
#+END_SRC
** Deactive hide details mode
Per default extensive details in dired are hidden with this layer.
This can be deactivated by setting the variable =vinegar-dired-hide-details= to =nil=.
#+BEGIN_SRC emacs-lisp
(setq-default dotspacemacs-configuration-layers '(
(vinegar :variables
vinegar-dired-hide-details t)))
#+END_SRC
** Mouse bindings
| Mouse Binding | Description |
|---------------+-----------------------------------------------|
| ~mouse-1~ | (Dired) Open selected file |
| ~mouse-2~ | (Dired) Open clicked file in other-window |
| ~mouse-3~ | (Dired) Open context popup or go up directory |
** Key bindings
| Key binding | Description |
|-------------+----------------------------------------------------|
| ~-~ | Navigate to parent directory in dired |
| ~0~ | (Dired) Move to the beginning of the file in dired |
| ~=~ | (Dired) Diff between selected files |
| ~C-j~ | (Dired) Move to next subdirectory |
| ~C-k~ | (Dired) Move to previous subdirectory |
| ~I~ | (Dired) Toggle showing dotfiles |
| ~~~ | (Dired) Navigate to home directory |
| ~f~ | (Dired) Helm find file |
| ~J~ | (Dired) Goto file |
| ~C-f~ | (Dired) dired-find |
| ~H~ | (Dired) Show dired history |
| ~T~ | (Dired) Move down in dired tree |
| ~K~ | (Dired) Kill marked lines (hide, do not delete) |
| ~r~ | (Dired) Redisplay buffer |