Spacemacs

https://github.com/syl20bnr/spacemacs
Admin
Spacemacs is a sophisticated Emacs configuration focused on ergonomics, mnemonics, and consistency,...
Tokens:496,051
Snippets:4,634
Trust Score:9.7
License:GPL-3.0
Update:3 days ago
Show doc for...
Tokens:
Raw
### Install keyboard-layout layer with kl-layout variable

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+intl/keyboard-layout/README.org

Adds the keyboard-layout layer to dotspacemacs-configuration-layers and sets kl-layout to 'dvorak. This is the basic installation example.

```emacs-lisp
(setq-default dotspacemacs-configuration-layers '(
  (keyboard-layout :variables kl-layout 'dvorak)))
```

--------------------------------

### Install reason via opam for refmt

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+lang/reasonml/README.org

Install the reason package using opam to get the refmt binary in your current opam switch.

```sh
opam install reason
```

--------------------------------

### Install merlin and reason via opam

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+lang/reasonml/README.org

Install the merlin and reason packages using opam to get the ocamlmerlin and ocamlmerlin-reason binaries on your current opam switch.

```sh
opam install merlin reason
```

--------------------------------

### Install shfmt for formatting

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+lang/shell-scripts/README.org

Install the shfmt application using Go's install command. Required to enable buffer formatting.

```sh
go install mvdan.cc/sh/v3/cmd/shfmt@latest
```

--------------------------------

### Install both ivy and helm layers with :can-shadow nil

Source: https://github.com/syl20bnr/spacemacs/blob/develop/doc/LAYERS.org

Example dotfile configuration to install both ivy and helm layers, preventing helm from shadowing ivy by setting :can-shadow to nil.

```emacs-lisp
(setq dotspacemacs-configuration-layers
 '(
   ivy
   (helm :can-shadow nil)
   )

```

--------------------------------

### Integrate eglot into language backend (Ruby example)

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+tools/eglot/README.org

Example functions for setting up a language backend with eglot. The first function conditionally configures the Ruby backend based on the ruby-backend variable, calling the eglot setup when 'eglot is selected. The second function checks if the eglot layer is used and calls eglot-ensure, otherwise displays a message to add the eglot layer.

```elisp
(defun spacemacs//ruby-setup-backend ()
  "Conditionally configure Ruby backend"
  (spacemacs//ruby-setup-version-manager)
  (pcase ruby-backend
    ('eglot (spacemacs//ruby-setup-eglot))
    ('lsp (spacemacs//ruby-setup-lsp))
    (nil (ignore))
    (_ (spacemacs-buffer/error "Ruby Layer - unknown language backend: %s" ruby-backend))))

(defun spacemacs//ruby-setup-eglot ()
  "Setup Ruby eglot."
  (if (configuration-layer/layer-used-p 'eglot)
      (eglot-ensure)
    (message "`eglot' layer is not installed, please add `eglot' layer to your dotfile.")))
```

--------------------------------

### Open the installed dotfile

Source: https://github.com/syl20bnr/spacemacs/blob/develop/doc/QUICK_START.org

Use this keybinding to open the installed dotfile.

```text
SPC f e d
```

--------------------------------

### Install erlang_ls with make install

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+lang/erlang/README.org

Install erlang_ls after building it. Ensure erlang_ls is in your PATH.

```bash
make install
```

--------------------------------

### Install purescript-language-server

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+lang/purescript/README.org

Install the LSP server and separate dependencies globally using npm.

```sh
npm i -g purescript-language-server
```

--------------------------------

### Example pianobar config file

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+music/pianobar/README.org

Example configuration for Pianobar on macOS, showing user, password, and autostart_station settings.

```bash
$ cat ~/.config/pianobar/config
user = foobar@gmail.com
password = 295TkBbHZiKwnDnQYhJW 
autostart_station = 30385222902831057
```

--------------------------------

### Build and install GNU Global

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+tags/gtags/README.org

Compile and install GNU Global after configuration.

```sh
make
sudo make install
```

--------------------------------

### Install go-mode auto-completion dependencies

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+lang/go/README.org

Install the gocode and gogetdoc binaries required for auto-completion with the go-mode backend.

```sh
go install github.com/mdempsky/gocode@latest
go install github.com/zmb3/gogetdoc@latest
```

--------------------------------

### Load Spacemacs from alternative location

Source: https://github.com/syl20bnr/spacemacs/blob/develop/README.md

Add this line to your Emacs init file (e.g., ~/.emacs.el) to load Spacemacs when it is installed in a non-default location. The example assumes Spacemacs is cloned to ~/Spacemacs.

```elisp
;; load Spacemacs's initialization file, "~" is equivalent to "${HOME}"
(load-file "~/Spacemacs/init.el")
```

--------------------------------

### Install rnix-lsp from nix

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+os/nixos/README.org

Run this shell command to install rnix-lsp from the nix-community repository.

```shell
nix-env -i -f https://github.com/nix-community/rnix-lsp/archive/master.tar.gz
```

--------------------------------

### Install git on Windows via Scoop

Source: https://github.com/syl20bnr/spacemacs/blob/develop/README.md

Installs git using Scoop from the main bucket.

```powershell
scoop bucket add main
scoop install git
```

--------------------------------

### Install js-beautify and prettier for formatting

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+frameworks/react/README.org

Install the required npm packages for automatic code formatting.

```sh
$ npm install -g js-beautify prettier
```

--------------------------------

### Install Go binary dependencies

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+lang/go/README.org

Install the required Go tools for the layer, including golangci-lint, godoc, goimports, and others. Run these commands in your shell.

```sh
GO111MODULE=on CGO_ENABLED=0 go install -v -trimpath -ldflags '-s -w' github.com/golangci/golangci-lint/v2/cmd/golangci-lint@latest
go install golang.org/x/tools/cmd/godoc@latest
go install golang.org/x/tools/cmd/goimports@latest
go install golang.org/x/tools/cmd/gorename@latest
go install golang.org/x/tools/cmd/guru@latest
go install github.com/cweill/gotests/...@latest
go install github.com/davidrjenni/reftools/cmd/fillstruct@latest
go install github.com/fatih/gomodifytags@latest
go install github.com/godoctor/godoctor@latest
go install github.com/haya14busa/gopkgs/cmd/gopkgs@latest
go install github.com/josharian/impl@latest
go install github.com/rogpeppe/godef@latest
```

--------------------------------

### Debugging Elisp example with helloworld and subroutine

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+lang/emacs-lisp/README.org

Interactive quick start to debug Emacs Lisp from an emacs-lisp-mode buffer. Open this code in an emacs-lisp-buffer, evaluate each sexp with , e f or , e b, then set a breakpoint on helloworld with SPC m d f (or , d f) and call (helloworld "Spacemacs") to trigger the debugger.

```elisp
(defun helloworld (name)
  (let ((n (subroutine name)))
    (message (format "Hello world, %s!" name))))

