Table of Contents

eaf layer

Table of ContentsClose

1. Description

This layer adds support for the Emacs Application Framework (EAF).

1.1. Features:

  • Browse using a full-fledged browser within Emacs
  • PDF viewer (with continuous scroll)
  • Video player
  • Image viewer
  • See EAF documentation for many more features

2. Install

To use this configuration layer, add it to your ~/.spacemacs. You will need to add eaf to the existing dotspacemacs-configuration-layers list in this file. Then after (re-)loading the dotfile, run M-x eaf-install to automatically install required dependencies, and to select the eaf applications you would like to get installed. The script let's you select from the following list of applications:

  • eaf-jupyter
  • eaf-browser
  • eaf-airshare
  • eaf-file-browser
  • eaf-file-manager
  • eaf-file-sender
  • eaf-music-player
  • eaf-system-monitor
  • eaf-mindmap
  • eaf-org-previewer
  • eaf-terminal
  • eaf-netease-cloud-music
  • eaf-video-player
  • eaf-image-viewer
  • eaf-demo
  • eaf-vue-demo
  • eaf-pdf-viewer
  • eaf-markdown-previewer
  • eaf-camera

3. Usage

3.1. Configuring applications

By default, all applications that were selected to be installed when running eaf-install command are loaded. By default all installed applications get loaded when eaf gets loaded. If you prefer to load some of the applications by default then adjust the variable eaf-apps.

3.2. Configuring key bindings

Configuration of EAF key bindings works in a different way than normally in Spacemacs.

Also EAF, and additionally this layer, implement some tricks that are required to make leader keys in EAF buffers behave as expected in Spacemacs. Therefore it is recommended to keep these default (major-mode-)leader keybindings.

For information about configuration of other key bindings for EAF, see here.

If you do want to modify the leader keys, then information about the tricks implemented in this layer can be found here and here.

4. Key bindings

Except for the few Spacemacs specific modifications listed below, all EAF keybindings are documented here.

Eaf provides some key bindings only conditionally, so if some key binding does not work, then be sure that the relevant eaf application has been correctly installed.

Use SPC t k m to show the EAF key bindings persistently in which-key, or use SPC h d K to show the `eaf-mode-map` in a separate buffer.

4.1. Global

4.1.1. All EAF-applications

Key binding Description
SPC a a f EAF open file (see EAF doc for supported file types)
SPC a a s EAF open system monitor
SPC a a M EAF open musik player
SPC t k m Show available key commands in which-key (read here for more details)
SPC m d toggle dark-mode (or in browser press M-d and in pdf-viewer just press d)

4.1.2. Browser

Key binding Description
SPC a a b o Open url in new buffer
SPC a a b s Search with your favorite search engine. Defaults to symbol at point or region string
SPC a a b b Open bookmark in new buffer
SPC a a b h Search and open buffer from history

4.2. Local

4.2.1. All EAF-applications

Key binding Description
j/k Scroll up/down

4.2.2. Browser

Key binding Description
J/K Scroll (half) page up/down
e Edit url
m Bookmark page
C-s Search/search find next (to enter new search prefix with C-g
C-r Search find previous
SPC m h Open new buffer from history
SPC m s Search web with favorite search engine

4.2.3. PDF-viewer

Key binding Description
d toggle dark-mode

4.2.4. pdf-view-mode (pdf-tools)

Key binding Description
SPC m e open in eaf pdf-viewer

Author: root

Created: 2024-07-23 Tue 17:37