(defun subroutine (s)
  (concat "my dear " s))

(helloworld "Spacemacs")
```

--------------------------------

### Install git on macOS

Source: https://github.com/syl20bnr/spacemacs/blob/develop/README.md

Installs git via Homebrew.

```sh
brew install git
```

--------------------------------

### Install Agda with cabal

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+lang/agda/README.org

Quick installation command for Agda assuming cabal is installed. Installs alex, happy, cpphs (< 1.19), and agda.

```sh
cabal install alex happy "cpphs < 1.19" agda
```

--------------------------------

### Install Cscope via apt-get

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+tags/cscope/README.org

Install Cscope using the package manager on Ubuntu.

```sh
sudo apt-get install cscope
```

--------------------------------

### Install ty language server via uv

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+lang/python/README.org

Install the ty language server using uv. The project method is recommended and also enables uv support.

```sh
# project (recommended, also [[#manage-environments-and-packages-with-uv][enable uv support]])
uv add --dev ty

# global
uv tool install ty@latest
```

--------------------------------

### Install rust-analyzer

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+lang/rust/README.org

Install rust-analyzer to provide IDE-like features for Rust.

```sh
rustup component add rust-analyzer
```

--------------------------------

### Install puppet-lint with gem

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+tools/puppet/README.org

Run this command to install puppet-lint, required for syntax checking in the Puppet layer.

```sh
$ gem install puppet-lint
```

--------------------------------

### Install eslint with babel and react support

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+frameworks/react/README.org

Install the required npm packages for on-the-fly syntax checking with eslint.

```sh
$ npm install -g eslint babel-eslint eslint-plugin-react
```

--------------------------------

### Install spacemacs-theme from MELPA

Source: https://github.com/syl20bnr/spacemacs/blob/develop/core/libs/spacemacs-theme/README.md

Install the theme using the package-install command in Emacs. This is the standard way to install from MELPA.

```emacs-lisp
M-x package-install RET spacemacs-theme
```

--------------------------------

### Install libtool-bin on Ubuntu

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+tools/shell/README.org

Install libtool on Ubuntu if the libtool command is not present in the system.

```shell
sudo apt install libtool-bin
```

--------------------------------

### Install texlab via cargo

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+lang/latex/README.org

Installs the texlab language server using cargo from the latex-lsp GitHub repository. Requires cargo to be installed.

```shell
cargo install --git https://github.com/latex-lsp/texlab
```

--------------------------------

### Install TypeScript language server (typescript-language-server)

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+lang/javascript/README.org

Install typescript-language-server and typescript globally via npm.

```sh
npm i -g typescript typescript-language-server
```

--------------------------------

### Install TypeScript language server (javascript-typescript-langserver)

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+lang/javascript/README.org

Install javascript-typescript-langserver and typescript globally via npm.

```sh
npm i -g typescript javascript-typescript-langserver
```

--------------------------------

### Example theming-modifications for monokai

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+themes/theming/README.org

Example configuration for the monokai theme, modifying font-lock-comment-face, web-mode-html-attr-name-face, and powerline-active1. The example is from a gist and shows how to set attributes like :slant, :inherit, :box, and :background.

```lisp
(defun dotspacemacs/user-init ()
  (setq theming-modifications
        '((monokai
           ;; Font locking
           (font-lock-comment-face :slant italic)
           (web-mode-html-attr-name-face :inherit font-lock-variable-name-face
                                         :foreground 'unspecified)
           ;; Modeline
           (powerline-active1 :box (:color "#999999"
                                    :line-width 1
                                    :style released-button)
                              :background "#5a5a5a")))))
```

--------------------------------

### Install JavaScript linters (jshint, standard) via npm

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+lang/javascript/README.org

Install jshint or standard globally using npm. If installed in non-standard locations, add the path to exec-path in dotspacemacs/user-init.

```sh
# or
$ npm install -g jshint
# or
$ npm install -g standard
```

--------------------------------

### Install python-lsp-server

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+lang/python/README.org

Install the python-lsp-server package, required for the lsp backend with pylsp.

```sh
pip install python-lsp-server
```

--------------------------------

### Example .jsbeautifyrc configuration

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+frameworks/react/README.org

Example configuration for js-beautify with e4x option set to true.

```json
{
  "indent_size": 2,
  "indent_char": " ",
  "eol": "\n",
  "indent_level": 0,
  "indent_with_tabs": false,
  "preserve_newlines": true,
  "max_preserve_newlines": 2,
  "jslint_happy": false,
  "space_after_anon_function": false,
  "brace_style": "collapse",
  "keep_array_indentation": false,
  "keep_function_indentation": false,
  "space_before_conditional": true,
  "break_chained_methods": true,
  "eval_code": false,
  "unescape_strings": false,
  "wrap_line_length": 80,
  "wrap_attributes": "auto",
  "wrap_attributes_indent_size": 2,
  "e4x": true,
  "end_with_newline": true,
  "brace_style": "collapse-preserve-inline"
}
```

--------------------------------

### Install svelte-language-server globally

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+frameworks/svelte/README.org

Install the Svelte language server globally for the lsp backend.

```sh
$ npm install -g svelte-language-server
```

--------------------------------

### Install recommended dependencies on Ubuntu

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+tags/gtags/README.org

Install exuberant-ctags and python-pygments on Ubuntu to take full advantage of GNU Global.

```sh
sudo apt-get install exuberant-ctags python-pygments
```

--------------------------------

### Install PyCscope via pip

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+tags/cscope/README.org

Install PyCscope using pip.

```sh
pip install pycscope
```

--------------------------------

### Install eslint-cli globally

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+frameworks/svelte/README.org

Install eslint-cli globally to enable on-the-fly syntax checking with eslint.

```sh
$ npm install -g eslint-cli
```

--------------------------------

### Start transmission-daemon

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+tools/transmission/README.org

Start the transmission-daemon service after configuration.

```sh
sudo service transmission-daemon start
```

--------------------------------

### Install rustfmt

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+lang/rust/README.org

Install rustfmt to format Rust code according to style guidelines.

```sh
rustup component add rustfmt
```

--------------------------------

### Install autoflake

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+lang/python/README.org

Install autoflake to suppress unused imports easily.

```sh
pip install autoflake
```

--------------------------------

### Install coreutils via Homebrew

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+os/osx/README.org

Installs coreutils using Homebrew to provide gls for dired.

```sh
brew install coreutils

```

--------------------------------

### Install Homebrew on macOS

Source: https://github.com/syl20bnr/spacemacs/blob/develop/README.md

Installs Homebrew, the recommended package manager for macOS. Run this in Terminal.

```sh
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
```

--------------------------------

### Install vim-language-server via npm

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+lang/vimscript/README.org

Install the latest version of the LSP server required for the LSP backend. Run this command in your terminal.

```sh
npm install -g vim-language-server
```

--------------------------------

### Install nimlsp server

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+lang/nim/README.org

Install the latest version of the LSP server required for the LSP backend. Run this command in your shell.

```sh
nimble install nimlsp
```

--------------------------------

### Install Emacs on Windows via Scoop

Source: https://github.com/syl20bnr/spacemacs/blob/develop/README.md

Installs Emacs using Scoop from the extras bucket.

```powershell
scoop bucket add extras
scoop install emacs
```

--------------------------------

### Install cargo-edit

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+lang/rust/README.org

Install cargo-edit to add, remove, and upgrade dependencies by modifying Cargo.toml.

```sh
cargo install cargo-edit
```

--------------------------------

### Install flow-bin globally via npm

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+lang/javascript/README.org

Install flow-bin globally using npm.

```sh
npm i -g flow-bin
```

--------------------------------

### Example theming-modifications for leuven

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+themes/theming/README.org

Example configuration for the leuven theme, setting the default face foreground to black. This example is provided in the Headers section and demonstrates overriding the default font colour.

```emacs-lisp
(defun dotspacemacs/user-init ()

  ; custom theme modification - overriding default font colour
  (setq-default
    theming-modifications
      '((leuven
          (default :foreground "#000000")
       ))
  )

)
```

--------------------------------

### Install the dotfile

Source: https://github.com/syl20bnr/spacemacs/blob/develop/doc/QUICK_START.org

Use this command to create a .spacemacs file in your home directory.

```text
SPC SPC dotspacemacs/install RET
```

--------------------------------

### Install and stop transmission-daemon (Debian)

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+tools/transmission/README.org

Install transmission-daemon and stop the service before configuring it. This is a Debian example.

```sh
sudo apt-get -y install transmission-daemon
sudo service transmission-daemon stop
```

--------------------------------

### Install python-lsp-server with all optional dependencies

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+lang/python/README.org

Install python-lsp-server along with all optional dependencies. See the python-lsp-server repository for more information on optional dependencies and 3rd-party plugins.

```sh
pip install 'python-lsp-server[all]'
```

--------------------------------

### Enable org agenda notifications with org-wild-notifier

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+emacs/org/README.org

Enables notifications for agenda events by setting org-enable-notifications to t and optionally starting the notification daemon on startup. Installs and configures org-wild-notifier. After install, run org-wild-notifier-mode to start the daemon.

```emacs-lisp
(setq-default dotspacemacs-configuration-layers '(
  (org :variables
       org-enable-notifications t
       org-start-notification-daemon-on-startup t)))
```

--------------------------------

### Install intelephense npm server

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+lang/php/README.org

Install the intelephense language server globally via npm. This is the recommended LSP server solution for PHP.

```sh
npm install -g intelephense
```

--------------------------------

### Initialize and configure OPAM

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+lang/ocaml/README.org

Initialize OPAM and set up the environment with opam init and opam config setup -a.

```sh
opam init
opam config setup -a
```

--------------------------------

### Install Symbola font with apt-get

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+fun/emoji/README.org

Linux users can install the Symbola font to get company-emoji support using this apt-get command.

```shell
apt-get install ttf-ancient-fonts
```

--------------------------------

### Install Python-Markdown for live preview

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+lang/markdown/README.org

Install the Python-Markdown package using pip. This is an alternative to the markdown or pandoc executables for live preview.

```shell
pip install --user Markdown
```

--------------------------------

### Download and build Python documentation database

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+lang/python/local/pylookup/README.md

Run 'make download' to download Python documentation and construct the database. If issues arise, follow the manual steps: download the HTML archive, unzip it, index with './pylookup.py -u', and test with './pylookup.py -l ljust'.

```shell
make download
```

```shell
unzip python-2.7.2-docs-html.zip
```

```shell
./pylookup.py -u python-2.7.1-docs-html
```

```shell
./pylookup.py -l ljust
```

--------------------------------

### Install required OPAM packages

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+lang/ocaml/README.org

Install the required OPAM packages: merlin, utop, ocp-indent, and ocamlformat.

```sh
opam install merlin utop ocp-indent ocamlformat
```

--------------------------------

### Install typescript-formatter for formatting

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+lang/typescript/README.org

Installs typescript-formatter globally via npm for formatting with the TypeScript layer.

```shell
npm install -g typescript-formatter
```

--------------------------------

### Install Copilot Language Server from Emacs

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+web-services/github-copilot/README.org

Install the Copilot language server from within Emacs using the command `SPC SPC copilot-install-server`.

```elisp
SPC SPC copilot-install-server
```

--------------------------------

### Install flake8 for syntax checking

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+lang/python/README.org

Install the flake8 package for syntax checking.

```sh
pip install flake8
```

--------------------------------

### README.org Tags Example

Source: https://github.com/syl20bnr/spacemacs/blob/develop/CONTRIBUTING.org

Example of a README.org file header with a #+TAGS: line. Tags are separated by '|' and the example has two tags: 'layer' and 'web service'. Valid tags are defined in the .ci/spacedoc-cfg.edn configuration file.

```org
#+TITLE: My layer

#+TAGS: layer|web service

* Table of Contents                     :TOC_5_gh:noexport:
...
```

--------------------------------

### Install vscode-html-languageserver-bin

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+lang/html/README.org

Install the HTML language server binary globally via npm. Required for HTML LSP support.

```sh
npm install -g vscode-html-languageserver-bin
```

--------------------------------

### Install clippy

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+lang/rust/README.org

Install clippy to provide a collection of lints to catch common mistakes and improve your code.

```sh
rustup component add clippy
```

--------------------------------

### Example gdb backtrace without function names

Source: https://github.com/syl20bnr/spacemacs/wiki/Debugging.org

This is an example of a gdb backtrace that lacks function names, which is not very useful. To get function names, you need to build Emacs from source with debug symbols.

```text
#0  0x00000000004ae1f0 in  ()
#1  0x00000000004b2472 in  ()
#2  0x000000000041cd3a in  ()
...
```

--------------------------------

### Install Copilot Language Server via npm

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+web-services/github-copilot/README.org

Install the Copilot language server globally using npm. This is a prerequisite for the copilot.el package.

```sh
$ npm install -g @github/copilot-language-server
```

--------------------------------

### Customize PDF display program with org-ref-open-pdf-function

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+lang/bibtex/README.org

Example configuration to use Zathura as the PDF viewer. The lambda function starts the process 'zathura' with the given file path.

```emacs-lisp
(setq org-ref-open-pdf-function
  (lambda (fpath)
    (start-process "zathura" "*helm-bibtex-zathura*" "/usr/bin/zathura" fpath)))
```

--------------------------------

### Install prettier globally

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+frameworks/svelte/README.org

Install prettier globally to enable automatic code formatting.

```sh
$ npm install -g prettier
```

--------------------------------

### Install import-js globally via npm

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+lang/javascript/README.org

Install ImportJS on your system using npm.

```sh
$ npm install -g import-js
```

--------------------------------

### Configure DAP in java layer

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+tools/dap/README.org

Example of how to configure DAP in the java layer. It adds java-mode to the supported modes and sets up a hook for DAP setup when java-backend is 'lsp'.

```emacs-lisp
(defun java/pre-init-dap-mode ()
  (when (eq java-backend 'lsp)
     (add-to-list 'spacemacs--dap-supported-modes 'java-mode))
  (add-hook 'java-mode-local-vars-hook #'spacemacs//java-setup-dap))
```

--------------------------------

### Setq Syntax and Example for Setting Variables

Source: https://github.com/syl20bnr/spacemacs/blob/develop/doc/VIMUSERS.org

Shows the syntax for setting variables in Emacs Lisp using setq, with an example demonstrating true, false, and list values. Use this to customize Spacemacs behavior.

```emacs-lisp
(setq variable value) ; Syntax
;; Setting variables example
(setq variable1 t ; True
      variable2 nil ; False
      variable3 '("A" "list" "of" "things"))
```

--------------------------------

### Customize welcome screen list sizes with dotspacemacs-startup-lists

Source: https://github.com/syl20bnr/spacemacs/blob/develop/news/news01.org

Set the maximum number of items displayed for the recent files and projects lists on the welcome screen. The example shows 5 items for recents and 7 for projects.

```emacs-lisp
(setq dotspacemacs-startup-lists '((recents  . 5)
                                     (projects . 7)))
```

--------------------------------

### Install LSP server via npm

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+lang/json/README.org

Install the vscode-langservers-extracted package globally via npm to provide the LSP server for JSON.

```sh
npm install -g vscode-langservers-extracted
```

--------------------------------

### Install Aider with uv

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+tools/aider/README.org

Install the Aider tool using uv, including the pip package. This is required before using the layer.

```sh
uv tool install --with pip aider-chat@latest
```

--------------------------------

### Install dockerfile-language-server-nodejs via npm

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+tools/docker/README.org

Install the LSP server executable globally using npm. Required for LSP support.

```sh
npm i -g dockerfile-language-server-nodejs
```

--------------------------------

### Install LSP server and dependencies

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+lang/elm/README.org

Required for LSP backend. Installs elm-analyse and @elm-tooling/elm-language-server globally via npm.

```sh
npm install -g elm-analyse @elm-tooling/elm-language-server
```

--------------------------------

### Install js-beautify globally with npm

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+tools/web-beautify/README.org

Run this command in a terminal to install js-beautify globally, which is required for the web-beautify layer to function.

```sh
$ npm install -g js-beautify
```

--------------------------------

### Install vscode-css-languageserver-bin

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+lang/html/README.org

Install the CSS language server binary globally via npm. Required for CSS LSP support.

```sh
npm i -g vscode-css-languageserver-bin
```

--------------------------------

### Build and install Cscope from source

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+tags/cscope/README.org

Build Cscope from source after downloading the tarball.

```sh
tar xvf cscope-15.8b
cd cscope-15.8b
./configure
make
sudo make install
```

--------------------------------

### Install jedhy for auto-completion

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+lang/hy/README.org

Install the jedhy package, which hy-mode relies on for auto-completion. This is a separate installation step.

```sh
pip3 install jedhy
```

--------------------------------

### Install fasd via Homebrew on macOS

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+tools/fasd/README.org

Install fasd using Homebrew on macOS. This is the recommended installation method for macOS users.

```sh
$ brew install fasd
```

--------------------------------

### Example dotspacemacs-configuration-layers entry with multiple c-c++ variables

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+lang/c-c++/README.org

Shows a complete configuration entry for the c-c++ layer, setting c-c++-adopt-subprojects, c-c++-backend, and c-c++-lsp-enable-semantic-highlight to 'rainbow.

```emacs-lisp
(setq-default dotspacemacs-configuration-layers
                '((c-c++ :variables
                         c-c++-adopt-subprojects t
                         c-c++-backend 'lsp-ccls
                         c-c++-lsp-enable-semantic-highlight 'rainbow)))
```

--------------------------------

### Install GNU Global on Ubuntu

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+tags/gtags/README.org

Install GNU Global using the apt package manager on Ubuntu.

```sh
sudo apt-get install global
```

--------------------------------

### Install php-language-server via composer

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+lang/php/README.org

Install the php-language-server and parse stubs using composer. This is an alternative LSP server implementation based on PHP.

```sh
composer require felixfbecker/language-server
composer run-script --working-dir=vendor/felixfbecker/language-server parse-stubs
```

--------------------------------

### Install crystal-icr via Homebrew

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+lang/crystal/README.org

Install icr on macOS using Homebrew. Although not in the official installation instructions, this command works on macOS.

```sh
brew install crystal-icr
```

--------------------------------

### Install TypeScript globally with npm

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+tools/tide/README.org

Run this command to install the TypeScript compiler globally, which is required for tsserver to work.

```sh
npm install -g typescript
```

--------------------------------

### Install ripgrep on Windows via Scoop (Optional)

Source: https://github.com/syl20bnr/spacemacs/blob/develop/README.md

Optionally installs ripgrep using Scoop from the main bucket.

```powershell
scoop bucket add main
scoop install ripgrep
```

--------------------------------

### Install gopls language server

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+lang/go/README.org

Install the gopls language server implementation and add it to your PATH. This is required for the LSP backend.

```sh
GO111MODULE=on go install golang.org/x/tools/gopls@latest
```

--------------------------------

### Install pyright language server via pip, yarn, or npm

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+lang/python/README.org

Install the pyright language server using your preferred package manager. Choose one of the three methods.

```sh
# via pip
pip install pyright
# or via yarn
yarn global add pyright
# or via npm
npm install -g pyright
```

--------------------------------

### Example sqls workspace configuration JSON

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+lang/sql/README.org

Example JSON configuration for sqls defining a MySQL connection with a data source name.

```json
{
  "sqls": {
    "connections": [
      {
        "driver": "mysql",
        "dataSourceName": "user1:password1@tcp(localhost:3306)/sample_db"
      }
    ]
  }
}
```

--------------------------------

### Install CoffeeLint for linting

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+lang/coffeescript/README.org

Run this command to install CoffeeLint globally via npm, which is required to enable linting in the CoffeeScript layer.

```sh
npm install -g coffeelint
```

--------------------------------

### Install DrRacket package with raco

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+lang/racket/README.org

Run this command in a terminal to install the DrRacket package when using the Minimal Racket installation. This is an alternative to having DrRacket pre-installed.

```Bash
raco pkg install drracket
```

--------------------------------

### Install MCP Filesystem Server via npm

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+web-services/github-copilot/README.org

Install the MCP filesystem server globally using npm. This is a manual step required for MCP tool integration.

```sh
$ npm install -g @modelcontextprotocol/server-filesystem
```

--------------------------------

### Install Idris with cabal

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+lang/idris/README.org

Install the Idris compiler using Haskell's cabal package manager. This is the primary installation method mentioned in the layer documentation.

```sh
cabal install idris
```

--------------------------------

### Install wakatime via pip

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+web-services/wakatime/README.org

Install the wakatime command-line tool using pip. For some Linux users, sudo may be required.

```sh
pip install wakatime
```

```sh
sudo pip install wakatime
```

--------------------------------

### Per-project backend selection with .dir-locals.el

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+lang/c-c++/README.org

Example of using directory local variables to select the lsp-ccls backend for a specific project. Place this in a .dir-locals.el file at the project root.

```elisp
;;; Directory Local Variables
;;; For more information see (info "(emacs) Directory Variables")
```

--------------------------------

### Install Perl::LanguageServer via cpan

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+lang/perl5/README.org

Alternative installation method for the LSP server using cpan. Run this command in a shell.

```sh
cpan Perl::LanguageServer
```

--------------------------------

### Initialize solium configuration

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+lang/solidity/README.org

Run this command in the root directory of your DApp to create the required .soliumrc.json file for the solium flycheck checker.

```sh
solium --init
```

--------------------------------

### Install anaconda-mode dependencies manually

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+lang/python/README.org

Install the required anaconda-mode dependencies by hand if automatic installation fails. If you encounter problems with Jedi 1.0, consider downgrading to 0.13.0.

```sh
pip install --upgrade "jedi>=0.13.0" "json-rpc>=1.8.1" "service_factory>=0.1.5"
```

--------------------------------

### Install recommended dependencies on Arch Linux

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+tags/gtags/README.org

Install ctags and python-pygments on Arch Linux to take full advantage of GNU Global.

```sh
sudo pacman -S ctags python-pygments
```

--------------------------------

### Install terminfo with tic

Source: https://github.com/syl20bnr/spacemacs/wiki/Terminal

Compiles the xterm-24bit.terminfo file into the user's terminfo database. Run after creating the file.

```bash
/usr/bin/tic -x -o ~/.terminfo xterm-24bit.terminfo
```

--------------------------------

### Install cmake-language-server via pip

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+tools/cmake/README.org

Install the latest version of the LSP server using pip. Required for the LSP backend to work.

```sh
pip install cmake-language-server
```

--------------------------------

### Install import-js with --unsafe-perm flag

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+tools/import-js/README.org

If the standard npm install fails, try this alternative using sudo and the --unsafe-perm flag.

```sh
$ sudo npm install --unsafe-perm -g import-js
```

--------------------------------

### Enable fcitx aggressive setup

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+intl/chinese/README.org

Activates fcitx aggressive setup, which likely ensures the input method is properly activated when needed.

```emacs-lisp
(fcitx-aggressive-setup)
```

--------------------------------

### Install languageserver package for LSP

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+lang/ess/README.org

Run this R command to install the external server required for LSP integration in the ESS layer.

```R
install.packages('languageserver')
```

--------------------------------

### Install poppler-utils for pdftotext

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+lang/asm/README.org

Command to install the pdftotext command line tool from Poppler, required for x86 instruction PDF lookup.

```sh
sudo apt-get install poppler-utils
```

--------------------------------

### Install GNU Tar on Windows via Scoop

Source: https://github.com/syl20bnr/spacemacs/blob/develop/README.md

Installs GNU Tar via Scoop because Windows ships with BSD Tar or may not have Tar installed. This avoids potential issues.

```powershell
scoop bucket add main
scoop install tar
```

--------------------------------

### Run Emacs with debug-init and timed-requires to log slow loading files

Source: https://github.com/syl20bnr/spacemacs/wiki/Debugging.org

Use this command to start Emacs with debugging enabled and a timer on all `require` and `load` statements. Files taking longer than 150ms will be logged in the `*load-times*` buffer, helping to identify slow startup causes.

```text
emacs --debug-init --timed-requires
```

--------------------------------

### Install yaml-language-server globally with npm

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+lang/yaml/README.org

Run this command to install the yaml-language-server package globally via npm, which is required to enable LSP support in the YAML layer.

```sh
npm i -g yaml-language-server
```

--------------------------------

### Install libvterm on macOS

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+tools/shell/README.org

Optional installation of libvterm on macOS using Homebrew.

```shell
brew install libvterm
```

--------------------------------

### Enable Emacs server at launch with dotspacemacs-enable-server

Source: https://github.com/syl20bnr/spacemacs/blob/develop/doc/DOCUMENTATION.org

Set dotspacemacs-enable-server to t in ~/.spacemacs to start the server at launch and kill it when closing Emacs windows.

```emacs-lisp
(setq-default dotspacemacs-enable-server t)
```

--------------------------------

### Install importmagic and epc

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+lang/python/README.org

Installs the required Python packages for importmagic functionality.

```sh
pip install importmagic epc
```

--------------------------------

### Example package list in packages.el

Source: https://github.com/syl20bnr/spacemacs/blob/develop/doc/LAYERS.org

Shows valid package specifications for the <layer>-packages variable, including built-in, ELPA, local, Quelpa recipe, GitHub recipe, and excluded packages.

```emacs-lisp
(defconst mylayer-packages
  '(
    ;; A built-in package
    (some-package :location built-in)

    ;; Get the package from MELPA, ELPA, etc.
    some-package
    (some-package :location elpa)

    ;; A local package
    (some-package :location local)

    ;; A local package to be built with Quelpa
    (some-package :location (recipe :fetcher local))

    ;; A package recipe
    (some-package :location (recipe
                             :fetcher github
                             :repo "some/repo"))

    ;; An excluded package
    (some-package :excluded t)
    ))
```

--------------------------------

### Install cargo-outdated

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+lang/rust/README.org

Install cargo-outdated to display dependencies that have new versions available.

```sh
cargo install cargo-outdated
```

--------------------------------

### Install elm-test via npm

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+lang/elm/README.org

Install elm-test to run unit tests.

```sh
npm install --global elm-test
```

--------------------------------

### Set kotlin-backend to LSP with server jar path

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+lang/kotlin/README.org

Configure the LSP backend by setting kotlin-backend to 'lsp and providing the path to the kotlin-language-server jar via kotlin-lsp-jar-path. The server starts automatically when a Kotlin file is opened.

```emacs-lisp
(kotlin :variables
          kotlin-backend 'lsp
          kotlin-lsp-jar-path "path/to/kotlin/installdir/install/server/bin/kotlin-language-server")
```

--------------------------------

### Install ripgrep on macOS (Optional)

Source: https://github.com/syl20bnr/spacemacs/blob/develop/README.md

Optionally installs ripgrep via Homebrew.

```sh
brew install ripgrep
```

--------------------------------

### Configure LanguageTool installation methods

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+checkers/languagetool/README.org

Provides five alternative configurations for the LanguageTool layer, depending on installation method: standalone jar, classpath, executable launcher, server jar, or HTTP server. Choose one method; each sets the appropriate variable.

```elisp
;; Standalone installation
(setq-default dotspacemacs-configuration-layers
              '((languagetool :variables
                              langtool-language-tool-jar "/home/username/languagetool/languagetool-commandline.jar")))
```

```elisp
;; Classpath (e.g. ArchLinux)
(setq-default dotspacemacs-configuration-layers
              '((languagetool :variables
                              langtool-java-classpath "/usr/share/languagetool:/usr/share/java/languagetool/*")))
```

```elisp
;; Executable standalone launcher (e.g. ArchLinux, Gentoo)
(setq-default dotspacemacs-configuration-layers
              '((languagetool :variables
                              langtool-bin "/usr/bin/languagetool")))
```

```elisp
;; Standalone installation (run server in background)
;; This is very fast after listen server, but has security risk if there are multiple user on a same host.
(setq-default dotspacemacs-configuration-layers
              '((languagetool :variables
                              ;; You can change HTTP server port number like following.
                              ;; langtool-server-user-arguments '("-p" "8081")
                              langtool-language-tool-server-jar "/path/to/languagetool-server.jar")))
```

```elisp
;; Running HTTP LanguageTool server instance on any machine
(setq-default dotspacemacs-configuration-layers
              '((languagetool :variables
                              langtool-http-server-host "localhost"
                              langtool-http-server-port 8081)))
```

--------------------------------

### Define-key Syntax and Example for Key Bindings

Source: https://github.com/syl20bnr/spacemacs/blob/develop/doc/VIMUSERS.org

Shows the syntax for defining key bindings with define-key, and an example binding H to previous-buffer in normal mode. Use this to customize key bindings in Spacemacs.

```emacs-lisp
(define-key map new-keybinding function) ; Syntax
;; Map H to go to the previous buffer in normal mode
(define-key evil-normal-state-map (kbd "H") 'previous-buffer)
```

--------------------------------

### Package initialization code for minimal bug reports

Source: https://github.com/syl20bnr/spacemacs/blob/develop/doc/DOCUMENTATION.org

Use this code in a scratch buffer after starting Emacs with emacs -q to reproduce package issues. It loads the package system, specifies packages to load, and initializes the package list. Evaluate with M-x eval-buffer.

```elisp
;; Load the package
(require 'package)

;; Mention all packages you wish to have loaded
(setq package-load-list
      '((package1 t)
        (package2 t)
        (package3 t)))

;; Do package specific configuration if required
;; (package-local-init)

;; Intialize your package list
(package-initialize)
```

--------------------------------

### Install Emacs Plus on macOS

Source: https://github.com/syl20bnr/spacemacs/blob/develop/README.md

Installs Emacs Plus via Homebrew tap, with optional Spacemacs icon and native compilation. Requires latest Xcode Command Line tools, which can be installed via softwareupdate.

```sh
brew tap d12frosted/emacs-plus

# install latest stable release, with Spacemacs icon and native compilation
brew install emacs-plus --with-spacemacs-icon --with-native-comp
```

```sh
softwareupdate --all --install --force
```

--------------------------------

### use-package with :init and :config sections

Source: https://github.com/syl20bnr/spacemacs/blob/develop/doc/VIMUSERS.org

Shows a use-package declaration with :init and :config sections. The :init section runs before the package loads, and the :config section runs after the package loads.

```emacs-lisp
  ;; The :init section is run before the package loads. The :config section is
  ;; run after the package loads
  (use-package package-name
    :defer t
    :init
    ;; Change some variables
    (setq variable1 t variable2 nil)
    ;; Define a function
    (defun foo ()
      (message "%s" "Hello, World!"))
    :config
    ;; Calling a function that is defined when the package loads
    (function-defined-when-package-loads))
```

--------------------------------

### boot profile.boot configuration for nREPL middleware

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+lang/clojure/README.org

Create ~/.boot/profile.boot with this content to add nREPL dependencies and middleware for CIDER, clj-refactor, and sayid when using boot. Requires boot 2.8.2 or newer. The cider-nrepl version should match your CIDER version for pre-0.18; use the most recent for 0.18+.

```clojure
(require 'boot.repl)

(swap! boot.repl/*default-dependencies* conj
       ;; When running an older version of CIDER (pre 0.18), use the
       ;; version that best matches M-x cider-version. For versions since
       ;; 0.18.0 use whatever version is the most recent.
       '[cider/cider-nrepl "0.21.1"]

       ;; Only necessary when using clj-refactor
       '[refactor-nrepl "2.4.0"]

       ;; Only necessary when using sayid
       '[com.billpiel/sayid "0.0.17"])

(swap! boot.repl/*default-middleware* conj
       'cider.nrepl/cider-middleware
       'refactor-nrepl.middleware/wrap-refactor
       'com.billpiel.sayid.nrepl-middleware/wrap-sayid)
```

--------------------------------

### Install eslint for linting

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+lang/typescript/README.org

Installs eslint globally via npm for linting with the TypeScript layer.

```shell
npm install eslint
```

--------------------------------

### Example mu4e configuration with maildir, shortcuts, and bookmarks

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+email/mu4e/README.org

Sets common mu4e variables such as maildir, trash/refile folders, and mail retrieval command. Also defines maildir shortcuts and bookmarks for quick access.

```emacs-lisp
;;; Set up some common mu4e variables
(setq mu4e-maildir "~/.mail"
      mu4e-trash-folder "/Trash"
      mu4e-refile-folder "/Archive"
      mu4e-get-mail-command "mbsync -a"
      mu4e-update-interval nil
      mu4e-compose-signature-auto-include nil
      mu4e-view-show-images t
      mu4e-view-show-addresses t)

;;; Mail directory shortcuts
(setq mu4e-maildir-shortcuts
      '(("/gmail/INBOX" . ?g)
        ("/college/INBOX" . ?c)))

;;; Bookmarks
(setq mu4e-bookmarks
      `(("flag:unread AND NOT flag:trashed" "Unread messages" ?u)
        ("date:today..now" "Today's messages" ?t)
        ("date:7d..now" "Last 7 days" ?w)
        ("mime:image/*" "Messages with images" ?p)
        (,(mapconcat 'identity
                     (mapcar
                      (lambda (maildir)
                        (concat "maildir:" (car maildir)))
                      mu4e-maildir-shortcuts) " OR ")
         "All inboxes" ?i)))
```

--------------------------------

### Install debugpy for dap-mode debugging

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+lang/python/README.org

Install debugpy to use dap-mode for debugging with the lsp backend.

```bash
pip install debugpy
```

--------------------------------

### Enable Trello support

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+emacs/org/README.org

Set org-enable-trello-support to t to install Trello support.

```emacs-lisp
(setq-default dotspacemacs-configuration-layers '(
  (org :variables
       org-enable-trello-support t)))
```

--------------------------------

### Set backend to lsp via directory local variables

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+lang/typescript/README.org

Example .dir-locals.el file to use the lsp backend for typescript-mode.

```elisp
;;; Directory Local Variables
;;; For more information see (info "(emacs) Directory Variables")
((typescript-mode (typescript-backend . lsp)))
```

--------------------------------

### Install CMake on Ubuntu

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+tools/shell/README.org

Install CMake 3.11 or higher on Ubuntu using apt, a prerequisite for vterm.

```shell
sudo apt install cmake
```

--------------------------------

### Install CMake on macOS

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+tools/shell/README.org

Install CMake 3.11 or higher on macOS using Homebrew, a prerequisite for vterm.

```shell
brew install cmake
```

--------------------------------

### CFEngine Hello World source block

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+tools/cfengine/README.org

A simple CFEngine policy that reports 'Hello World!'. Execute it in org-mode with ,, or Ctrl-c Ctrl-c.

```cfengine3
bundle agent main
{
  reports:

      "Hello World!";
}
```

--------------------------------

### Install Tern globally with npm

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+tools/tern/README.org

Run this command in a terminal to install Tern globally via npm.

```sh
$ npm install -g tern
```

--------------------------------

### Example template filename ordering

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+completion/templates/README.org

Template files must be named with a prefix and a regexp, e.g., '00:test_.*.py'. The prefix enforces ordering; more specific templates should come first.

```text
00:test_.*.py
01:.*.py
```

--------------------------------

### Install GNU Global on macOS using Homebrew

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+tags/gtags/README.org

Install GNU Global using Homebrew on macOS.

```sh
brew install global
```

--------------------------------

### Install GNU Global on Arch Linux

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+tags/gtags/README.org

Install GNU Global using yay on Arch Linux.

```sh
yay -S global
```

--------------------------------

### Set groovy-backend to lsp with jar path

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+lang/groovy/README.org

Explicitly configure the LSP backend in the dotfile. Requires obtaining the latest groovy-language-server jar from the provided link and setting groovy-lsp-jar-path to the path of groovy-language-server-all.jar.

```emacs-lisp
(groovy :variables
        groovy-backend 'lsp
        groovy-lsp-jar-path "path/to/groovy/lsp/jar-all.jar")
```

--------------------------------

### Install solargraph gem globally

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+lang/ruby/README.org

Install the solargraph gem globally, which is the only prerequisite gem for the LSP backend.

```sh
gem install solargraph
```

--------------------------------

### Set javascript-backend to lsp via directory local variables

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+lang/javascript/README.org

Use directory local variables in .dir-locals.el to set the backend to lsp for a project.

```elisp
;;; Directory Local Variables
;;; For more information see (info "(emacs) Directory Variables")

((js2-mode (javascript-backend . lsp)))
```

--------------------------------

### Update Pylookup database with multiple sources

Source: https://github.com/syl20bnr/spacemacs/blob/develop/layers/+lang/python/local/pylookup/README.md

These commands show how to index single or multiple documentation sources into the database. Use '-u' to add a source and '-a' to append to an existing database. The examples include remote and local sources for Python, SciPy, NumPy, and Matplotlib.

```shell
./pylookup.py -u http://docs.python.org
```

```shell
./pylookup.py -u http://docs.python.org -u ~/doc/python2.7
```

```shell
./pylookup.py -a -u ~/doc/python
```

```shell
./pylookup.py -u http://docs.python.org
./pylookup.py -u http://docs.scipy.org/doc/numpy/genindex.html
./pylookup.py -u http://docs.scipy.org/doc/scipy/reference/genindex.html
./pylookup.py -u http://matplotlib.sourceforge.net/genindex.html
```
Tokens:
Raw